virementmaitrise 0.6.2

data/README.md

@@ -0,0 +1,404 @@
+# Virement Maitrisé
+
+Virement Maitrisé is connected with most European banks and enables a user to initiate a payment directly from their bank account. This results to a bank transfer sent from the user's bank account directly to your bank account, skipping all intermediaries. Within the SEPA region, transfers take between 10 seconds to 1 business day to arrive on your bank account. No hidden fees. Check out [our website](https://www.virementmaitrise.societegenerale.eu).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'virementmaitrise'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install virementmaitrise
+
+## Usage
+
+Get started by subscribing to a free developer account. Join today to get access to our sandbox by registering on the [developer console](https://console.virementmaitrise.societegenerale.eu/auth/register) by creating your first sets of API Keys. When creating an account, specify you are an ECOMMERCE. When you’re ready to deploy to production, just go through the Activation Form in your console. Once the Virement Maitrisé Team activates your account, you’ll be ready to start receiving real bank transfers directly on the bank account specified during activation.
+
+By default `sandbox` is the initial environment, but you can change to production when initializing your PIS or AIS client:
+
+### Initialize your PIS client 
+
+```ruby
+pis_client = Fintecture::PisClient.new({
+    environment: 'sandbox', # => ["sandbox", "test", "production"]
+    app_id: 'your_app_id',
+    app_secret: 'your_app_secret',
+    private_key: %q(your_private_key)
+})
+```    
+
+
+
+### Initialize your AIS client 
+
+```ruby
+ais_client = Fintecture::AisClient.new({
+    environment: 'sandbox', # => ["sandbox", "test", "production"]
+    app_id: 'your_app_id',
+    app_secret: 'your_app_secret',
+    private_key: %q(your_private_key)
+})
+```
+
+
+
+## PIS
+
+PIS client properties
+```ruby
+pis_client.app_id
+pis_client.app_secret
+pis_client.private_key
+pis_client.environment
+pis_client.token
+pis_client.token_expires_in
+```
+
+### Access token
+This method return the token and store it in the client for future requests
+```ruby
+pis_client.generate_token
+```
+
+
+### POST /connect
+
+Creates a connect session for a PSU to initiate a payment.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/createpisv2connect
+
+```ruby
+# connect (payload, state, redirect_uri = nil, origin_uri = nil, with_virtualbeneficiary: false)
+#       payload: {}
+#       state: string
+#       redirect_uri: string
+#       origin_uri: string
+
+response = pis_client.connect payload, "my-state", "https://www.my-redirect-uri.fr", "https://www.my-origine-uri.fr", with_virtualbeneficiary: true
+```
+
+### GET /payments
+
+Get the details of all transfers or of a specific transfer, with virtual beneficiary information if required.
+
+Documentation:
+- Get all payments: https://doc.virementmaitrise.societegenerale.eu/reference/getpisv2payments
+- Get a specific payment: https://doc.virementmaitrise.societegenerale.eu/reference/getpaymentsession
+
+```ruby
+# payments (session_id = nil, with_virtualbeneficiary: false)
+#       session_id: string
+
+response = pis_client.payments 
+# OR
+response = pis_client.payments "7f47d3675f5d4964bc416b43af63b06e"
+# OR
+response = pis_client.payments "7f47d3675f5d4964bc416b43af63b06e", with_virtualbeneficiary: true
+```
+
+### POST /refund
+
+Initiates a refund. If the amount is not specified, refunds the total.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/createpisv2refund
+
+```ruby
+# refund (session_id, amount = nil, user_id = nil))
+#       session_id: string
+#       amount: number
+#       user_id: string
+
+response = pis_client.refund "7f47d3675f5d4964bc416b43af63b06e", 5.75, "8886aaa4-527d-4253-8951-a07d8bf4cf52"
+```
+
+### POST /request-to-pay
+
+Creates a request to pay that merchant can then share by link, mail or sms to a customer for asynchronous payment.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/createpisv2requesttopay
+
+```ruby
+# refund (payload, x_language, redirect_uri = nil)
+#       payload: {}
+#       x_language: string
+#       redirect_uri: string
+
+response = pis_client.request_to_pay payload, 'fr', "https://www.my-redirect-uri.fr"
+```
+
+### GET /settlements
+
+Get the details of all settlements or of a specific settlement.
+
+Documentation:
+- Get all settlements: https://doc.virementmaitrise.societegenerale.eu/reference/getpisv2settlements
+- Get a specific settlement: https://doc.virementmaitrise.societegenerale.eu/reference/getpisv2settlement
+
+```ruby
+# settlements (settlement_id = nil, include_payments = false)
+#       settlement_id: string
+#       include_payments: boolean
+
+response = pis_client.settlements
+OR
+response = pis_client.settlements "127335fdeb073e0eb2313ba0bd71ad44"
+OR
+response = pis_client.settlements "127335fdeb073e0eb2313ba0bd71ad44", true
+```
+
+## AIS     
+AIS client properties
+```ruby
+ais_client.app_id
+ais_client.app_secret
+ais_client.private_key
+ais_client.environment
+ais_client.token
+ais_client.refresh_token
+ais_client.token_expires_in
+``` 
+### GET /connect
+
+Get a connect session for a PSU to create a connection that will enable access to AIS features.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/getaisv2connect
+
+```ruby
+# connect (state, redirect_uri, scope = nil)
+#       state: string
+#       redirect_uri: string
+#       scope: string
+
+response = ais_client.connect "my-state", "https://www.my-redirect-uri.fr"
+```
+When you follow the returned url, you'll be redirect with "customer_id" & "code" parameters
+```ruby
+customer_id = "fa51058b5f8306f1e048f1adda5488a9"
+code = "f66ec660b0bbd2797bf6847fb4b98454"
+```
+
+### Access token
+
+Returns the token and store it in the client for future requests.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/createaccesstoken
+
+```ruby
+ais_client.generate_token code
+```
+
+### Refresh token
+
+Returns the token and store it in the client for future requests.
+If you do not pass the refreshtoken as a parameter, the client refreshtoken will be used.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/createrefreshtoken
+
+```ruby
+# generate_refresh_token (refresh_token = nil)
+#       refresh_token: string
+
+ais_client.generate_refresh_token
+```
+
+### GET /authorize
+
+Authenticates your customer to their Bank for AIS access
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/getaisv1providerauthorization
+
+```ruby
+# authorize (app_id_auth: false, provider_id:, redirect_uri:, state: nil, x_psu_id: nil, x_psu_ip_address: nil)
+#       app_id_auth: boolean
+#       provider_id: string
+#       redirect_uri: string
+#       state: string
+#       x_psu_id: string
+#       x_psu_ip_address: string
+
+response = ais_client.authorize app_id_auth: false, provider_id: "agfbfr", redirect_uri: "https://www.google.fr", state: "ok", x_psu_id: "123456", x_psu_ip_address: "192.168.1.1"
+```
+
+### GET /accounts
+
+Get all accounts linked to a specific AIS connection.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/getaisv1customeraccounts
+
+```ruby
+# accounts (customer_id:, account_id: nil, remove_nulls: nil, withBalances: nil)
+#       customer_id: string
+#       account_id: string
+#       remove_nulls: boolean
+#       withBalances: boolean
+
+response = ais_client.accounts customer_id: customer_id, account_id: nil, remove_nulls: nil, withBalances: nil
+```
+
+### GET /transactions
+
+Get all transactions linked to a specific AIS connection for a specific account.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/getaisv1customeraccounttransactions
+
+```ruby
+# transactions (customer_id:, account_id:, remove_nulls: nil, convert_dates: nil, filters: nil)
+#       customer_id: string
+#       account_id: string
+#       remove_nulls: boolean
+#       convert_dates: boolean
+#       filters: {}
+
+transactions_filters = {
+  "filter[date_to]": "2020-01-01",
+  'filter[date_from]': "max" # Date or 'max'
+}
+response = ais_client.transactions customer_id: customer_id, account_id: "b71722204d1a3f5ecd895", remove_nulls: true, convert_dates: true, filters: transactions_filters
+```
+
+### GET /accountholders
+
+Retrieves all personal information of the client such as name, address and contact details for all the beneficiary owners.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/getaisv1customeraccountholders
+
+```ruby
+# account_holders (customer_id:, remove_nulls: nil)
+#       customer_id: string
+#       remove_nulls: boolean
+
+response = ais_client.account_holders customer_id: customer_id, remove_nulls: true
+```
+
+### DELETE /customer
+
+Deletes all active access tokens and all PSU data linked to requested connection.
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/deleteaisv1customer
+
+```ruby
+# account_holders (customer_id:)
+#       customer_id: string
+
+response = ais_client.delete_customer customer_id: customer_id
+```
+## RESSOURCES
+Use the PIS client to get ressources. The "generate_token" step is not needed for this calls
+
+### GET /providers
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/getresv1providers
+
+```ruby
+# providers (provider_id: nil, paramsProviders: nil)
+#       provider_id: string
+#       paramsProviders: string
+
+paramsProviders = {
+    'filter[country]': 'FR',
+    'filter[pis]': 'SEPA',
+    'filter[ais]': 'Accounts',
+    'filter[psu_type]': 'retail',
+    'filter[auth_model]': 'redirect',
+    'sort[name]': 'DESC',
+    'sort[full_name]': 'DESC',
+    'sort[country]': 'DESC',
+    'sort[provider_id]': 'DESC'
+}
+response = pis_client.providers provider_id: 'agfbfr', paramsProviders: paramsProviders
+```
+
+### GET /applications
+
+Documentation:
+- https://doc.virementmaitrise.societegenerale.eu/reference/getresv1applications
+
+```ruby
+# applications ()
+
+response = pis_client.applications
+```
+
+## API Errors handling
+Hash version
+```ruby
+begin
+    pis_client.refund "7f47d3675f5d4964bc416b43af63b06e", 1
+rescue => e
+    error = JSON.parse e.to_s
+    puts error
+end
+```
+
+```ruby
+{
+    "type"=>"Virement Maitrisé api",
+    "status"=>401,
+    "errors"=>[
+        {
+            "code"=>"invalid_token",
+            "title"=>"Invalid Token",
+            "message"=>"The token is either invalid or expired."
+        }
+    ],
+    "error_string"=>"\nVirement Maitrisé server errors : \n status: 401 \n code: unauthorized\n id : 3006ddbf-2f97-44d8-9f63-35711b78e8a6\n\n   code: invalid_token\n   title: Invalid Token\n   message: The token is either invalid or expired.\n\n"
+}
+```
+Text version
+```ruby
+begin
+    pis_client.refund "7f47d3675f5d4964bc416b43af63b06e", 1
+rescue => e
+    error = JSON.parse e.to_s
+    puts error['error_string']
+end
+```
+
+```ruby
+Fintecture server errors :
+ status: 401
+ code: unauthorized
+ id : 2adb9e35-ff0d-4477-959e-b1b1a7d7c812
+
+   code: invalid_token
+   title: Invalid Token
+   message: The token is either invalid or expired.
+
+```
+## 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 tags, 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/Virementmaitrise/virementmaitrise-sdk-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [GPL-3.0 License](http://www.gnu.org/licenses/gpl-3.0.txt).
+
+## Code of Conduct
+
+Everyone interacting in the Virement Maitrisé project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Virementmaitrise/virementmaitrise-sdk-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'virementmaitrise'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exemples/ais.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require './lib/virementmaitrise'
+
+config = JSON.parse(File.read('./exemples/config_ais.json'))
+
+ais_client = VirementMaitrise::AisClient.new({
+                                         environment: config['environment'],
+                                         app_id: config['app_id'],
+                                         app_secret: config['app_secret'],
+                                         private_key: config['private_key']
+                                       })
+
+# ######################## AIS ########################
+
+# ------------ Connect ------------
+connect_response = ais_client.connect 'ok', 'https://www.google.fr'
+connect_id = connect_response['meta']['connect_id']
+url = connect_response['meta']['url']
+
+puts "Connect url => #{url}"
+
+# Put the return of connect url here
+customer_id = 'c84e6a2c66862f6ce169a11262b28f4c'
+code = '173535d0acc16271e7942cc6e1772a5b'
+
+# ------------ Get access token ------------
+ais_client.generate_token code
+ais_client.generate_refresh_token
+# ------------ Authorize ------------
+puts ais_client.authorize app_id_auth: true, provider_id: 'agfbfr', redirect_uri: 'https://www.google.fr', state: 'ok',
+                          x_psu_id: nil, x_psu_ip_address: nil
+# ------------ Authorize decoupled ------------
+puts ais_client.authorize_decoupled app_id_auth: false, provider_id: 'agfbfr', polling_id: '1234'
+# ------------ Get accounts ------------
+accounts_response = ais_client.accounts customer_id: customer_id, account_id: nil, remove_nulls: nil, withBalances: nil
+account = accounts_response['data'].first
+account_id = account['id']
+# ------------ Get transactions ------------
+transactions_filters = {
+  "filter[date_to]": '2020-01-01',
+  'filter[date_from]': 'max'
+}
+transactions_response = ais_client.transactions customer_id: customer_id, account_id: account_id, remove_nulls: true,
+                                                convert_dates: true, filters: transactions_filters
+transaction = transactions_response['data'].first
+puts transaction
+# ------------ Get account holders ------------
+# Caution the hasAccountholders field in db must have a value = 1.
+puts ais_client.account_holders customer_id: customer_id, remove_nulls: nil
+# ------------ Delete customer ------------
+# Customer not found if customer you don't use the api before
+puts ais_client.delete_customer customer_id: customer_id

data/exemples/pis.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require './lib/virementmaitrise'
+
+config = JSON.parse(File.read('./exemples/config_pis.json'))
+
+pis_client = VirementMaitrise::PisClient.new({
+                                         environment: config['environment'],
+                                         app_id: config['app_id'],
+                                         app_secret: config['app_secret'],
+                                         private_key: config['private_key']
+                                       })
+
+payload_connect = {
+  meta: {
+    psu_name: 'John Doe', # Mandatory
+    psu_email: 'John.Doe@gmail.com', # Mandatory
+    psu_phone: '666777888', # Mandatory
+    psu_phone_prefix: '', # Optionnal
+    psu_ip: '127.0.0.1', # Optionnal (Plante la signature)
+    psu_form: '', # Mandatory - if no fixed beneficiary
+    psu_incorporation: '', # Mandatory - if no fixed beneficiary
+    psu_address: {
+      street: 'Main St.', # Mandatory
+      # number: '123', # Optional
+      complement: '2nd floor', # Optional
+      city: 'Paris', # Mandatory
+      zip: '75000', # Mandatory
+      country: 'fr' # Mandatory
+    }
+  },
+  data: {
+    type: 'PIS',
+    attributes: {
+      amount: '123', # Mandatory
+      currency: 'EUR', # Mandatory
+      communication: 'Thanks Mom!' # Mandatory
+      # execution_date: '2021-09-31', # Optional
+      # beneficiary: {      # Optional
+      #     name: "Dummy SA", # Conditional
+      #     iban: "FR1420041010050500013M02606", # Conditional
+      #     swift_bic: "FTSBSESSXXX", # Conditional
+      #     street: "road of somewhere", # Conditional
+      #     number: "2", # Optional
+      #     complement:"", # Optional
+      #     city: "Paris", # Conditional
+      #     zip: "93160", # Conditional
+      #     country: "FR", # Conditional
+      #     form: "", # Mandatory if no fixed beneficiary
+      #     incorporation: "" # Mandatory if no fixed beneficiary
+      # },
+      # debited_account_id: 'FR1420041010050500013M02606', # Optional
+      # debited_account_type: 'iban', # Mandatory if debited_account_id exist
+      # end_to_end_id: '5f78e902907e4209aa8df63659b05d24',
+      # scheme: 'AUTO' # Optional
+    }
+  }
+}
+
+payload_request_to_pay = {
+  meta: {
+    psu_name: 'John Doe', # Mandatory
+    psu_email: 'John.Doe@gmail.com', # Mandatory
+    psu_phone: '666777888', # Mandatory
+    psu_phone_prefix: '+33', # Optionnal
+    psu_address: {
+      street: 'Main St.', # Mandatory
+      number: '123', # Optional
+      city: 'Paris', # Mandatory
+      zip: '75000', # Mandatory
+      country: 'fr' # Mandatory
+    },
+    expirary: 86_400, # Optional
+    cc: 'John.Doe@gmail.com', # Optional
+    bcc: 'John.Doe@gmail.com' # Optional
+  },
+  data: {
+    type: 'REQUEST_TO_PAY',
+    attributes: {
+      amount: 123, # Mandatory
+      currency: 'EUR', # Mandatory
+      communication: 'Thanks Mom!' # Mandatory
+    }
+  }
+}
+
+payload_initiate = {
+  "meta": {
+    "psu_name": 'Bob McCheese',
+    "psu_email": 'John.Doe@gmail.com',
+    "psu_phone": '09743593535',
+    "psu_address": {
+      "street": 'route de la france',
+      "number": '33',
+      "complement": '2nd floor',
+      "zip": '12001',
+      "city": 'Paris',
+      "country": 'FR'
+    }
+  },
+  "data": {
+    "type": 'PIS',
+    "attributes": {
+      "amount": '149.30',
+      "currency": 'EUR',
+      "communication": 'Order 6543321'
+      # "beneficiary": {
+      #     "name": "Bob Smith",
+      #     "street": "road of somewhere",
+      #     "number": "2",
+      #     "city": "Paris",
+      #     "zip": "93160",
+      #     "country": "FR",
+      #     "iban": "FR1420041010050500013M02606",
+      #     "swift_bic": "BANKFRXXXXX"
+      # }
+    }
+  }
+}
+
+paramsProviders = {
+  'filter[country]': 'FR',
+  'filter[pis]': 'SEPA',
+  'filter[ais]': 'Accounts',
+  'filter[psu_type]': 'retail',
+  'filter[auth_model]': 'redirect',
+  'sort[name]': 'ASC',
+  'sort[full_name]': 'ASC',
+  'sort[country]': 'ASC',
+  'sort[provider_id]': 'ASC'
+}
+
+# ######################## PIS ########################
+# ------------ Get access token ------------
+pis_client.generate_token
+# ------------ Connect ------------
+puts pis_client.connect payload_connect, 'ok', 'https://www.google.fr'
+# ------------ Request to pay ------------
+puts pis_client.request_to_pay payload_request_to_pay, 'fr', 'https://www.google.fr'
+# ------------ Get payments ------------
+puts pis_client.payments '7f47d3675f5d4964bc416b43af63b06e'
+# ------------ Initiate ------------
+puts pis_client.initiate payload_initiate, 'cmcifrpp', 'https://www.google.fr', 'ok'
+# ------------ Refund ------------
+puts pis_client.refund '7f47d3675f5d4964bc416b43af63b06e', 1
+# ------------ settlements ------------
+pis_client.settlements
+pis_client.settlements '127335fdeb073e0eb2313ba0bd71ad44', true

data/exemples/ressources.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require './lib/virementmaitrise'
+
+# ------------ Test class -------------
+config = JSON.parse(File.read('./exemples/config_pis.json'))
+
+pis_client = VirementMaitrise::PisClient.new({
+                                         environment: config['environment'],
+                                         app_id: config['app_id'],
+                                         app_secret: config['app_secret'],
+                                         private_key: config['private_key']
+                                       })
+
+# ######################## RESSOURCES ########################
+# ------------ Get providers ------------
+puts pis_client.providers provider_id: 'agfbfr'
+puts pis_client.providers paramsProviders: paramsProviders
+# ------------ Get applications ------------
+puts pis_client.applications
+# ------------ Get test accounts ------------
+puts pis_client.test_accounts
+puts pis_client.test_accounts 'bbvaes'