debitech_soap 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+tools
+.bundle
+pkg
+todo.txt
+*/*.swp
+*.swp
+*/**/.*.swp
+*/**/*.swp
+*/*/*/*.swp

data/.rvmrc

@@ -0,0 +1 @@
+rvm ree@debitech_soap

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in debitech_soap.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    debitech_soap (0.0.1)
+      activesupport
+      i18n
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    activesupport (3.0.3)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  debitech_soap!
+  rspec

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Joakim Kolsjö
+
+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.markdown

@@ -0,0 +1,61 @@
+Work in progress!
+----
+
+This is **work in progress and not usable yet**. [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)... 
+
+WIP docs below
+----
+
+This is a wrapper of the DebiTech SOAP API. It's intended to be API compatible with the DebiTech Java client but also supports a more developer friendly syntax :).
+
+Installing
+----
+
+    gem install debitech_soap
+
+Usage
+----
+ 
+This is how you would have used the DebiTech Java API:
+
+    include_class "com.verifyeasy.server.VEServer"
+    veserver = VEServer.get_instance("https://secure.incab.se/verify/server/merchant_name")
+
+This is how you use DebitechSoap:
+
+    require 'debitech_soap'
+    veserver = DebitechSoap::API.new(:merchant => "merchant_name", :username => "api_user_name", :password => "api_user_password")
+
+Supported arguments
+----
+
+Java style (see DebitechSoap::API::PARAMS.keys in lib/debitech_soap.rb):
+
+    veserver.refund(1234567, 23456, 100, "extra")
+
+Hash:
+
+    veserver.refund(:verifyID => 1234567, :transID => 23456, :amount => 100, :extra => "extra")
+
+Custom methods
+----
+
+**valid_credentials?**: Returns **true** if the credentials work (calls "checkSwedishPersNo").
+
+Return data
+----
+
+- An object with methods for each attribute (See DebitechSoap::RETURN_DATA).
+- Each attribute has serveral methods, for example "infoCode" can also be "getInfoCode" or "get_info_code".
+- If the return value is a number it will be converted to an integer.
+
+API docs
+----
+
+Get DIBSServerManual.pdf from the DIBS Manager.
+
+Known issues
+----
+
+- Does not work with Ruby 1.9 (does not have "soap/wsdlDriver"). We have not been able to get "savon" to work.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs"
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/**/*.rb'
+end
+
+task :default => :spec
+

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/debitech_soap.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "debitech_soap/version"
+
+Gem::Specification.new do |s|
+  s.name        = "debitech_soap"
+  s.version     = DebitechSoap::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Joakim Kolsjö", 'Niklas Holmgren']
+  s.email       = ["joakim.kolsjo@gmail.com", 'niklas.holmgren@bukowskis.com']
+  s.homepage    = "http://github.com/joakimk/debitech_soap"
+  s.summary     = %q{A pure ruby way to make payments with DebiTech}
+  s.description = %q{An implementation of the DebiTech Java API using pure ruby and the SOAP API.}
+
+  s.add_dependency "activesupport"
+  s.add_dependency "i18n" # Because of activesupport infections
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'autotest'
+
+  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

data/lib/debitech_soap/version.rb

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

data/lib/debitech_soap.rb

@@ -0,0 +1,105 @@
+require 'soap/wsdlDriver'
+require 'ostruct'
+require 'rubygems'
+require 'active_support'
+
+begin
+  # Required for active_support 3+
+  require 'active_support/core_ext/string/inflections'
+rescue LoadError
+end
+
+module DebitechSoap
+  class API
+
+    RETURN_DATA = %w{aCSUrl acquirerAddress acquirerAuthCode acquirerAuthResponseCode acquirerCity acquirerConsumerLimit acquirerErrorDescription acquirerFirstName acquirerLastName acquirerMerchantLimit acquirerZipCode amount errorMsg infoCode infoDescription pAReqMsg resultCode resultText verifyID}
+
+    PARAMS = { "settle"                => ["verifyID", "transID", "amount", "extra"],
+               "subscribe_and_settle"  => ["verifyID", "transID", "data", "ip", "extra"],
+               "authorize"             => ["billingFirstName", "billingLastName", "billingAddress", "billingCity",
+                                           "billingCountry", "cc", "expM", "expY", "eMail", "ip", "data", "currency", "transID", "extra"],
+               "authorizeAndSettle3DS" => ["verifyID", "paRes", "extra"],
+               "refund"                => ["verifyID", "transID", "amount", "extra"],
+               "askIf3DSEnrolled"      => ["billingFirstName", "billingLastName", "billingAddress", "billingCity",
+                                           "billingCountry", "cc", "expM", "expY", "eMail", "ip", "data", "currency", "transID",
+                                           "httpAcceptHeader", "httpUserAgentHeader", "method", "referenceNo", "extra"],
+               "auth_reversal"         => ["verifyID", "amount", "transID", "extra"],
+               "authorize3DS"          => ["verifyID", "paRes", "extra"],
+               "subscribe"             => ["verifyID", "transID", "data", "ip", "extra"],
+               "authorize_and_settle"  => ["billingFirstName", "billingLastName", "billingAddress", "billingCity", "billingCountry",
+                                           "cc", "expM", "expY", "eMail", "ip", "data", "currency", "transID", "extra"] }
+
+    def initialize(opts = {})
+      @api_credentials = {}
+      @api_credentials[:shopName] = opts[:merchant]
+      @api_credentials[:userName] = opts[:username]
+      @api_credentials[:password] = opts[:password]
+      
+      disable_stderr do
+        @client = SOAP::WSDLDriverFactory.new('https://secure.incab.se/axis2/services/DTServerModuleService_v1?wsdl').create_rpc_driver
+      end
+
+      define_java_wrapper_methods!  
+    end
+
+    def valid_credentials?
+      disable_stderr do
+        @client.checkSwedishPersNo(@api_credentials.merge({ :persNo => "555555-5555" })).return == "true"
+      end
+    end
+
+  private
+
+    def define_java_wrapper_methods!
+      PARAMS.keys.each { |method|
+        (class << self; self; end).class_eval do                          # Doc:
+          define_method(method) do |*args|                                # def refund(*args)
+            attributes = @api_credentials.clone
+
+            if args.first.is_a?(Hash) 
+              attributes.merge!(args.first)
+            else
+              parameter_order = PARAMS[method.to_s] 
+              args.each_with_index { |argument, i|
+                attributes[parameter_order[i].to_sym] = argument
+              }
+            end
+
+            return_data @client.send(method, attributes).return
+          end                                                             # end
+        end
+      }
+    end
+
+    def return_data(results)
+      hash = {}
+
+      RETURN_DATA.each { |attribute|
+        result = results.send(attribute)
+        unless result.is_a?(SOAP::Mapping::Object)
+          result = result.to_i if integer?(result)
+          hash[attribute] = result
+          hash["get_" + attribute.underscore] = result
+          hash["get" + attribute.camelcase] = result
+          hash[attribute.underscore] = result
+        end
+      }
+
+      OpenStruct.new(hash)
+    end
+
+    def integer?(result)
+      result.to_i != 0 || result == "0"
+    end
+
+    def disable_stderr
+      begin
+        $stderr = File.open('/dev/null', 'w')
+        yield
+      ensure
+        $stderr = STDERR
+      end
+    end
+
+  end
+end

data/spec/debitech_soap_spec.rb

@@ -0,0 +1,139 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/debitech_soap'))
+
+class MockSoapResult
+  class MockReturn
+    def method_missing(*opts)
+      SOAP::Mapping::Object.new
+    end
+  end
+
+  def return
+    @return ||= MockReturn.new
+  end
+end
+
+describe DebitechSoap::API, "valid_credentials?" do
+  
+  before do
+    @client = mock(Object)
+    SOAP::WSDLDriverFactory.stub!(:new).and_return(mock(Object, :create_rpc_driver => @client))
+  end
+
+  it "should call checkSwedishPersNo with the credentials and a valid swedish social security number" do
+    @client.should_receive(:checkSwedishPersNo).with(:shopName => "merchant_name", :userName => "api_user_name",
+                                                     :password => "api_user_password", :persNo => "555555-5555").
+                                                     and_return(mock(Object, :return => "true"))
+
+    api = DebitechSoap::API.new(:merchant => "merchant_name", :username => "api_user_name", :password => "api_user_password")
+    api.valid_credentials?.should == true
+  end
+
+  it "should return false if the service returns false" do
+    @client.stub!(:checkSwedishPersNo).and_return(mock(Object, :return => "false"))
+    api = DebitechSoap::API.new(:merchant => "merchant_name", :username => "api_user_name", :password => "api_user_password")
+    api.valid_credentials?.should == false
+  end
+
+end
+
+describe DebitechSoap::API, "calling a method with java-style arguments" do
+
+  before do
+    @client = mock(Object)
+    SOAP::WSDLDriverFactory.stub!(:new).and_return(mock(Object, :create_rpc_driver => @client))
+  end
+  
+  it "should map the arguments to a hash and call the corresponding SOAP method" do
+    api = DebitechSoap::API.new(:merchant => "merchant_name", :username => "api_user_name", :password => "api_user_password")
+    @client.should_receive("refund").with(:verifyID => 1234567, :transID => 23456, :amount => 100, :extra => "extra",
+                                          :shopName => "merchant_name", :userName => "api_user_name", :password => "api_user_password").
+                                          and_return(MockSoapResult.new)
+    api.refund(1234567, 23456, 100, "extra")
+  end
+  
+  it "should not keep old attributes when making subsequent api calls" do
+    api = DebitechSoap::API.new(:merchant => "merchant_name", :username => "api_user_name", :password => "api_user_password")
+    @client.should_receive("refund").with(:verifyID => 1234567, :transID => 23456, :amount => 100, :extra => "extra",
+                                          :shopName => "merchant_name", :userName => "api_user_name", :password => "api_user_password").
+                                          and_return(MockSoapResult.new)
+    @client.should_receive("authorize3DS").with(:verifyID => 1234567, :paRes => "RES", :extra => "extra",
+                                          :shopName => "merchant_name", :userName => "api_user_name", :password => "api_user_password").
+                                          and_return(MockSoapResult.new)
+                                          
+    api.refund(1234567, 23456, 100, "extra")
+    api.authorize3DS(1234567, "RES", "extra")
+  end
+
+  it "should create a return object" do
+    api = DebitechSoap::API.new
+    mock_soap_result = MockSoapResult.new
+    mock_soap_result.return.stub!(:resultText).and_return("success")
+    @client.stub!("refund").and_return(mock_soap_result)
+    api.refund(1234567, 23456, 100, "extra").resultText.should == "success"
+  end
+
+  it "should return nil when there is no data" do
+    api = DebitechSoap::API.new
+    mock_soap_result = MockSoapResult.new
+    @client.stub!("refund").and_return(mock_soap_result)
+    api.refund(1234567, 23456, 100, "extra").resultCode.should be_nil
+  end
+
+  it "should be able to access the data using getCamelCase, get_underscore and underscore methods" do
+    api = DebitechSoap::API.new
+    mock_soap_result = MockSoapResult.new
+    mock_soap_result.return.stub!(:resultText).and_return("success")
+    @client.stub!("refund").and_return(mock_soap_result)
+    result = api.refund(1234567, 23456, 100, "extra")
+    result.getResultText.should == "success"
+    result.get_result_text.should == "success"
+    result.result_text.should == 'success'
+  end
+
+  it "should convert the result to an integer when its a number" do
+    api = DebitechSoap::API.new
+    mock_soap_result = MockSoapResult.new
+    mock_soap_result.return.stub!(:resultCode).and_return("100")
+    @client.stub!("refund").and_return(mock_soap_result)
+    result = api.refund(1234567, 23456, 100, "extra")
+    result.resultCode.should == 100
+    result.getResultCode.should == 100
+    result.get_result_code.should == 100
+  end
+
+  it "should convert the result to an integer when its zero" do
+    api = DebitechSoap::API.new
+    mock_soap_result = MockSoapResult.new
+    mock_soap_result.return.stub!(:resultCode).and_return("0")
+    @client.stub!("refund").and_return(mock_soap_result)
+    result = api.refund(1234567, 23456, 100, "extra")
+    result.resultCode.should == 0
+  end
+
+end
+
+describe DebitechSoap::API, "calling a method with hash-style arguments" do
+
+  before do
+    @client = mock(Object)
+    SOAP::WSDLDriverFactory.stub!(:new).and_return(mock(Object, :create_rpc_driver => @client))
+  end
+
+  it "should call the corresponding soap method" do
+    api = DebitechSoap::API.new(:merchant => "merchant_name", :username => "api_user_name", :password => "api_user_password")
+    @client.should_receive("refund").with(:verifyID => 1234567, :transID => 23456, :amount => 100, :extra => "extra",
+                                          :shopName => "merchant_name", :userName => "api_user_name", :password => "api_user_password").
+                                          and_return(MockSoapResult.new)
+    api.refund(:verifyID => 1234567, :transID => 23456, :amount => 100, :extra => "extra")
+  end
+
+  it "should return data" do
+    api = DebitechSoap::API.new
+    mock_soap_result = MockSoapResult.new
+    mock_soap_result.return.stub!(:resultText).and_return("success")
+    @client.stub!("refund").and_return(mock_soap_result)
+    api.refund(:verifyID => 1234567, :transID => 23456, :amount => 100, :extra => "extra").getResultText.should == "success"
+  end
+
+end
+

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: debitech_soap
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Joakim Kolsj\xC3\xB6"
+- Niklas Holmgren
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-27 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: An implementation of the DebiTech Java API using pure ruby and the SOAP API.
+email: 
+- joakim.kolsjo@gmail.com
+- niklas.holmgren@bukowskis.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENCE
+- README.markdown
+- Rakefile
+- autotest/discover.rb
+- debitech_soap.gemspec
+- lib/debitech_soap.rb
+- lib/debitech_soap/version.rb
+- spec/debitech_soap_spec.rb
+has_rdoc: true
+homepage: http://github.com/joakimk/debitech_soap
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A pure ruby way to make payments with DebiTech
+test_files: 
+- spec/debitech_soap_spec.rb