mollie-api-ruby 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00c764099a49ead8514278cfa6db983f644c35f0
+  data.tar.gz: 04224d5226ac3b33340225fb2a4126f0f058ff8e
+SHA512:
+  metadata.gz: e1f1fb6c5e98c36fec4de50dcb300e45529373c62b11bae41ed2c2febf9e54e529dc3ab85dfadf7d2224e2c999b5b634b895cfad50e8cc2c57f2ba11fa97ca47
+  data.tar.gz: c7fe28ba206cdea937e4e1d2300dd10501c7738d3cebc6058433a877d12c4cdc6e96d6e711e9cb843b517e5a7b33d477b4a431603c8c48133addbe966451c5da

data/.gitignore

@@ -0,0 +1,3 @@
+/.idea
+.DS_Store
+mollie-api-ruby*.gem

data/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2014, Mollie B.V.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.mdown

@@ -0,0 +1,92 @@
+![Mollie](http://www.mollie.nl/files/Mollie-Logo-Style-Small.png) 
+
+# Mollie API client for Ruby #
+
+Accepting [iDEAL](https://www.mollie.nl/betaaldiensten/ideal/), [Mister Cash](https://www.mollie.nl/betaaldiensten/mistercash/), [Creditcard](https://www.mollie.nl/betaaldiensten/creditcard/), [PayPal](https://www.mollie.nl/betaaldiensten/paypal/), and [paysafecard](https://www.mollie.nl/betaaldiensten/paysafecard/) online payments without fixed monthly costs or any punishing registration procedures. Just use the Mollie API to receive payments directly on your website.
+
+## Requirements ##
+To use the Mollie API client, the following things are required:
+
++ Get yourself a free [Mollie account](https://www.mollie.nl/aanmelden). No sign up costs.
++ Create a new [Website profile](https://www.mollie.nl/beheer/account/profielen/) to generate API keys (live and test mode) and setup your webhook.
++ Now you're ready to use the Mollie API client in test mode.
++ In order to accept payments in live mode, payment methods must be activated in your account. Follow [a few of steps](https://www.mollie.nl/beheer/diensten), and let us handle the rest.
++ This API client requires the [REST Client](https://github.com/rest-client/rest-client) and [JSON](https://rubygems.org/gems/json) gems.
+
+## Installation ##
+
+By far the easiest way to install the Mollie API client is to install it with [gem](http://rubygems.org/).
+
+```
+	$ gem install mollie-api-ruby
+```
+
+You may also git checkout or [download all the files](https://github.com/mollie/mollie-api-ruby/archive/master.zip), and include the Mollie API client manually.
+
+## How to receive payments ##
+
+To successfully receive a payment, these steps should be implemented:
+
+1. Use the Mollie API client to create a payment with the requested amount, description and optionally, a payment method. It is important to specify a unique redirect URL where the customer is supposed to return to after the payment is completed.
+
+2. Immediately after the payment is completed, our platform will send an asynchronous request to the configured webhook to allow the payment details to be retrieved, so you know when exactly to start processing the customer's order.
+
+3. The customer returns, and should be satisfied to see that the order was paid and is now being processed.
+
+## Getting started ##
+
+Requiring the Mollie API Client.
+
+```ruby
+		require "Mollie/API/Client"
+```	
+
+Initializing the Mollie API client, and setting your API key.
+
+```ruby
+		mollie = Mollie::API::Client.new
+		mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+```	
+
+Creating a new payment.
+	
+```ruby
+		payment = mollie.payments.create \
+			:amount      => 10.00,
+			:description => "My first API payment",
+			:redirectUrl => "https://webshop.example.org/order/12345/"
+```
+	
+Retrieving a payment.
+
+```ruby
+		payment = mollie.payments.get payment.id
+		
+		if payment.paid?
+			puts "Payment received."
+		end
+```
+
+## Examples ##
+
+The examples require [Sinatra](http://rubygems.org/gems/sinatra) so you will need to install that gem first. Afterwards simply run:
+
+```
+	$ cd mollie-api-ruby
+	$ ruby examples/app.rb
+```
+
+## License ##
+[BSD (Berkeley Software Distribution) License](http://www.opensource.org/licenses/bsd-license.php).
+Copyright (c) 2014, Mollie B.V.
+
+## Support ##
+Contact: [www.mollie.nl](http://www.mollie.nl) — info@mollie.nl — +31 20-612 88 55
+
++ [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 PayPal via Mollie](https://www.mollie.nl/betaaldiensten/paypal/)
++ [More information about paysafecard via Mollie](https://www.mollie.nl/betaaldiensten/paysafecard/)
+
+![Powered By Mollie](http://www.mollie.nl/images/badge-betaling-medium.png)

data/examples/1-new-payment.rb

@@ -0,0 +1,55 @@
+#
+# Example 1 - How to prepare a new payment with the Mollie API.
+#
+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_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+
+	#
+	# Generate a unique order id for this example. It is important to include this unique attribute
+	# in the redirectUrl (below) so a proper return page can be shown to the customer.
+	#
+	order_id = Time.now.to_i
+
+	#
+	# Determine the url parts to these example files.
+	#
+	protocol = $request.secure? && "https" || "http"
+	hostname = $request.host || "localhost"
+	port     = $request.port || 80
+	path     = $request.script_name || ""
+
+	#
+	# Payment parameters:
+	#   amount        Amount in EUROs. This example creates a € 10,- payment.
+	#   description   Description of the payment.
+	#   redirectUrl   Redirect location. The customer will be redirected there after the payment.
+	#   metadata      Custom metadata that is stored with the payment.
+	#
+	payment = mollie.payments.create \
+		:amount       => 10.00,
+		:description  => "My first API payment",
+		:redirectUrl  => "#{protocol}://#{hostname}:#{port}#{path}/3-return-page?order_id=#{order_id}",
+		:metadata     => {
+			:order_id => order_id
+		}
+
+	#
+	# In this example we store the order with its payment status in a database.
+	#
+	database_write order_id, payment.status
+
+	#
+	# Send the customer off to complete the payment.
+	#
+	$response.redirect payment.getPaymentUrl
+rescue Mollie::API::Exception => e
+	$response.body << "API call failed: " << (CGI.escapeHTML e.message)
+end

data/examples/2-webhook-verification.rb

@@ -0,0 +1,41 @@
+#
+# Example 2 - How to verify Mollie API Payments in a webhook.
+#
+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_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+
+	#
+	# Retrieve the payment's current state.
+	#
+	payment  = mollie.payments.get $request.params['id']
+	order_id = payment.metadata.order_id
+
+	#
+	# Update the order in the database.
+	#
+	database_write order_id, payment.status
+
+	if payment.paid?
+		#
+		# At this point you'd probably want to start the process of delivering the product to the customer.
+		#
+		$response.body << "Paid"
+	elsif payment.open? == false
+		#
+		# The payment isn't paid and isn't open anymore. We can assume it was aborted.
+		#
+		$response.body << "Cancelled"
+	else
+		$response.body << "In progress"
+	end
+rescue Mollie::API::Exception => e
+	$response.body << "API call failed: " << (CGI.escapeHTML e.message)
+end

data/examples/3-return-page.rb

@@ -0,0 +1,21 @@
+#
+# Example 3 - How to show a return page to the customer.
+#
+# In this example we retrieve the order stored in the database.
+# Here, it's unnecessary to use the Mollie API Client.
+#
+if $request.params.empty?
+	$response.body << "No order"
+else
+	status = database_read $request.params['order_id']
+
+	#
+	# Determine the url parts to these example files.
+	#
+	path = $request.script_name || ""
+
+	$response.body << "<p>Your payment status is '" << (CGI.escapeHTML status) << "'.</p>"
+	$response.body << "<p>"
+	$response.body << '<a href="' << path << '/">Back to examples</a><br>'
+	$response.body << "</p>"
+end

data/examples/4-ideal-payment.rb

@@ -0,0 +1,77 @@
+#
+# Example 4 - How to prepare an iDEAL payment with the Mollie API.
+#
+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_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+
+	#
+	# First, let the customer pick the bank in a simple HTML form. This step is actually optional.
+	#
+	if $request.params.empty?
+		issuers = mollie.issuers.all
+
+		$response.body << '<form method="post">Select your bank: <select name="issuer">'
+
+		issuers.each { |issuer| 
+			if issuer.method == Mollie::API::Object::Method::IDEAL
+				$response.body << '<option value=' << (CGI.escapeHTML issuer.id) << '>' << (CGI.escapeHTML issuer.name)
+			end
+		}
+
+		$response.body <<  '<option value="">or select later</option>'
+		$response.body <<  '</select><button>OK</button></form>'
+	else
+		#
+		# Generate a unique order id for this example. It is important to include this unique attribute
+		# in the redirectUrl (below) so a proper return page can be shown to the customer.
+		#
+		order_id = Time.now.to_i
+
+		#
+		# Determine the url parts to these example files.
+		#
+		protocol = $request.secure? && "https" || "http"
+		hostname = $request.host || "localhost"
+		port     = $request.port || 80
+		path     = $request.script_name || ""
+
+		#
+		# Payment parameters:
+		#   amount        Amount in EUROs. This example creates a € 27,50 payment.
+		#   description   Description of the payment.
+		#   redirectUrl   Redirect location. The customer will be redirected there after the payment.
+		#   metadata      Custom metadata that is stored with the payment.
+	 	#   method        Payment method "ideal".
+	 	#   issuer        The customer's bank. If empty the customer can select it later.
+		#
+		payment = mollie.payments.create \
+			:amount       => 27.50,
+			:description  => "My first API payment",
+			:redirectUrl  => "#{protocol}://#{hostname}:#{port}#{path}/3-return-page?order_id=#{order_id}",
+			:metadata     => {
+				:order_id => order_id
+			},
+			:method       => Mollie::API::Object::Method::IDEAL,
+			:issuer       => !$request.params['issuer'].empty? ? $request.params['issuer'] : nil
+		
+		#
+		# In this example we store the order with its payment status in a database.
+		#
+		database_write order_id, payment.status
+
+		#
+		# Send the customer off to complete the payment.
+		#
+		$response.redirect payment.getPaymentUrl
+	end
+rescue Mollie::API::Exception => e
+	$response.body << "API call failed: " << (CGI.escapeHTML e.message)
+end

data/examples/5-payments-history.rb

@@ -0,0 +1,27 @@
+#
+# Example 5 - How to retrieve your payments history.
+#
+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_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+
+	#
+	# Get the all payments for this API key ordered by newest.
+	#
+	payments = mollie.payments.all
+
+	$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>"
+	}
+rescue Mollie::API::Exception => e
+	$response.body << "API call failed: " << (CGI.escapeHTML e.message)
+end

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

@@ -0,0 +1,30 @@
+#
+# Example 6 - How to get the currently activated payment methods.
+#
+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_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+
+	#
+	# Get the all the activated methods for this API key.
+	#
+	methods = mollie.methods.all
+
+	$response.body << "Your API key has #{methods.totalCount} activated payment methods:<br>"
+
+	methods.each { |method|
+		$response.body << '<div style="line-height:40px; vertical-align:top">'
+		$response.body << '<img src="' << (CGI.escapeHTML method.image.normal) << '"> '
+		$response.body << (CGI.escapeHTML method.description) << ' (' << (CGI.escapeHTML method.id) << ')'
+		$response.body << '</div>'
+	}
+rescue Mollie::API::Exception => e
+	$response.body << "API call failed: " << (CGI.escapeHTML e.message)
+end

data/examples/app.rb

@@ -0,0 +1,57 @@
+require 'sinatra'
+
+#
+# Show all examples as links.
+#
+examples = [
+	'1-new-payment',
+	'2-webhook-verification',
+	'3-return-page',
+	'4-ideal-payment',
+	'5-payments-history',
+	'6-list-activated-methods'
+]
+
+get "/" do
+	index = ""
+
+	examples.each { |example|
+		index << "<a href='/#{example}'>#{example}</a><br>"
+	}
+
+	index
+end
+
+#
+# Register all examples as pages.
+#
+examples.each { |example|
+	get "/#{example}" do
+		$request  = request
+		$response = response
+		load File.expand_path "#{example}.rb", __dir__
+	end
+
+	post "/#{example}" do
+		$request  = request
+		$response = response
+		load File.expand_path "#{example}.rb", __dir__
+	end
+}
+
+#
+# NOTE: This example uses a text file as a database. Please use a real database like MySQL in production code.
+#
+def database_write (order_id, status)
+	order_id = order_id.to_i
+	database = File.expand_path "orders/order-#{order_id}.txt", __dir__
+
+	File.open(database, 'w') { |file| file.write status }
+end
+
+def database_read (order_id)
+	order_id = order_id.to_i
+	database = File.expand_path "orders/order-#{order_id}.txt", __dir__
+
+	status = File.read(database) || "unknown order"
+end

data/examples/orders/.gitignore

@@ -0,0 +1 @@
+*.txt

data/lib/Mollie/API/Client.rb

@@ -0,0 +1,102 @@
+require "json"
+require "rest_client"
+
+["Exception",
+"Resource/Base",
+"Resource/Payments",
+"Resource/Issuers",
+"Resource/Methods",
+"Object/Base",
+"Object/List",
+"Object/Payment",
+"Object/Issuer",
+"Object/Method"].each {|file| require File.expand_path file, __dir__ }
+
+module Mollie
+	module API
+		class Client
+			CLIENT_VERSION = "1.0.1"
+			API_ENDPOINT   = "https://api.mollie.nl"
+			API_VERSION    = "v1"
+
+			attr_reader :payments, :issuers, :methods
+
+			def initialize ()
+				@payments = Mollie::API::Resource::Payments.new self
+				@issuers  = Mollie::API::Resource::Issuers.new self
+				@methods  = Mollie::API::Resource::Methods.new self
+				
+				@api_endpoint    = API_ENDPOINT
+				@api_key         = ""
+				@version_strings = []
+
+				addVersionString "Mollie/" << CLIENT_VERSION
+				addVersionString "Ruby/" << RUBY_VERSION
+				addVersionString OpenSSL::OPENSSL_VERSION.split(" ").slice(0, 2).join "/"
+			end
+
+			def setApiEndpoint (api_endpoint)
+				@api_endpoint = api_endpoint.chomp "/"
+			end
+
+			def getApiEndpoint ()
+				@api_endpoint
+			end
+
+			def setApiKey (api_key)
+				@api_key = api_key
+			end
+
+			def addVersionString (version_string)
+				@version_strings << (version_string.gsub /\s+/, "-")
+			end
+
+			def _getRestClient (request_url, request_headers)
+				RestClient::Resource.new request_url,
+					:headers     => request_headers,
+					:ssl_ca_file => (File.expand_path "cacert.pem", __dir__),
+					:verify_ssl  => OpenSSL::SSL::VERIFY_PEER
+			end
+
+			def performHttpCall (http_method, api_method, id = nil, http_body = nil)
+				request_headers = {
+					:accept => :json,
+					:authorization => "Bearer #{@api_key}",
+					:user_agent => @version_strings.join(" "),
+					"X-Mollie-Client-Info" => getUname
+				}
+
+				if http_body.respond_to? :delete_if
+					http_body.delete_if { |k, v| v.nil? }
+				end
+
+				begin
+					request_url = "#{@api_endpoint}/#{API_VERSION}/#{api_method}/#{id}".chomp "/"
+					rest_client = _getRestClient request_url, request_headers
+
+					case http_method
+					when "GET"
+						response = rest_client.get 
+					when "POST"
+						response = rest_client.post http_body
+					when "DELETE"
+						response = rest_client.delete
+					end
+					response = JSON.parse response, :symbolize_names => true
+				rescue RestClient::ExceptionWithResponse => e
+					response = JSON.parse e.response, :symbolize_names => true
+					raise e if response[:error].nil?
+				end
+
+				raise Mollie::API::Exception.new response[:error][:message] unless response[:error].nil?
+				response
+			end
+
+			def getUname ()
+				`uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
+			rescue Errno::ENOMEM
+				"uname lookup failed"
+			end
+		end
+	end
+end