activemerchant-paymentech-orbital 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 John Corrigan
+
+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.rdoc

@@ -0,0 +1,18 @@
+= activemerchant-paymentech-orbital
+
+A gem to provide a ruby interface for Chase Paymentech Orbital payment gateway.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 John Corrigan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "activemerchant-paymentech-orbital"
+    gem.summary = "A gem to provide a ruby interface for Chase Paymentech Orbital payment gateway."
+    gem.description = "A gem to provide a ruby interface for Chase Paymentech Orbital payment gateway."
+    gem.email = "john@mintdigital.com"
+    gem.homepage = "http://github.com/johnideal/activemerchant-paymentech-orbital"
+    gem.authors = ["John Corrigan"]
+    gem.add_dependency("activemerchant", "= 1.4.2")
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activemerchant-paymentech-orbital #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/activemerchant-paymentech-orbital.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{activemerchant-paymentech-orbital}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Corrigan"]
+  s.date = %q{2009-12-03}
+  s.description = %q{A gem to provide a ruby interface for Chase Paymentech Orbital payment gateway.}
+  s.email = %q{john@mintdigital.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "activemerchant-paymentech-orbital.gemspec",
+     "lib/active_merchant/billing/paymentech_orbital.rb",
+     "lib/active_merchant/billing/paymentech_orbital/request.rb",
+     "lib/active_merchant/billing/paymentech_orbital/request/end_of_day.rb",
+     "lib/active_merchant/billing/paymentech_orbital/request/new_order.rb",
+     "lib/active_merchant/billing/paymentech_orbital/request/profile_management.rb",
+     "lib/active_merchant/billing/paymentech_orbital/request/void.rb",
+     "lib/active_merchant/billing/paymentech_orbital/response.rb",
+     "lib/activemerchant-paymentech-orbital.rb",
+     "test/activemerchant-paymentech-orbital_test.rb",
+     "test/factories.rb",
+     "test/mocks/active_merchant/billing/gateway.rb",
+     "test/options.rb",
+     "test/payment_orbital/gateway_test.rb",
+     "test/payment_orbital/request/end_of_day_test.rb",
+     "test/payment_orbital/request/new_order_test.rb",
+     "test/payment_orbital/request/profile_management_test.rb",
+     "test/payment_orbital/request/void_test.rb",
+     "test/payment_orbital/request_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/johnideal/activemerchant-paymentech-orbital}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A gem to provide a ruby interface for Chase Paymentech Orbital payment gateway.}
+  s.test_files = [
+    "test/activemerchant-paymentech-orbital_test.rb",
+     "test/factories.rb",
+     "test/mocks/active_merchant/billing/gateway.rb",
+     "test/options.rb",
+     "test/payment_orbital/gateway_test.rb",
+     "test/payment_orbital/request/end_of_day_test.rb",
+     "test/payment_orbital/request/new_order_test.rb",
+     "test/payment_orbital/request/profile_management_test.rb",
+     "test/payment_orbital/request/void_test.rb",
+     "test/payment_orbital/request_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activemerchant>, ["= 1.4.2"])
+    else
+      s.add_dependency(%q<activemerchant>, ["= 1.4.2"])
+    end
+  else
+    s.add_dependency(%q<activemerchant>, ["= 1.4.2"])
+  end
+end
+

data/lib/active_merchant/billing/paymentech_orbital.rb

@@ -0,0 +1,113 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module PaymentechOrbital
+      class Gateway < ActiveMerchant::Billing::Gateway
+        cattr_accessor :currency_code, :currency_exponent, :headers, :urls
+
+        self.urls = {
+          :test => [
+            'https://orbitalvar1.paymentech.net/authorize', 
+            'https://orbitalvar2.paymentech.net/authorize'
+          ], 
+          :live => [
+            'https://orbital1.paymentech.net/authorize',
+            'https://orbital2.paymentech.net/authorize'
+          ]
+        }
+
+        # Currency information for the api.
+        self.currency_code = "840"
+        self.currency_exponent = "2"
+
+        # Money format
+        self.money_format = :cents
+
+        # The countries the gateway supports merchants from as 2 digit ISO country codes
+        self.supported_countries = ['US']
+
+        # The card types supported by the payment gateway
+        self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+
+        # The homepage URL of the gateway
+        self.homepage_url = 'http://www.example.net/'
+
+        # The name of the gateway
+        self.display_name = 'Paymentect Orbital Gateway'
+
+        # Headers
+        self.headers = {
+          "MIME-Version" => "1.0",
+          "Content-Type" => "Application/PTI46",
+          "Content-transfer-encoding" => "text",
+          "Request-number" => "1",
+          "Document-type" => "Request"
+        }
+
+        attr_reader :request, :response
+
+        def initialize(options = {})
+          requires!(options, :login, :password, :merchant_id, :bin, :terminal_id)
+          @options = options.merge({
+            :currency_code => self.class.currency_code, 
+            :currency_exponent => self.class.currency_exponent
+          })
+          super
+        end
+
+        def authorize(money, credit_card=nil, options = {})
+          @request = Request::NewOrder.new("A", money, credit_card, options.merge(@options))
+
+          commit('authonly', @request)
+        end
+
+        def purchase(money, credit_card=nil, options = {})
+          @request = Request::NewOrder.new("AC", money, credit_card, options.merge(@options))
+
+          commit('sale', @request)
+        end
+
+        def refund(money, credit_card=nil, options={})
+          @request = Request::NewOrder.new("R", money, credit_card, options.merge(@options))
+
+          commit('refund', @request)
+        end
+
+        def profile(action, credit_card=nil, options={})
+          @request = Request::ProfileManagement.new(action, credit_card, options.merge(@options))
+
+          commit("profile-#{action}", @request)
+        end
+
+        def void(tx_ref_num, tx_ref_idx, money=nil, options={})
+          @request = Request::Void.new(tx_ref_num, tx_ref_idx, money, options.merge(@options))
+
+          commit('void', @request)
+        end
+
+        def end_of_day(options={})
+          @request = Request::EndOfDay.new(options.merge(@options))
+
+          commit('end of day', @request)
+        end
+
+        private
+        def commit(action, request)
+          resp = ssl_post(endpoint_url, request.to_xml, headers)
+
+          @response ||= Response.new(resp, request.request_type, {
+            :test => test?
+          })
+        end
+
+        def headers
+          self.class.headers.merge(request.headers)
+        end
+
+        def endpoint_url
+          self.class.urls[Base.gateway_mode][0]
+        end
+      end
+    end
+  end
+end
+

data/lib/active_merchant/billing/paymentech_orbital/request.rb

@@ -0,0 +1,67 @@
+require 'ostruct'
+
+module ActiveMerchant
+  module Billing
+    module PaymentechOrbital
+      module Request
+        class Base
+          attr_reader :gateway, :options
+
+          def initialize(options={})
+            @options = OpenStruct.new(options)
+          end
+
+          def to_xml
+            @_xml ||= build_request
+          end
+          alias :xml :to_xml
+
+          def headers
+            @_headers ||= options.headers || {}
+          end
+
+          private
+          delegate :login, :password, :merchant_id, 
+            :bin, :terminal_id, :currency_code, 
+            :currency_exponent, :customer_ref_num, 
+            :order_id, :to => :options
+
+          def address
+            @_address ||= options.billing_address || options.address || {}
+          end
+
+          def full_street_address
+            "#{address[:address1]} #{address[:address2]}".strip
+          end
+
+          # Implement me. I should be the parent tag for the request.
+          def request_type; "RequestType"; end
+
+          def build_request
+            xml = Builder::XmlMarkup.new(:indent => 2)
+
+            xml.instruct!(:xml, :version => '1.0', :encoding => 'UTF-8')
+            xml.tag! "Request" do
+              xml.tag! request_type do
+                add_authentication(xml)
+
+                request_body(xml)
+              end
+            end
+
+            xml.target!
+          end
+
+          # Implement me. I should take the provided
+          # xml builder and add tags to the request.
+          def request_body(xml); xml; end
+
+          def add_authentication(xml)
+            xml.tag! "OrbitalConnectionUsername", login
+            xml.tag! "OrbitalConnectionPassword", password
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/paymentech_orbital/request/end_of_day.rb

@@ -0,0 +1,22 @@
+module ActiveMerchant
+  module Billing
+    module PaymentechOrbital
+      module Request
+        class EndOfDay < PaymentechOrbital::Request::Base
+          def request_type; "EndOfDay"; end
+
+          private
+          def request_body(xml)
+            add_meta_info(xml)
+          end
+
+          def add_meta_info(xml)
+            xml.tag! "BIN", bin
+            xml.tag! "MerchantID", merchant_id
+            xml.tag! "TerminalID", terminal_id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/paymentech_orbital/request/new_order.rb

@@ -0,0 +1,121 @@
+module ActiveMerchant
+  module Billing
+    module PaymentechOrbital
+      module Request
+        class NewOrder < PaymentechOrbital::Request::Base
+          attr_reader :message_type, :money, :credit_card
+
+          def initialize(message_type, money, credit_card, options)
+            @message_type = message_type
+            @money = money
+            @credit_card = credit_card
+            super(options)
+          end
+
+          delegate :industry_type, :mb_type, :recurring_start_date,
+            :recurring_end_date, :recurring_end_date_flag,
+            :recurring_max_billings, :recurring_frequency,
+            :deferred_bill_date, :soft_descriptors, 
+            :to => :options
+
+          def request_type; "NewOrder"; end
+
+          def recurring?
+            industry_type == "RC"
+          end
+
+          private
+          def request_body(xml)
+            add_meta_info(xml)
+            add_credit_card(xml)
+            add_billing_address(xml)
+            add_profile_management_options(xml)
+            add_order_information(xml)
+            add_soft_descriptor_info(xml)
+            add_managed_billing_info(xml)
+          end
+
+          def add_meta_info(xml)
+            xml.tag! "IndustryType", industry_type || "EC"
+            xml.tag! "MessageType", message_type
+            xml.tag! "BIN", bin
+            xml.tag! "MerchantID", merchant_id
+            xml.tag! "TerminalID", terminal_id
+          end
+
+          def add_credit_card(xml)
+            if credit_card
+              xml.tag! "CardBrand", credit_card.respond_to?(:brand) ? credit_card.brand : credit_card.type
+              xml.tag! "AccountNum", credit_card.number
+              xml.tag! "Exp", "#{credit_card.month}#{credit_card.year}"
+              add_currency(xml)
+              xml.tag! "CardSecValInd", "1"
+              xml.tag! "CardSecVal", credit_card.verification_value
+            else
+              xml.tag! "AccountNum", nil
+              add_currency(xml)
+            end
+          end
+
+          def add_currency(xml)
+            xml.tag! "CurrencyCode", currency_code
+            xml.tag! "CurrencyExponent", currency_exponent
+          end
+
+          def add_billing_address(xml)
+            xml.tag! "AVSzip", address[:zip]
+            if full_street_address.length < 30
+              xml.tag! "AVSaddress1", full_street_address
+            else
+              xml.tag! "AVSaddress1", address[:address1]
+              xml.tag! "AVSaddress2", address[:address2]
+            end
+            xml.tag! "AVScity", address[:city]
+            xml.tag! "AVSstate", address[:state]
+            xml.tag! "AVSphoneNum" , address[:phone]
+            xml.tag! "AVSname", address[:name]
+            xml.tag! "AVScountryCode", address[:country]
+          end
+
+          def add_profile_management_options(xml)
+            if customer_ref_num
+              xml.tag! "CustomerRefNum", customer_ref_num
+            else
+              xml.tag! "CustomerProfileFromOrderInd", "A"
+              xml.tag! "CustomerProfileOrderOverrideInd", "NO"
+            end
+          end
+
+          def add_order_information(xml)
+            xml.tag! "OrderID", order_id
+            xml.tag! "Amount", money
+          end
+
+          def add_soft_descriptor_info(xml)
+            if soft_descriptors
+              xml.tag! "SDMerchantName", soft_descriptors[:merchant_name]
+              xml.tag! "SDProductDescription", soft_descriptors[:production_description]
+              xml.tag! "SDMerchantCity", soft_descriptors[:merchant_city]
+              xml.tag! "SDMerchantPhone", soft_descriptors[:merchant_phone]
+              xml.tag! "SDMerchantURL", soft_descriptors[:merchant_url]
+              xml.tag! "SDMerchantEmail", soft_descriptors[:merchant_email]
+            end
+          end
+
+          def add_managed_billing_info(xml)
+            if recurring?
+              xml.tag! "MBType", mb_type || "R"
+              xml.tag! "MBOrderIdGenerationMethod", "DI"
+              xml.tag! "MBRecurringStartDate", recurring_start_date || (Date.today + 1).strftime("%m%d%Y")
+              xml.tag! "MBRecurringEndDate", recurring_end_date
+              xml.tag! "MBRecurringNoEndDateFlag", recurring_end_date_flag || (recurring_end_date ? "N" : "Y")
+              xml.tag! "MBRecurringMaxBillings", recurring_max_billings
+              xml.tag! "MBRecurringFrequency", recurring_frequency
+              xml.tag! "MBDeferredBillDate", deferred_bill_date
+            end
+          end
+        end
+      end
+    end
+  end
+end