mollie-api-ruby 2.2.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7d6b6f21eeda06bcb33555aa029fe76466497263
-  data.tar.gz: 64aadca75fd234e1df340843b1f92627ffa75a05
+SHA256:
+  metadata.gz: 1c2e6be24fa39ccf69510523b4b5a40cb6751db4ea6f819cde67fa3ef395586c
+  data.tar.gz: 33c5f94a0ccfe001a1c4762af6bd6e5e1f3759fea8b80ffc845eb2d704ceb778
 SHA512:
-  metadata.gz: dac9bb4f03cd09e80eeab7fd0af5ed5f13cc3a3bdabbc71176ab125e829f6b7634512f4afd849dc75f482125687d80db9dbe481e87835ddccc74f7e7460783e6
-  data.tar.gz: 29dca80e86f9876f1512c76b3a3f872c27e55c5eef8a369b0e08f2edbe97b700a5ca7ce95852a101c4a50906fdfff3fa2ee02b53c80d42054e978541031eabbb
+  metadata.gz: 5d0e2c5c93a303db70129236a2ffd11a9b2008683d02c22a5577971b7b9a894a1d3609caa07b05af3c6231683dec75e7ae4142fc66bd12849b5d15bcd179ee7b
+  data.tar.gz: 76fc4df609c87e70abde982aa12d8190c10e02a3a5c82a1b0ee28c7a3a17eef57f4d4c1b2d0eed24c26776c99ac8300fc8ecdd84a753b799a9898ad582cb112a

data/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 All notable changes to this project will be documented in this file.
 
+#### 3.1.0 - ....
+  - Removed old api
+
+#### 3.0.0 - ....
+  - Introduced new api
+  - Deprecated old api
+
 #### 2.2.1 - 2017-09-13
   - Added support for gift card method.
   - Added support for `invoice` endpoint.

data/README.md

@@ -1,5 +1,7 @@
 ![Mollie](https://www.mollie.nl/files/Mollie-Logo-Style-Small.png)
 
+# LOOKING FOR VERSION v2.2.X README [CLICK HERE](https://github.com/mollie/mollie-api-ruby/tree/2.2.x) #
+
 # Mollie API client for Ruby #
 
 [![Gem Version](https://badge.fury.io/rb/mollie-api-ruby.svg)](https://badge.fury.io/rb/mollie-api-ruby)
@@ -20,6 +22,9 @@ To use the Mollie API client, the following things are required:
 By far the easiest way to install the Mollie API client is to install it with [gem](http://rubygems.org/).
 
 ```
+# Gemfile
+gem 'mollie-api-ruby'
+
 $ gem install mollie-api-ruby
 ```
 
@@ -37,22 +42,46 @@ To successfully receive a payment, these steps should be implemented:
 
 ## Getting started ##
 
-Requiring the Mollie API Client.
+Requiring the Mollie API Client. *Not required when used with a Gemfile*
+
+```ruby
+require 'mollie-api-ruby'
+```
+
+Create an initializer and add the following line:
 
 ```ruby
-require 'mollie/api/client'
+Mollie::Client.configure do |config|
+  config.api_key = '<your-api-key>'
+end
+```
+
+You can also include the API Key in each request you make, for instance if you are using the Connect API
+
+```ruby
+Mollie::Payment.get("pay-id", api_key: '<your-api-key>')
 ```
 
-Initializing the Mollie API client, and setting your API key.
+If you need to do multiple calls with the same API Key, use the following helper
 
 ```ruby
-mollie = Mollie::API::Client.new('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
+Mollie::Client.with_api_key('<your-api-key>') do
+  mandates = Mollie::Customer::Mandate.all(customer_id: params[:customer_id])
+  if mandates.any?
+    payment = Mollie::Payment.create(
+      amount:       10.00,
+      description:  'My first API payment',
+      redirect_url: 'https://webshop.example.org/order/12345/',
+      webhook_url:  'https://webshop.example.org/mollie-webhook/'
+    )
+  end
+end
 ```
 
 Creating a new payment.
 
 ```ruby
-payment = mollie.payments.create(
+payment = Mollie::Payment.create(
   amount:       10.00,
   description:  'My first API payment',
   redirect_url: 'https://webshop.example.org/order/12345/',
@@ -63,7 +92,7 @@ payment = mollie.payments.create(
 Retrieving a payment.
 
 ```ruby
-payment = mollie.payments.get(payment.id)
+payment = Mollie::Payment.get(payment.id)
 
 if payment.paid?
   puts 'Payment received.'
@@ -77,8 +106,8 @@ definitive. Refunds are only supported for iDEAL, credit card and Bank Transfer
 be refunded through our API at the moment.
 
 ```ruby
-payment = mollie.payments.get(payment.id)
-refund  = mollie.payments_refunds.with(payment).create
+payment = Mollie::Payment.get(payment.id)
+refund  = payment.refunds.create
 ```
 
 ## Examples ##

data/examples/apis/api_docs.rb

@@ -2,7 +2,7 @@ class Application < Sinatra::Application
   ::Application
   swagger_root do
     key :swagger, '2.0'
-    info version:        Mollie::API::Client::VERSION,
+    info version:        Mollie::Client::VERSION,
          title:          'Mollie',
          description:    'Examples for the mollie api',
          termsOfService: 'https://github.com/mollie/mollie-api-ruby',

data/examples/apis/chargebacks.rb

@@ -0,0 +1,17 @@
+class Application < Sinatra::Application
+  swagger_path '/v1/chargebacks' do
+    operation :get, description: 'List chargebacks https://www.mollie.com/en/docs/reference/chargebacks/list', tags: ['Chargebacks'] do
+      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
+      parameter name: :count, in: 'query', description: 'Count', type: :integer
+      parameter name: :testmode, in: 'query', description: 'Test mode', type: :boolean
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  get '/v1/chargebacks' do
+    chargebacks = Mollie::Chargeback.all(params[:offset], params[:limit], testmode: params[:test_mode])
+    JSON.pretty_generate(chargebacks.attributes)
+  end
+end

data/examples/apis/connect.rb

@@ -6,7 +6,7 @@ class Application < Sinatra::Application
       parameter name: :secret, in: 'query', description: 'oAuth Secret', type: :string
       parameter name: :redirect_uri, in: 'query', description: 'Redirect URI', type: :string, default: "#{Ngrok::Tunnel.ngrok_url_https}/token"
       parameter name: :state, in: 'query', description: 'State', type: :string, default: SecureRandom.uuid
-      parameter name: :scope, in: 'query', description: 'Scope', type: :string, default: Mollie::API::Resource::Permissions.available.join(' ')
+      parameter name: :scope, in: 'query', description: 'Scope', type: :string, default: Mollie::Permission::AVAILABLE.join(' ')
       parameter name: :response_type, in: 'query', description: 'Response Type', type: :string
       parameter name: :approval_prompt, in: 'query', description: 'Approval prompt', type: :boolean
       security api_key: []

data/examples/apis/customers.rb

@@ -64,17 +64,17 @@ class Application < Sinatra::Application
   end
 
   get '/v1/customers' do
-    customers = client.customers.all(params[:offset], params[:count], testmode: params[:testmode])
+    customers = Mollie::Customer.all(params[:offset], params[:count], testmode: params[:testmode])
     JSON.pretty_generate(customers.attributes)
   end
 
   get '/v1/customers/:id' do
-    customer = client.customers.get(params[:id], testmode: params[:testmode])
+    customer = Mollie::Customer.get(params[:id], testmode: params[:testmode])
     JSON.pretty_generate(customer.attributes)
   end
 
   post '/v1/customers' do
-    customer = client.customers.create(
+    customer = Mollie::Customer.create(
       name:      json_params['name'],
       email:     json_params['email'],
       locale:    json_params['locale'],
@@ -86,7 +86,7 @@ class Application < Sinatra::Application
   end
 
   patch '/v1/customers/:id' do
-    customer = client.customers.update(params[:id],
+    customer = Mollie::Customer.update(params[:id],
                                        name:     json_params['name'],
                                        email:    json_params['email'],
                                        locale:   json_params['locale'],
@@ -96,12 +96,13 @@ class Application < Sinatra::Application
   end
 
   get '/v1/customers/:customer_id/payments' do
-    payments = client.customers_payments.with(params[:customer_id]).all(testmode: params[:testmode])
+    payments = Mollie::Customer::Payment.all(customer_id: params[:customer_id], testmode: params[:testmode])
     JSON.pretty_generate(payments.attributes)
   end
 
   post '/v1/customers/:customer_id/payments' do
-    payment = client.customers_payments.with(params[:customer_id]).create(
+    payment = Mollie::Customer::Payment.create(
+      customer_id:  params[:customer_id],
       amount:       json_params['amount'],
       description:  json_params['description'],
       redirect_url: json_params['redirect_url'],

data/examples/apis/invoices.rb

@@ -23,7 +23,7 @@ class Application < Sinatra::Application
   end
 
   get '/v1/invoices' do
-    invoices = client.invoices.all(params[:offset], params[:count],
+    invoices = Mollie::Invoice.all(params[:offset], params[:count],
                                    include:   params[:include],
                                    reference: params[:reference],
                                    year:      params[:year]
@@ -32,7 +32,7 @@ class Application < Sinatra::Application
   end
 
   get '/v1/invoices/:id' do
-    invoice = client.invoices.get(params[:id], include: params[:include])
+    invoice = Mollie::Invoice.get(params[:id], include: params[:include])
     JSON.pretty_generate(invoice.attributes)
   end
 end

data/examples/apis/issuers.rb

@@ -21,13 +21,13 @@ class Application < Sinatra::Application
   end
 
   get '/v1/issuers' do
-    issuers = client.issuers.all(params[:offset], params[:count],
+    issuers = Mollie::Issuer.all(params[:offset], params[:count],
                                  testmode: params[:testmode])
     JSON.pretty_generate(issuers.attributes)
   end
 
   get '/v1/issuers/:id' do
-    issuer = client.issuers.get(params[:id],
+    issuer = Mollie::Issuer.get(params[:id],
                                 testmode: params[:testmode]
     )
     JSON.pretty_generate(issuer.attributes)

data/examples/apis/mandates.rb

@@ -51,7 +51,8 @@ class Application < Sinatra::Application
   end
 
   post '/v1/customers/:customer_id/mandates' do
-    mandate = client.customers_mandates.with(params[:customer_id]).create(
+    mandate = Mollie::Customer::Mandate.create(
+      customer_id:       params[:customer_id],
       method:            json_params['method'],
       consumer_name:     json_params['consumer_name'],
       consumer_account:  json_params['consumer_account'],
@@ -65,19 +66,18 @@ class Application < Sinatra::Application
   end
 
   get '/v1/customers/:customer_id/mandates' do
-    mandates = client.customers_mandates.with(params[:customer_id]).all(params[:offset], params[:count], testmode: params[:testmode]
-    )
+    mandates = Mollie::Customer::Mandate.all(params[:offset], params[:count], testmode: params[:testmode], customer_id: params[:customer_id])
     JSON.pretty_generate(mandates.attributes)
   end
 
 
   get '/v1/customers/:customer_id/mandates/:id' do
-    mandate = client.customers_mandates.with(params[:customer_id]).get(params[:id], testmode: params[:testmode])
+    mandate = Mollie::Customer::Mandate.get(params[:id], testmode: params[:testmode], customer_id: params[:customer_id])
     JSON.pretty_generate(mandate.attributes)
   end
 
   delete '/v1/customers/:customer_id/mandates/:id' do
-    client.customers_mandates.with(params[:customer_id]).delete(params[:id], testmode: params[:testmode])
+    Mollie::Customer::Mandate.delete(params[:id], testmode: params[:testmode], customer_id: params[:customer_id])
     "deleted"
   end
 end

data/examples/apis/methods.rb

@@ -28,7 +28,7 @@ class Application < Sinatra::Application
   end
 
   get '/v1/methods' do
-    methods = client.methods.all(params[:offset], params[:count],
+    methods = Mollie::Method.all(params[:offset], params[:count],
                                  include:        params[:include],
                                  recurring_type: params[:recurring_type],
                                  locale:         params[:locale],
@@ -39,7 +39,7 @@ class Application < Sinatra::Application
   end
 
   get '/v1/methods/:id' do
-    method = client.methods.get(params[:id],
+    method = Mollie::Method.get(params[:id],
                                 include:    params[:include],
                                 locale:     params[:locale],
                                 profile_id: params[:profile_id],

data/examples/apis/organizations.rb

@@ -10,7 +10,7 @@ class Application < Sinatra::Application
   end
 
   get '/v1/organizations/:id' do
-    organization = client.organizations.get(params[:id], testmode: params[:testmode])
+    organization = Mollie::Organization.get(params[:id], testmode: params[:testmode])
     JSON.pretty_generate(organization.attributes)
   end
 end

data/examples/apis/payments.rb

@@ -67,7 +67,7 @@ class Application < Sinatra::Application
   end
 
   swagger_path '/v1/payments/{payment_id}/refunds/{id}' do
-    operation :get, description: 'Create payment https://www.mollie.com/nl/docs/reference/refunds/get', tags: ['Payments'] do
+    operation :get, description: 'Get refund https://www.mollie.com/nl/docs/reference/refunds/get', tags: ['Payments'] do
       parameter name: :payment_id, in: 'path', description: 'Payment id', type: :string
       parameter name: :id, in: 'path', description: 'Refund id', type: :string
       parameter name: :testmode, in: 'query', description: 'Testmode', type: :boolean, default: true
@@ -76,7 +76,7 @@ class Application < Sinatra::Application
       response 500, description: 'Unexpected error'
     end
 
-    operation :delete, description: 'Delete payment https://www.mollie.com/nl/docs/reference/refunds/delete', tags: ['Payments'] do
+    operation :delete, description: 'Delete refund https://www.mollie.com/nl/docs/reference/refunds/delete', tags: ['Payments'] do
       parameter name: :payment_id, in: 'path', description: 'Payment id', type: :string
       parameter name: :id, in: 'path', description: 'Refund id', type: :string
       parameter name: :testmode, in: 'query', description: 'Testmode', type: :boolean, default: true
@@ -86,8 +86,31 @@ class Application < Sinatra::Application
     end
   end
 
+  swagger_path '/v1/payments/{payment_id}/chargebacks' do
+    operation :get, description: 'List payment chargebacks https://www.mollie.com/en/docs/reference/chargebacks/list', tags: ['Payments'] do
+      parameter name: :payment_id, in: 'path', description: 'Payment id', type: :string
+      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
+      parameter name: :count, in: 'query', description: 'Count', type: :integer
+      parameter name: :testmode, in: 'query', description: 'Testmode', type: :boolean, default: true
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  swagger_path '/v1/payments/{payment_id}/chargebacks/{id}' do
+    operation :get, description: 'Get chargeback https://www.mollie.com/nl/docs/reference/chargebacks/get', tags: ['Payments'] do
+      parameter name: :payment_id, in: 'path', description: 'Payment id', type: :string
+      parameter name: :id, in: 'path', description: 'Refund id', type: :string
+      parameter name: :testmode, in: 'query', description: 'Testmode', type: :boolean, default: true
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
   get '/v1/payments' do
-    payments = client.payments.all(params[:offset], params[:count],
+    payments = Mollie::Payment.all(params[:offset], params[:count],
                                    profile_id: params[:profile_id],
                                    testmode:   params[:testmode]
     )
@@ -96,12 +119,12 @@ class Application < Sinatra::Application
   end
 
   get '/v1/payments/:id' do
-    payment = client.payments.get(params[:id], testmode: params[:testmode])
+    payment = Mollie::Payment.get(params[:id], testmode: params[:testmode])
     JSON.pretty_generate(payment.attributes)
   end
 
   post '/v1/payments' do
-    payment = client.payments.create(
+    payment = Mollie::Payment.create(
       amount:       json_params['amount'],
       description:  json_params['description'],
       redirect_url: json_params['redirect_url'],
@@ -114,7 +137,8 @@ class Application < Sinatra::Application
   end
 
   post '/v1/payments/:payment_id/refunds' do
-    refund = client.payments_refunds.with(params[:payment_id]).create(
+    refund = Mollie::Payment::Refund.create(
+      payment_id:  params[:payment_id],
       amount:      json_params['amount'],
       description: json_params['description'],
       testmode:    json_params['testmode']
@@ -123,18 +147,28 @@ class Application < Sinatra::Application
   end
 
   get '/v1/payments/:payment_id/refunds/:id' do
-    refund = client.payments_refunds.with(params[:payment_id]).get(params[:id], testmode: params[:testmode])
+    refund = Mollie::Payment::Refund.get(params[:id], testmode: params[:testmode], payment_id: params[:payment_id])
     JSON.pretty_generate(refund.attributes)
   end
 
   delete '/v1/payments/:payment_id/refunds/:id' do
-    client.payments_refunds.with(params[:payment_id]).delete(params[:id], testmode: params[:testmode])
+    Mollie::Payment::Refund.delete(params[:id], testmode: params[:testmode], payment_id: params[:payment_id])
     "deleted"
   end
 
   get '/v1/payments/:payment_id/refunds' do
-    refunds = client.payments_refunds.with(params[:payment_id]).all(params[:offset], params[:count], testmode: params[:testmode])
+    refunds = Mollie::Payment::Refund.all(params[:offset], params[:count], testmode: params[:testmode], payment_id: params[:payment_id])
     JSON.pretty_generate(refunds.attributes)
   end
 
+  get '/v1/payments/:payment_id/chargebacks/:id' do
+    chargeback = Mollie::Payment::Chargeback.get(params[:id], testmode: params[:testmode], payment_id: params[:payment_id])
+    JSON.pretty_generate(chargeback.attributes)
+  end
+
+  get '/v1/payments/:payment_id/chargebacks' do
+    chargebacks = Mollie::Payment::Chargeback.all(params[:offset], params[:count], testmode: params[:testmode], payment_id: params[:payment_id])
+    JSON.pretty_generate(chargebacks.attributes)
+  end
+
 end

data/examples/apis/permissions.rb

@@ -21,12 +21,12 @@ class Application < Sinatra::Application
   end
 
   get '/v1/permissions' do
-    permissions = client.permissions.all(params[:offset], params[:count], testmode: params[:testmode])
+    permissions = Mollie::Permission.all(params[:offset], params[:count], testmode: params[:testmode])
     JSON.pretty_generate(permissions.attributes)
   end
 
   get '/v1/permissions/:id' do
-    permission = client.permissions.get(params[:id], testmode: params[:testmode])
+    permission = Mollie::Permission.get(params[:id], testmode: params[:testmode])
     JSON.pretty_generate(permission.attributes)
   end
 end

data/examples/apis/profiles.rb

@@ -76,17 +76,17 @@ class Application < Sinatra::Application
   end
 
   get '/v1/profiles' do
-    profiles = client.profiles.all(params[:offset], params[:count])
+    profiles = Mollie::Profile.all(params[:offset], params[:count])
     JSON.pretty_generate(profiles.attributes)
   end
 
   get '/v1/profiles/:id' do
-    profile = client.profiles.get(params[:id])
+    profile = Mollie::Profile.get(params[:id])
     JSON.pretty_generate(profile.attributes)
   end
 
   post '/v1/profiles' do
-    profile = client.profiles.create(
+    profile = Mollie::Profile.create(
       name:         json_params['name'],
       website:      json_params['website'],
       email:        json_params['email'],
@@ -98,7 +98,7 @@ class Application < Sinatra::Application
   end
 
   patch '/v1/profiles/:id' do
-    profile = client.profiles.update(params[:id],
+    profile = Mollie::Profile.update(params[:id],
                                      name:         json_params['name'],
                                      website:      json_params['website'],
                                      email:        json_params['email'],
@@ -110,17 +110,17 @@ class Application < Sinatra::Application
   end
 
   get '/v1/profiles/:profile_id/apikeys' do
-    api_keys = client.profiles_api_keys.with(params[:profile_id]).all
+    api_keys = Mollie::Profile::ApiKey.all(profile_id: params[:profile_id])
     JSON.pretty_generate(api_keys.attributes)
   end
 
   get '/v1/profiles/:profile_id/apikeys/:mode' do
-    api_key = client.profiles_api_keys.with(params[:profile_id]).get(params[:mode])
+    api_key = Mollie::Profile::ApiKey.get(params[:mode], profile_id: params[:profile_id])
     JSON.pretty_generate(api_key.attributes)
   end
 
   post '/v1/profiles/:profile_id/apikeys/:mode' do
-    payment = client.profiles_api_keys.with(params[:profile_id]).create(params[:mode])
+    payment = Mollie::Profile::ApiKey.create(params[:mode], profile_id: params[:profile_id])
     JSON.pretty_generate(payment.attributes)
   end
 end