mollie-api-ruby 1.4.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2408d6e8c1b9aef184a32b5d571998f3177e1d99
-  data.tar.gz: d41e032d7d1542b37866a50b6d38ac23ec5f2342
+  metadata.gz: 7d5c227d854ac6e5a402fbd2b908c74498c99d00
+  data.tar.gz: 9d15b18d8eb8602b290ac72df24715347caab492
 SHA512:
-  metadata.gz: aaef654274f774dfeedc710e05c394c24815565b5286683aa503d68150d63710be71175cf08700bfcf4e186055444c133467a9ed2c98d775958a69087def1129
-  data.tar.gz: 03bac53f11dd5804f0117b72e373cb42a7bec3ee2433091762a859e95462387b19701e62d45a170a6e8de19ae63bfaa675cc17a6eb9dc2787808991cdddf391e
+  metadata.gz: 608d8337e5de29059eb38e6b612873c98f937b361655e7fe803a9c14e35ca43d6091ba563661cc11110e879a7ce45e5364348aeedc5ec6bd77e696d93cc7b30c
+  data.tar.gz: 33ec2a635718181ce1c8dc9ab89145253c82308d4cd5c376f115d18cb1e1d795d6eaf6a0d99f14b51ed3f1bb7d5aa81455c3963352b7bbb678017af47db79db3

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+before_install: gem install bundler
+rvm:
+ - 2.0.0
+ - 2.1
+ - 2.2
+ - 2.3.0
+ - jruby
+matrix:
+  allow_failures:
+  - rvm: 2.0.0
+  - rvm: jruby

data/CHANGELOG.md

@@ -5,6 +5,12 @@
 All notable changes to this project will be documented in this file.
 
 
+#### 2.0.0 - 2016-11-10
+  - Refactor to a more ruby like library.
+    - all methods use underscores
+    - payloads to call api functions will be camel cased before sending
+    - getters and setters are now just attr_accessors and omit get and set
+
 #### v1.4.2 - 2016-10-19
   - Added payment method KBC/CBC Payment Button
   - Fixed an issue where the required `mime-types` dependency did not work correctly ([#32](https://github.com/mollie/mollie-api-ruby/pull/32)).

data/README.mdown

@@ -2,6 +2,8 @@
 
 # Mollie API client for Ruby #
 
+[![](https://travis-ci.org/mollie/mollie-api-ruby.png)](https://travis-ci.org/mollie/mollie-api-ruby)
+
 Accepting [iDEAL](https://www.mollie.com/ideal/), [Bancontact/Mister Cash](https://www.mollie.com/mistercash/), [SOFORT Banking](https://www.mollie.com/sofort/), [Creditcard](https://www.mollie.com/creditcard/), [SEPA Bank transfer](https://www.mollie.com/overboeking/), [SEPA Direct debit](https://www.mollie.com/directdebit/), [Bitcoin](https://www.mollie.com/bitcoin/), [PayPal](https://www.mollie.com/paypal/), [KBC/CBC Payment Button](https://www.mollie.com/kbccbc/), [Belfius Direct Net](https://www.mollie.com/belfiusdirectnet/) and [paysafecard](https://www.mollie.com/paysafecard/) online payments without fixed monthly costs or any punishing registration procedures. Just use the Mollie API to receive payments directly on your website or easily refund transactions to your customers.
 
 ## Requirements ##
@@ -11,7 +13,6 @@ To use the Mollie API client, the following things are required:
 + 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) (with [mime-types](https://github.com/mime-types/ruby-mime-types/) version <3) and  [JSON](https://rubygems.org/gems/json) gems.
 
 ## Installation ##
 
@@ -38,14 +39,13 @@ To successfully receive a payment, these steps should be implemented:
 Requiring the Mollie API Client.
 
 ```ruby
-require 'Mollie/API/Client'
+require 'mollie/api/client'
 ```
 
 Initializing the Mollie API client, and setting your API key.
 
 ```ruby
-mollie = Mollie::API::Client.new
-mollie.api_key = 'test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM'
+mollie = Mollie::API::Client.new('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
 ```
 
 Creating a new payment.
@@ -54,7 +54,7 @@ Creating a new payment.
 payment = mollie.payments.create(
   amount: 10.00,
   description: 'My first API payment',
-  redirectUrl: 'https://webshop.example.org/order/12345/'
+  redirect_url: 'https://webshop.example.org/order/12345/'
 )
 ```
 

data/Rakefile

@@ -0,0 +1,6 @@
+task default: %w[test]
+
+task :test do
+  ruby "test/run-test.rb"
+end
+

data/examples/1-new-payment.rb

@@ -1,7 +1,7 @@
 #
 # Example 1 - How to prepare a new payment with the Mollie API.
 #
-require File.expand_path "../lib/Mollie/API/Client", File.dirname(__FILE__)
+require File.expand_path "../lib/mollie/api/client", File.dirname(__FILE__)
 
 begin
   #
@@ -10,7 +10,7 @@ begin
   # See: https://www.mollie.nl/beheer/account/profielen/
   #
   mollie = Mollie::API::Client.new
-  mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+  mollie.api_key =  "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
 
   #
   # Generate a unique order id for this example. It is important to include this unique attribute
@@ -36,11 +36,10 @@ begin
   payment = mollie.payments.create \
     :amount       => 10.00,
     :description  => "My first API payment",
-    :redirectUrl  => "#{protocol}://#{hostname}:#{port}#{path}/3-return-page?order_id=#{order_id}",
+    :redirect_url  => "#{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.
   #
@@ -49,7 +48,7 @@ begin
   #
   # Send the customer off to complete the payment.
   #
-  $response.redirect payment.getPaymentUrl
+  $response.redirect payment.payment_url
 rescue Mollie::API::Exception => e
   $response.body << "API call failed: " << (CGI.escapeHTML e.message)
 end

data/examples/2-webhook-verification.rb

@@ -1,7 +1,7 @@
 #
 # Example 2 - How to verify Mollie API Payments in a webhook.
 #
-require File.expand_path "../lib/Mollie/API/Client", File.dirname(__FILE__)
+require File.expand_path "../lib/mollie/api/client", File.dirname(__FILE__)
 
 begin
   #
@@ -10,7 +10,7 @@ begin
   # See: https://www.mollie.nl/beheer/account/profielen/
   #
   mollie = Mollie::API::Client.new
-  mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+  mollie.api_key =  "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
 
   #
   # Retrieve the payment's current state.

data/examples/4-ideal-payment.rb

@@ -1,7 +1,7 @@
 #
 # Example 4 - How to prepare an iDEAL payment with the Mollie API.
 #
-require File.expand_path "../lib/Mollie/API/Client", File.dirname(__FILE__)
+require File.expand_path "../lib/mollie/api/client", File.dirname(__FILE__)
 
 begin
   #
@@ -10,7 +10,7 @@ begin
   # See: https://www.mollie.nl/beheer/account/profielen/
   #
   mollie = Mollie::API::Client.new
-  mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+  mollie.api_key =  "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
 
   #
   # First, let the customer pick the bank in a simple HTML form. This step is actually optional.
@@ -70,7 +70,7 @@ begin
     #
     # Send the customer off to complete the payment.
     #
-    $response.redirect payment.getPaymentUrl
+    $response.redirect payment.payment_url
   end
 rescue Mollie::API::Exception => e
   $response.body << "API call failed: " << (CGI.escapeHTML e.message)

data/examples/5-payments-history.rb

@@ -1,7 +1,7 @@
 #
 # Example 5 - How to retrieve your payments history.
 #
-require File.expand_path "../lib/Mollie/API/Client", File.dirname(__FILE__)
+require File.expand_path "../lib/mollie/api/client", File.dirname(__FILE__)
 
 begin
   #
@@ -10,14 +10,14 @@ begin
   # See: https://www.mollie.nl/beheer/account/profielen/
   #
   mollie = Mollie::API::Client.new
-  mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+  mollie.api_key =  "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>"
+  $response.body = "Your API key has #{payments.total_count} payments, last #{payments.count}:<br>"
 
   payments.each { |payment|
     $response.body << "&euro; #{payment.amount}, status: #{CGI.escapeHTML payment.status} (#{CGI.escapeHTML payment.id})<br>"

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

@@ -1,7 +1,7 @@
 #
 # Example 6 - How to get the currently activated payment methods.
 #
-require File.expand_path "../lib/Mollie/API/Client", File.dirname(__FILE__)
+require File.expand_path "../lib/mollie/api/client", File.dirname(__FILE__)
 
 begin
   #
@@ -10,14 +10,14 @@ begin
   # See: https://www.mollie.nl/beheer/account/profielen/
   #
   mollie = Mollie::API::Client.new
-  mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+  mollie.api_key =  "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>"
+  $response.body << "Your API key has #{methods.total_count} activated payment methods:<br>"
 
   methods.each { |method|
     $response.body << '<div style="line-height:40px; vertical-align:top">'

data/examples/7-refund-payment.rb

@@ -1,7 +1,7 @@
 #
 # Example 7 - How to refund a payment programmatically.
 #
-require File.expand_path "../lib/Mollie/API/Client", File.dirname(__FILE__)
+require File.expand_path "../lib/mollie/api/client", File.dirname(__FILE__)
 
 begin
   #
@@ -10,7 +10,7 @@ begin
   # See: https://www.mollie.nl/beheer/account/profielen/
   #
   mollie = Mollie::API::Client.new
-  mollie.setApiKey "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
+  mollie.api_key =  "test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
 
   #
   # Retrieve the payment you want to refund from the API.
@@ -30,9 +30,9 @@ begin
   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> Refund date: ' << (CGI.escapeHTML refund.refunded_datetime)
+    $response.body << '<br> Refunded: &euro; ' << (CGI.escapeHTML refund.amount_refunded)
+    $response.body << '<br> Remaining: &euro; ' << (CGI.escapeHTML refund.amount_remaining)
     $response.body << '<br>'
   }
 rescue Mollie::API::Exception => e

data/lib/mollie/api/client.rb

@@ -0,0 +1,120 @@
+require "json"
+require "time"
+require "ostruct"
+require "bigdecimal"
+
+["exception",
+ "util",
+ "client/version",
+ "resource/base",
+ "resource/customers",
+ "resource/customers/payments",
+ "resource/customers/mandates",
+ "resource/customers/subscriptions",
+ "resource/payments",
+ "resource/payments/refunds",
+ "resource/issuers",
+ "resource/methods",
+ "object/base",
+ "object/list",
+ "object/customer",
+ "object/mandate",
+ "object/subscription",
+ "object/payment",
+ "object/payment/refund",
+ "object/issuer",
+ "object/method"].each { |file| require File.expand_path file, File.dirname(__FILE__) }
+
+module Mollie
+  module API
+    class Client
+      API_ENDPOINT = "https://api.mollie.nl"
+      API_VERSION  = "v1"
+
+      attr_accessor :api_key
+      attr_reader :payments, :issuers, :methods, :payments_refunds,
+                  :customers, :customers_payments, :customers_mandates, :customers_subscriptions,
+                  :api_endpoint
+
+      def initialize(api_key)
+        @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
+        @customers               = Mollie::API::Resource::Customers.new self
+        @customers_payments      = Mollie::API::Resource::Customers::Payments.new self
+        @customers_mandates      = Mollie::API::Resource::Customers::Mandates.new self
+        @customers_subscriptions = Mollie::API::Resource::Customers::Subscriptions.new self
+
+        @api_endpoint    = API_ENDPOINT
+        @api_key         = api_key
+        @version_strings = []
+
+        add_version_string "Mollie/" << VERSION
+        add_version_string "Ruby/" << RUBY_VERSION
+        add_version_string OpenSSL::OPENSSL_VERSION.split(" ").slice(0, 2).join "/"
+      end
+
+      def api_endpoint=(api_endpoint)
+        @api_endpoint = api_endpoint.chomp "/"
+      end
+
+      def add_version_string(version_string)
+        @version_strings << (version_string.gsub /\s+/, "-")
+      end
+
+      def perform_http_call(http_method, api_method, id = nil, http_body = {})
+        path = "/#{API_VERSION}/#{api_method}/#{id}".chomp('/')
+        case http_method
+          when 'GET'
+            request = Net::HTTP::Get.new(path)
+          when 'POST'
+            http_body.delete_if { |k, v| v.nil? }
+            request      = Net::HTTP::Post.new(path)
+            request.body = Util.camelize_keys(http_body).to_json
+          when 'DELETE'
+            request = Net::HTTP::Delete.new(path)
+          else
+            raise Mollie::API::Exception.new("Invalid HTTP Method: #{http_method}")
+        end
+
+        request['Accept']        = 'application/json'
+        request['Authorization'] = "Bearer #{@api_key}"
+        request['User-Agent']    = @version_strings.join(" ")
+
+        begin
+          response = client.request(request)
+        rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+            Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+          raise Mollie::API::Exception.new(e.message)
+        end
+
+        http_code = response.code.to_i
+        case http_code
+          when 200, 201
+            Util.nested_underscore_keys(JSON.parse(response.body))
+          when 204
+            {} # No Content
+          else
+            response        = JSON.parse(response.body)
+            exception       = Mollie::API::Exception.new response['error']['message']
+            exception.code  = http_code
+            exception.field = response['error']['field'] unless response['error']['field'].nil?
+            raise exception
+        end
+      end
+
+      private
+
+      def client
+        return @client if defined? @client
+        uri                 = URI.parse(@api_endpoint)
+        @client             = Net::HTTP.new(uri.host, uri.port)
+        @client.use_ssl     = true
+        @client.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        @client.ca_file     = (File.expand_path "cacert.pem", File.dirname(__FILE__))
+        @client
+      end
+    end
+  end
+end

data/lib/{Mollie/API/Client/Version.rb → mollie/api/client/version.rb}

@@ -1,7 +1,7 @@
 module Mollie
   module API
     class Client
-      CLIENT_VERSION = "1.4.2"
+      VERSION = "2.0.0"
     end
   end
 end

data/lib/mollie/api/object/base.rb

@@ -0,0 +1,18 @@
+module Mollie
+  module API
+    module Object
+      class Base
+        attr_reader :attributes
+
+        def initialize(attributes)
+          @attributes = attributes
+          attributes.each do |key, value|
+            if self.respond_to?("#{key}=")
+              public_send("#{key}=", value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mollie/api/object/customer.rb

@@ -0,0 +1,28 @@
+module Mollie
+  module API
+    module Object
+      class Customer < Base
+        attr_accessor :id,
+                      :mode,
+                      :name,
+                      :email,
+                      :locale,
+                      :metadata,
+                      :recently_used_methods,
+                      :created_datetime
+
+        def created_datetime=(created_datetime)
+          @created_datetime = Time.parse(created_datetime.to_s)
+        end
+
+        def recently_used_methods=(methods)
+          @recently_used_methods = Array(methods).map(&:to_s)
+        end
+
+        def metadata=(metadata)
+          @metadata = OpenStruct.new(metadata) if metadata.is_a?(Hash)
+        end
+      end
+    end
+  end
+end