obi-wan 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'nokogiri',   '~> 1.4.4'
+gem "httpclient", '~> 2.2.1'

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/example/subscription_example.rb

@@ -0,0 +1,47 @@
+require 'obi-wan'
+require 'securerandom'
+
+include ObiWan
+include ObiWan::XmlClient::Functions
+
+# setup
+client = XmlClient.new({
+    :base_url   => 'https://aol.xbus.qat.ps.aol.com/biz/api',
+    :dev_id     => 'pb19dgbLSGltGDiW',
+    :cipherdata => 'hello',
+    :hexresult  => 'e1c9e47be92b358510029b76aea4c5e9',
+    :sg         => 'patchselfserviceads' 
+})
+
+# tg is static for this example.
+tg = 1
+
+
+client.create_instrument(
+  tg,
+  Type::InstrumentInfo.new( :email => 'spencer@corp.aol.com', :nick_name => 'SP', :card_on_file_flag => true, :default_flag => false ),
+  Type::BillingAddress.new( :street1 => '1201 dean st', :city => 'nyc', :state => 'ny', :zip => 11206, :country => 'US'),
+  Type::Instrument.new( :account_number => 4444424444444440, :expiry_date => '2012-12-31T09:46:25.705Z', :last_four_digits => 5674, :payment_type => 'VISA_DEBIT' ),
+  Type::Name.new(:first_name => 'bob', :last_name => 'hope', :middle_name => 'robert', :honorific => 'mr'),
+  Type::Phone.new( :type => 'HOME', :number => 7032641272, :area_code => 703, :country_code => 001 ) )
+
+payment_id = xml_to_hash( client.list_instruments(tg, "DETAIL") )[:response][:data][:listInstrumentsResponse][:result][:instruments][:Instrument][:id]
+
+# I LOVE this offer!
+1.upto(1) do 
+  client.register_offer_subscription(
+    tg,
+    Type::RegisterOfferSubscription.new( :offer_id => 1003421, :event_source => rand(), :payment_instrument_id => payment_id, :contact_email => 'pants@example.com' )
+  )
+end
+
+sub = client.list_subscriptions(tg, nil, false)
+offer_sub_ids = offer_subscription_id(sub)
+
+# i've been scammed!  refund me!
+responses = []
+offer_sub_ids.each do |o|
+  puts "Cancelling sub.. #{o}"
+  resp = client.cancel_offer(tg, o, 'CANCEL_OFFER_SUBSCRIPTION') 
+  puts "Transaction failed: #{resp}" unless success? resp
+end

data/example/subscription_example_async.rb

@@ -0,0 +1,57 @@
+require 'obi-wan'
+require 'securerandom'
+
+include ObiWan
+include ObiWan::XmlClient::Functions
+
+# setup
+client = XmlClient.new({
+    :debug      => STDERR,
+    :base_url   => 'https://aol.xbus.qat.ps.aol.com/biz/api',
+    :dev_id     => 'pb19dgbLSGltGDiW',
+    :cipherdata => 'hello',
+    :hexresult  => 'e1c9e47be92b358510029b76aea4c5e9',
+    :sg         => 'patchselfserviceads' 
+})
+
+# let's go asynchonous for only cancel_offer for some mass cancellation fun
+client.set_asynchronous(:cancel_offer)
+
+# tg is static for this example.
+tg = 1
+
+
+client.create_instrument(
+  tg,
+  Type::InstrumentInfo.new( :email => 'spencer@corp.aol.com', :nick_name => 'SP', :card_on_file_flag => true, :default_flag => false ),
+  Type::BillingAddress.new( :street1 => '1201 dean st', :city => 'nyc', :state => 'ny', :zip => 11206, :country => 'US'),
+  Type::Instrument.new( :account_number => 4444424444444440, :expiry_date => '2012-12-31T09:46:25.705Z', :last_four_digits => 5674, :payment_type => 'VISA_DEBIT' ),
+  Type::Name.new(:first_name => 'bob', :last_name => 'hope', :middle_name => 'robert', :honorific => 'mr'),
+  Type::Phone.new( :type => 'HOME', :number => 7032641272, :area_code => 703, :country_code => 001 ) )
+
+payment_id = xml_to_hash( client.list_instruments(tg, "DETAIL") )[:response][:data][:listInstrumentsResponse][:result][:instruments][:Instrument][:id]
+
+# I LOVE this offer!
+1.upto(20) do 
+  client.register_offer_subscription(
+    tg,
+    Type::RegisterOfferSubscription.new( :offer_id => 1003421, :event_source => rand(), :payment_instrument_id => payment_id, :contact_email => 'pants@example.com' )
+  )
+end
+
+sub = client.list_subscriptions(tg, nil, false)
+offer_sub_ids = offer_subscription_id(sub)
+
+# i've been scammed!  refund me!
+# since cancel is now async, do a time on ruby to see how much faster this goes
+responses = []
+offer_sub_ids.each do |o|
+  puts "Cancelling sub.. #{o}"
+  responses << client.cancel_offer(tg, o, 'CANCEL_OFFER_SUBSCRIPTION')
+end
+
+responses.each do |r|
+  r.join
+  resp = resp_to_xml(r.pop)
+  puts "Transaction failed: #{resp}" unless success? resp
+end

data/lib/obi-wan/messages.rb

@@ -0,0 +1,173 @@
+require 'nokogiri'
+
+module ObiWan
+  class XmlClient
+    module Functions
+      def self.included(base)
+        base.module_eval { extend(Functions) }
+      end
+
+      def xml_to_hash(node)
+
+        # this doesn't cover <a>bcdefg<h>pants</h></a>  
+        # luckily, obi doesn't do insane things like this
+        
+        if node.elements.empty?
+          result = node.text
+        else
+          result = {}
+          node.elements.each do |c|
+            key = c.name.to_sym
+            val = xml_to_hash(c)
+          
+            if result[key].nil?
+              result[key] = val
+            elsif result[key].is_a? Array
+              result[key] << val
+            else
+              result[key] = [ result[key], val ]
+            end
+          end
+        end
+        result
+      end
+
+      def resp_to_xml(resp)
+        Nokogiri::XML(resp.body)
+      end
+
+      def success?(response)
+        result = response.search("statusCode")
+        !result.nil? and result.text.to_i / 100 === 2
+      end
+
+      def offer_subscription_id(response)
+        puts response.xpath("/")
+        response.xpath("//offerSubscriptionId/value")
+      end
+    end
+
+    module CancelOffer
+      def self.obi_request(offer_subscription_id, type, reason_text=nil, code=nil, language_code=nil)
+        builder = Nokogiri::XML::Builder.new do 
+          request('xmlns' => 'http://biz.aol.com/schema/2006-12-18') { 
+            cancelOffer {
+              cancelOfferDetail {
+                offerSubscriptionId offer_subscription_id
+                reason {
+                  text reason_text
+                  languageCode code
+                }
+                actionType type
+              }
+            }
+          }
+        end.doc.to_xml
+      end
+    end
+
+    module ListSubscriptions
+      def self.obi_request(product_class_name, active_only) 
+        builder = Nokogiri::XML::Builder.new do 
+          request('xmlns' => 'http://biz.aol.com/schema/2006-12-18') { 
+            listSubscriptions {
+              productClassName product_class_name 
+              active_only      active_only
+            }
+          }
+        end.doc.to_xml
+      end
+    end
+
+    module RegisterOfferSubscription
+      def self.obi_request(offer_subscription)
+        os = offer_subscription
+        builder = Nokogiri::XML::Builder.new do
+          request('xmlns' => 'http://biz.aol.com/schema/2006-12-18') { 
+            registerOfferSubscription {
+              orderRequests {
+                OrderRequest {
+                  offerId             os.offer_id
+
+                  # event_source is a unique order id, non numeric if desired
+                  # can be something like timestamp-userid-random()
+                  eventSource         os.event_source
+                  paymentInstrumentId os.payment_instrument_id
+                  contactEmail        os.contact_email
+                  promoCode           os.promo_code
+                  tosAcceptedDate     os.tos_accepted_date
+                  tosName             os.tos_name
+                }
+              }
+            }
+          }
+        end.doc.to_xml
+      end
+    end
+
+    module ListInstruments
+      def self.obi_request(detail_level)
+        builder = Nokogiri::XML::Builder.new do 
+          request('xmlns' => 'http://biz.aol.com/schema/2006-12-18') { 
+            listInstruments  {
+              paymentDetailLevel detail_level
+            }
+          }
+        end.doc.to_xml
+      end
+    end
+    
+    module Instrument
+      def self.obi_request(info, billing_address, instrument, name, phone)
+        builder = Nokogiri::XML::Builder.new do 
+          request('xmlns' => 'http://biz.aol.com/schema/2006-12-18') { 
+            createInstrument {
+              email {
+                value info.email
+              }
+              instrument  {
+                id_         info.id
+                nickName    info.nick_name
+                defaultFlag info.default_flag
+                cardOnFileFlag info.card_on_file_flag
+
+                userInformation {
+                  firstUserName {
+                    firstName  name.first_name
+                    lastName   name.last_name
+                    middleName name.middle_name
+                    honorific  name.honorific
+                  }
+
+                  billingAddress {
+                    street1 billing_address.street1
+                    street2 billing_address.street2
+                    city  billing_address.city
+                    state billing_address.state
+                    zip billing_address.zip
+                    country billing_address.country
+                  }
+
+                  eveningPhone {
+                    countryCode phone.country_code
+                    areaCode phone.area_code
+                    number phone.number
+                    type phone.type
+                  }
+                }
+                paymentInstrument {
+                  accountNumber  instrument.account_number
+                  routingNumber  instrument.routing_number
+                  paymentType    instrument.payment_type
+                  expiryDate     instrument.expiry_date
+                  lastFourDigits instrument.last_four_digits
+                  pinNumber      instrument.pin_number
+                }
+              }
+            }
+          }
+        end.doc.to_xml
+      end
+    end
+  end
+end

data/lib/obi-wan/type.rb

@@ -0,0 +1,68 @@
+module ObiWan
+  module Type
+    class Builder
+      def initialize(init={})
+        init.keys.each do |attr|
+          self.send("#{attr}=".to_sym, init[attr])
+        end
+      end
+    end
+
+    # some api calls have misc data.  it's easier to group them as single classes
+
+    class RegisterOfferSubscription < Builder
+      attr_accessor :offer_id
+      attr_accessor :event_source
+      attr_accessor :payment_instrument_id
+      attr_accessor :contact_email
+      attr_accessor :discount_amount
+      attr_accessor :promo_code
+      attr_accessor :tos_accepted_date
+      attr_accessor :tos_name
+    end
+
+    class InstrumentInfo < Builder
+      attr_accessor :email
+      attr_accessor :id
+      attr_accessor :nick_name
+      attr_accessor :default_flag
+      attr_accessor :card_on_file_flag
+    end
+
+   # obi data types
+
+    class BillingAddress < Builder
+      attr_accessor :street1
+      attr_accessor :street2
+      attr_accessor :city
+      attr_accessor :state
+      attr_accessor :zip
+      attr_accessor :country
+    end
+
+    class Name < Builder
+      attr_accessor :first_name
+      attr_accessor :middle_name
+      attr_accessor :last_name
+      attr_accessor :honorific
+    end
+
+    class Phone < Builder
+      attr_accessor :country_code
+      attr_accessor :area_code
+      attr_accessor :number
+      attr_accessor :type
+    end
+
+    class Instrument < Builder
+      attr_accessor :account_number
+      attr_accessor :routing_number
+      attr_accessor :payment_type
+      attr_accessor :expiry_date
+      attr_accessor :last_four_digits
+      attr_accessor :pin_number
+      attr_accessor :authorize_email_address
+      attr_accessor :authorize_ip_address
+    end
+  end
+end

data/lib/obi-wan/version.rb

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

data/lib/obi-wan/xml-client.rb

@@ -0,0 +1,64 @@
+require 'obi-wan/messages'
+require 'httpclient'
+
+#
+# XmlClient has methods and modules registered to it. Messages are in the messages/ dir.  
+# The first parameter to each call must be the target id for use in the url.  The rest of the 
+# parameters are in the def per message.
+#
+# If you don't like the XML response, you can peform a to_hash on it.
+#
+module ObiWan
+  class XmlClient
+
+    @@DEFAULT_CALLS = {
+      :register_offer_subscription => RegisterOfferSubscription,
+      :create_instrument           => Instrument,
+      :edit_instrument             => Instrument,
+      :list_instruments            => ListInstruments,
+      :list_subscriptions          => ListSubscriptions,
+      :cancel_offer                => CancelOffer
+    }
+
+    def register(method, message_handler, synchronous = true)
+      method = method.to_sym
+
+      self.send(:define_singleton_method, method) do |tg, *args|
+        query = {
+          :devId      => @config[:dev_id],
+          :cipherdata => @config[:cipherdata],
+          :hexresult  => @config[:hexresult],
+          :tg         => tg,
+          :sg         => @config[:sg]
+        }
+
+        header = [['Content-Type', 'text/xml'], ['Accept','*/*'], ['User-Agent', 'obi-wan-0.0.1']]
+
+        req = HTTPClient.new
+        req.debug_dev = @config[:debug] if @config[:debug]
+
+        if synchronous
+          res = req.request(:POST, @config[:base_url], query, message_handler.obi_request(*args), header)
+          return resp_to_xml(res)
+        else
+          return req.request_async(:POST, @config[:base_url], query, message_handler.obi_request(*args), header)
+        end 
+      end
+    end
+
+    def set_asynchronous(method, target = @@DEFAULT_CALLS[method])
+      register method, @@DEFAULT_CALLS[method], false
+    end
+
+    def set_synchronous(method, target = @@DEFAULT_CALLS[method])
+      register method, @@DEFAULT_CALLS[method], true
+    end
+
+    def initialize(options={})
+      @config = options
+      @@DEFAULT_CALLS.each do |k,v| 
+        register k, v, true
+      end
+    end
+  end
+end

data/lib/obi-wan.rb

@@ -0,0 +1,5 @@
+require 'obi-wan/xml-client'
+require 'obi-wan/type'
+
+module ObiWan
+end

data/obi-wan.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "obi-wan/version"
+
+Gem::Specification.new do |s|
+  s.name        = "obi-wan"
+  s.version     = ObiWan::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["spencer.portee@patch.com"]
+  s.email       = ["spencer.portee@patch.com"]
+  s.homepage    = ""
+  s.summary     = %q{ruby wrapper to obi's xml api}
+  s.description = %q{ruby wrapper to obi's xml api}
+
+  s.rubyforge_project = "obi-wan"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: obi-wan
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- spencer.portee@patch.com
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-28 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: ruby wrapper to obi's xml api
+email: 
+- spencer.portee@patch.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- example/subscription_example.rb
+- example/subscription_example_async.rb
+- lib/obi-wan.rb
+- lib/obi-wan/messages.rb
+- lib/obi-wan/type.rb
+- lib/obi-wan/version.rb
+- lib/obi-wan/xml-client.rb
+- obi-wan.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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: obi-wan
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: ruby wrapper to obi's xml api
+test_files: []
+