mollie-api-ruby 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00c764099a49ead8514278cfa6db983f644c35f0
-  data.tar.gz: 04224d5226ac3b33340225fb2a4126f0f058ff8e
+  metadata.gz: 1814d5f5f87cb8fe85890e2a1b7381045e5483a6
+  data.tar.gz: 25c77c32cda7f816ab3a67f6d0c7cb1804c7ee81
 SHA512:
-  metadata.gz: e1f1fb6c5e98c36fec4de50dcb300e45529373c62b11bae41ed2c2febf9e54e529dc3ab85dfadf7d2224e2c999b5b634b895cfad50e8cc2c57f2ba11fa97ca47
-  data.tar.gz: c7fe28ba206cdea937e4e1d2300dd10501c7738d3cebc6058433a877d12c4cdc6e96d6e711e9cb843b517e5a7b33d477b4a431603c8c48133addbe966451c5da
+  metadata.gz: e356234410dbd7ddfce3878af51ea8d1e5599a2e46772e7bcb5c30d3b7c6dd33ef7bef7673a9e792eb607d370e913182676501208f04b3a385be3f424c612f4a
+  data.tar.gz: 57429e86b3b93ba8409ab5f5dc6a1175f9a0b02965d54e78773be744b59303953b04c36f4a00c7ae85d40cd1ebae988da628589f4a02584372c397c5b878a722

data/README.mdown

@@ -67,6 +67,17 @@ Retrieving a payment.
 		end
 ```
 
+### Refunding payments ###
+
+The API also supports refunding payments. Note that there is no confirmation and that all refunds are immediate and
+definitive. Refunds are only supported for iDEAL, credit card and Bank Transfer payments. Other types of payments cannot
+be refunded through our API at the moment.
+
+```ruby
+		payment = mollie.payments.get payment.id
+		refund  = mollie.payments_refunds.with(payment).create
+```
+
 ## Examples ##
 
 The examples require [Sinatra](http://rubygems.org/gems/sinatra) so you will need to install that gem first. Afterwards simply run:
@@ -86,6 +97,7 @@ Contact: [www.mollie.nl](http://www.mollie.nl) — info@mollie.nl — +31 20-612
 + [More information about iDEAL via Mollie](https://www.mollie.nl/betaaldiensten/ideal/)
 + [More information about Creditcard via Mollie](https://www.mollie.nl/betaaldiensten/creditcard/)
 + [More information about Mister Cash via Mollie](https://www.mollie.nl/betaaldiensten/mistercash/)
++ [More information about Bank transfer via Mollie](https://www.mollie.nl/betaaldiensten/overboeking/)
 + [More information about PayPal via Mollie](https://www.mollie.nl/betaaldiensten/paypal/)
 + [More information about paysafecard via Mollie](https://www.mollie.nl/betaaldiensten/paysafecard/)
 

data/examples/1-new-payment.rb

@@ -10,7 +10,7 @@ begin
 	# See: https://www.mollie.nl/beheer/account/profielen/
 	#
 	mollie = Mollie::API::Client.new
-	mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+	mollie.setApiKey "test_bt7vvByF6jTcBR4dLuW66eNnHYNIJp"
 
 	#
 	# Generate a unique order id for this example. It is important to include this unique attribute

data/examples/2-webhook-verification.rb

@@ -10,7 +10,7 @@ begin
 	# See: https://www.mollie.nl/beheer/account/profielen/
 	#
 	mollie = Mollie::API::Client.new
-	mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+	mollie.setApiKey "test_bt7vvByF6jTcBR4dLuW66eNnHYNIJp"
 
 	#
 	# Retrieve the payment's current state.

data/examples/4-ideal-payment.rb

@@ -10,7 +10,7 @@ begin
 	# See: https://www.mollie.nl/beheer/account/profielen/
 	#
 	mollie = Mollie::API::Client.new
-	mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+	mollie.setApiKey "test_bt7vvByF6jTcBR4dLuW66eNnHYNIJp"
 
 	#
 	# First, let the customer pick the bank in a simple HTML form. This step is actually optional.

data/examples/5-payments-history.rb

@@ -10,7 +10,7 @@ begin
 	# See: https://www.mollie.nl/beheer/account/profielen/
 	#
 	mollie = Mollie::API::Client.new
-	mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+	mollie.setApiKey "test_bt7vvByF6jTcBR4dLuW66eNnHYNIJp"
 
 	#
 	# Get the all payments for this API key ordered by newest.
@@ -20,7 +20,7 @@ begin
 	$response.body = "Your API key has #{payments.totalCount} payments, last #{payments.count}:<br>"
 
 	payments.each { |payment| 
-		$response.body << "&euro; #{payment.amount}, status: #{CGI.escapeHTML payment.status}<br>"
+		$response.body << "&euro; #{payment.amount}, status: #{CGI.escapeHTML payment.status} (#{CGI.escapeHTML payment.id})<br>"
 	}
 rescue Mollie::API::Exception => e
 	$response.body << "API call failed: " << (CGI.escapeHTML e.message)

data/examples/6-list-activated-methods.rb

@@ -10,7 +10,7 @@ begin
 	# See: https://www.mollie.nl/beheer/account/profielen/
 	#
 	mollie = Mollie::API::Client.new
-	mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+	mollie.setApiKey "test_bt7vvByF6jTcBR4dLuW66eNnHYNIJp"
 
 	#
 	# Get the all the activated methods for this API key.

data/examples/7-refund-payment.rb

@@ -0,0 +1,40 @@
+#
+# Example 7 - How to refund a payment programmatically.
+#
+require File.expand_path "../lib/Mollie/API/Client", __dir__
+
+begin 
+	#
+	# Initialize the Mollie API library with your API key.
+	#
+	# See: https://www.mollie.nl/beheer/account/profielen/
+	#
+	mollie = Mollie::API::Client.new
+	mollie.setApiKey "test_bt7vvByF6jTcBR4dLuW66eNnHYNIJp"
+
+	#
+	# Retrieve the payment you want to refund from the API.
+	#
+	payment = mollie.payments.get "tr_dO6CPyCfoK"
+
+	#
+	# Refund the payment.
+	#
+	refund = mollie.payments_refunds.with(payment).create
+
+	$response.body << "The payment #{payment.id} is now refunded.<br>"
+
+	#
+	# Retrieve refunds on a payment.
+	#
+	refunds = mollie.payments_refunds.with(payment).all
+
+	refunds.each { |refund|
+		$response.body << '<br> Refund date: ' << (CGI.escapeHTML refund.refundedDatetime)
+		$response.body << '<br> Refunded: &euro; ' << (CGI.escapeHTML refund.amountRefunded) 
+		$response.body << '<br> Remaining: &euro; ' << (CGI.escapeHTML refund.amountRemaining)
+		$response.body << '<br>'
+	}
+rescue Mollie::API::Exception => e
+	$response.body << "API call failed: " << (CGI.escapeHTML e.message)
+end

data/examples/app.rb

@@ -9,7 +9,8 @@ examples = [
 	'3-return-page',
 	'4-ideal-payment',
 	'5-payments-history',
-	'6-list-activated-methods'
+	'6-list-activated-methods',
+	'7-refund-payment'
 ]
 
 get "/" do

data/lib/Mollie/API/Client.rb

@@ -4,27 +4,30 @@ require "rest_client"
 ["Exception",
 "Resource/Base",
 "Resource/Payments",
+"Resource/Payments/Refunds",
 "Resource/Issuers",
 "Resource/Methods",
 "Object/Base",
 "Object/List",
 "Object/Payment",
+"Object/Payment/Refund",
 "Object/Issuer",
 "Object/Method"].each {|file| require File.expand_path file, __dir__ }
 
 module Mollie
 	module API
 		class Client
-			CLIENT_VERSION = "1.0.1"
+			CLIENT_VERSION = "1.1.0"
 			API_ENDPOINT   = "https://api.mollie.nl"
 			API_VERSION    = "v1"
 
-			attr_reader :payments, :issuers, :methods
+			attr_reader :payments, :issuers, :methods, :payments_refunds
 
 			def initialize ()
-				@payments = Mollie::API::Resource::Payments.new self
-				@issuers  = Mollie::API::Resource::Issuers.new self
-				@methods  = Mollie::API::Resource::Methods.new self
+				@payments         = Mollie::API::Resource::Payments.new self
+				@issuers          = Mollie::API::Resource::Issuers.new self
+				@methods          = Mollie::API::Resource::Methods.new self
+				@payments_refunds = Mollie::API::Resource::Payments::Refunds.new self
 				
 				@api_endpoint    = API_ENDPOINT
 				@api_key         = ""
@@ -88,7 +91,12 @@ module Mollie
 					raise e if response[:error].nil?
 				end
 
-				raise Mollie::API::Exception.new response[:error][:message] unless response[:error].nil?
+				unless response[:error].nil?
+					exception       = Mollie::API::Exception.new response[:error][:message] 
+					exception.field = response[:error][:field] unless response[:error][:field].nil?
+					raise exception
+				end
+
 				response
 			end
 

data/lib/Mollie/API/Exception.rb

@@ -1,6 +1,9 @@
 module Mollie
 	module API
 		class Exception < StandardError
+			@field = nil
+
+			attr_accessor :field
 		end
 	end
 end

data/lib/Mollie/API/Object/Method.rb

@@ -2,11 +2,12 @@ module Mollie
 	module API
 		module Object
 			class Method < Base
-				IDEAL       = "ideal"
-				CREDITCARD  = "creditcard"
-				MISTERCASH  = "mistercash"
-				PAYPAL      = "paypal"
-				PAYSAFECARD = "paysafecard"
+				IDEAL        = "ideal"
+				CREDITCARD   = "creditcard"
+				MISTERCASH   = "mistercash"
+				BANKTRANSFER = "banktransfer"
+				PAYPAL       = "paypal"
+				PAYSAFECARD  = "paysafecard"
 
 				attr_accessor :id,
 				              :description,
@@ -23,4 +24,4 @@ module Mollie
 			end
 		end
 	end
-end
+end

data/lib/Mollie/API/Object/Payment/Refund.rb

@@ -0,0 +1,15 @@
+module Mollie
+	module API
+		module Object
+			class Payment
+				class Refund < Base
+					attr_accessor :id,
+								  :amountRefunded,
+								  :amountRemaining,
+								  :payment,
+								  :refundedDatetime
+				end
+			end
+		end
+	end
+end

data/lib/Mollie/API/Resource/Base.rb

@@ -11,27 +11,41 @@ module Mollie
 				end
 
 				def create (data = {})
-					response = @client.performHttpCall "POST", getResourceName, nil, data
-					getResourceObject.new response
+					request("POST", nil, data) { |response|
+						newResourceObject response
+					}
 				end
 
 				def get (id)
-					response = @client.performHttpCall "GET", getResourceName, id || 0
-					getResourceObject.new response
+					request("GET", id, {}) { |response| 
+						newResourceObject response
+					}
 				end
 
 				def update (id, data = {})
-					response = @client.performHttpCall "POST", getResourceName, id || 0, data
-					getResourceObject.new response
+					request("POST", id, data) { |response|
+						newResourceObject response
+					}
 				end
 
 				def delete (id)
-					@client.performHttpCall "DELETE", getResourceName, id || 0
+					request "DELETE", id, {}
 				end
 
 				def all ()
-					response = @client.performHttpCall "GET", getResourceName
-					Mollie::API::Object::List.new response, getResourceObject
+					request("GET", nil, {}) { |response|
+						Mollie::API::Object::List.new response, getResourceObject
+					}
+				end
+				
+				def newResourceObject (response)
+					getResourceObject.new response
+				end
+				
+				def request (method, id = 0, data = {})
+					response = @client.performHttpCall method, getResourceName, id, data
+
+					yield(response) if block_given?
 				end
 			end
 		end

data/lib/Mollie/API/Resource/Payments/Refunds.rb

@@ -0,0 +1,27 @@
+require 'open-uri'
+
+module Mollie
+	module API
+		module Resource
+			class Payments
+				class Refunds < Base
+					@payment_id = nil
+
+					def getResourceObject ()
+						Mollie::API::Object::Payment::Refund
+					end
+
+					def getResourceName ()
+						payment_id = URI::encode(@payment_id)
+						"payments/#{payment_id}/refunds"
+					end
+
+					def with (payment)
+						@payment_id = payment.id
+						self
+					end
+				end
+			end
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mollie-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Rick Wong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
+date: 2014-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -55,6 +55,7 @@ files:
 - examples/4-ideal-payment.rb
 - examples/5-payments-history.rb
 - examples/6-list-activated-methods.rb
+- examples/7-refund-payment.rb
 - examples/app.rb
 - examples/orders/.gitignore
 - lib/Mollie/API/Client.rb
@@ -64,10 +65,12 @@ files:
 - lib/Mollie/API/Object/List.rb
 - lib/Mollie/API/Object/Method.rb
 - lib/Mollie/API/Object/Payment.rb
+- lib/Mollie/API/Object/Payment/Refund.rb
 - lib/Mollie/API/Resource/Base.rb
 - lib/Mollie/API/Resource/Issuers.rb
 - lib/Mollie/API/Resource/Methods.rb
 - lib/Mollie/API/Resource/Payments.rb
+- lib/Mollie/API/Resource/Payments/Refunds.rb
 - lib/Mollie/API/cacert.pem
 - mollie.gemspec
 homepage: https://github.com/mollie/mollie-api-ruby