activemerchant-clickandbuy 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+/spec/support/clickand_buy.yml

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--tag ~remote

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    activemerchant-clickandbuy (0.1.0)
+      activemerchant
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_utils (1.0.5)
+      activesupport (>= 2.3.11)
+      i18n
+    activemerchant (1.28.0)
+      active_utils (>= 1.0.2)
+      activesupport (>= 2.3.11)
+      builder (>= 2.0.0)
+      i18n
+      json (>= 1.5.1)
+      money
+      nokogiri
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.1.3)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    json (1.7.5)
+    money (5.0.0)
+      i18n (~> 0.4)
+      json
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemerchant-clickandbuy!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Olek Janiszewski
+
+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,68 @@
+# Active Merchant ClickandBuy gateway
+
+This gem provides integration of ClickandBuy (http://www.clickandbuy.com) with Active Merchant (http://activemerchant.org).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activemerchant-clickandbuy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activemerchant-clickandbuy
+
+## Usage
+
+To use the gateway, you'll need to provide your merchant ID, project ID and secret key:
+
+    auth = {merchant_id: 'foo', project_id: 'bar', secret_key: 'baz'}
+    gateway = ActiveMerchant::Billing::ClickandBuyGateway.new(auth)
+
+Now you can initiate a transaction at ClickandBuy:
+
+    amount = Money.new(1000, 'EUR')
+    options = {
+      success_url: 'https://www.your-site.com/callback/success', # where to redirect the user on success
+      failure_url: 'https://www.your-site.com/callback/failure', # where to redirect the user on failure
+      order_id: 123,                                             # your unique order identifier
+      ip: '1.2.3.4',                                             # user's IP address
+      order_description: 'ACME Earthquake Pills',                # what the user is buying
+      locale: 'en',                                              # user's locale ('en' or 'de')
+      success_expiration: 1439                                   # (optional) how many minutes to wait for success
+    }
+    response = gateway.setup_purchase(amount, options)
+
+The `response` hash will contain amongst other keys two important ones: `transactionID` and `redirectURL`.
+The `transactionID` identifies the transaction at ClickandBuy, make sure you store it together with your order.
+The `redirectURL` is where you redirect the user so that they can confirm the purchase.
+
+After a user lands on `success_url`, you can check whether or not the transaction had been confirmed:
+
+    transaction = gateway.check_status(transaction_id)
+
+The `transaction` variable is a hash containing the response details, amongst others a `transactionStatus` key.
+
+## Running specs
+
+Copy `spec/support/clickand_buy.yml.example` to `spec/support/clickand_buy.yml`. Now run:
+
+    bundle exec rspec
+
+By default, only "fast" specs will be running (the API will not be hit). In order to be able
+to execute remote specs, populate the `clickand_buy.yml` file with your staging account's
+authentication credentials. To run the remote specs, run the following:
+
+    bundle exec rspec --tag remote
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/activemerchant-clickandbuy.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_merchant/clickand_buy/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'activemerchant-clickandbuy'
+  gem.version       = ActiveMerchant::ClickandBuy::VERSION
+  gem.authors       = ['Olek Janiszewski']
+  gem.email         = ['olek.janiszewski@gmail.com']
+  gem.description   = %q{This gem provides integration of ClickandBuy with Active Merchant}
+  gem.summary       = %q{Integration of ClickandBuy with Active Merchant}
+  gem.homepage      = "https://github.com/exviva/activemerchant-clickandbuy"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'activemerchant'
+
+  gem.add_development_dependency 'rspec'
+end

data/lib/active_merchant/billing/clickand_buy_gateway.rb

@@ -0,0 +1,42 @@
+require 'active_merchant/clickand_buy/request/pay_request'
+require 'active_merchant/clickand_buy/request/status_request'
+
+module ActiveMerchant
+	module Billing
+    class ClickandBuyGateway < Gateway
+      self.test_url = 'https://api.clickandbuy-s1.com/webservices/soap/pay_1_1_0'
+      self.live_url = 'https://api.clickandbuy.com/webservices/soap/pay_1_1_0'
+
+      self.homepage_url = 'http://www.clickandbuy.com'
+      self.display_name = 'ClickandBuy'
+
+      def initialize(auth)
+        requires!(auth, :project_id, :merchant_id, :secret_key)
+        @auth = auth
+      end
+
+      def setup_purchase(amount, options)
+        requires!(options, :success_url, :failure_url, :order_id, :ip, :order_description, :locale)
+        perform(ClickandBuy::Request::PayRequest.new(@auth, amount, options))
+      end
+
+      def check_status(transaction_id)
+        perform(ClickandBuy::Request::StatusRequest.new(@auth, transaction_id))
+      end
+
+      private
+      def perform(request)
+        response_string = ssl_post(endpoint_url, request.body, headers)
+        request.handle_response(response_string)
+      end
+
+      def headers
+        {'Content-Type' => 'text/xml; charset=UTF-8'}
+      end
+
+      def endpoint_url
+        test? ? test_url : live_url
+      end
+    end
+  end
+end

data/lib/active_merchant/clickand_buy/request/base.rb

@@ -0,0 +1,58 @@
+module ActiveMerchant::ClickandBuy::Request
+  class Base
+    def initialize(auth)
+      @auth = auth
+    end
+
+    def body
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+
+      xml.SOAP :Envelope, 'xmlns:SOAP' => 'http://schemas.xmlsoap.org/soap/envelope/' do
+        xml.SOAP :Body do
+          xml.tag! request_tag, xmlns: 'http://api.clickandbuy.com/webservices/pay_1_1_0/' do
+            xml.authentication do
+              xml.merchantID @auth[:merchant_id]
+              xml.projectID @auth[:project_id]
+              xml.token token
+            end
+
+            xml.details do
+              details(xml)
+            end
+          end
+        end
+      end
+
+      xml.target!
+    end
+
+    def handle_response(response_string)
+      response = Hash.from_xml(response_string)
+      extract_response_details(response['Envelope']['Body'][response_tag])
+    end
+
+    private
+    def details; raise NotImplementedError end
+    def extract_response_details(response); raise NotImplementedError end
+
+    def token
+      timestamp = Time.now.utc.strftime('%Y%m%d%H%M%S')
+      hash_input = [@auth[:project_id], @auth[:secret_key], timestamp].join('::')
+      hash = Digest::SHA1.hexdigest(hash_input)
+      [timestamp, hash].join('::')
+    end
+
+    def request_name
+      self.class.name.demodulize.camelize(:lower)
+    end
+
+    def request_tag
+      "#{request_name}_Request"
+    end
+
+    def response_tag
+      "#{request_name}_Response"
+    end
+  end
+end

data/lib/active_merchant/clickand_buy/request/pay_request.rb

@@ -0,0 +1,32 @@
+require 'active_merchant/clickand_buy/request/base'
+
+module ActiveMerchant::ClickandBuy::Request
+  class PayRequest < Base
+    def initialize(auth, amount, options)
+      super(auth)
+      @amount = amount
+      @options = options
+    end
+
+    private
+    def details(xml)
+      xml.amount do
+        xml.amount sprintf('%.2f', @amount.to_f)
+        xml.currency @amount.currency_as_string
+      end
+      xml.orderDetails do
+        xml.text @options[:order_description]
+      end
+      xml.successURL @options[:success_url]
+      xml.failureURL @options[:failure_url]
+      xml.externalID @options[:order_id]
+      xml.consumerIPAddress @options[:ip]
+      xml.consumerLanguage @options[:locale]
+      xml.successExpiration @options[:success_expiration] if @options.key?(:success_expiration)
+    end
+
+    def extract_response_details(response)
+      response['transaction']
+    end
+  end
+end

data/lib/active_merchant/clickand_buy/request/status_request.rb

@@ -0,0 +1,21 @@
+require 'active_merchant/clickand_buy/request/base'
+
+module ActiveMerchant::ClickandBuy::Request
+  class StatusRequest < Base
+    def initialize(auth, transaction_id)
+      super(auth)
+      @transaction_id = transaction_id
+    end
+
+    private
+    def details(xml)
+      xml.transactionIDList do
+        xml.transactionID @transaction_id
+      end
+    end
+
+    def extract_response_details(response)
+      response['transactionList']['transaction']
+    end
+  end
+end

data/lib/active_merchant/clickand_buy/version.rb

@@ -0,0 +1,5 @@
+module ActiveMerchant
+  module ClickandBuy
+    VERSION = '0.1.0'
+  end
+end

data/lib/activemerchant-clickandbuy.rb

@@ -0,0 +1,3 @@
+require 'active_merchant'
+require 'active_merchant/clickand_buy/version'
+require 'active_merchant/billing/clickand_buy_gateway'

data/spec/active_merchant/billing/clickand_buy_gateway_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe ActiveMerchant::Billing::ClickandBuyGateway do
+  let(:auth) { YAML.load_file(File.expand_path('../../../support/clickand_buy.yml', __FILE__)) }
+  let(:gateway) { described_class.new(auth) }
+  let(:amount) { Money.new(1000, 'EUR') }
+  let(:order_id) { Time.now.to_i }
+  let(:setup_purchase_options) { {success_url: 'http://example.com', failure_url: 'http://example.com', order_id: order_id, ip: '1.2.3.4', order_description: '', locale: 'en', success_expiration: 30} }
+
+  def perform_setup_purchase
+    gateway.setup_purchase(amount, setup_purchase_options)
+  end
+
+  describe '#initialize' do
+    [:project_id, :merchant_id, :secret_key].each do |key|
+      it "requires #{key} in auth" do
+        expect { described_class.new(auth.except(key)) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#setup_purchase' do
+    subject { perform_setup_purchase }
+
+    [:success_url, :failure_url, :order_id, :ip, :order_description, :locale].each do |key|
+      context "without #{key} in options" do
+        subject { gateway.setup_purchase(amount, setup_purchase_options.except(key)) }
+
+        it 'raises an argument error' do
+          expect { subject }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    it 'returns a hash with transaction details', :remote do
+      subject.should be_a(Hash)
+
+      subject['transactionID'].should match(/\d+/)
+      subject['transactionStatus'].should eq('CREATED')
+      subject['transactionType'].should eq('PAY')
+      subject['externalID'].should eq(order_id.to_s)
+
+      URI.parse(subject['redirectURL']).tap do |redirect_url|
+        redirect_url.scheme.should eq('https')
+        redirect_url.host.should eq('checkout.clickandbuy-s1.com')
+        redirect_url.path.should eq('/frontend/secure/checkout')
+      end
+    end
+  end
+
+  describe '#check_status', :remote do
+    let(:transaction_id) { '123' }
+    subject { gateway.check_status(transaction_id) }
+
+    it 'returns the transaction ID' do
+      subject['transactionID'].should eq('123')
+    end
+
+    it 'returns an error if transaction not found' do
+      subject['errorDetails']['code'].should eq('3')
+    end
+
+    context 'with a valid transaction ID' do
+      let(:transaction_id) { perform_setup_purchase['transactionID'] }
+
+      it 'returns the transaction status' do
+        subject['transactionStatus'].should eq('CREATED')
+      end
+    end
+  end
+end

data/spec/active_merchant/clickand_buy/request/pay_request_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe ActiveMerchant::ClickandBuy::Request::PayRequest do
+  let(:url) { proc {|variation| "http://example.com/callback/#{variation}" } }
+  let(:success_url) { url[:success] }
+  let(:failure_url) { url[:failure] }
+  let(:order_id) { Time.now.to_i }
+  let(:ip) { '1.2.3.4' }
+  let(:locale) { 'en' }
+  let(:order_description) { 'Foo bar baz' }
+  let(:success_url) { url[:success] }
+
+  let(:auth) { {merchant_id: 123, project_id: 456, secret_key: 'foo'} }
+  let(:amount) { Money.new(1000, 'EUR') }
+  let(:options) { {success_url: success_url, failure_url: failure_url, order_id: order_id, ip: ip, order_description: order_description, locale: locale} }
+
+  let(:request) { described_class.new(auth, amount, options) }
+
+  describe '#body' do
+    let(:body) { request.body }
+    let(:body_hash) { Hash.from_xml(request.body) }
+    let(:request_hash) { body_hash['Envelope']['Body']['payRequest_Request'] }
+    let(:details) { request_hash['details'] }
+
+    it 'uses the auth argument to provide authentication' do
+      authentication = request_hash['authentication']
+      authentication['merchantID'].should eq('123')
+      authentication['projectID'].should eq('456')
+      authentication['token'].should match(/\A\d{14}::\w{40}\z/)
+    end
+
+    it 'uses the amount argument to provide amount' do
+      amount_tag = details['amount']
+      amount_tag['amount'].should eq(sprintf('%.2f', amount.to_f))
+      amount_tag['currency'].should eq(amount.currency_as_string)
+    end
+
+    it 'uses the order_description option for order details text' do
+      text = details['orderDetails']['text']
+      text.should eq(order_description)
+    end
+
+    it 'uses the success_url option for successURL' do
+      details['successURL'].should eq(success_url)
+    end
+
+    it 'uses the failure_url option for failureURL' do
+      details['failureURL'].should eq(failure_url)
+    end
+
+    it 'uses the order_id option for externalID' do
+      details['externalID'].should eq(order_id.to_s)
+    end
+
+    it 'uses the ip option for consumerIPAddress' do
+      details['consumerIPAddress'].should eq(ip)
+    end
+
+    it 'uses the locale option for consumerLanguage' do
+      details['consumerLanguage'].should eq(locale)
+    end
+
+    it 'does not have successExpiration' do
+      details.should_not have_key('successExpiration')
+    end
+
+    describe 'with success_expiration provided' do
+      before { options[:success_expiration] = 1439 }
+
+      it 'uses the success_expiration option for successExpiration' do
+        details['successExpiration'].should eq('1439')
+      end
+    end
+  end
+
+  describe '#handle_response' do
+    let(:response_string) { File.read(File.expand_path('../../../../support/requests/pay_request_response.xml', __FILE__)) }
+    subject { request.handle_response(response_string) }
+
+    it 'returns the transaction hash' do
+      subject['transactionID'].should eq('1397737001')
+      subject['redirectURL'].should eq('https://checkout.clickandbuy-s1.com/frontend/secure/checkout?tx=1397737001&s=988809699F35D642&h=09FBBC928EDAA067207D4E69B5EA9CAD441D4812')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+
+require 'activemerchant-clickandbuy'
+require 'money'
+require 'active_support/core_ext/hash/except'
+
+ActiveMerchant::Billing::Base.mode = :test
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/clickand_buy.yml.example

@@ -0,0 +1,3 @@
+:project_id: 'your project ID'
+:merchant_id: 'your merchant ID'
+:secret_key: 'your secret key'

data/spec/support/requests/pay_request_response.xml

@@ -0,0 +1 @@
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Header/><SOAP-ENV:Body><ns2:payRequest_Response xmlns:ns2="http://api.clickandbuy.com/webservices/pay_1_1_0/"><ns2:requestTrackingID>3a121134#m1-s1#20120925165757</ns2:requestTrackingID><ns2:transaction><ns2:transactionID>1397737001</ns2:transactionID><ns2:externalID>1348592270</ns2:externalID><ns2:transactionStatus>CREATED</ns2:transactionStatus><ns2:transactionType>PAY</ns2:transactionType><ns2:redirectURL>https://checkout.clickandbuy-s1.com/frontend/secure/checkout?tx=1397737001&amp;s=988809699F35D642&amp;h=09FBBC928EDAA067207D4E69B5EA9CAD441D4812</ns2:redirectURL></ns2:transaction></ns2:payRequest_Response></SOAP-ENV:Body></SOAP-ENV:Envelope>

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: activemerchant-clickandbuy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Olek Janiszewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemerchant
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides integration of ClickandBuy with Active Merchant
+email:
+- olek.janiszewski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activemerchant-clickandbuy.gemspec
+- lib/active_merchant/billing/clickand_buy_gateway.rb
+- lib/active_merchant/clickand_buy/request/base.rb
+- lib/active_merchant/clickand_buy/request/pay_request.rb
+- lib/active_merchant/clickand_buy/request/status_request.rb
+- lib/active_merchant/clickand_buy/version.rb
+- lib/activemerchant-clickandbuy.rb
+- spec/active_merchant/billing/clickand_buy_gateway_spec.rb
+- spec/active_merchant/clickand_buy/request/pay_request_spec.rb
+- spec/spec_helper.rb
+- spec/support/clickand_buy.yml.example
+- spec/support/requests/pay_request_response.xml
+homepage: https://github.com/exviva/activemerchant-clickandbuy
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Integration of ClickandBuy with Active Merchant
+test_files:
+- spec/active_merchant/billing/clickand_buy_gateway_spec.rb
+- spec/active_merchant/clickand_buy/request/pay_request_spec.rb
+- spec/spec_helper.rb
+- spec/support/clickand_buy.yml.example
+- spec/support/requests/pay_request_response.xml