ruby-ecomm-client 1.1.0 → 1.7.0

data/fixtures/vcr_cassettes/transitions/many.yml

@@ -1,42 +1,57 @@
---- 
-http_interactions: 
-- request: 
+---
+http_interactions:
+- request:
     method: post
-    uri: http://bonsai.dev.glbt1.gdg/bonsai/bonsaimanager/service.asmx
-    body: 
-      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:tns="#Bonsai" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><tns:GetAccountXml><tns:IDType>ORION</tns:IDType><tns:PrivateLabelID>1</tns:PrivateLabelID><tns:ResourceType>outright</tns:ResourceType><tns:TreeID>1735</tns:TreeID><tns:ResourceID>10e16f14-b606-11e3-a45e-0050569575d8</tns:ResourceID></tns:GetAccountXml></env:Body></env:Envelope>
-    headers: 
-      content-type: 
+    uri: http://bonsai.dev.glbt1.gdg/Bonsai/BonsaiManager/Service.asmx
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="#Bonsai"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><tns:GetAccountXml><tns:ResourceID>b6be6fd0-c1a5-11e3-8e42-0050569575d8</tns:ResourceID><tns:ResourceType>outright</tns:ResourceType><tns:IDType>ORION</tns:IDType><tns:TreeID>2410</tns:TreeID><tns:PrivateLabelID>1</tns:PrivateLabelID></tns:GetAccountXml></env:Body></env:Envelope>
+    headers:
+      soapaction:
+      - ! '"#Bonsai/GetAccountXml"'
+      content-type:
       - text/xml;charset=UTF-8
-      content-length: 
-      - "515"
-      accept: 
-      - "*/*"
-      soapaction: 
-      - "\"#Bonsai/GetAccountXml\""
-  response: 
-    status: 
+      content-length:
+      - '515'
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      content-type: 
-      - text/xml; charset=utf-8
-      content-length: 
-      - "1626"
-      x-aspnet-version: 
-      - 4.0.30319
-      cache-control: 
+    headers:
+      cache-control:
       - private, max-age=0
-      server: 
+      content-type:
+      - text/xml; charset=utf-8
+      server:
       - Microsoft-IIS/7.0
-      date: 
-      - Fri, 28 Mar 2014 00:22:33 GMT
-      connection: 
-      - close
-      x-powered-by: 
+      x-aspnet-version:
+      - 4.0.30319
+      x-powered-by:
       - ASP.NET
-    body: 
-      string: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><GetAccountXmlResponse xmlns="#Bonsai"><ResultCode>0</ResultCode><AccountXml><Bonsai><Bonsai PrivateLabelID="1" ResourceID="10e16f14-b606-11e3-a45e-0050569575d8" IsPastDue="False" IsFree="False" CurrentTreeID="1735" CurrentUnifiedProductID="2701" xmlns=""><Tree TreeID="1735" NodeID="1735" UnifiedProductID="2701" IsFree="False"><Transition NodeName="Outright - Monthly Plus" UnifiedProductID="2697" TreeID="1734" IsFree="False" NodeID="1734" /><Transition NodeName="Outright - Annual Plus 1 year" UnifiedProductID="2699" TreeID="1736" IsFree="False" NodeID="1736" /><Transition NodeName="Outright - Annual Plus 2 years" UnifiedProductID="2703" TreeID="1737" IsFree="False" NodeID="1737" /><Transition NodeName="Outright - Annual Plus 3 years" UnifiedProductID="2705" TreeID="1738" IsFree="False" NodeID="1738" /><Transition NodeName="Outright - Annual Plus 4 years" UnifiedProductID="2707" TreeID="1739" IsFree="False" NodeID="1739" /><Transition NodeName="Outright - Annual Plus 5 years" UnifiedProductID="2709" TreeID="1740" IsFree="False" NodeID="1740" /><FilteredTransitions /><Prepaid><Item Name="Prepaid Previous Tax - Outright" CategoryName="Prepaid Previous Tax" CategoryID="49" MinQty="1" MaxQty="-1" MinDuration="1" MaxDuration="-1" IsQuantityBased="False" Increment="1" UnifiedProductID="2711" /></Prepaid></Tree></Bonsai></Bonsai></AccountXml></GetAccountXmlResponse></soap:Body></soap:Envelope>
-    http_version: "1.1"
-  recorded_at: Fri, 28 Mar 2014 00:22:36 GMT
+      date:
+      - Fri, 18 Apr 2014 16:29:10 GMT
+      connection:
+      - close
+      content-length:
+      - '924'
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><GetAccountXmlResponse
+        xmlns="#Bonsai"><ResultCode>0</ResultCode><AccountXml><Bonsai><Bonsai PrivateLabelID="1"
+        ResourceID="b6be6fd0-c1a5-11e3-8e42-0050569575d8" IsPastDue="False" IsFree="False"
+        CurrentTreeID="2410" CurrentUnifiedProductID="326365" xmlns=""><Tree TreeID="2410"
+        NodeID="2410" UnifiedProductID="326365" IsFree="False"><Transition NodeName="Starter
+        Outright Get Paid - Monthly" UnifiedProductID="326363" TreeID="2402" IsFree="False"
+        NodeID="2402" /><Transition NodeName="Premium Outright Get Paid - Monthly"
+        UnifiedProductID="326388" TreeID="2418" IsFree="False" NodeID="2418" /><FilteredTransitions
+        /></Tree></Bonsai></Bonsai></AccountXml></GetAccountXmlResponse></soap:Body></soap:Envelope>
+    http_version: '1.1'
+  recorded_at: Fri, 18 Apr 2014 16:30:09 GMT
 recorded_with: VCR 2.8.0

data/fixtures/vcr_cassettes/transitions/one.yml

@@ -1,42 +1,57 @@
---- 
-http_interactions: 
-- request: 
+---
+http_interactions:
+- request:
     method: post
-    uri: http://bonsai.dev.glbt1.gdg/bonsai/bonsaimanager/service.asmx
-    body: 
-      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:tns="#Bonsai" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><tns:GetAccountXml><tns:IDType>ORION</tns:IDType><tns:PrivateLabelID>1</tns:PrivateLabelID><tns:ResourceType>outright</tns:ResourceType><tns:TreeID>1734</tns:TreeID><tns:ResourceID>10e16f14-b606-11e3-a45e-0050569575d8</tns:ResourceID></tns:GetAccountXml></env:Body></env:Envelope>
-    headers: 
-      content-type: 
+    uri: http://bonsai.dev.glbt1.gdg/Bonsai/BonsaiManager/Service.asmx
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="#Bonsai"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><tns:GetAccountXml><tns:ResourceID>b6be6fd0-c1a5-11e3-8e42-0050569575d8</tns:ResourceID><tns:ResourceType>outright</tns:ResourceType><tns:IDType>ORION</tns:IDType><tns:TreeID>2402</tns:TreeID><tns:PrivateLabelID>1</tns:PrivateLabelID></tns:GetAccountXml></env:Body></env:Envelope>
+    headers:
+      soapaction:
+      - ! '"#Bonsai/GetAccountXml"'
+      content-type:
       - text/xml;charset=UTF-8
-      content-length: 
-      - "515"
-      accept: 
-      - "*/*"
-      soapaction: 
-      - "\"#Bonsai/GetAccountXml\""
-  response: 
-    status: 
+      content-length:
+      - '515'
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
       code: 200
       message: OK
-    headers: 
-      content-type: 
-      - text/xml; charset=utf-8
-      content-length: 
-      - "768"
-      x-aspnet-version: 
-      - 4.0.30319
-      cache-control: 
+    headers:
+      cache-control:
       - private, max-age=0
-      server: 
+      content-type:
+      - text/xml; charset=utf-8
+      server:
       - Microsoft-IIS/7.0
-      date: 
-      - Fri, 28 Mar 2014 00:22:33 GMT
-      connection: 
-      - close
-      x-powered-by: 
+      x-aspnet-version:
+      - 4.0.30319
+      x-powered-by:
       - ASP.NET
-    body: 
-      string: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><GetAccountXmlResponse xmlns="#Bonsai"><ResultCode>0</ResultCode><AccountXml><Bonsai><Bonsai PrivateLabelID="1" ResourceID="10e16f14-b606-11e3-a45e-0050569575d8" IsPastDue="False" IsFree="False" CurrentTreeID="1735" CurrentUnifiedProductID="2701" xmlns=""><Tree TreeID="1734" NodeID="1734" UnifiedProductID="2697" IsFree="False"><Transition NodeName="Outright - Free" UnifiedProductID="2701" TreeID="1735" IsFree="False" NodeID="1735" /><FilteredTransitions /></Tree></Bonsai></Bonsai></AccountXml></GetAccountXmlResponse></soap:Body></soap:Envelope>
-    http_version: "1.1"
-  recorded_at: Fri, 28 Mar 2014 00:22:36 GMT
+      date:
+      - Fri, 18 Apr 2014 16:29:09 GMT
+      connection:
+      - close
+      content-length:
+      - '926'
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><GetAccountXmlResponse
+        xmlns="#Bonsai"><ResultCode>0</ResultCode><AccountXml><Bonsai><Bonsai PrivateLabelID="1"
+        ResourceID="b6be6fd0-c1a5-11e3-8e42-0050569575d8" IsPastDue="False" IsFree="False"
+        CurrentTreeID="2410" CurrentUnifiedProductID="326365" xmlns=""><Tree TreeID="2402"
+        NodeID="2402" UnifiedProductID="326363" IsFree="False"><Transition NodeName="Essential
+        Outright Get Paid - Monthly" UnifiedProductID="326365" TreeID="2410" IsFree="False"
+        NodeID="2410" /><Transition NodeName="Premium Outright Get Paid - Monthly"
+        UnifiedProductID="326388" TreeID="2418" IsFree="False" NodeID="2418" /><FilteredTransitions
+        /></Tree></Bonsai></Bonsai></AccountXml></GetAccountXmlResponse></soap:Body></soap:Envelope>
+    http_version: '1.1'
+  recorded_at: Fri, 18 Apr 2014 16:30:08 GMT
 recorded_with: VCR 2.8.0

data/lib/ruby-ecomm-client.rb

@@ -1,10 +1,22 @@
+require 'freddy'
 require 'savon'
 
 require 'ruby-ecomm-client/version'
 require 'ruby-ecomm-client/error'
-require 'ruby-ecomm-client/converter'
+require 'ruby-ecomm-client'
+require 'ruby-ecomm-client/util'
+
+require 'ruby-ecomm-client/service_base'
+require 'ruby-ecomm-client/service_manager'
+require 'ruby-ecomm-client/service_profile'
+require 'ruby-ecomm-client/service_purchase'
+
+require 'ruby-ecomm-client/config'
 require 'ruby-ecomm-client/client'
 
 module RubyEcommClient
   # Your code goes here...
 end
+
+#HACK: Avoid broken adapter ignoring SSL Certs when ExCon installed
+HTTPI::Adapter.use = :net_http

data/lib/ruby-ecomm-client/client.rb

@@ -1,33 +1,6 @@
 module RubyEcommClient
   class Client
-    include ResponseConverter
-
-    ENDPOINTS_MANAGER = {
-      :development => 'http://bonsai.dev.glbt1.gdg/bonsai/bonsaimanager/service.asmx',
-      :test => 'http://bonsai.dev.glbt1.gdg/bonsai/bonsaimanager/service.asmx',
-      :production => 'http://gdbonsaiXv01.prod.mesa1.gdg/bonsai/bonsaimanager/service.asmx',
-      :qa => 'http://bonsai.test.glbt1.gdg/bonsai/bonsaimanager/service.asmx'
-    }
-    ENDPOINTS_PROFILE = {
-      :development => 'http://gdcomm.dev.glbt1.gdg/WSgdInstantPurchasePublic/Service.asmx',
-      :test => 'http://gdcomm.dev.glbt1.gdg/WSgdInstantPurchasePublic/Service.asmx',
-      :production => 'http://gdcomm.godaddy.com/WSgdInstantPurchasePublic/Service.asmx',
-      :qa => 'http://gdcomm.test.glbt1.gdg/WSgdInstantPurchasePublic/Service.asmx'
-    }
-    ENDPOINTS_PURCHASE = {
-      :development => 'https://bonsaipurchase.dev.glbt1.gdg/BonsaiPurchase/Service.asmx',
-      :test => 'https://bonsaipurchase.dev.glbt1.gdg/BonsaiPurchase/Service.asmx',
-      :production => 'https://bonsaipurchase.prod.mesa1.gdg/BonsaiPurchase/Service.asmx',
-      :qa => 'https://bonsaipurchase.test.glbt1.gdg/BonsaiPurchase/Service.asmx'
-    }
-
-    HOST_NAME = `hostname`.chomp
-
-    ID_TYPE = 'ORION'
-
-    WSDL_MANAGER = 'manager.wsdl'
-    WSDL_PROFILE = 'profile.wsdl'
-    WSDL_PURCHASE = 'purchase.wsdl'
+    include Utils
 
     attr_accessor :shopper_id, :resource_type, :resource_id
 
@@ -41,148 +14,46 @@ module RubyEcommClient
       @resource_id = resource_id
     end
 
-    def self.environment
-      ((defined?(Rails) ? Rails.env : ENV['RAILS_ENV']) || 'development').to_sym
-    end
-
     def express_checkout?
-      result = client_profile.call(:shopper_has_instant_purchase_payment, :message => {
-        'sShopperID' => @shopper_id
-      })
-      response = convert_value(result.body[:shopper_has_instant_purchase_payment_response])
-      response[:b_has_instant_purchase_payment]
+      service_profile.express_checkout?
     end
 
     def account_info(source_tree_id = 0)
-      result = client_manager.call(:get_account_xml, :message => {
-        'ResourceID' => @resource_id,
-        'ResourceType' => @resource_type,
-        'IDType' => ID_TYPE,
-        'TreeID' => source_tree_id,
-        'PrivateLabelID' => 1
-      })
-      response = convert_response(result.body[:get_account_xml_response])
-      if response[:result_code] == 0
-        response[:account_xml][:bonsai][:bonsai]
-      else
-        raise RubyEcommError.new(response[:result_code])
-      end
+      service_manager.account_info(source_tree_id)
     end
 
     def transitions(source_tree_id = 0)
-      transitions = account_info(source_tree_id)[:tree][:transition]
-      transitions.is_a?(Array) ? transitions : [transitions]
+      service_manager.transitions(source_tree_id)
     end
 
-    def request_change(target_tree_id, client_ip = '127.0.0.1')
-      raise ArgumentError.new('target_tree_id must be specified') if blank?(target_tree_id)
-
-      if express_checkout?
-        request_change_via_express(target_tree_id, client_ip)
-      else
-        request_change_via_manager(target_tree_id)
-      end
-    end
-
-    private
-
-    def blank?(value)
-      value.nil? || value.to_s == ''
+    def find_transition(transitions, target_pfid)
+      service_manager.find_transition(transitions, target_pfid)
     end
 
-    def wsdl_path
-      "#{File.expand_path(File.dirname(__FILE__))}/wsdl/"
-    end
-
-    def shared_globals(globals)
-      globals.convert_response_tags_to TAG_CONVERTER
-      globals.log false
-      globals.logger Rails.logger if defined?(Rails)
-      globals.namespace '#Bonsai'
-      globals.open_timeout 15
-      globals.read_timeout 15
+    def request_change_via_manager(target_tree_id)
+      service_manager.request_change_via_manager(target_tree_id)
     end
 
-    def client_manager
-      @client_manager ||= Savon.client do |globals|
-        shared_globals(globals)
-
-        globals.wsdl "#{wsdl_path}#{WSDL_MANAGER}"
-        globals.endpoint ENDPOINTS_MANAGER[Client.environment]
-      end
+    def request_change_via_express(target_tree_id, client_ip = '127.0.0.1')
+      service_purchase.request_change_via_express(target_tree_id, client_ip)
     end
 
-    def client_profile
-      @client_profile ||= Savon.client do |globals|
-        shared_globals(globals)
-
-        globals.wsdl "#{wsdl_path}#{WSDL_PROFILE}"
-        globals.endpoint ENDPOINTS_PROFILE[Client.environment]
-        globals.namespace 'http://tempuri.org/'
-      end
+    def request_change(target_tree_id, client_ip = '127.0.0.1')
+      service_purchase.request_change(target_tree_id, client_ip)
     end
 
-    def client_purchase
-      @client_purchase ||= Savon.client do |globals|
-        shared_globals(globals)
-
-        globals.wsdl "#{wsdl_path}#{WSDL_PURCHASE}"
-        globals.endpoint ENDPOINTS_PURCHASE[Client.environment]
+    private
 
-        globals.ssl_verify_mode :none
-        ssl_cert_file = "config/environments/#{Client.environment}/client.crt"
-        globals.ssl_cert_file ssl_cert_file if File.exists?(ssl_cert_file)
-        ssl_cert_key_file = "config/environments/#{Client.environment}/client.key"
-        globals.ssl_cert_key_file ssl_cert_key_file if File.exists?(ssl_cert_key_file)
-      end
+    def service_manager
+      @service_manager ||= ServiceManager.new(self)
     end
 
-    def request_change_via_express(target_tree_id, client_ip = '127.0.0.1')
-      raise ArgumentError.new('target_tree_id must be specified') if blank?(target_tree_id)
-
-      result = client_purchase.call(:purchase_change_account_request, :message => {
-        'ResourceID' => @resource_id,
-        'ResourceType' => @resource_type,
-        'IDType' => ID_TYPE,
-        'AccountPurchaseChangeXml' => "<ClientChange TreeID='#{target_tree_id}' ShopperID='#{@shopper_id}' TransactionCurrency='USD' RequestingApp='outright' RequestingAppHost='#{HOST_NAME}' ClientAddr='#{client_ip}' EnteredBy='customer' OrderSource='Online' RedirectToBasket='false' EstimateOnly='false' SendConfirmEmail='false'/>",
-        'RenewalPFID' => 0,
-        'RenewalPeriods' => 0,
-        'ItemRequestXml' => '<itemRequest/>'
-      })
-      response = convert_response(result.body[:purchase_change_account_request_response])
-      if response[:result_code] == 0
-        {
-          :used_express_checkout => true,
-          :request_result => response[:purchase_change_account_request_result],
-          :error => response[:error],
-          :order_xml => response[:order_xml]
-        }
-      else
-        raise RubyEcommError.new(response[:result_code], response[:change_account_request_result])
-      end
+    def service_profile
+      @service_profile ||= ServiceProfile.new(self)
     end
 
-    def request_change_via_manager(target_tree_id)
-      raise ArgumentError.new('target_tree_id must be specified') if blank?(target_tree_id)
-
-      result = client_manager.call(:change_account_request, :message => {
-        'ResourceID' => @resource_id,
-        'ResourceType' => @resource_type,
-        'IDType' => ID_TYPE,
-        'AccountChangeXml' => "<ClientChange TreeID='#{target_tree_id}' ShopperID='#{@shopper_id}'/>",
-        'RenewalPFID' => 0,
-        'RenewalPeriods' => 0,
-        'ItemRequestXml' => '<itemRequest/>'
-      })
-      response = convert_response(result.body[:change_account_request_response])
-      if response[:result_code] == 0
-        {
-          :used_express_checkout => false,
-          :request_result => response[:change_account_request_result]
-        }
-      else
-        raise RubyEcommError.new(response[:result_code], response[:change_account_request_result])
-      end
+    def service_purchase
+      @service_purchase ||= ServicePurchase.new(self)
     end
   end
 end

data/lib/ruby-ecomm-client/config.rb

@@ -0,0 +1,25 @@
+module RubyEcommClient
+  class Config
+    include Utils
+
+    attr_accessor :requesting_app,
+                  :ssl_cert_content,
+                  :ssl_cert_file,
+                  :ssl_cert_key_content,
+                  :ssl_cert_key_file
+
+    def validate
+      raise ArgumentError.new('requesting_app must be specified') if Config.blank?(requesting_app)
+    end
+  end
+
+  def self.configure
+    cur_config = config
+    yield cur_config
+    cur_config.validate
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+end

data/lib/ruby-ecomm-client/service_base.rb

@@ -0,0 +1,55 @@
+module RubyEcommClient
+  class ServiceBase
+    include Utils
+    include Freddy::ResponseConverter
+
+    ID_TYPE = 'ORION'
+
+    def initialize(config_client)
+      raise ArgumentError.new('config_client must be specified') if config_client.nil?
+
+      @config_client = config_client
+    end
+
+    protected
+
+    attr_reader :config_client
+
+    def config_global
+      RubyEcommClient.config
+    end
+
+    def wsdl_path
+      "#{File.expand_path(File.dirname(__FILE__))}/wsdl/"
+    end
+
+    def create_client
+      Savon.client do |globals|
+        globals.convert_response_tags_to TAG_CONVERTER
+        globals.log false
+        globals.logger Rails.logger if defined?(Rails)
+        globals.namespace '#Bonsai'
+        globals.open_timeout 15
+        globals.read_timeout 15
+
+        yield globals
+      end
+    end
+
+    def generate_request_hash
+      {
+        'ResourceID'     => config_client.resource_id,
+        'ResourceType'   => config_client.resource_type,
+        'IDType'         => ID_TYPE
+      }
+    end
+
+    def generate_request_change_hash
+      generate_request_hash.merge({
+        'RenewalPFID'    => 0,
+        'RenewalPeriods' => 0,
+        'ItemRequestXml' => '<itemRequest/>'
+      })
+    end
+  end
+end