slimpay_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c877f64434afcfc536f35f655513016378812511148e1acfd06253773556acca
+  data.tar.gz: 64a0b5b31b3adb349ac525144e6fd6ebc4cdddb79d6f49c714105f069ec8ab22
+SHA512:
+  metadata.gz: eb2567473d6f701279d72de25806e207e84b024a868c79bae29ba6faec952f32beae25a7cc184b9215865c16b6587c21d971562e1f10e93006fb426bfbe40022
+  data.tar.gz: ea6e26aa6877b4a156d0c381f781931a5a233f73316e7073eccfc32352922a67481cb73e2996733b2b88cc7d7f92bb58ad5e85b108fffa5e7b9b3990f3233b93

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at idrissa.bara@widegroup.eu. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in slimpay_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Idrissa Bara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,232 @@
+# SlimpayClient
+
+Welcome to your new gem!
+
+SlimpayClient is a Ruby gem designed to provide a comprehensive and up-to-date interface for interacting with the Slimpay API. This gem extends the original \`slimpay\` gem created by gdurelle, addressing the need for maintenance and updates to ensure compatibility with the latest Slimpay API features and best practices.
+
+## Features
+
+- Seamless integration with the Slimpay API
+- Support for the latest API endpoints and features
+- Improved error handling and logging
+- Easy configuration and setup
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slimpay_client'
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install slimpay_client
+```
+
+## Usage
+
+**API Docs: [https://dev.slimpay.com/](https://dev.slimpay.com/)**
+
+### Configuration
+
+If you use _Rails_ place this code in _config/initializers/slimpay_client.rb_:
+
+```ruby
+SlimpayClient.configure do |config|
+  config.client_id = "your_client_id"
+  config.client_secret = "your_client_secret"
+  config.creditor_reference = "your_creditor_reference"
+  config.sandbox = true
+  config.notify_url = 'you_notifications_url'
+  config.success_url = 'your_success_url'
+  config.failure_url = 'your_failure_url'
+  config.cancel_url = 'your_cancel_url'
+  # or
+  config.return_url = 'your_return_url'
+end
+```
+
+### Notification and return URLs
+
+The notification URL is the point of your application where Slimpay will send a POST request with the result of the current order.
+The state of the order will be either **close.completed** or **closed.aborted.aborted_byclient** if everything worked normally, or one of those quoted in the ([API Order documentation](https://dev.slimpay.com/hapi/reference/orders)).
+
+The return URL is the point of your application where your user/customer will be redirected to when he will have finish signing its mandate with Slimpay.
+
+### The root endpoint:
+
+The Slimpay API uses self-discovery. It means that each time you will perform a request, the answer will be a Hash of links to follow in order to perform more requestq.
+
+The more you do requests, the more methods will appear.
+
+When you emplement any class, it will inherits from the root-endpoint and thus already have available methods.
+
+```ruby
+slimpay = Slimpay::Base.new(client_id = '1234', client_secret = '987654321', creditor_reference = 'azerty')
+slimpay.api_methods
+```
+
+⚠️ If you call ``Slimpay::Base.new`` without arguments, the _Sandbox_ credentials will be used.
+
+Result will be a Hash:
+
+```ruby
+{"self"=>"https://api.preprod.slimpay.com/",
+   "profile"=>"https://api.preprod.slimpay.com/alps/v1",
+   "post_token"=>"https://api.preprod.slimpay.com/oauth/token",
+   "create_orders"=>"https://api.preprod.slimpay.com/orders",
+   "get_orders"=>"https://api.preprod.slimpay.com/orders{?creditorReference,reference}",
+   "search_order_by_id"=>"https://api.preprod.slimpay.com/orders/{id}",
+   "search_orders"=>"https://api.preprod.slimpay.com/orders{?id,creditorReference,entityReference,subscriberReference,reference,state,type,dateCreatedBefore,dateCreatedAfter,embed,withPageMetadata,page,size}",
+   "get_creditors"=>"https://api.preprod.slimpay.com/creditors{?reference}",
+   "create_mandates"=>"https://api.preprod.slimpay.com/mandates",
+   "get_mandates"=>"https://api.preprod.slimpay.com/mandates{?creditorReference,reference,rum,id,paymentScheme}",
+   "search_mandates"=>"https://api.preprod.slimpay.com/mandates{?creditorReference,entityReference,subscriberReference,mandateReference,paymentScheme,creationChannel,dateSignedBefore,dateSignedAfter,state,iban,signatoryLastName,signatoryEmail,companyName,embed,withPageMetadata,page,size}",
+   "create_documents"=>"https://api.preprod.slimpay.com/documents",
+   "get_documents"=>"https://api.preprod.slimpay.com/documents{?creditorReference,entityReference,reference}",
+   "search_document_by_id"=>"https://api.preprod.slimpay.com/documents/{id}",
+   "search_documents"=>"https://api.preprod.slimpay.com/documents/search{?creditorReference,status,creationDateBefore,creationDateAfter,documentReference,publicReference,subscriberReference,signatoryLastName,signatoryEmail,withPageMetadata,page,size}",
+   "create_payins"=>"https://api.preprod.slimpay.com/payments/in",
+   "create_payouts"=>"https://api.preprod.slimpay.com/payments/out",
+   "search_payments"=>"https://api.preprod.slimpay.com/payments{?creditorReference,entityReference,subscriberReference,mandateReference,cardAliasReference,scheme,direction,reference,category,currency,state,executionStatus,processor,executionDateBefore,executionDateAfter,embed,withPageMetadata,page,size}",
+   "search_payment_by_id"=>"https://api.preprod.slimpay.com/payments/{id}",
+   "search_payment_issues"=>"https://api.preprod.slimpay.com/payment-issues{?creditorReference,entityReference,subscriberReference,scheme,currency,executionStatus,dateCreatedBefore,dateCreatedAfter,withPageMetadata,page,size}",
+   "search_payment_issue_by_id"=>"https://api.preprod.slimpay.com/payment-issues/{id}",
+   "create_direct_debits"=>"https://api.preprod.slimpay.com/direct-debits",
+   "get_direct_debits"=>"https://api.preprod.slimpay.com/direct-debits{?id}",
+   "search_direct_debits"=>"https://api.preprod.slimpay.com/direct-debits{?creditorReference,entityReference,subscriberReference,mandateReference,paymentReference,currency,executionDateBefore,executionDateAfter,withPageMetadata,page,size}",
+   "search_direct_debit_issues"=>"https://api.preprod.slimpay.com/direct-debit-issues{?creditorReference,entityReference,subscriberReference,currency,executionStatus,dateCreatedBefore,dateCreatedAfter,withPageMetadata,page,size}",
+   "get_direct_debit_issues"=>"https://api.preprod.slimpay.com/direct-debit-issues{?id}",
+   "create_recurrent_direct_debits"=>"https://api.preprod.slimpay.com/recurrent-direct-debits",
+   "get_recurrent_direct_debits"=>"https://api.preprod.slimpay.com/recurrent-direct-debits{?id}",
+   "search_recurrent_direct_debits"=>"https://api.preprod.slimpay.com/recurrent-direct-debits{?creditorReference,entityReference,subscriberReference,reference,currency,activated,frequency,dateFromBefore,dateFromAfter,withPageMetadata,page,size}",
+   "create_credit_transfers"=>"https://api.preprod.slimpay.com/credit-transfers",
+   "get_credit_transfers"=>"https://api.preprod.slimpay.com/credit-transfers{?id}",
+   "search_credit_transfers"=>"https://api.preprod.slimpay.com/credit-transfers{?creditorReference,entityReference,subscriberReference,mandateReference,paymentReference,currency,executionDateBefore,executionDateAfter,page,size}",
+   "get_card_aliases"=>"https://api.preprod.slimpay.com/card-aliases{?id}",
+   "search_card_aliases"=>"https://api.preprod.slimpay.com/card-aliases{?creditorReference,entityReference,subscriberReference,reference,status,withPageMetadata,page,size}",
+   "search_card_by_id"=>"https://api.preprod.slimpay.com/cards/{id}",
+   "get_recurrent_card_transactions"=>"https://api.preprod.slimpay.com/recurrent-card-transactions{?id}",
+   "search_recurrent_card_transactions"=>"https://api.preprod.slimpay.com/recurrent-card-transactions{?creditorReference,entityReference,subscriberReference,reference,currency,activated,frequency,dateFromBefore,dateFromAfter,page,size}",
+   "create_recurrent_card_transactions"=>"https://api.preprod.slimpay.com/recurrent-card-transactions",
+   "get_card_transaction_issues"=>"https://api.preprod.slimpay.com/card-transaction-issues{?id}",
+   "search_bank_account_by_id"=>"https://api.preprod.slimpay.com/bank-accounts{?id}",
+   "search_balances"=>"https://api.preprod.slimpay.com/balances{?creditorReference,entityReference,currency,lastCalculated,page,size}",
+   "search_order_item_by_id"=>"https://api.preprod.slimpay.com/order-items/{id}",
+   "search_subscribers"=>"https://api.preprod.slimpay.com/subscribers{?creditorReference,entityReference,reference,withPageMetadata,page,size}",
+   "search_report"=>"https://api.preprod.slimpay.com/reports{?creditorReference,entityReference,dateFrom,dateTo}",
+   "search_document_templates"=>"https://api.preprod.slimpay.com/document-templates{?creditorReference,page,size}",
+   "create_document_template"=>"https://api.preprod.slimpay.com/document-templates",
+   "search_document_template_by_id"=>"https://api.preprod.slimpay.com/document-templates/{id}",
+   "search_mandate_templates"=>"https://api.preprod.slimpay.com/mandate-templates{?creditorReference,page,size}",
+   "create_mandate_template"=>"https://api.preprod.slimpay.com/mandate-templates",
+   "search_mandate_template_by_id"=>"https://api.preprod.slimpay.com/mandate-templates/{id}",
+   "search_files"=>"https://api.preprod.slimpay.com/files{?creditorReference,name,creationDateBefore,creationDateAfter,flow,category,status,state,withPageMetadata,page,size}",
+   "search_file_by_id"=>"https://api.preprod.slimpay.com/files/{id}",
+   "create_file"=>"https://api.preprod.slimpay.com/files{?creditorReference}",
+   "create_webhook"=>"https://api.preprod.slimpay.com/v1/webhook-configurations",
+   "get_webhook"=>"https://api.preprod.slimpay.com/v1/webhook-configurations/{id}",
+   "get_webhooks"=>"https://api.preprod.slimpay.com/v1/webhook-configurations{?creditorReference}"}
+```
+
+The keys of this Hash are the methods name you can call on the class instance (here Slimpay::Base).
+The value is the URL that will be used, with its arguments.
+
+**Example:**
+
+```ruby
+"get_orders"=>"https://api.preprod.slimpay.com/orders{?creditorReference,reference}",
+```
+
+The arguments will be _creditorReference_ and _reference_. You can give them as a Hash.
+See below for an example.
+
+Some methods as been added to this gem as shortcuts to these root methods.
+
+### Available resources :
+
+**Order**, **Mandate**, **App**
+
+Each resource inherit from _Resource_ wich itself inherits from _Base_.
+_Base_ defines root methods according to the Slimpay API.
+
+**Example:**
+
+The official API method:
+
+```ruby
+orders = Slimpay::Order.new(client_id = '1234', client_secret = '987654321', creditor_reference = 'azerty')
+orders.get_orders({creditorReference: 'mysellername', reference: 1234})
+```
+
+The shortcut:
+
+```ruby
+orders = Slimpay::Order.new(client_id = '1234', client_secret = '987654321', creditor_reference = 'azerty')
+orders.get_one(1234)
+```
+
+Result will be a Hash:
+
+```json
+{"_links"=>
+  {"self"=>{"href"=>"https://api.preprod.slimpay.com/creditors/democreditor/orders/1"},
+   "https://api.slimpay.net/alps#get-creditor"=>{"href"=>"https://api.preprod.slimpay.com/creditors/democreditor"},
+   "https://api.slimpay.net/alps#get-subscriber"=>{"href"=>"https://api.preprod.slimpay.com/creditors/democreditor/orders/1/subscribers/subscriber01"},
+   "https://api.slimpay.net/alps#user-approval"=>{"href"=>"https://slimpay.net/slimpaytpe16/userApproval?accessCode=spK534N0cuZztBGwj2FjC6eKzcsKFRzXbfy8buloUHiZV6p9PhIfcPgV7c507R"},
+   "https://api.slimpay.net/alps#get-order-items"=>{"href"=>"https://api.preprod.slimpay.com/creditors/democreditor/orders/1/items"},
+   "https://api.slimpay.net/alps#get-mandate"=>{"href"=>"https://api.preprod.slimpay.com/creditors/democreditor/mandates/1"}},
+ "reference"=>"1",
+ "state"=>"closed.completed",
+ "started"=>true,
+ "dateCreated"=>"2014-12-12T09:35:39.000+0000",
+ "mandateReused"=>false}
+```
+
+Now you can call new methods : get_creditor, get_subscriber, user_approval, get_order_items, get_mandate
+
+**NB:** Note that the methods in the resulting Hash are dashed-named, but the generated methods are camelcased.
+
+## Credentials
+
+The sanbox let you test credentials connection and few methods.
+
+You will need a test environment setted up by Slimpay to go further.
+
+### SANDBOX
+
+* client_id =  'democreditor01'
+* client_secret = 'demosecret01'
+* creditor_reference : democreditor
+
+### Test
+
+* IBAN : FR1420041010050500013M02606
+* BIC : PSSTFRPP
+* Code for phone verification : 0000
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slimpay_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/slimpay_client/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SlimpayClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/slimpay_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/slimpay_client/app.rb

@@ -0,0 +1,84 @@
+module SlimpayClient
+  # Used only to get and set callback URLs.
+  class App < Resource
+    # Prepare an admin token for app requests.
+    #
+    # Arguments:
+    #   username: Your SlimpayClient admin username
+    #   password: Your SlimpayClient admin password
+    def initialize(username = nil, password = nil)
+      init_config
+      @username = username || SlimpayClient.configuration.username
+      @password = password || SlimpayClient.configuration.password
+      @basic_auth = {username: "#{@creditor_reference}##{@username}", password: @password}
+      response = HTTParty.post(@token_endpoint, basic_auth: @basic_auth, body: app_options)
+      @token = response['access_token']
+    end
+
+    # Change the successUrl
+    # ===== Example:
+    #   app = SlimpayClient::App.new
+    #   app.success_url = "mywebsite.com/client/123/"
+    def success_url(url)
+      response = HTTParty.patch("#{@endpoint}/creditors/#{@creditor_reference}/apps/#{@client_id}", body: {successUrl: url}.to_json, headers: options)
+      SlimpayClient.answer(response)
+    end
+
+    # Change the failureUrl
+    # ===== Example:
+    #   app = SlimpayClient::App.new
+    #   app.failure_url = "mywebsite.com/client/123/"
+    def failure_url(url)
+      response = HTTParty.patch("#{@endpoint}/creditors/#{@creditor_reference}/apps/#{@client_id}", body: {failureUrl: url}.to_json, headers: options)
+      SlimpayClient.answer(response)
+    end
+
+    # Change the cancelUrl
+    # ===== Example:
+    #   app = SlimpayClient::App.new
+    #   app.cancel_url = "mywebsite.com/client/123/"
+    def cancel_url(url)
+      response = HTTParty.patch("#{@endpoint}/creditors/#{@creditor_reference}/apps/#{@client_id}", body: {cancelUrl: url}.to_json, headers: options)
+      SlimpayClient.answer(response)
+    end
+
+    # Change the returnUrl
+    # ===== Example:
+    #   app = SlimpayClient::App.new
+    #   app.return_url = "mywebsite.com/client/123/"
+    def return_url(url)
+      response = HTTParty.patch("#{@endpoint}/creditors/#{@creditor_reference}/apps/#{@client_id}", body: {returnUrl: url}.to_json, headers: options)
+      SlimpayClient.answer(response)
+    end
+
+    # Change the notifyUrl
+    def notify_url(url)
+      response = HTTParty.patch("#{@endpoint}/creditors/#{@creditor_reference}/apps/#{@client_id}", body: {notifyUrl: url}.to_json, headers: options)
+      SlimpayClient.answer(response)
+    end
+
+    # Change the notification and return URLs.
+    #
+    # ===== Arguments:
+    #   successUrl: (String) URL to your app the customer is gonna be redirected to when leaving SlimpayClient platform (success).
+    #   failureUrl: (String) URL to your app the customer is gonna be redirected to when leaving SlimpayClient platform (failure).
+    #   cancelUrl: (String) URL to your app the customer is gonna be redirected to when leaving SlimpayClient platform (cancel).
+    #   returnUrl: (String) URL to your app the customer is gonna be redirected to when leaving SlimpayClient platform.
+    #   notifyUrl: (String) URL to your app SlimpayClient is gonna send a notification to, to confirm a Signature, a payment, etc.
+    def change_urls(urls_params)
+      response = HTTParty.patch("#{@endpoint}/creditors/#{@creditor_reference}/apps/#{@client_id}", body: urls_params.to_json, headers: options)
+      SlimpayClient.answer(response)
+    end
+
+    private
+
+    def app_options
+      {
+        'Accept' => API_HEADER,
+        'Content-type' => 'application/hal+json',
+        'grant_type' => 'client_credentials',
+        'scope' => 'api_admin'
+      }
+    end
+  end
+end

data/lib/slimpay_client/base.rb

@@ -0,0 +1,183 @@
+module SlimpayClient
+  # Defines constants, main variables, requests options.
+  #
+  # Connect to the API through OAuth2 and generates API's first resources GET methods.
+  # ===== Usage:
+  #   slimpay = SlimpayClient::Base.new(client_id = '1234', client_secret = '987654321', creditor_reference = 'azerty')
+  #   slimpay.api_methods
+  #   =>
+  #     { "post_token"=>"https://api-sandbox.slimpay.net/oauth/token",
+  #       "create_orders"=>"https://api-sandbox.slimpay.net/orders",
+  #       "get_creditors"=>"https://api-sandbox.slimpay.net/creditors{?reference}",
+  #       "get_orders"=>"https://api-sandbox.slimpay.net/orders{?creditorReference,reference}",
+  #       "get_mandates"=>"https://api-sandbox.slimpay.net/mandates{?creditorReference,rum}",
+  #       "create_documents"=>"https://api-sandbox.slimpay.net/documents",
+  #       "get_documents"=>"https://api-sandbox.slimpay.net/documents{?creditorReference,entityReference,reference}",
+  #       "create_direct_debits"=>"https://api-sandbox.slimpay.net/direct-debits",
+  #       "get_direct_debits"=>"https://api-sandbox.slimpay.net/direct-debits{?id}",
+  #       "create_recurrent_direct_debits"=>"https://api-sandbox.slimpay.net/recurrent-direct-debits",
+  #       "get_recurrent_direct_debits"=>"https://api-sandbox.slimpay.net/recurrent-direct-debits{?id}",
+  #       "get_card_transactions"=>"https://api-sandbox.slimpay.net/card-transactions{?id}",
+  #       "get_card_transaction_issues"=>"https://api-sandbox.slimpay.net/card-transaction-issues{?id}",
+  #       "profile"=>"https://api-sandbox.slimpay.net/alps/v1"}
+  #
+  # ===== Arguments
+  #   client_id: (String)
+  #   client_secret: (String)
+  #   creditor_reference: (String)
+  class Base
+    def initialize
+      init_config
+      connect_api_with_oauth
+      api_response = JSON.parse(request_to_api)
+      generate_api_methods(api_response)
+    end
+
+    # Root endpoint provides GET links to resources.
+    # This methods create a method for each resources.
+    # It will also create new methods from future answers.
+    def generate_api_methods(response)
+      methods = {}
+      links = response['_links']
+      links = links.merge(response['_embedded']['items'].first['_links']) if response['_embedded'] && response['_embedded']['items']
+      return if links.nil?
+
+      links.each do |k, v|
+        name = k.gsub('https://api.slimpay.net/alps#', '').underscore
+        next if @methods && @methods.keys.include?(name) && !k.eql?('self')
+
+        url = v['href']
+        api_args = url.scan(/{\?(.*),?}/).flatten.first
+
+        methods[name] = generate_method(name, url, api_args)
+      end
+      list_api_methods(methods)
+    end
+
+    private
+
+    def init_config
+      SlimpayClient.configuration ||= SlimpayClient::Configuration.new
+      @client_id = SlimpayClient.configuration.client_id
+      @client_secret = SlimpayClient.configuration.client_secret
+      @creditor_reference = SlimpayClient.configuration.creditor_reference
+      @sandbox = SlimpayClient.configuration.sandbox
+      @success_url = SlimpayClient.configuration.success_url
+      @failure_url = SlimpayClient.configuration.failure_url
+      @cancel_url = SlimpayClient.configuration.cancel_url
+      @return_url = SlimpayClient.configuration.return_url
+      @notify_url = SlimpayClient.configuration.notify_url
+      @endpoint = sandbox? ? SANDBOX_ENDPOINT : PRODUCTION_ENDPOINT
+      @token_endpoint = @endpoint# + '/oauth/token'
+    end
+
+    # A request call to the endpoint.
+    # An empty call will return list of available methods in the API.
+    def request_to_api(url = '')
+      response = HTTParty.get("#{@endpoint}/#{url}", headers: options)
+      SlimpayClient.answer response
+    end
+
+    # OAuth2 call to retrieve the token
+    def connect_api_with_oauth
+      client = OAuth2::Client.new(@client_id, @client_secret, site: @token_endpoint, headers: oauth_options, auth_scheme: :basic_auth)
+      response = client.client_credentials.get_token
+      @token = response.token
+    end
+
+    # === Arguments:
+    #   name: (String) The method name
+    #   url: (String) URL called in the method block
+    #   api_args: (String) API arguments for this URL.
+    def generate_method(name, url, api_args)
+      if name.start_with?('create', 'post', 'cancel')
+        generate_post_method(name, url)
+      elsif name.start_with?('patch')
+        generate_patch_method(name, url)
+      else
+        generate_get_method(name, url, api_args)
+      end
+      url
+    end
+
+    def generate_get_method(name, url, api_args)
+      self.class.send(:define_method, name) do |method_arguments = nil|
+        if api_args.nil?
+          response = HTTParty.get(url, headers: options)
+        else
+          clean_url = url.gsub(/{\?.*/, '')
+          url_args = format_html_arguments(api_args, method_arguments)
+          response = HTTParty.get("#{clean_url}?#{url_args}", headers: options)
+        end
+        follow_up_api(response)
+      end
+    end
+
+    def generate_post_method(name, url)
+      self.class.send(:define_method, name) do |method_arguments = nil|
+        response = HTTParty.post(url, body: method_arguments.to_json, headers: options)
+        follow_up_api(response)
+      end
+    end
+
+    def generate_patch_method(name, url)
+      self.class.send(:define_method, name) do |method_arguments = nil|
+        response = HTTParty.patch(url, body: method_arguments.to_json, headers: options)
+        follow_up_api(response)
+      end
+    end
+
+    # Change APIs documented URL's arguments into real HTTP arguments through given method arguments
+    # ===== Arguments
+    #   api_args: (String) SlimpayClient given argument within URLs. Formated like: ?{arg1, arg2}
+    #   method_arguments: (String) Arguments called on the currently defined method.
+    def format_html_arguments(api_args, method_arguments)
+      url_args = ''
+      api_args.split(',').each_with_index do |arg, index|
+        if method_arguments[arg.to_sym].to_s.present?
+          url_args += "#{arg}=#{method_arguments[arg.to_sym]}"
+          url_args += '&' if (index + 1) < api_args.size
+        end
+      end
+      url_args
+    end
+
+    # Create the 'api_methods' instance method to retrieve an array of API methods previously created.
+    #
+    # ===== Usage:
+    #   slim = SlimpayClient::Base.new
+    #   slim.api_methods
+    #   => [apps, creditors, direct_debits, mandates, orders, recurrent_direct_debits, subscribers, ...]
+    def list_api_methods(methods)
+      @methods ||= methods
+      self.class.send(:define_method, 'api_methods') do
+        @methods = @methods.merge(methods) if @methods != methods
+        @methods
+      end
+    end
+
+    # Catch up potential errors and generate new methods if needed.
+    def follow_up_api(response)
+      answer = SlimpayClient.answer(response)
+      generate_api_methods(response)
+      answer
+    end
+
+    def oauth_options
+      {
+        'Accept' => 'application/json',
+        'Content-type' => 'application/x-www-form-urlencoded',
+        'grant_type' => 'client_credentials',
+        'scope' => 'api'
+      }
+    end
+
+    def options
+      {'Authorization' => "Bearer #{@token}", 'Content-type' => 'application/json'}
+    end
+
+    def sandbox?
+      @sandbox || @client_id.eql?('democreditor01') ? true : false
+    end
+  end
+end