mollie-api-ruby 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 719ea9fd2cb5e56072dc35c2f66efdd2c87e278b
-  data.tar.gz: 3c460d1338c55e3fb80449da019ad5702e65b0a7
+  metadata.gz: 7d6b6f21eeda06bcb33555aa029fe76466497263
+  data.tar.gz: 64aadca75fd234e1df340843b1f92627ffa75a05
 SHA512:
-  metadata.gz: 6035c6b84b160788f7f9ea14259bcc8ac1fe64e71e676e5227b8bf45f7dd0cad717b1fc7ed04a2a98b7655977e1c8d32863bcdf579beaeb312f0c5dc991b4665
-  data.tar.gz: d69710e8d191ed705a3b391f3d08bb29868d38d30e67f7e77741d1f329546605772b8da1de98c944e11404d1d3182e6ca49cbac6e2b1b95de015c3f6bd140621
+  metadata.gz: dac9bb4f03cd09e80eeab7fd0af5ed5f13cc3a3bdabbc71176ab125e829f6b7634512f4afd849dc75f482125687d80db9dbe481e87835ddccc74f7e7460783e6
+  data.tar.gz: 29dca80e86f9876f1512c76b3a3f872c27e55c5eef8a369b0e08f2edbe97b700a5ca7ce95852a101c4a50906fdfff3fa2ee02b53c80d42054e978541031eabbb

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 All notable changes to this project will be documented in this file.
 
+#### 2.2.1 - 2017-09-13
+  - Added support for gift card method.
+  - Added support for `invoice` endpoint.
+  - Improved support for `refunds` endpoint.
+  - Added and updated examples.
+
 #### 2.2.0 - 2017-04-21
   - Add support for organizations, permissions, profiles, settlement and profiles/apikeys resources ([#54](https://github.com/mollie/mollie-api-ruby/issues/54)).
   - Remove `jruby` from the build.

data/README.md

@@ -83,14 +83,27 @@ 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:
+In order to run the examples first run `bundle install`
 
 ```
 $ cd mollie-api-ruby
-$ ruby examples/app.rb
+$ bundle install
+$ cd examples
+$ rackup
 ```
 
 ## API documentation ##
+If you wish to learn more about the Ruby API, download the source code and run the Example app as follows:
+
+```
+$ git clone git@github.com:mollie/mollie-api-ruby.git
+$ cd mollie-api-ruby
+$ bundle
+$ cd examples
+$ API_KEY=test_xxxxxx rackup
+```
+You can then browse the swagger documentation on [http://localhost:9292](http://localhost:9292)
+
 If you wish to learn more about our API, please visit the [Mollie Developer Portal](https://www.mollie.com/developer/). API Documentation is available in both Dutch and English.
 
 ## License ##

data/examples/apis/api_docs.rb

@@ -0,0 +1,37 @@
+class Application < Sinatra::Application
+  ::Application
+  swagger_root do
+    key :swagger, '2.0'
+    info version:        Mollie::API::Client::VERSION,
+         title:          'Mollie',
+         description:    'Examples for the mollie api',
+         termsOfService: 'https://github.com/mollie/mollie-api-ruby',
+         contact:        { name: 'Mollie B.V.' },
+         license:        { name: 'BSD' }
+    key :basePath, '/'
+    key :consumes, %w(application/json multipart/form-data)
+    key :produces, ['application/json', "text/plain"]
+
+    security_definition :api_key do
+      key :type, :apiKey
+      key :name, :"X-Mollie-Api-Key"
+      key :in, :header
+    end
+  end
+
+  swagger_schema :ErrorModel do
+    property :message do
+      key :type, :string
+    end
+  end
+
+  get '/' do
+    # redirect "http://petstore.swagger.io/?url=#{Ngrok::Tunnel.ngrok_url_https}/api-docs"
+    redirect "#{Ngrok::Tunnel.ngrok_url_https}/index.html"
+  end
+
+  get '/api-docs' do
+    content_type :json
+    Swagger::Blocks.build_root_json([Application ]).to_json
+  end
+end

data/examples/apis/connect.rb

@@ -0,0 +1,58 @@
+require 'rack/oauth2'
+class Application < Sinatra::Application
+  swagger_path '/oauth2/authorize' do
+    operation :get, description: 'https://www.mollie.com/en/docs/reference/oauth/authorize', tags: ['Connect'] do
+      parameter name: :client_id, in: 'query', description: 'Client Id', type: :string
+      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: :response_type, in: 'query', description: 'Response Type', type: :string
+      parameter name: :approval_prompt, in: 'query', description: 'Approval prompt', type: :boolean
+      security api_key: []
+      response 301, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  swagger_path '/oauth2/token' do
+    operation :get, description: 'Get access token', tags: ['Connect'] do
+      parameter name: :client_id, in: 'query', description: 'Client Id', type: :string
+      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: :code, in: 'query', description: 'Authorization code', type: :string
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  get '/oauth2/authorize' do
+    client = Rack::OAuth2::Client.new(
+        identifier:             params[:client_id],
+        secret:                 params[:secret],
+        state:                  params[:state],
+        redirect_uri:           params[:redirect_uri],
+        authorization_endpoint: 'https://www.mollie.com/oauth2/authorize',
+        token_endpoint:         'https://api.mollie.nl/oauth2/tokens'
+    )
+    client.authorization_uri(state: params[:state], scope: params[:scope], approval_prompt: params[:approval_prompt])
+  end
+
+  get '/token' do
+    params[:code]
+  end
+
+  get '/oauth2/token' do
+    client = Rack::OAuth2::Client.new(
+        identifier:             params[:client_id],
+        secret:                 params[:secret],
+        redirect_uri:           params[:redirect_uri],
+        authorization_endpoint: 'https://www.mollie.com/oauth2/authorize',
+        token_endpoint:         'https://api.mollie.nl/oauth2/tokens'
+    )
+
+    client.authorization_code = params['code']
+    client.access_token!.access_token
+  end
+end

data/examples/apis/customers.rb

@@ -0,0 +1,115 @@
+class Application < Sinatra::Application
+  swagger_schema :CustomerRequest do
+    property :name, type: :string, description: 'Name', example: "John doe"
+    property :email, type: :string, description: 'Email', example: "john@example.com"
+    property :locale, type: :string, description: 'locale', example: "en_US"
+    property :metadata, type: :object, description: 'Metadata', example: { "user_id" => "12345" }
+    property :profileId, type: :object, description: 'ProfileId (Connect api only)', example: "pfl_FxPFwdxxJf"
+    property :testmode, type: :boolean, description: '(Connect api only)', example: true
+  end
+
+  swagger_path '/v1/customers' do
+    operation :get, description: 'https://www.mollie.com/en/docs/reference/customers/list', tags: ['Customers'] do
+      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
+      parameter name: :count, in: 'query', description: 'Count', type: :integer
+      parameter name: :testmode, in: 'query', type: :boolean, description: '(Connect api only)', example: true
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  swagger_path '/v1/customers' do
+    operation :post, description: 'https://www.mollie.com/en/docs/reference/customers/create', tags: ['Customers'] do
+      security api_key: []
+      parameter name: :customer, in: 'body', description: 'CustomerRequest params', schema: { '$ref' => '#/definitions/CustomerRequest' }
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  swagger_path '/v1/customers/{id}' do
+    operation :get, description: 'https://www.mollie.com/en/docs/reference/customers/get', tags: ['Customers'] do
+      parameter name: :id, in: 'path', description: 'Customer id', type: :string, default: 'cst_GUvJFqwVCD'
+      parameter name: :testmode, in: 'query', type: :boolean, description: '(Connect api only)', example: true
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+    operation :patch, description: 'https://www.mollie.com/en/docs/reference/customers/create', tags: ['Customers'] do
+      parameter name: :id, in: 'path', description: 'Customer id', type: :string, default: 'cst_GUvJFqwVCD'
+      security api_key: []
+      parameter name: :customer, in: 'body', description: 'CustomerRequest params', schema: { '$ref' => '#/definitions/CustomerRequest' }
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  swagger_path '/v1/customers/{customer_id}/payments' do
+    operation :get, description: 'https://www.mollie.com/en/docs/reference/customers/list-payments', tags: ['Customers'] do
+      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: 'cst_GUvJFqwVCD'
+      parameter name: :testmode, in: 'query', type: :boolean, description: '(Connect api only)', example: true
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+
+    operation :post, description: 'https://www.mollie.com/en/docs/reference/customers/create-payment', tags: ['Customers'] do
+      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: 'cst_GUvJFqwVCD'
+      parameter name: :payment, in: 'body', description: 'PaymentRequest params', schema: { '$ref' => '#/definitions/PaymentRequest' }
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  get '/v1/customers' do
+    customers = client.customers.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])
+    JSON.pretty_generate(customer.attributes)
+  end
+
+  post '/v1/customers' do
+    customer = client.customers.create(
+      name:      json_params['name'],
+      email:     json_params['email'],
+      locale:    json_params['locale'],
+      metadata:  json_params['metadata'],
+      profileId: json_params['profileId'],
+      testmode:  json_params['testmode']
+    )
+    JSON.pretty_generate(customer.attributes)
+  end
+
+  patch '/v1/customers/:id' do
+    customer = client.customers.update(params[:id],
+                                       name:     json_params['name'],
+                                       email:    json_params['email'],
+                                       locale:   json_params['locale'],
+                                       metadata: json_params['metadata'],
+    )
+    JSON.pretty_generate(customer.attributes)
+  end
+
+  get '/v1/customers/:customer_id/payments' do
+    payments = client.customers_payments.with(params[:customer_id]).all(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(
+      amount:       json_params['amount'],
+      description:  json_params['description'],
+      redirect_url: json_params['redirect_url'],
+      webhook_url:  json_params['webhook_url'],
+      metadata:     json_params['metadata'],
+      profileId:    json_params['profileId'],
+      testmode:     json_params['testmode']
+    )
+    JSON.pretty_generate(payment.attributes)
+  end
+end

data/examples/apis/invoices.rb

@@ -0,0 +1,38 @@
+class Application < Sinatra::Application
+  swagger_path '/v1/invoices' do
+    operation :get, description: 'List invoices https://www.mollie.com/en/docs/reference/invoices/list', tags: ['Invoices'] do
+      parameter name: :include, in: 'query', description: 'Include', type: :string, example: "lines,settlements"
+      parameter name: :reference, in: 'query', description: 'Issuer id', type: :string, example: "inv_FrvewDA3Pr"
+      parameter name: :year, in: 'query', description: 'Issuer id', type: :integer, example: Time.now.year
+      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
+      parameter name: :count, in: 'query', description: 'Count', type: :integer
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  swagger_path '/v1/invoices/{id}' do
+    operation :get, description: 'Get invoice', tags: ['Invoices'] do
+      parameter name: :id, in: 'path', description: 'Issuer id', type: :string, example: "inv_FrvewDA3Pr"
+      parameter name: :include, in: 'query', description: 'Includes', type: :string, example: "lines,settlements"
+      security api_key: []
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+  end
+
+  get '/v1/invoices' do
+    invoices = client.invoices.all(params[:offset], params[:count],
+                                   include:   params[:include],
+                                   reference: params[:reference],
+                                   year:      params[:year]
+    )
+    JSON.pretty_generate(invoices.attributes)
+  end
+
+  get '/v1/invoices/:id' do
+    invoice = client.invoices.get(params[:id], include: params[:include])
+    JSON.pretty_generate(invoice.attributes)
+  end
+end

data/examples/apis/issuers.rb

@@ -0,0 +1,35 @@
+class Application < Sinatra::Application
+  swagger_path '/v1/issuers' do
+    operation :get, description: 'List issuers https://www.mollie.com/en/docs/reference/issuers/list', tags: ['Issuers'] 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
+
+  swagger_path '/v1/issuers/{id}' do
+    operation :get, description: 'Get issuer', tags: ['Issuers'] do
+      parameter name: :id, in: 'path', description: 'Issuer id', type: :string
+      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/issuers' do
+    issuers = client.issuers.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],
+                                testmode: params[:testmode]
+    )
+    JSON.pretty_generate(issuer.attributes)
+  end
+end

data/examples/apis/mandates.rb

@@ -0,0 +1,83 @@
+class Application < Sinatra::Application
+  swagger_schema :MandateRequest do
+    property :method, type: :decimal, description: 'Method', example: "directdebit"
+    property :consumer_name, type: :string, description: 'Consumer name', example: "Customer A"
+    property :consumer_account, type: :string, description: 'Account number', example: "NL17RABO0213698412"
+    property :consumer_bic, type: :string, description: 'BIC', example: "RABONL2U"
+    property :signature_date, type: :string, description: 'Date mandate was signed', example: "2016-05-01"
+    property :mandate_reference, type: :string, description: 'A custom reference', example: "YOUR-COMPANY-MD13804"
+    property :webhook_url, type: :string, description: 'URL for redirection', example: "https://webshop.example.org/payments/webhook/"
+    property :testmode, type: :boolean, description: '(Connect api only)', example: true
+  end
+
+  swagger_path '/v1/customers/{customer_id}/mandates' do
+    operation :post, description: 'Create mandates', tags: ['Mandates'] do
+      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: "cst_GUvJFqwVCD"
+      security api_key: []
+      parameter name: :mandate, in: 'body', description: 'MandateRequest params', schema: { '$ref' => '#/definitions/MandateRequest' }
+      response 200, description: 'Successful response'
+      response 500, description: 'Unexpected error'
+    end
+
+    operation :get, description: 'List mandates', tags: ['Mandates'] do
+      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: "cst_GUvJFqwVCD"
+      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/customers/{customer_id}/mandates/{id}' do
+    operation :get, description: 'Get mandate', tags: ['Mandates'] do
+      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: "cst_GUvJFqwVCD"
+      parameter name: :id, in: 'path', description: 'Mandate id', type: :string, default: "mdt_qP7Qk6mgaz"
+      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
+
+    operation :delete, description: 'Remove mandate', tags: ['Mandates'] do
+      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: "cst_GUvJFqwVCD"
+      parameter name: :id, in: 'path', description: 'Mandate id', type: :string, default: "mdt_qP7Qk6mgaz"
+      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
+
+  post '/v1/customers/:customer_id/mandates' do
+    mandate = client.customers_mandates.with(params[:customer_id]).create(
+      method:            json_params['method'],
+      consumer_name:     json_params['consumer_name'],
+      consumer_account:  json_params['consumer_account'],
+      consumer_bic:      json_params['consumer_bic'],
+      signature_date:    json_params['signature_date'],
+      mandate_reference: json_params['mandate_reference'],
+      webhook_url:       json_params['webhook_url'],
+      testmode:          json_params['testmode']
+    )
+    JSON.pretty_generate(mandate.attributes)
+  end
+
+  get '/v1/customers/:customer_id/mandates' do
+    mandates = client.customers_mandates.with(params[:customer_id]).all(params[:offset], params[:count], testmode: params[:testmode]
+    )
+    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])
+    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])
+    "deleted"
+  end
+end

data/examples/apis/methods.rb

@@ -0,0 +1,50 @@
+class Application < Sinatra::Application
+  swagger_path '/v1/methods' do
+    operation :get, description: 'List methods https://www.mollie.com/en/docs/reference/methods/list', tags: ['Methods'] do
+      parameter name: :include, in: 'query', description: 'Include additional data, e.g. issuers', type: :string
+      parameter name: :recurring_type, in: 'query', description: 'Recurring type', type: :string, default: 'first'
+      parameter name: :locale, in: 'query', description: 'Locale', type: :integer
+      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
+      parameter name: :count, in: 'query', description: 'Count', type: :integer
+      parameter name: :profile_id, in: 'query', description: 'Profile ID', type: :string
+      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
+
+  swagger_path '/v1/methods/{id}' do
+    operation :get, description: 'Get method', tags: ['Methods'] do
+      parameter name: :id, in: 'path', description: 'Method id', type: :string
+      parameter name: :include, in: 'query', description: 'Include additional data, e.g. issuers', type: :string
+      parameter name: :locale, in: 'query', description: 'Locale', type: :integer
+      parameter name: :profile_id, in: 'query', description: 'Profile ID', type: :string
+      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/methods' do
+    methods = client.methods.all(params[:offset], params[:count],
+                                 include:        params[:include],
+                                 recurring_type: params[:recurring_type],
+                                 locale:         params[:locale],
+                                 profile_id:     params[:profile_id],
+                                 testmode:       params[:testmode]
+    )
+    JSON.pretty_generate(methods.attributes)
+  end
+
+  get '/v1/methods/:id' do
+    method = client.methods.get(params[:id],
+                                include:    params[:include],
+                                locale:     params[:locale],
+                                profile_id: params[:profile_id],
+                                testmode:   params[:testmode]
+    )
+    JSON.pretty_generate(method.attributes)
+  end
+end