debitech 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+pkg

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-p0@debitech --create

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joakim Kolsjö
+
+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,39 @@
+# Debitech
+
+This is a DebiTech payment library extracted from production code.
+
+You can use this to do subscription payments without needing to handle any
+credit card information yourself.
+
+Todo:
+
+* Examples and documentation
+* Gotchas about the debitech API
+* Page set templates (the pages that are shown at DIBS to input credit card info)
+* Rake tasks to update page sets
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'debitech'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install debitech
+
+## 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,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/**/*.rb'
+end
+
+task :default => :spec
+

data/debitech.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/debitech/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joakim Kolsjö"]
+  gem.email         = ["joakim@barsoom.se"]
+  gem.description   = %q{Library for doing payments using DebiTech (DIBS)}
+  gem.summary       = %q{Library for doing payments using DebiTech (DIBS)}
+  gem.homepage      = "https://github.com/barsoom/debitech"
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  gem.name          = "debitech"
+  gem.require_paths = ["lib"]
+  gem.version       = Debitech::VERSION
+  gem.add_dependency "debitech_soap"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-rspec"
+end

data/lib/debitech/mac.rb

@@ -0,0 +1,9 @@
+require 'digest/sha1'
+
+module Debitech
+  class Mac
+    def self.build(data)
+      Digest::SHA1.hexdigest(data.map { |s| s.to_s + "&" }.join).upcase
+    end
+  end
+end

data/lib/debitech/server_api.rb

@@ -0,0 +1,51 @@
+require 'debitech_soap'
+require 'debitech/mac'
+
+module Debitech
+  class ServerApi
+    class ChargeResult
+      attr_reader :response
+
+      PENDING_RESULT_CODE = 403
+
+      def initialize(response)
+        @response = response
+      end
+
+      def success?
+        @response.result_code.to_s[0,1] == "1"
+      end
+
+      def pending?
+        @response.result_code == PENDING_RESULT_CODE
+      end
+    end
+
+    class ValidUniqueReferenceRequired < StandardError; end
+    
+    # Don't know about the upper bound, but we need it to be atleast 5 characters to be
+    # able to search for it in DIBS Manager.
+    LEAST_NUMBER_OF_CHARACTERS_IN_UNIQUE_ID = 5
+
+    def initialize(config = {})
+      @config = config
+      @soap_api = DebitechSoap::API.new(config[:soap_opts])
+    end
+
+    def charge(opts = {})
+      if opts[:amount] && (opts[:amount] - opts[:amount].to_i) > 0
+        raise "The amount (#{opts[:amount]}) contains fractions (for example 10.44 instead of 10), amount should specified in cents."
+      end
+
+      if opts[:unique_reference].to_s.size < LEAST_NUMBER_OF_CHARACTERS_IN_UNIQUE_ID
+        raise ValidUniqueReferenceRequired
+      end
+
+      data = "001:payment:1:#{opts[:amount].to_i}:"
+      mac = Mac.build [ data, opts[:currency], opts[:unique_reference], @config[:secret_key] ]
+      extra = "&method=#{@config[:method]}&currency=#{opts[:currency]}&MAC=#{mac}&referenceNo=#{opts[:unique_reference]}"
+      response = @soap_api.subscribe_and_settle(:verifyID => opts[:verify_id], :ip => opts[:ip], :data => data, :extra => extra)
+      ChargeResult.new(response)
+    end
+  end
+end

data/lib/debitech/version.rb

@@ -0,0 +1,3 @@
+module Debitech
+  VERSION = "1.0.0"
+end

data/lib/debitech/web_api.rb

@@ -0,0 +1,56 @@
+require 'digest/sha1'
+require 'debitech/mac'
+
+module Debitech
+  class WebApi
+    APPROVED_REPLY = "A"
+
+    def initialize(opts = {})
+      @opts = opts
+    end
+
+    def form_fields
+      base_fields.merge(:MAC => request_mac)
+    end
+
+    def form_action
+      "https://secure.incab.se/verify/bin/#{@opts[:merchant]}/index"
+    end
+
+    def valid_response?(mac, sum, reply, verify_id)
+      response_mac(sum, reply, verify_id) == mac.upcase.split("=").last
+    end
+
+    def approved_reply?(reply)
+      reply == APPROVED_REPLY
+    end
+
+    private
+
+    def base_fields
+      {
+        :currency         => "SEK",
+        :method           => 'cc.test',
+        :amount           => '100',
+        :authOnly         => 'true',
+        :pageSet          => 'creditcard',
+        :data             => '001:auth:1:100:',
+        :uses3dsecure     => 'false',
+        :billingFirstName => "First name",
+        :billingLastName  => "Last name",
+        :billingAddress   => "Address",
+        :billingCity      => "City",
+        :billingCountry   => "Country",
+        :eMail            => "email@example.com"
+      }.merge!(@opts[:fields] || {})
+    end
+
+    def request_mac
+      Mac.build [ base_fields[:data], base_fields[:currency], base_fields[:method], @opts[:secret_key] ]
+    end
+
+    def response_mac(sum, reply, verify_id)
+      Mac.build [ sum, base_fields[:currency], reply, verify_id, @opts[:secret_key] ]
+    end
+  end
+end

data/lib/debitech.rb

@@ -0,0 +1,3 @@
+require "debitech/version"
+require "debitech/server_api"
+require "debitech/web_api"

data/spec/debitech/server_api_spec.rb

@@ -0,0 +1,104 @@
+require 'debitech'
+
+describe Debitech::ServerApi, "charge" do
+
+  it "should perform a subscribe_and_settle call" do
+    settings = { 
+      :secret_key => "112756FC8C60C5603C58DA6E0A4844ACFDB60525",
+      :method => "cc.cekab",
+      :soap_opts => { :merchant => "store", :username => "api_user", :password => "api_password" } }
+
+    DebitechSoap::API.should_receive(:new).with({ :merchant => "store", :username => "api_user", :password => "api_password" }).
+                                           and_return(soap_api = mock) 
+    soap_api.should_receive(:subscribe_and_settle).with(:verifyID => 1234567,
+                            :data => "001:payment:1:10000:",
+                            :ip => "127.0.0.1",
+                            :extra => "&method=cc.cekab&currency=SEK&MAC=1931EE498A77F6B12B2C2D2EC8599719EF9CE419&referenceNo=some_unique_ref")
+
+    server_api = Debitech::ServerApi.new(settings)
+    server_api.charge(:verify_id => 1234567, :amount => 10000, :currency => "SEK", :unique_reference => "some_unique_ref", :ip => "127.0.0.1")
+  end
+
+  it "should convert the amount to a integer to avoid 500 errors" do
+    DebitechSoap::API.stub!(:new).and_return(soap_api = mock) 
+    soap_api.should_receive(:subscribe_and_settle).with(:verifyID => 1234567,
+                            :data => "001:payment:1:2235:",
+                            :ip => "127.0.0.1",
+                            :extra => "&method=&currency=SEK&MAC=78B1144270B1A74A55539FAEB81BB49EC39B90DF&referenceNo=some_unique_ref")
+
+    server_api = Debitech::ServerApi.new({})
+    server_api.charge(:verify_id => 1234567, :amount => 2235.0, :currency => "SEK", :unique_reference => "some_unique_ref", :ip => "127.0.0.1")
+  end
+
+  it "should raise an error if the amount has a fraction" do
+    DebitechSoap::API.stub!(:new).and_return(soap_api = mock) 
+    server_api = Debitech::ServerApi.new({})
+    lambda {
+      server_api.charge(:verify_id => 1234567, :amount => 2235.55, :currency => "SEK", :unique_reference => "some_unique_ref", :ip => "127.0.0.1")
+    }.should raise_error("The amount (2235.55) contains fractions (for example 10.44 instead of 10), amount should specified in cents.")
+  end
+
+  it "should raise an error if the unique_reference is nil" do
+    DebitechSoap::API.stub!(:new).and_return(soap_api = mock) 
+    server_api = Debitech::ServerApi.new({})
+    lambda {
+      server_api.charge(:verify_id => 1234567, :amount => 2235, :currency => "SEK", :unique_reference => nil, :ip => "127.0.0.1")
+    }.should raise_error(Debitech::ServerApi::ValidUniqueReferenceRequired)
+  end
+
+  it "should raise an error if the unique_reference is less than 4 characters" do
+    DebitechSoap::API.stub!(:new).and_return(soap_api = mock) 
+    server_api = Debitech::ServerApi.new({})
+    lambda {
+      server_api.charge(:verify_id => 1234567, :amount => 2235, :currency => "SEK",
+                        :unique_reference => "1234", :ip => "127.0.0.1")
+    }.should raise_error(Debitech::ServerApi::ValidUniqueReferenceRequired)
+  end
+
+  it "should be valid with a 5 character unique_reference" do
+    DebitechSoap::API.stub!(:new).and_return(soap_api = mock) 
+    soap_api.stub!(:subscribe_and_settle)
+    server_api = Debitech::ServerApi.new({})
+    server_api.charge(:verify_id => 1234567, :amount => 2235, :currency => "SEK",
+                      :unique_reference => "12345", :ip => "127.0.0.1")
+  end
+
+  [ 100, 101, 150, 199 ].each do |result_code|
+    it "should return success for result_code #{result_code}" do
+      DebitechSoap::API.stub!(:new).and_return(soap_api = mock) 
+      soap_api.stub!(:subscribe_and_settle).and_return(response = mock(:result_code => result_code))
+
+      server_api = Debitech::ServerApi.new({})
+      result = server_api.charge({ :unique_reference => "some_unique_ref" })
+
+      result.should be_success
+      result.should_not be_pending
+      result.response.result_code.should == result_code
+    end
+  end
+
+  [ 200, 250, 300, 400 ].each do |result_code|
+    it "should not be successful for result_code #{result_code}" do
+      DebitechSoap::API.stub!(:new).and_return(soap_api = mock) 
+      soap_api.stub!(:subscribe_and_settle).and_return(response = mock(:result_code => result_code))
+
+      server_api = Debitech::ServerApi.new({})
+      result = server_api.charge({ :unique_reference => "some_unique_ref" })
+
+      result.should_not be_success
+      result.should_not be_pending
+      result.response.result_code.should == result_code
+    end
+  end
+
+  it "should return pending and not be successful for 403" do
+    DebitechSoap::API.stub!(:new).and_return(soap_api = mock) 
+    soap_api.stub!(:subscribe_and_settle).and_return(response = mock(:result_code => 403))
+    server_api = Debitech::ServerApi.new({})
+    result = server_api.charge({ :unique_reference => "some_unique_ref" })
+
+    result.should_not be_success
+    result.should be_pending
+  end
+
+end

data/spec/debitech/web_api_spec.rb

@@ -0,0 +1,65 @@
+require 'ostruct'
+require 'debitech'
+
+describe Debitech::WebApi, "form_fields" do
+  it "should include static values" do
+    fields = Debitech::WebApi.new({ :secret_key => 'secretkey' }).form_fields
+    fields[:currency].should == 'SEK'
+    fields[:method].should == 'cc.test'
+  end
+
+  it "should be possible to override the values" do
+    fields = Debitech::WebApi.new({ :secret_key => 'secretkey', :fields => { :method => "cc.cekab" } }).form_fields
+    fields[:method].should == 'cc.cekab'
+  end
+
+  it "should calculate mac" do
+    Debitech::WebApi.new({ :secret_key => "secretkey1" }).form_fields[:MAC].should == "DF253765337968C5ED7E6EA530CD692942416ABE"
+    Debitech::WebApi.new({ :secret_key => "secretkey2" }).form_fields[:MAC].should == "BEB3C370E37837734642111D44CA7E304A0F45F2"
+  end
+end
+
+describe Debitech::WebApi, "form_action" do
+  it "should return the url based on shop" do
+    Debitech::WebApi.new({ :merchant => "shop" }).form_action.should == "https://secure.incab.se/verify/bin/shop/index"
+  end
+end
+
+describe Debitech::WebApi, "approved_response?" do
+  context "given reply is 'A' for approved" do
+    it "should be true" do
+      api = Debitech::WebApi.new
+      api.approved_reply?("A").should be_true
+    end
+  end
+
+  context "given reply is 'D' for denied" do
+    it "should be false" do
+      api = Debitech::WebApi.new
+      api.approved_reply?("D").should be_false
+    end
+  end
+end
+
+describe Debitech::WebApi, "valid_response?" do
+  it "should validate that the response hashes down to the mac value" do
+    api = Debitech::WebApi.new({ :secret_key => "secretkey" })
+    api.valid_response?("MAC=667026AD7692F9AFDA362919EA72D8E6A250A849", "1,00", "A", "1234567").should be_true
+  end
+
+  it "should not be true if any of the values are wrong" do
+    api = Debitech::WebApi.new({ :secret_key => "secretkey" })
+    api.valid_response?("MAC=667026AD7692F9AFDA362919EA72D8E6A250A849", "1,00", "A", "1234568").should be_false
+  end
+
+  it "should not be true if the secretkey is different" do
+    api = Debitech::WebApi.new({ :secret_key => "secretkey2" })
+    api.valid_response?("MAC=667026AD7692F9AFDA362919EA72D8E6A250A849", "1,00", "A", "1234567").should be_false
+  end
+
+  it "should handle if verify_id is an int" do
+    api = Debitech::WebApi.new({ :secret_key => "secretkey" })
+    api.valid_response?("MAC=667026AD7692F9AFDA362919EA72D8E6A250A849", "1,00", "A", 1234567).should be_true
+  end
+
+end 

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: debitech
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Joakim Kolsjö
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debitech_soap
+  requirement: &2152307340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152307340
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152306700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152306700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152306260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152306260
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &2152305800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152305800
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2152304760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152304760
+description: Library for doing payments using DebiTech (DIBS)
+email:
+- joakim@barsoom.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- debitech.gemspec
+- lib/debitech.rb
+- lib/debitech/mac.rb
+- lib/debitech/server_api.rb
+- lib/debitech/version.rb
+- lib/debitech/web_api.rb
+- spec/debitech/server_api_spec.rb
+- spec/debitech/web_api_spec.rb
+homepage: https://github.com/barsoom/debitech
+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.5
+signing_key: 
+specification_version: 3
+summary: Library for doing payments using DebiTech (DIBS)
+test_files: []