#@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ # # Copyright (c) 2016, Electric Power Research Institute (EPRI) # All rights reserved. # # OpenADR ("this software") is licensed under BSD 3-Clause license. # # Redistribution and use in source and binary forms, with or without modification, # are permitted provided that the following conditions are met: # # * Redistributions of source code must retain the above copyright notice, this # list of conditions and the following disclaimer. # # * Redistributions in binary form must reproduce the above copyright notice, # this list of conditions and the following disclaimer in the documentation # and/or other materials provided with the distribution. # # * Neither the name of EPRI nor the names of its contributors may # be used to endorse or promote products derived from this software without # specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. # IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, # INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY # OF SUCH DAMAGE. # # This EPRI software incorporates work covered by the following copyright and permission # notices. You may not use these works except in compliance with their respective # licenses, which are provided below. # # These works are provided by the copyright holders and contributors "as is" and any express or # implied warranties, including, but not limited to, the implied warranties of merchantability # and fitness for a particular purpose are disclaimed. # ######################################################################################### # MIT Licensed Libraries ######################################################################################### # # * actionmailer 3.2.12 (http://www.rubyonrails.org) - Email composition, delivery, and receiving framework (part of Rails). # * actionpack 3.2.12 (http://www.rubyonrails.org) - Web-flow and rendering framework putting the VC in MVC (part of Rails). # * activemodel 3.2.12 (http://www.rubyonrails.org) - A toolkit for building modeling frameworks (part of Rails). # * activerecord 3.2.12 (http://www.rubyonrails.org) - Object-relational mapper framework (part of Rails). # * activeresource 3.2.12 (http://www.rubyonrails.org) - REST modeling framework (part of Rails). # * activesupport 3.2.12 (http://www.rubyonrails.org) - A toolkit of support libraries and Ruby core extensions extracted from the Rails framework. # * arel 3.0.2 (http://github.com/rails/arel) - Arel is a SQL AST manager for Ruby # * bootstrap-sass 3.1.1.0 (https://github.com/twbs/bootstrap-sass) - Twitter's Bootstrap, converted to Sass and ready to drop into Rails or Compass # * builder 3.0.4 (http://onestepback.org) - Builders for MarkUp. # * bundler 1.12.5 (http://bundler.io) - The best way to manage your application's dependencies # * capybara 2.4.4 (http://github.com/jnicklas/capybara) - Capybara aims to simplify the process of integration testing Rack applications, such as Rails, Sinatra or Merb # * coffee-rails 3.2.2 () - Coffee Script adapter for the Rails asset pipeline. # * coffee-script-source 1.6.3 (http://jashkenas.github.com/coffee-script/) - The CoffeeScript Compiler # * docile 1.1.5 (https://ms-ati.github.io/docile/) - Docile keeps your Ruby DSLs tame and well-behaved # * edn 1.0.0 () - 'edn implements a reader for Extensible Data Notation by Rich Hickey.' # * erubis 2.7.0 (http://www.kuwata-lab.com/erubis/) - a fast and extensible eRuby implementation which supports multi-language # * execjs 1.4.0 (https://github.com/sstephenson/execjs) - Run JavaScript code from Ruby # * factory_girl 4.5.0 (https://github.com/thoughtbot/factory_girl) - factory_girl provides a framework and DSL for defining and using model instance factories. # * factory_girl_rails 4.5.0 (http://github.com/thoughtbot/factory_girl_rails) - factory_girl_rails provides integration between factory_girl and rails 3 # * gem-licenses 0.1.2 (http://github.com/dblock/gem-licenses) - List all gem licenses. # * hike 1.2.3 (http://github.com/sstephenson/hike) - Find files in a set of paths # * i18n 0.6.5 (http://github.com/svenfuchs/i18n) - New wave Internationalization support for Ruby # * jdbc-postgresql 9.2.1000 (https://github.com/rosenfeld/jdbc-postgresql) - PostgresSQL jdbc driver for JRuby # * journey 1.0.4 (http://github.com/rails/journey) - Journey is a router # * jquery-rails 3.0.4 (http://rubygems.org/gems/jquery-rails) - Use jQuery with Rails 3 # * json-schema 2.6.2 (http://github.com/ruby-json-schema/json-schema/tree/master) - Ruby JSON Schema Validator # * mail 2.4.4 (http://github.com/mikel/mail) - Mail provides a nice Ruby DSL for making, sending and reading emails. # * metaclass 0.0.4 (http://github.com/floehopper/metaclass) - Adds a metaclass method to all Ruby objects # * mime-types 1.23 (http://mime-types.rubyforge.org/) - This library allows for the identification of a file's likely MIME content type # * mocha 1.1.0 (http://gofreerange.com/mocha/docs) - Mocking and stubbing library # * multi_json 1.7.9 (http://github.com/intridea/multi_json) - A common interface to multiple JSON libraries. # * nokogiri 1.6.5 (http://nokogiri.org) - Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser # * polyglot 0.3.3 (http://github.com/cjheath/polyglot) - Augment 'require' to load non-Ruby file types # * rack-test 0.6.2 (http://github.com/brynary/rack-test) - Simple testing API built on Rack # * railties 3.2.12 (http://www.rubyonrails.org) - Tools for creating, working with, and running Rails applications. # * rake 10.1.0 (http://rake.rubyforge.org) - Ruby based make-like utility. # * rspec-core 2.14.3 (http://github.com/rspec/rspec-core) - rspec-core-2.14.3 # * rspec-expectations 2.14.0 (http://github.com/rspec/rspec-expectations) - rspec-expectations-2.14.0 # * rspec-mocks 2.14.1 (http://github.com/rspec/rspec-mocks) - rspec-mocks-2.14.1 # * rspec-rails 2.14.0 (http://github.com/rspec/rspec-rails) - rspec-rails-2.14.0 # * sass 3.2.9 (http://sass-lang.com/) - A powerful but elegant CSS compiler that makes CSS fun again. # * sass-rails 3.2.6 () - Sass adapter for the Rails asset pipeline. # * simplecov 0.9.0 (http://github.com/colszowka/simplecov) - Code coverage for Ruby 1.9+ with a powerful configuration library and automatic merging of coverage across test suites # * spork 1.0.0rc3 (http://github.com/sporkrb/spork) - spork # * therubyrhino 2.0.2 (http://github.com/cowboyd/therubyrhino) - Embed the Rhino JavaScript interpreter into JRuby # * thor 0.18.1 (http://whatisthor.com/) - A scripting framework that replaces rake, sake and rubigen # * tilt 1.4.1 (http://github.com/rtomayko/tilt/) - Generic interface to multiple Ruby template engines # * treetop 1.4.14 (https://github.com/cjheath/treetop) - A Ruby-based text parsing and interpretation DSL # * uglifier 2.1.2 (http://github.com/lautis/uglifier) - Ruby wrapper for UglifyJS JavaScript compressor # * xpath 2.0.0 (http://github.com/jnicklas/xpath) - Generate XPath expressions from Ruby # * blankslate 2.1.2.4 (http://github.com/masover/blankslate) - BlankSlate extracted from Builder. # * bourbon 3.1.8 (https://github.com/thoughtbot/bourbon) - Bourbon Sass Mixins using SCSS syntax. # * coffee-script 2.2.0 (http://github.com/josh/ruby-coffee-script) - Ruby CoffeeScript Compiler # * diff-lcs 1.2.4 (http://diff-lcs.rubyforge.org/) - Diff::LCS computes the difference between two Enumerable sequences using the McIlroy-Hunt longest common subsequence (LCS) algorithm # * jquery-ui-rails 4.0.3 (https://github.com/joliss/jquery-ui-rails) - jQuery UI packaged for the Rails asset pipeline # * parslet 1.4.0 (http://kschiess.github.com/parslet) - Parser construction library with great error reporting in Ruby. # * rack 1.4.5 (http://rack.github.com/) - a modular Ruby webserver interface # * rack-cache 1.2 (http://tomayko.com/src/rack-cache/) - HTTP Caching for Rack # * rack-ssl 1.3.3 (https://github.com/josh/rack-ssl) - Force SSL/TLS in your app. # * rails 3.2.12 (http://www.rubyonrails.org) - Full-stack web application framework. # * simplecov-html 0.8.0 (https://github.com/colszowka/simplecov-html) - Default HTML formatter for SimpleCov code coverage tool for ruby 1.9+ # * tzinfo 0.3.37 (http://tzinfo.rubyforge.org/) - Daylight-savings aware timezone library # * warbler 1.4.0.beta1 (http://caldersphere.rubyforge.org/warbler) - Warbler chirpily constructs .war files of your Rails applications. # ######################################################################################### # BSD Licensed Libraries ######################################################################################### # # * activerecord-jdbc-adapter 1.2.9.1 (https://github.com/jruby/activerecord-jdbc-adapter) - Copyright (c) 2006-2012 Nick Sieger , Copyright (c) 2006-2008 Ola Bini # * jdbc-postgres 9.2.1004 (https://github.com/jruby/activerecord-jdbc-adapter) - Copyright (c) 1997-2011, PostgreSQL Global Development Group # * d3js 3.5.16 (https://d3js.org/) Copyright (c) 2015 Mike Bostock # ######################################################################################### # Ruby Licensed Libraries ######################################################################################### # # * json 1.8.0 (http://json-jruby.rubyforge.org/) - JSON implementation for JRuby # * rubyzip 0.9.9 (http://github.com/aussiegeek/rubyzip) - rubyzip is a ruby module for reading and writing zip files # * httpclient 2.3.4.1 (http://github.com/nahi/httpclient) - gives something like the functionality of libwww-perl (LWP) in Ruby # * test-unit 2.5.5 (http://test-unit.rubyforge.org/) - test-unit - Improved version of Test::Unit bundled in Ruby 1.8.x. # ######################################################################################### # Public domain - creative commons Licensed Libraries ######################################################################################### # # * torquebox 3.1.2 (http://torquebox.org/) - TorqueBox Gem # * torquebox-cache 3.1.2 (http://torquebox.org/) - TorqueBox Cache Gem # * torquebox-configure 3.1.2 (http://torquebox.org/) - TorqueBox Configure Gem # * torquebox-core 3.1.2 (http://torquebox.org/) - TorqueBox Core Gem # * torquebox-messaging 3.1.2 (http://torquebox.org/) - TorqueBox Messaging Client # * torquebox-naming 3.1.2 (http://torquebox.org/) - TorqueBox Naming Client # * torquebox-rake-support 3.1.2 (http://torquebox.org/) - TorqueBox Rake Support # * torquebox-security 3.1.2 (http://torquebox.org/) - TorqueBox Security Gem # * torquebox-server 3.1.2 (http://torquebox.org/) - TorqueBox Server Gem # * torquebox-stomp 3.1.2 (http://torquebox.org/) - TorqueBox STOMP Support # * torquebox-transactions 3.1.2 (http://torquebox.org/) - TorqueBox Transactions Gem # * torquebox-web 3.1.2 (http://torquebox.org/) - TorqueBox Web Gem # ######################################################################################### # Apache Licensed Libraries ######################################################################################### # # * addressable 2.3.8 (https://github.com/sporkmonger/addressable) - URI Implementation # * bcrypt-ruby 3.0.1 (http://bcrypt-ruby.rubyforge.org) - OpenBSD's bcrypt() password hashing algorithm. # * database_cleaner 1.4.0 (http://github.com/bmabey/database_cleaner) - Strategies for cleaning databases. Can be used to ensure a clean state for testing. # * annotate 2.5.0 (http://github.com/ctran/annotate_models) - Annotates Rails Models, routes, fixtures, and others based on the database schema. # * nvd3 1.8.4 (http://nvd3.org/) Copeyright (c) 2014 Novus Partners - chart library based on d3js # * smack 3.3.1 (https://www.igniterealtime.org/projects/smack/) - XMPP library # ######################################################################################### # LGPL ######################################################################################### # # * jruby-1.7.4 # * jruby-jars 1.7.4 (http://github.com/jruby/jruby/tree/master/gem/jruby-jars) - The core JRuby code and the JRuby stdlib as jar # ** JRuby is tri-licensed GPL, LGPL, and EPL. # ######################################################################################### # MPL Licensed Libraries ######################################################################################### # # * therubyrhino_jar 1.7.4 (http://github.com/cowboyd/therubyrhino) - Rhino's jars packed for therubyrhino # ######################################################################################### # Artistic 2.0 # * mime-types 1.23 (http://mime-types.rubyforge.org/) - This library allows for the identification of a file's likely MIME content type # ######################################################################################### # ######################################################################################### # GPL-2 ######################################################################################### # * mime-types 1.23 (http://mime-types.rubyforge.org/) - This library allows for the identification of a file's likely MIME content type # ######################################################################################### # No License Given ######################################################################################### # # * spork-testunit 0.0.8 (http://github.com/timcharper/spork-testunit) - spork-testunit # * sprockets 2.2.2 (http://getsprockets.org/) - Rack-based asset packaging system # #@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ require 'java' # require 'lib/oadr/oadr2b.jar' # $CLASSPATH << "lib/oadr/oadr2b.jar" require 'oadr_service.rb' require 'marshalling20b.rb' java_import Java::epri.oadr2b.lib.OadrCreatedPartyRegistration java_import Java::epri.oadr2b.lib.OadrCreatePartyRegistration java_import Java::epri.oadr2b.lib.OadrCancelPartyRegistration java_import Java::epri.oadr2b.lib.OadrCanceledPartyRegistration java_import Java::epri.oadr2b.lib.OadrRequestReregistration #import Java::epri.oadr2b.lib.OadrProfiles require 'singleton' class RegisterPartyService < OadrService #include Singleton ######################################################## def initialize super() register_function("epri.oadr2b.lib.OadrQueryRegistration", :process_query_registration) register_function("epri.oadr2b.lib.OadrCreatePartyRegistration", :process_create_registration) register_function("epri.oadr2b.lib.OadrCancelPartyRegistration", :process_cancel_registration) register_function("epri.oadr2b.lib.OadrCanceledPartyRegistration", :process_canceled_registration) end ######################################################## def process_query_registration(query_registration) # lookup the VEN for VEN ID and registration ID. if the VEN is registered, add the registration ID to the response # queryRegistration does not include ven ID... need to use the signature of the SSL cert # to find the VEN # ven = Ven.find_by_name(query_registration.) vtn_parameters = VtnParameter.first ven_id = '' registration_id = '' # connection is over SSL but the CN did not match an entry # in the database; return an error if @ssl_ven.nil? and @validate_cn return Oadr2bFactory.create_created_party_registration('452', 'Invalid ID', query_registration.request_id, '', '', '', '') # add VEN ID and Registraiton ID if the VEN is registered elsif not @ssl_ven.nil? and not @ssl_ven.registration.nil? ven_id = @ssl_ven.ven_id registration_id = @ssl_ven.registration.nil? ? '' : @ssl_ven.registration.registration_id end created_party_registration = Oadr2bFactory.create_created_party_registration('200', 'OK', query_registration.request_id, ven_id, vtn_parameters.vtn_name, vtn_parameters.poll_interval, registration_id) created_party_registration end ######################################################## def process_create_registration(create_registration) # this is to aid in code completion: remember to comment out! # create_registration = OadrCreatePartyRegistration.new # TODO: if the ven isn't found, what error should be returned? # TODO: use the fingerprint from the SSL cert to lookup the VEN if not create_registration.ven_id.nil? and create_registration.ven_id != "" # the VEN can submit a preconfigured VEN ID; use the VEN ID to find the VEN # if the lookup by ven_name failed ven = Ven.find_by_ven_id(create_registration.ven_id) # lookup by VEN id failed but we found the VEN by SSL lookup # this indicates a pre-allocated VEN ID; save the ID if ven.nil? and not @ssl_ven.nil? ven = @ssl_ven @ssl_ven.ven_id = create_registration.ven_id @ssl_ven.save end elsif not create_registration.oadr_ven_name.nil? and create_registration.oadr_ven_name != "" ven = Ven.find_by_name(create_registration.oadr_ven_name) else ven = @ssl_ven end vtn_parameters = VtnParameter.first # failed to find VEN by common name if @ssl_ven.nil? and @validate_cn OadrLogger.instance.log_error("VEN not found by common name and SSL is on") return Oadr2bFactory.create_created_party_registration('452', 'Invalid ID', create_registration.request_id, '', '', '', '') end if ven.nil? OadrLogger.instance.log_error("VEN not found") return Oadr2bFactory.create_created_party_registration('452', 'Invalid ID', create_registration.request_id, '', '', '', '') end # the ven indicate by ven_name should match the ven # indicated in the SSL certificate if not @ssl_ven.nil? if @ssl_ven.id != ven.id return Oadr2bFactory.create_created_party_registration('463', 'Not Registered/Authorized', create_registration.request_id, '', '', '', '') end end if ven.registration.nil? registration = ven.registrations.new registration.registration_id = SecureRandom.hex(10) else registration = ven.registration end # TODO: check if create_registration.registration_id exists and that it's for this VEN registration.request_id = create_registration.request_id registration.ven_name = ven.name registration.oadr_profile_name = create_registration.oadr_profile_name registration.oadr_transport_name = create_registration.oadr_transport_name.value registration.oadr_transport_address = create_registration.oadr_transport_address registration.oadr_report_only = create_registration.oadr_report_only registration.oadr_xml_signature = create_registration.oadr_xml_signature registration.oadr_ven_name = create_registration.oadr_ven_name registration.oadr_http_pull_model = create_registration.is_oadr_http_pull_model registration.save if ven.registration.nil? ven.registration = registration ven.save end # clear any pending messages; messages prior to registration are likely invalid ven.ven_messages.destroy_all # after registering, the VEN will send an OadrPoll, expecting a register report message # queue an empty RegisterReport message register_report = Oadr2bFactory.create_register_report(ven.ven_id) Marshalling20b.instance.queue_message(ven, register_report, 'EiReport', false) # created_party_registration = Oadr2bFactory.create_created_party_registration('200', 'OK', create_registration.request_id, ven_name, vtn_parameters.vtn_name, vtn_parameters.poll_interval, create_registration.registration_id) created_party_registration = Oadr2bFactory.create_created_party_registration('200', 'OK', create_registration.request_id, ven.ven_id, vtn_parameters.vtn_name, vtn_parameters.poll_interval, registration.registration_id) created_party_registration end ######################################################## # @param [OadrCanceledPartyRegistration] canceled_registration def process_canceled_registration(canceled_registration) ven_id = canceled_registration.ven_id ven = validate_ven(ven_id, '') ven.registration = nil ven.save # clear any pending messages ven.ven_messages.destroy_all # TODO: should the server handle this type of message? What type of message shold it return, nothing? like # if VEN receives a cancel message in a poll, does it turn around # and send a cancel? # for now, just return the default 200, OK Oadr2bFactory.create_oadr_response(nil, '200', 'OK', canceled_registration.ei_response.request_id) end ######################################################## def process_cancel_registration(cancel_registration) # this is to aid in code completion: remember to comment out! # create_registration = OadrCancelPartyRegistration.new ven_id = cancel_registration.ven_id request_id = cancel_registration.request_id begin ven = validate_ven(ven_id, request_id) rescue OadrException => e canceled_party_registration = Oadr2bFactory.create_canceled_registration(e.code, e.description, ven_id, request_id, cancel_registration.registration_id) return canceled_party_registration end # TODO: should we check that the registration ID matches? if ven.registration.nil? or ven.registration.registration_id != cancel_registration.registration_id canceled_party_registration = Oadr2bFactory.create_canceled_registration('452', 'Invalid ID', cancel_registration.ven_id, cancel_registration.request_id, cancel_registration.registration_id) return canceled_party_registration end registration_id = ven.registration.registration_id if not ven.registration.nil? # at this point, the correct VEN requested that registration be cancel # cancel registration for the VEN ven.registration = nil ven.save # clear any pending messages ven.ven_messages.destroy_all canceled_party_registration = Oadr2bFactory.create_canceled_registration('200', 'OK', ven.ven_id, cancel_registration.request_id, cancel_registration.registration_id) canceled_party_registration end ######################################################## def queue_reregistration(ven) request_reregistration = Oadr2bFactory.create_oadr_reregistration(ven.ven_id) Marshalling20b.instance.queue_message(ven, request_reregistration, 'EiRegisterParty', true) end ######################################################## def queue_cancel_registration(ven, registration) return if registration.nil? cancel_registration = Oadr2bFactory.create_cancel_registration(ven.ven_id, registration.registration_id) Marshalling20b.instance.queue_message(ven, cancel_registration, 'EiRegisterParty', true) end end