mollie-payment 0.1.0 → 0.5.0

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/README.md

@@ -3,9 +3,9 @@ Mollie Payment
 
 This repository is currently a work in progress and under [Documentation Driven Development](http://thinkingphp.org/spliceit/docs/0.1_alpha/pages/ddd_info.html).
 
-On the one hand to get familiar with documenting and [YARD](http://yardoc.org/). On the other hand to create an opiniated Ruby-wrapper for the Mollie [iDEAL API](https://www.mollie.nl/beheer/betaaldiensten/documentatie/ideal/).
+On the one hand to get familiar with documenting and [YARD](http://yardoc.org/). On the other hand to focus on creating an opiniated Ruby-wrapper for the Mollie [iDEAL API](https://www.mollie.nl/beheer/betaaldiensten/documentatie/ideal/).
 
-The generated docs can be [found here](http://rubydoc.info/gems/mollie-payment/0.0.2/frames).
+The generated docs can be [found here](http://rubydoc.info/gems/mollie-payment).
 
 Develop
 ------------
@@ -13,6 +13,7 @@ Develop
     $ git clone git://github.com/eval/mollie-payment.git
     $ cd mollie-payment
     $ bundle
+    $ bundle exec autotest -s rspec2
 
 Author
 ------

data/Rakefile

@@ -1 +1,14 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
+end
+
+desc "Run the specs"
+task :default => :spec
+
+desc 'Removes trailing whitespace'
+task :whitespace do
+  sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
+end

data/lib/mollie/ideal.rb

@@ -1,12 +1,23 @@
+require 'httparty'
+
 module Mollie
   class Ideal
+    include HTTParty
+    base_uri 'https://secure.mollie.nl/xml/ideal'
+
+    attr_reader :partner_id, :production
     # Create a new Ideal object
     #
     # @param [String] partner_id your Mollie partner id
     # @param [Hash] options
-    # @option options [Boolean] :production (false) whether or not to operate 
+    # @option options [Boolean] :production (false) whether or not to operate
     #   in production-mode
-    def initialize(partner_id, options={:production => false});end
+    def initialize(partner_id, options={:production => false})
+      @partner_id = partner_id
+      @production = options[:production]
+    end
+
+    alias :production? :production
 
     # All supported banks.
     #
@@ -17,7 +28,12 @@ module Mollie
     #   # => [{:id => '0031', :name => 'ABN AMRO'}, ...]
     #
     # @return [Array<Hash{Symbol => String}>] the list of banks.
-    def self.banks;end
+    def self.banks
+      resp = get('', :query => {:a => 'banklist'}).parsed_response
+      resp["response"]["bank"].map do |b|
+        {:id => b["bank_id"], :name => b["bank_name"]}
+      end
+    end
     class << self
       alias :banklist :banks
     end
@@ -29,20 +45,20 @@ module Mollie
     # @param [Hash] opts
     # @option opts [Fixnum] :amount the amount in cents.
     # @option opts [String] :bank_id the id of the bank (see {banks}).
-    # @option opts [String] :description description of the transaction 
+    # @option opts [String] :description description of the transaction
     #   (max. 30 characters).
-    # @option opts [String] :report_url address where the result of the 
+    # @option opts [String] :report_url address where the result of the
     #   transaction is sent (POSTed?).
     # @option opts [String] :return_url address where the visitor is sent.
-    # @option opts [String] :profile_key (nil) the profile this transaction 
+    # @option opts [String] :profile_key (nil) the profile this transaction
     #   should be linked to.
-    # 
+    #
     # @example
-    #   
-    #   mi = Mollie::Ideal.new('12345')  
-    #   mi.request_transaction(:amount => 1465, 
+    #
+    #   mi = Mollie::Ideal.new('12345')
+    #   mi.request_transaction(:amount => 1465,
     #                           :bank_id => '0721',
-    #                           :description => "Charlie Brown's Tree", 
+    #                           :description => "Charlie Brown's Tree",
     #                           :report_url => 'http://example.org/report',
     #                           :return_url => 'http://example.org/return')
     #   # => {
@@ -53,7 +69,23 @@ module Mollie
     #   #      }
     #
     # @return [Hash] the transaction (see example)
-    def request_transaction(opts);end
+    def request_transaction(options={})
+      query_options = options_to_query_options(options)
+
+      query_options.merge!(:a => 'fetch', :partnerid => self.partner_id)
+      query_options.merge!(:testmode => 'true') unless self.production?
+
+      resp = self.class.get('', :query => query_options).parsed_response
+      order = resp["response"]["order"]
+
+      %w(transaction_id amount currency url).map(&:to_sym).inject({}) do |res, k|
+        v = order[k.to_s]
+        v = v.to_i if k == :amount
+
+        res[k] = v
+        res
+      end
+    end
 
     # Verify the status of a transaction.
     #
@@ -61,7 +93,7 @@ module Mollie
     #
     # @param [Hash] options
     # @option options [String] :transaction_id the transaction to verify.
-    # 
+    #
     # @example
     #   mi = Mollie::Ideal.new('12345')
     #   mi.verify_transaction(:transaction_id => '482d599bbcc7795727650330ad65fe9b')
@@ -75,15 +107,56 @@ module Mollie
     #   #          :account => 'P001234567',
     #   #          :city => 'Amsterdam'
     #   #        },
-    #   #        :message => 'This iDEAL-order has successfuly been payed for, 
-    #   #                     and this is the first time you check it.'
+    #   #        :message => 'This iDEAL-order has successfuly been payed for,
+    #   #                     and this is the first time you check it.',
+    #   #        :status => 'Expired'
     #   #      }
-    # TODO: docs mention 'status' instead of 'message'
-    # 
+    #
     # @note Once a transaction is payed, only the next time you verify the
-    #   transaction will the value of 'payed' be 'true'. 
+    #   transaction will the value of 'payed' be 'true'.
     #   Else it will be 'false'.
     # @return [Hash] the status of the transaction (see example)
-    def verify_transaction(options);end
+    def verify_transaction(options={})
+      query_options = options_to_query_options(options)
+      query_options.merge!(:a => 'check', :partnerid => self.partner_id)
+      query_options.merge!(:testmode => 'true') unless self.production?
+
+      resp = self.class.get('', :query => query_options).parsed_response
+      order = resp["response"]["order"]
+
+      result = %w(transaction_id amount currency payed status message).map(&:to_sym).inject({}) do |res, k|
+        v = order[k.to_s]
+        v = v.to_i if k == :amount
+        v = (v == 'true') if k == :payed
+
+        res[k] = v
+        res
+      end
+
+      if consumer = order["consumer"]
+        consumer = {'consumerName' => 'name', 'consumerAccount' => 'account', 'consumerCity' => 'city'}.inject({}) do |res, (theirs, ours)|
+          res[ours.to_sym] = consumer[theirs]
+          res
+        end
+        result[:consumer] = consumer
+      end
+      result
+    end
+
+    protected
+    # Convert our naming to their naming
+    def options_to_query_options(options)
+      {
+        :bank_id => :bank_id,
+        :amount => :amount,
+        :return_url => :returnurl,
+        :report_url => :reporturl,
+        :description => :description,
+        :transaction_id => :transaction_id
+      }.inject({}) do |result, (ours, theirs)|
+        result[theirs] = options[ours] if options[ours]
+        result
+      end
+    end
   end
 end

data/lib/mollie/payment/version.rb

@@ -0,0 +1,5 @@
+module Mollie
+  class Payment
+    VERSION = "0.5.0"
+  end
+end

data/mollie-ideal.gemspec

@@ -1,15 +1,15 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "mollie/ideal/version"
+require "mollie/payment/version"
 
 Gem::Specification.new do |s|
   s.name        = "mollie-payment"
-  s.version     = Mollie::Ideal::VERSION
+  s.version     = Mollie::Payment::VERSION
   s.authors     = ["Gert Goet"]
   s.email       = ["gert@thinkcreate.nl"]
   s.homepage    = "https://github.com/eval/mollie-payment"
-  s.summary     = %q{WIP}
-  s.description = %q{WIP}
+  s.summary     = %q{Client for the Mollie API (currently iDEAL only}
+  s.description = %q{Client for the Mollie API (currently iDEAL only}
 
   s.rubyforge_project = "mollie-payment"
 
@@ -18,6 +18,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency "httparty"
+
   s.add_development_dependency "yard"
   s.add_development_dependency "rdiscount"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "ZenTest"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock"
 end

data/spec/fixtures/vcr_cassettes/banks.yml

@@ -0,0 +1,39 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: https://secure.mollie.nl:443/xml/ideal?a=banklist
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.67
+      date:
+      - Thu, 01 Dec 2011 15:41:34 GMT
+      content-type:
+      - text/xml
+      connection:
+      - keep-alive
+      content-location:
+      - ideal.php
+      vary:
+      - negotiate
+      tcn:
+      - choice
+      x-powered-by:
+      - PHP/5.2.6-1+lenny13
+      content-length:
+      - '854'
+    body: ! "<?xml version=\"1.0\" ?>\n<response>\n\t<bank>\n\t\t<bank_id>0031</bank_id>\n\t\t<bank_name>ABN
+      AMRO</bank_name>\n\t</bank>\n\t<bank>\n\t\t<bank_id>0761</bank_id>\n\t\t<bank_name>ASN
+      Bank</bank_name>\n\t</bank>\n\t<bank>\n\t\t<bank_id>0091</bank_id>\n\t\t<bank_name>Friesland
+      Bank</bank_name>\n\t</bank>\n\t<bank>\n\t\t<bank_id>0721</bank_id>\n\t\t<bank_name>ING</bank_name>\n\t</bank>\n\t<bank>\n\t\t<bank_id>0021</bank_id>\n\t\t<bank_name>Rabobank</bank_name>\n\t</bank>\n\t<bank>\n\t\t<bank_id>0771</bank_id>\n\t\t<bank_name>RegioBank</bank_name>\n\t</bank>\n\t<bank>\n\t\t<bank_id>0751</bank_id>\n\t\t<bank_name>SNS
+      Bank</bank_name>\n\t</bank>\n\t<bank>\n\t\t<bank_id>0511</bank_id>\n\t\t<bank_name>Triodos
+      Bank</bank_name>\n\t</bank>\n\t<bank>\n\t\t<bank_id>0161</bank_id>\n\t\t<bank_name>van
+      Lanschot</bank_name>\n\t</bank>\n<message>This is the current list of banks
+      and their ID's that currently support iDEAL-payments</message>\n</response>"
+    http_version: '1.1'

data/spec/fixtures/vcr_cassettes/request_transaction.yml

@@ -0,0 +1,66 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: https://secure.mollie.nl:443/xml/ideal?a=fetch&amount=12345&bank_id=0031&description=description%20goes%20here&partnerid=123456&reporturl=http://example.org/report&returnurl=http://example.org/return&testmode=true
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.67
+      date:
+      - Thu, 01 Dec 2011 20:45:53 GMT
+      content-type:
+      - text/xml
+      connection:
+      - keep-alive
+      content-location:
+      - ideal.php
+      vary:
+      - negotiate
+      tcn:
+      - choice
+      x-powered-by:
+      - PHP/5.2.6-1+lenny13
+      content-length:
+      - '430'
+    body: ! "<?xml version=\"1.0\" ?>\n<response>\n\t<order>\n\t\t<transaction_id>e0be830d5e46289e7da9636beb84729e</transaction_id>\n\t\t<amount>12345</amount>\n\t\t<currency>EUR</currency>\n\t\t<URL>https://www.abnamro.nl/nl/ideal/identification.do?randomizedstring=4164247836&amp;trxid=30000182948803</URL>\n\t\t<message>Your
+      iDEAL-payment has successfully been setup. Your customer should visit the given
+      URL to make the payment</message>\n\t</order>\n</response>"
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: https://secure.mollie.nl:443/xml/ideal?a=fetch&amount=&bank_id=&description=&partnerid=123456&reporturl=&returnurl=&testmode=true
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.67
+      date:
+      - Thu, 01 Dec 2011 20:45:53 GMT
+      content-type:
+      - text/html
+      connection:
+      - keep-alive
+      content-location:
+      - ideal.php
+      vary:
+      - negotiate
+      tcn:
+      - choice
+      x-powered-by:
+      - PHP/5.2.6-1+lenny13
+      content-length:
+      - '189'
+    body: ! "<?xml version=\"1.0\" ?>\n<response>\n\t<item type=\"error\">\n\t\t<errorcode>-3</errorcode>\n\t\t<message>A
+      fetch was issued without (proper) specification of 'reporturl'</message>\n\t</item>\n</response>"
+    http_version: '1.1'

data/spec/fixtures/vcr_cassettes/verify_transaction.yml

@@ -0,0 +1,34 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: https://secure.mollie.nl:443/xml/ideal?a=check&partnerid=123456&testmode=true&transaction_id=e0be830d5e46289e7da9636beb84729e
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.67
+      date:
+      - Fri, 02 Dec 2011 11:49:35 GMT
+      content-type:
+      - text/xml
+      connection:
+      - keep-alive
+      content-location:
+      - ideal.php
+      vary:
+      - negotiate
+      tcn:
+      - choice
+      x-powered-by:
+      - PHP/5.2.6-1+lenny13
+      content-length:
+      - '380'
+    body: ! "<?xml version=\"1.0\" ?>\n<response>\n\t<order>\n\t\t<transaction_id>e0be830d5e46289e7da9636beb84729e</transaction_id>\n\t\t<amount>12345</amount>\n\t\t<currency>EUR</currency>\n\t\t<payed>false</payed>\n\t\t<message>This
+      iDEAL-order wasn't payed for, or was already checked by you. (We give payed=true
+      only once, for your protection)</message>\n\t\t<status>CheckedBefore</status>\n\t</order>\n\n</response>"
+    http_version: '1.1'

data/spec/mollie/ideal_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Mollie::Ideal do
+  context "#banks" do
+    it "returns an array with hashes containing keys :id and :name" do
+      VCR.use_cassette('banks') do
+        banks = described_class.banks
+        banks.class.should == Array
+        banks.first.keys.should =~ [:id, :name]
+      end
+    end
+  end
+
+  context "#request_transaction" do
+    subject{ Mollie::Ideal.new('123456')}
+
+    it "should return a hash with the correct keys and values" do
+      VCR.use_cassette('request_transaction') do
+        t = subject.request_transaction(:amount => 12345,
+                                        :bank_id => '0031',
+                                        :description => 'description goes here',
+                                        :report_url => 'http://example.org/report',
+                                        :return_url => 'http://example.org/return')
+        t.class.should == Hash
+        expected_keys_with_values = {:transaction_id => nil, :amount => 12345, :currency => 'EUR', :url => nil}
+        check_hash_keys_and_values(t, expected_keys_with_values)
+      end
+    end
+  end
+
+  context "#verify_transaction" do
+    subject{ Mollie::Ideal.new('123456')}
+
+    it "should return a hash with the correct keys and values" do
+      VCR.use_cassette('verify_transaction') do
+        t = subject.verify_transaction(:transaction_id => 'e0be830d5e46289e7da9636beb84729e')
+
+        t.class.should == Hash
+        expected_keys_with_values = {:transaction_id => 'e0be830d5e46289e7da9636beb84729e',
+                                      :amount => 12345,
+                                      :currency => 'EUR',
+                                      :payed => false,
+                                      :status => 'CheckedBefore'}
+        check_hash_keys_and_values(t, expected_keys_with_values)
+      end
+    end
+  end
+
+  protected
+  # Checks target for:
+  # - existance of supplied keys
+  # - value for given key if supplied
+  #
+  # @example passing example
+  #   check_hash_keys_and_values({:a => 1, :b => 'anything'}, {:a => 1, :b => nil})
+  def check_hash_keys_and_values(target, keys_and_values)
+    keys_and_values.each do |key, value|
+      if value
+        target[key].should == value
+      else
+        target.keys.should include(key)
+      end
+    end
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require "mollie-ideal"
+
+Bundler.require(:test)
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.stub_with :webmock
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mollie-payment
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-01 00:00:00.000000000Z
+date: 2011-12-02 00:00:00.000000000Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70206244600140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70206244600140
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70303083420680 !ruby/object:Gem::Requirement
+  requirement: &70206244599500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +32,54 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70303083420680
+  version_requirements: *70206244599500
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70303083420260 !ruby/object:Gem::Requirement
+  requirement: &70206244598920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70206244598920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70206244598340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70206244598340
+- !ruby/object:Gem::Dependency
+  name: ZenTest
+  requirement: &70206244597780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70206244597780
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70206244597020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70206244597020
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70206244596440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,8 +87,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70303083420260
-description: WIP
+  version_requirements: *70206244596440
+description: Client for the Mollie API (currently iDEAL only
 email:
 - gert@thinkcreate.nl
 executables: []
@@ -41,13 +96,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - README.md
 - Rakefile
-- lib/mollie-ideal.rb
+- lib/mollie-payment.rb
 - lib/mollie/ideal.rb
-- lib/mollie/ideal/version.rb
+- lib/mollie/payment/version.rb
 - mollie-ideal.gemspec
+- spec/fixtures/vcr_cassettes/banks.yml
+- spec/fixtures/vcr_cassettes/request_transaction.yml
+- spec/fixtures/vcr_cassettes/verify_transaction.yml
+- spec/mollie/ideal_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 homepage: https://github.com/eval/mollie-payment
 licenses: []
 post_install_message: 
@@ -71,6 +133,12 @@ rubyforge_project: mollie-payment
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: WIP
-test_files: []
+summary: Client for the Mollie API (currently iDEAL only
+test_files:
+- spec/fixtures/vcr_cassettes/banks.yml
+- spec/fixtures/vcr_cassettes/request_transaction.yml
+- spec/fixtures/vcr_cassettes/verify_transaction.yml
+- spec/mollie/ideal_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: 

data/lib/mollie/ideal/version.rb

@@ -1,5 +0,0 @@
-module Mollie
-  class Ideal
-    VERSION = "0.1.0"
-  end
-end