fintecture 0.2.1 → 0.3.0

data/exemples/config_pis.json

@@ -0,0 +1,6 @@
+{
+    "environment": "test",
+    "app_id": "your_app_id_here",
+    "app_secret": "your_app_secret_here",
+    "private_key": "your_private_key here"
+}

data/exemples/pis.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require './lib/fintecture'
+
+config = JSON.parse(File.read('./exemples/config_pis.json'))
+
+pis_client = Fintecture::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'

data/exemples/ressources.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require './lib/fintecture'
+
+# ------------ Test class -------------
+config = JSON.parse(File.read('./exemples/config_pis.json'))
+
+pis_client = Fintecture::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'

data/fintecture.gemspec

@@ -1,43 +1,44 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fintecture/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fintecture"
+  spec.name          = 'fintecture'
   spec.version       = Fintecture::VERSION
   spec.authors       = ['Fintecture']
-  spec.email         = ["alvaro.fernandez@nazaries.com"]
+  spec.email         = ['alvaro.fernandez@nazaries.com']
 
   spec.summary       = 'Short summary'
   spec.description   = 'Longer summary'
-  spec.homepage      = "http://fintecture.com"
-  spec.license       = "GPL-3.0"
+  spec.homepage      = 'http://fintecture.com'
+  spec.license       = 'GPL-3.0'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     # spec.metadata["allowed_push_host"] = 'http://mygemserver.com'
 
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/Fintecture/fintecture-sdk-ruby"
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/Fintecture/fintecture-sdk-ruby'
     # spec.metadata["changelog_uri"] = spec.homepage
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_dependency 'faraday'
 end

data/lib/fintecture/ais_client.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'fintecture/api/ais/connect'
+require 'fintecture/api/ais/accounts'
+require 'fintecture/api/ais/transactions'
+require 'fintecture/api/ais/account_holders'
+require 'fintecture/api/ais/delete_customer'
+require 'fintecture/api/ais/authorize'
+require 'fintecture/api/ais/authorize_decoupled'
+
+module Fintecture
+  class AisClient
+    @environment = 'sandbox'
+    @environments = %w[local sandbox production].freeze
+
+    def initialize(config)
+      @app_id = config[:app_id]
+      @app_secret = config[:app_secret]
+      @private_key = config[:private_key]
+
+      environment = config[:environment].downcase
+      unless environment.include?(environment)
+        raise "#{environment} not a valid environment, options are [#{environment.join(', ')}]"
+      end
+
+      @environment = environment
+    end
+
+    # Getters
+    attr_reader :app_id, :app_secret, :private_key, :environment, :token, :token_expires_in, :refresh_token
+
+    #  Methodes
+    def connect(state, redirect_uri, scope = nil)
+      res = Fintecture::Ais::Connect.generate self, state, redirect_uri, scope
+
+      JSON.parse res.body
+    end
+
+    def generate_token(auth_code)
+      res = Fintecture::Authentication.get_access_token self, auth_code
+      body = JSON.parse res.body
+      @token = body['access_token']
+      @token_expires_in = body['expires_in']
+      @refresh_token = body['refresh_token']
+
+      body
+    end
+
+    def generate_refresh_token(refresh_token = nil)
+      res = Fintecture::Authentication.refresh_token self, (refresh_token || @refresh_token)
+      body = JSON.parse res.body
+      @token = body['access_token']
+
+      body
+    end
+
+    def accounts(customer_id:, account_id: nil, remove_nulls: nil, withBalances: nil)
+      res = Fintecture::Ais::Accounts.get self, customer_id, account_id, remove_nulls, withBalances
+
+      JSON.parse res.body
+    end
+
+    def transactions(customer_id:, account_id:, remove_nulls: nil, convert_dates: nil, filters: nil)
+      res = Fintecture::Ais::Transactions.get self, customer_id, account_id, remove_nulls, convert_dates, filters
+
+      JSON.parse res.body
+    end
+
+    def account_holders(customer_id:, remove_nulls: nil)
+      res = Fintecture::Ais::AccountHolders.get self, customer_id, remove_nulls
+
+      JSON.parse res.body
+    end
+
+    def delete_customer(customer_id:)
+      res = Fintecture::Ais::DeleteCustomer.delete self, customer_id
+
+      JSON.parse res.body
+    end
+
+    def authorize(provider_id:, redirect_uri:, app_id_auth: false, state: nil, x_psu_id: nil, x_psu_ip_address: nil)
+      res = Fintecture::Ais::Authorize.get self, app_id_auth, provider_id, redirect_uri, state, x_psu_id,
+                                           x_psu_ip_address
+
+      JSON.parse res.body
+    end
+
+    def authorize_decoupled(provider_id:, polling_id:, app_id_auth: false)
+      res = Fintecture::Ais::AuthorizeDecoupled.get self, app_id_auth, provider_id, polling_id
+
+      JSON.parse res.body
+    end
+  end
+end

data/lib/fintecture/api/ais/account_holders.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+require 'faraday'
+require 'fintecture/utils/validation'
+require 'fintecture/exceptions'
+require 'fintecture/utils/date'
+require 'fintecture/utils/constants'
+
+module Fintecture
+  module Ais
+    class AccountHolders
+      class << self
+        # ------------ PUBLIC METHOD ------------
+        def get(client, customer_id, remove_nulls)
+          @client = client
+
+          # Do the request
+          _request customer_id, remove_nulls
+        end
+
+        private
+
+        # ------------ REQUEST ------------
+        def _request(customer_id, remove_nulls)
+          # Get the url request
+          url = _endpoint customer_id
+
+          # Build uri params
+          query_string = ''
+          if remove_nulls
+            params = {}
+            params['remove_nulls'] = remove_nulls if remove_nulls
+            query_string = "?#{params.map { |key, value| "#{key}=#{value}" }.join('&')}"
+          end
+
+          # Do connect request
+          Fintecture::Faraday::Authentication::Connection.get(
+            url: url + query_string,
+            client: @client,
+            custom_content_type: 'application/json',
+            bearer: "Bearer #{@client.token}",
+            secure_headers: true
+          )
+        end
+
+        # ------------ API ENDPOINT ------------
+        def _endpoint(customer_id)
+          "#{_api_base_url}/#{Fintecture::Api::Endpoints::Ais::ACCOUNTHOLDERS}/#{customer_id}/accountholders"
+        end
+
+        # ------------ BASE URL ------------
+        def _api_base_url
+          Fintecture::Api::BaseUrl::FINTECTURE_API_URL[@client.environment.to_sym]
+        end
+
+      end
+    end
+  end
+end

data/lib/fintecture/api/ais/accounts.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+require 'faraday'
+require 'fintecture/utils/validation'
+require 'fintecture/exceptions'
+require 'fintecture/utils/date'
+require 'fintecture/utils/constants'
+
+module Fintecture
+  module Ais
+    class Accounts
+      class << self
+        # ------------ PUBLIC METHOD ------------
+        def get(client, customer_id, account_id, remove_nulls, withBalances)
+          @client = client
+
+          # Do the request
+          _request customer_id, account_id, remove_nulls, withBalances
+        end
+
+        private
+
+        # ------------ REQUEST ------------
+        def _request(customer_id, account_id, remove_nulls, withBalances)
+          # Get the url request
+          url = _endpoint customer_id, account_id
+
+          # Build uri params
+          query_string = ''
+          if remove_nulls || withBalances
+            params = {}
+            params['remove_nulls'] = remove_nulls if remove_nulls
+            params['withBalances'] = withBalances if withBalances
+
+            query_string = "?#{params.map { |key, value| "#{key}=#{value}" }.join('&')}"
+          end
+
+          # Do connect request
+          Fintecture::Faraday::Authentication::Connection.get(
+            url: url + query_string,
+            client: @client,
+            custom_content_type: 'application/json',
+            bearer: "Bearer #{@client.token}",
+            secure_headers: true
+          )
+        end
+
+        # ------------ API ENDPOINT ------------
+        def _endpoint(customer_id, account_id)
+          "#{_api_base_url}/#{Fintecture::Api::Endpoints::Ais::ACCOUNTS}/#{customer_id}/accounts/#{account_id || ''}"
+        end
+
+        # ------------ BASE URL ------------
+        def _api_base_url
+          Fintecture::Api::BaseUrl::FINTECTURE_API_URL[@client.environment.to_sym]
+        end
+
+      end
+    end
+  end
+end

data/lib/fintecture/api/ais/authorize.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+require 'faraday'
+require 'fintecture/utils/validation'
+require 'fintecture/exceptions'
+require 'fintecture/utils/date'
+require 'fintecture/utils/constants'
+
+module Fintecture
+  module Ais
+    class Authorize
+      class << self
+        # ------------ PUBLIC METHOD ------------
+        def get(client, app_id_auth, provider_id, redirect_uri, state, x_psu_id, x_psu_ip_address)
+          @client = client
+
+          # Do the request
+          _request app_id_auth, provider_id, redirect_uri, state, x_psu_id, x_psu_ip_address
+        end
+
+        private
+
+        # ------------ REQUEST ------------
+        def _request(app_id_auth, provider_id, redirect_uri, state, x_psu_id, x_psu_ip_address)
+          # Get the url request
+          url = _endpoint provider_id
+
+          # Build uri params
+          query_string = ''
+
+          params = {}
+          params['response_type'] = 'code' if app_id_auth
+          params['redirect_uri'] = redirect_uri if redirect_uri
+          params['state'] = state if state
+          params['model'] = 'redirect'
+
+          query_string = "?#{params.map { |key, value| "#{key}=#{value}" }.join('&')}"
+
+          # Build additional headers
+          additional_headers = {}
+          additional_headers['app_id'] = @client.app_id if app_id_auth
+          additional_headers['x-psu-id'] = x_psu_id if x_psu_id
+          additional_headers['x-psu-ip-address'] = x_psu_ip_address if x_psu_ip_address
+
+          # Do connect request
+          Fintecture::Faraday::Authentication::Connection.get(
+            url: url + query_string,
+            client: @client,
+            custom_content_type: 'application/json',
+            bearer: "Bearer #{@client.token}",
+            secure_headers: true,
+            additional_headers: additional_headers,
+            disableAuthorization: app_id_auth ? true : false
+          )
+        end
+
+        # ------------ API ENDPOINT ------------
+        def _endpoint(provider_id)
+          "#{_api_base_url}/#{Fintecture::Api::Endpoints::Ais::AUTHORIZE}/#{provider_id}/authorize"
+        end
+
+        # ------------ BASE URL ------------
+        def _api_base_url
+          Fintecture::Api::BaseUrl::FINTECTURE_API_URL[@client.environment.to_sym]
+        end
+
+      end
+    end
+  end
+end

data/lib/fintecture/api/ais/authorize_decoupled.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+require 'faraday'
+require 'fintecture/utils/validation'
+require 'fintecture/exceptions'
+require 'fintecture/utils/date'
+require 'fintecture/utils/constants'
+
+module Fintecture
+  module Ais
+    class AuthorizeDecoupled
+      class << self
+        # ------------ PUBLIC METHOD ------------
+        def get(client, app_id_auth, provider_id, polling_id)
+          @client = client
+
+          # Do the request
+          _request app_id_auth, provider_id, polling_id
+        end
+
+        private
+
+        # ------------ REQUEST ------------
+        def _request(app_id_auth, provider_id, polling_id)
+          # Get the url request
+          url = _endpoint provider_id, polling_id
+
+          # Build uri params
+          query_string = ''
+
+          params = {}
+          params['response_type'] = 'code' if app_id_auth
+          params['model'] = 'decoupled'
+
+          query_string = "?#{params.map { |key, value| "#{key}=#{value}" }.join('&')}"
+
+          # Build additional headers
+          additional_headers = {}
+          additional_headers['app_id'] = @client.app_id if app_id_auth
+
+          # Do connect request
+          Fintecture::Faraday::Authentication::Connection.get(
+            url: url + query_string,
+            client: @client,
+            custom_content_type: 'application/json',
+            bearer: "Bearer #{@client.token}",
+            secure_headers: true,
+            additional_headers: additional_headers,
+            disableAuthorization: app_id_auth ? true : false
+          )
+        end
+
+        # ------------ API ENDPOINT ------------
+        def _endpoint(provider_id, polling_id)
+          "#{_api_base_url}/#{Fintecture::Api::Endpoints::Ais::AUTHORIZE}/#{provider_id}/authorize/decoupled/#{polling_id}"
+        end
+
+        # ------------ BASE URL ------------
+        def _api_base_url
+          Fintecture::Api::BaseUrl::FINTECTURE_API_URL[@client.environment.to_sym]
+        end
+
+      end
+    end
+  end
+end

data/lib/fintecture/api/ais/connect.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+require 'faraday'
+require 'fintecture/utils/validation'
+require 'fintecture/exceptions'
+require 'fintecture/utils/date'
+require 'fintecture/utils/constants'
+
+module Fintecture
+  module Ais
+    class Connect
+      class << self
+        # ------------ PUBLIC METHOD ------------
+        def generate(client, state, redirect_uri, scope)
+          @client = client
+
+          # Do the request
+          _request state, redirect_uri, scope
+        end
+
+        private
+
+        # ------------ REQUEST ------------
+        def _request(state, redirect_uri, scope)
+          # Get the url request
+          url = _endpoint
+
+          # Build uri params
+          params = {}
+          params['state'] = state
+          params['redirect_uri'] = redirect_uri
+          params['scope'] = scope if scope
+
+          query_string = "?#{params.map { |key, value| "#{key}=#{value}" }.join('&')}"
+
+          # Build additional headers
+          additional_headers = {}
+          additional_headers['app_id'] = @client.app_id
+
+          # Do connect request
+          Fintecture::Faraday::Authentication::Connection.get(
+            url: url + query_string,
+            client: @client,
+            custom_content_type: 'application/json',
+            secure_headers: true,
+            additional_headers: additional_headers
+          )
+        end
+
+        # ------------ API ENDPOINT ------------
+        def _endpoint
+          "#{_api_base_url}/#{Fintecture::Api::Endpoints::Ais::CONNECT}"
+        end
+
+        # ------------ BASE URL ------------
+        def _api_base_url
+          Fintecture::Api::BaseUrl::FINTECTURE_API_URL[@client.environment.to_sym]
+        end
+
+      end
+    end
+  end
+end