starapi 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in starapi.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Filipe Chagas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Starapi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'starapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install starapi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/generators/starapi/install_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators"
+module Starapi
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Starapi initializer in your application initializers directory."
+      def copy_initializer
+        template "starapi.rb", "config/initializers/starapi.rb"
+      end
+
+    end # end class
+  end #end module
+end # end module

data/lib/generators/templates/starapi.rb

@@ -0,0 +1,6 @@
+Starapi.setup do |config|
+  config.namespace   = "http://www.example.com/RS/webservices/"
+  config.service_url = 'http://www.example.com/READiDataExchange/WSRSDataExchange.asmx'
+  config.user        = "user"
+  config.password    = "password"
+end

data/lib/starapi.rb

@@ -0,0 +1,23 @@
+require 'rails'
+require "starapi/version"
+require "starapi/soap_service_facade"
+require "starapi/soap_service_target"
+
+module Starapi
+  mattr_accessor :namespace
+  @@namespace   = "http://www.example.com/RS/webservices/"
+  mattr_accessor :service_url
+  @@service_url = 'http://example/READiDataExchange/WSRSDataExchange.asmx'
+  mattr_accessor :user
+  @@user        = "user"
+  mattr_accessor :password
+  @@password    = "password"
+
+  class << self
+    def setup
+      yield self
+    end
+  end
+
+
+end

data/lib/starapi/soap_service_facade.rb

@@ -0,0 +1,6 @@
+Dir[File.dirname(__FILE__) + "/soap_service_facade/*.rb"].each {|file| load file }
+
+module StarApi
+  module SoapServiceFacade
+  end
+end

data/lib/starapi/soap_service_facade/base.rb

@@ -0,0 +1,42 @@
+require 'typhoeus'
+require 'nokogiri'
+
+module Starapi
+  module SoapServiceFacade
+    class Base
+      def construct_envelope(&block)
+        Nokogiri::XML::Builder.new do |xml|
+          xml.Envelope("xmlns:soap12" => "http://www.w3.org/2003/05/soap-envelope",
+                       "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+                       "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema") do
+                         xml.parent.namespace = xml.parent.namespace_definitions.first
+                         xml['soap12'].Body(&block)
+                       end
+        end
+      end
+
+      def process_response(response)
+        @last_response = response
+
+        if response.body =~ /soap:Fault/ then
+          handle_error(response)
+        else
+          return response
+        end
+      end
+
+      def handle_error(response)
+        xml   = Nokogiri::XML(response.body)
+        xpath = '/soap:Envelope/soap:Body/soap:Fault//soap:Text'
+        msg   = xml.xpath(xpath).text
+
+        # TODO: Capture any app-specific exception messages here.
+        #       For example, if the server returns a Fault when a search
+        #       has no results, you might rather return an empty array.
+
+        raise SoapServiceFacade::SoapError.new("Error from server: #{msg}")
+      end
+
+    end
+  end
+end

data/lib/starapi/soap_service_facade/execute_sp.rb

@@ -0,0 +1,63 @@
+#################### Xml Structure #########################################################
+#
+#  POST /READiDataExchange/WSRSDataExchange.asmx HTTP/1.1
+#  Host: 198.61.141.129
+#  Content-Type: application/soap+xml; charset=utf-8
+#  Content-Length: length
+#
+#  <?xml version="1.0" encoding="utf-8"?>
+#  <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
+#    <soap12:Body>
+#      <ExecuteSP xmlns="http://www.opsolve.com/RS/webservices/">
+#        <user>string</user>
+#        <password>string</password>
+#        <spName>string</spName>
+#        <paramList>
+#          <string>string</string>
+#        </paramList>
+#        <outputParamList>
+#          <string>string</string>
+#        </outputParamList>
+#        <langCode>string</langCode>
+#      </ExecuteSP>
+#    </soap12:Body>
+#  </soap12:Envelope>
+
+module Starapi
+  module SoapServiceFacade
+    class ExecuteSP < Base
+      attr_reader :request_xml, :response
+
+      def envelope_execute_sp(input_xml)
+        envelope = construct_envelope do |xml|
+          xml.ExecuteSP("xmlns" => Starapi.namespace) do
+            xml.user Starapi.user
+            xml.password Starapi.password
+            xml.spName "RS_sp_EAI_Output"
+            xml.paramList do
+              xml.string "input_xml;#{input_xml}"
+            end
+            xml.outputParamList do
+              xml.string "output_xml;8000"
+            end
+            xml.langCode "en-us"
+          end
+        end
+      end
+
+      def soap_execute_sp!(input_xml)
+        @request_xml = envelope_execute_sp(input_xml).to_xml
+        @response = Typhoeus::Request.post(Starapi.service_url,
+                                           :body    => @request_xml,
+                                           :headers => {
+                                             'Content-Type' => "text/xml; charset=utf-8",
+                                             'Host' => '198.61.141.129',
+                                             'SOAPAction'=>  '"http://www.opsolve.com/RS/webservices/ExecuteSP"',
+                                             'Content-Length' => @request_xml.length
+                                           })
+                                           @response = process_response(@response)
+      end
+
+    end
+  end
+end

data/lib/starapi/soap_service_facade/soap_error.rb

@@ -0,0 +1,9 @@
+module Starapi
+  module SoapServiceFacade
+    class SoapError < StandardError
+      def initialize(message)
+        super(message)
+      end
+    end
+  end
+end

data/lib/starapi/soap_service_target.rb

@@ -0,0 +1,6 @@
+Dir[File.dirname(__FILE__) + "/soap_service_target/*.rb"].each {|file| load file }
+
+module StarApi
+  module SoapServiceTarget
+  end
+end

data/lib/starapi/soap_service_target/base.rb

@@ -0,0 +1,11 @@
+module Starapi
+  module SoapServiceTarget
+  class Base
+    attr_reader :soap_execute_sp
+
+    def soap_service_sp
+      @soap_execute_sp ||= SoapServiceFacade::ExecuteSP.new
+    end
+  end
+end
+end

data/lib/starapi/soap_service_target/price_quote.rb

@@ -0,0 +1,92 @@
+#################### Xml Structure #########################################################
+#
+# #### Request ###
+#
+#  <ReadiSystem>
+#    <proc_type>GU_sp_DR_Price_Quote</proc_type>
+#    <entno>7827</entno>
+#    <supno>DUKE_OH</supno>
+#    <rev_type>R</rev_type>
+#    <request_date>2012-12-05</request_date>
+#  </ReadiSystem>
+#
+#  ### Response ###
+#	<READiSystem>
+#		<GU_sp_DR_FF_Quote>
+#			<entno>0001</entno>
+#			<supno>FE_OHED</supno>
+#			<offer_desc>Ohio Electric - Residential</offer_desc>
+#			<rev_type>R</rev_type>
+#			<price_desc>Ohio Res - 1 Yr Fixed - Dec 12</price_desc>
+#			<enroll_eff_date>2012-12-01</enroll_eff_date>
+#			<enroll_exp_date>2012-12-31</enroll_exp_date>
+#			<offer_price>0.0965</offer_price >
+#			<price_uom>kWh</price_uom>
+#			<price_to_compare >0.0984</price_to_compare>
+#			<ptc_message>The Price to Compare for Ohio Electric was derived assuming a 750kWh average monthly consumption.  Your actual Price to Compare could vary slightly based on your actual usage.</ptc_message>
+#		</GU_sp_DR_FF_Quote>
+#	</READiSystem>
+
+module Starapi
+  module SoapServiceTarget
+    class PriceQuote < Base
+
+      @@PROC_TYPE = "GU_sp_DR_Price_Quote"
+
+      attr_reader :entno, :supno, :rev_type, :request_date, :request_xml, :last_response
+      attr_writer :entno, :supno, :rev_type, :request_date
+
+      def initialize(entno, supno, rev_type, request_date)
+        @entno, @supno, @rev_type, @request_date = entno, supno, rev_type, request_date
+      end
+
+      def construct_xml
+        Nokogiri::XML::Builder.new do |xml|
+          xml.ReadiSystem do
+            xml.proc_type @@PROC_TYPE
+            xml.entno @entno
+            xml.supno @supno
+            xml.rev_type @rev_type
+            xml.request_date @request_date
+          end
+        end
+      end
+
+      def soap_price_quote!
+        @request_xml = construct_xml.to_xml
+        @last_response = get_target_response soap_service_sp.soap_execute_sp!(@request_xml)
+      end
+
+      def parse_response
+        if @last_response.blank?
+          raise StandardError.new "Response is not loaded. It looks like the request was not made."
+        end
+
+        xml = Nokogiri::XML(@last_response)
+
+        parsed_obj = OpenStruct.new
+
+        parsed_obj.entno            = xml.xpath("//entno").text
+        parsed_obj.supno            = xml.xpath("//supno").text
+        parsed_obj.offer_desc       = xml.xpath("//offer_desc").text
+        parsed_obj.rev_type         = xml.xpath("//rev_type").text
+        parsed_obj.price_desc       = xml.xpath("//price_desc").text
+        parsed_obj.enroll_eff_date  = xml.xpath("//enroll_eff_date").text
+        parsed_obj.enroll_exp_date  = xml.xpath("//enroll_exp_date").text
+        parsed_obj.offer_price      = xml.xpath("//offer_price").text
+        parsed_obj.price_uom        = xml.xpath("//price_uom").text
+        parsed_obj.price_to_compare = xml.xpath("//price_to_compare").text
+        parsed_obj.ptc_message      = xml.xpath("//ptc_message").text
+        parsed_obj
+      end
+
+      private
+      def get_target_response(response)
+        xml   = Nokogiri::XML(response.body)
+        xpath = '/soap:Envelope/soap:Body'
+        xml.xpath(xpath).text
+      end
+
+    end # end class
+  end # end module
+end #end module

data/lib/starapi/version.rb

@@ -0,0 +1,3 @@
+module Starapi
+  VERSION = "0.0.1"
+end

data/starapi.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "starapi/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Filipe Chagas"]
+  gem.email         = ["filipe@ochagas.com"]
+  gem.license = "MIT"
+  gem.description   = %q{Gem created in order to consume READi System Webservices}
+  gem.summary       = %q{Gem created in order to consume READi System Webservices}
+  gem.homepage      = "http://github.com/Quezmedia/quez_starapi"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "starapi"
+  gem.require_paths = ["lib", "lib/soap_service_facade", "lib/soap_service_target"]
+  gem.version       = Starapi::VERSION
+
+  gem.add_dependency 'typhoeus'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency("railties", "~> 3.1")
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: starapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Filipe Chagas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &70302244985180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70302244985180
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70302244984600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70302244984600
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70302245015660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70302245015660
+description: Gem created in order to consume READi System Webservices
+email:
+- filipe@ochagas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/starapi/install_generator.rb
+- lib/generators/templates/starapi.rb
+- lib/starapi.rb
+- lib/starapi/soap_service_facade.rb
+- lib/starapi/soap_service_facade/base.rb
+- lib/starapi/soap_service_facade/execute_sp.rb
+- lib/starapi/soap_service_facade/soap_error.rb
+- lib/starapi/soap_service_target.rb
+- lib/starapi/soap_service_target/base.rb
+- lib/starapi/soap_service_target/price_quote.rb
+- lib/starapi/version.rb
+- starapi.gemspec
+homepage: http://github.com/Quezmedia/quez_starapi
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/soap_service_facade
+- lib/soap_service_target
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Gem created in order to consume READi System Webservices
+test_files: []