slimpay_client 0.1.0

data/lib/slimpay_client/card.rb

@@ -0,0 +1,18 @@
+module SlimpayClient
+  # An abstract CardAlias to be inherited from.
+  #
+  # Defines API CardAlias non-semantic methods.
+  class Card < Resource
+    def initialize
+      @resource_name = self.class.to_s.demodulize.underscore.dasherize.pluralize
+      super
+    end
+
+    def get_one(id = 1)
+      url = "#{@endpoint}/cards/#{id}"
+      response = HTTParty.get(url, headers: options)
+      generate_api_methods(JSON.parse(response.body))
+      SlimpayClient.answer(response)
+    end
+  end
+end

data/lib/slimpay_client/card_alias.rb

@@ -0,0 +1,18 @@
+module SlimpayClient
+  # An abstract CardAlias to be inherited from.
+  #
+  # Defines API CardAlias non-semantic methods.
+  class CardAlias < Resource
+    def initialize
+      @resource_name = self.class.to_s.demodulize.underscore.dasherize.pluralize
+      super
+    end
+
+    def get_one(id = 1)
+      url = "#{@endpoint}/card_aliases/#{id}"
+      response = HTTParty.get(url, headers: options)
+      generate_api_methods(JSON.parse(response.body))
+      SlimpayClient.answer(response)
+    end
+  end
+end

data/lib/slimpay_client/configuration.rb

@@ -0,0 +1,27 @@
+module SlimpayClient
+  class Configuration
+    attr_accessor :client_id
+    attr_accessor :client_secret
+    attr_accessor :creditor_reference
+    attr_accessor :sandbox
+    attr_accessor :success_url
+    attr_accessor :failure_url
+    attr_accessor :cancel_url
+    attr_accessor :return_url
+    attr_accessor :notify_url
+    attr_accessor :username
+    attr_accessor :password
+
+    def initialize
+      @client_id = SlimpayClient::SANDBOX_CLIENT_ID
+      @client_secret = SlimpayClient::SANDBOX_SECRET_ID
+      @creditor_reference = SlimpayClient::SANDBOX_CREDITOR
+      @sandbox = true
+      @success_url = 'localhost:5000'
+      @failure_url = 'localhost:5000'
+      @cancel_url = 'localhost:5000'
+      @return_url = 'localhost:5000'
+      @notify_url = 'localhost:5000'
+    end
+  end
+end

data/lib/slimpay_client/creditor.rb

@@ -0,0 +1,18 @@
+module SlimpayClient
+  # An abstract Creditor to be inherited from.
+  #
+  # Defines API Creditor non-semantic methods.
+  class Creditor < Resource
+    def initialize
+      @resource_name = self.class.to_s.demodulize.underscore.dasherize.pluralize
+      super
+    end
+
+    def get_one(reference = 1)
+      url = "#{@endpoint}/creditors/#{reference}"
+      response = HTTParty.get(url, headers: options)
+      generate_api_methods(JSON.parse(response.body))
+      SlimpayClient.answer(response)
+    end
+  end
+end

data/lib/slimpay_client/direct_debit.rb

@@ -0,0 +1,38 @@
+module SlimpayClient
+  class DirectDebit < Resource
+    # Override the Resource#get_one method because the url is not the same for DirectDebits
+    #
+    def get_one(reference = 1)
+      url = "#{@endpoint}/#{@resource_name}/#{reference}"
+      response = HTTParty.get(url, headers: options)
+      generate_api_methods(JSON.parse(response.body))
+      SlimpayClient.answer(response)
+    end
+
+    # Alias method for create_direct_debits
+    # ===== Arguments
+    #   debit_hash: (Hash) Your payment informations. See API DirectDebit documentation for details.
+    #
+    #   /!\ Amount as to be rounded to maximum 2 numbers after comma.
+    #   If not you'll receive an error : { "code" : 100, "message" : "Internal error : Rounding necessary" }
+    def make_payment(debit_hash = default_debit_hash)
+      self.create_direct_debits(debit_hash)
+    end
+
+    private
+
+    def default_debit_hash
+      {
+        creditor: {
+          reference: @creditor_reference
+        },
+        mandate: {
+          rum: '1'
+        },
+        amount: 100.00,
+        label: 'The label',
+        paymentReference: 'Payment 123'
+      }
+    end
+  end
+end

data/lib/slimpay_client/error.rb

@@ -0,0 +1,80 @@
+module SlimpayClient
+  # To display SlimpayClient error messages with the HTTP code.
+  #
+  # ==== Possible API errors
+  # * code: 906 message: "Error : Could not find acceptable representation"
+  # * code: 906 message: "Error : Request method 'POST' not supported"
+  # * code: 906 message: "Error : Content type 'application/x-www-form-urlencoded' not supported"
+  # * code: 904 message: "Access denied : cannot access creditor democreditor"
+  # * error:"invalid_token", error_description: "Invalid access token: 1234-123456-abcdef-123456"
+  # * code: 205, message: "Client data are inconsistent : missing query parameters creditorReference and/or rum"
+  class Error < StandardError
+    attr_reader :message
+    # If the HTTP response is nil or empty returns an actual message.
+    def self.empty
+      @message = {code: 418, message: 'The answer was empty.'}
+    end
+
+    # Returns either formated error with its HTTP code or the raw HTTP response.
+    # ===== Arguments:
+    #   http_response: (HTTParty::Response)
+    def initialize(http_response)
+      if defined?(http_response.code)
+        display_http_error(http_response)
+      else
+        @message = JSON.parse(http_response.body)
+      end
+      fail self, @message.to_s
+    end
+
+    def to_s
+      @message
+    end
+
+    private
+
+    def display_http_error(http_response)
+      @message = case http_response.code
+                 when 400
+                   bad_request(http_response)
+                 when 401
+                   unauthorized(http_response)
+                 when 403
+                   forbidden(http_response)
+                 when 404
+                   not_found
+                 when 406
+                   not_acceptable(http_response)
+                 else
+                   http_response
+                 end
+    end
+
+    def bad_request(http_message)
+      {code: 400, message: "HTTP Bad Request. #{slimpay_error(http_message)}"}
+    end
+
+    def unauthorized(http_message)
+      {code: 401, message: "HTTP Unauthorized. #{slimpay_error(http_message)}"}
+    end
+
+    def forbidden(http_message)
+      {code: 403, message: "HTTP Forbidden. #{slimpay_error(http_message)}"}
+    end
+
+    def not_found
+      {code: 404, message: 'URI not found.'}
+    end
+
+    def not_acceptable(http_message)
+      {code: 406, message: "HTTP Not Acceptable. #{slimpay_error(http_message)}"}
+    end
+
+    def slimpay_error(http_message)
+      slimpay_error = http_message.is_a?(Hash) ? http_message : JSON.parse(http_message.body)
+      slimpay_code = slimpay_error['code']
+      slimpay_message = slimpay_error['message'] || slimpay_error['error_description']
+      "SlimpayClient #{slimpay_code} : #{slimpay_message}"
+    end
+  end
+end

data/lib/slimpay_client/mandate.rb

@@ -0,0 +1,18 @@
+module SlimpayClient
+  class Mandate < Resource
+    # POST
+    def revoke(id = 'mandate01')
+      url = "mandates/#{id}/revocation"
+      body_options = {}
+      response = HTTParty.post("#{@endpoint}/#{url}", body: body_options.to_json, headers: options)
+      follow_up_api(response)
+    end
+
+    def document(id = 'mandate01')
+      url = "mandates/#{id}/document"
+      body_options = {}
+      response = HTTParty.get("#{@endpoint}/#{url}", body: body_options.to_json, headers: options)
+      follow_up_api(response)
+    end
+  end
+end

data/lib/slimpay_client/order.rb

@@ -0,0 +1,108 @@
+module SlimpayClient
+  # Inherits from Resouce and thus defines its associated resource's methods.
+  #
+  # Defines shortcut methods for the create_order method with various arguments.
+  class Order < Resource
+    # Override the Resource#get_one method because the url is not the same for Orders
+    #
+    # ===== Example:
+    #   orders = SlimpayClient::Order.new
+    #   orders.get_one
+    #   =>
+    #     {"_links"=>
+    #       {"self"=>{"href"=>"https://api-sandbox.slimpay.net/creditors/democreditor/orders/1"},
+    #        "https://api.slimpay.net/alps#get-creditor"=>{"href"=>"https://api-sandbox.slimpay.net/creditors/democreditor"},
+    #        "https://api.slimpay.net/alps#get-subscriber" =>
+    #           {"href"=>"https://api-sandbox.slimpay.net/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-sandbox.slimpay.net/creditors/democreditor/orders/1/items"},
+    #        "https://api.slimpay.net/alps#get-mandate"=>{"href"=>"https://api-sandbox.slimpay.net/creditors/democreditor/mandates/1"}},
+    #      "reference"=>"1",
+    #      "state"=>"closed.completed",
+    #      "started"=>true,
+    #      "dateCreated"=>"2014-12-12T09:35:39.000+0000",
+    #      "mandateReused"=>false}
+    # ===== Arguments:
+    #   reference: (String)
+    def get_one(reference = 1)
+      query_options = "creditorReference=#{@creditor_reference}&reference=#{reference}"
+      response = HTTParty.get("#{@endpoint}/#{@resource_name}?#{query_options}", headers: options)
+      follow_up_api(response)
+    end
+
+    # POST
+    def login(reference = 'subscriber01')
+      url = 'orders'
+      body_options = {
+        creditor: {
+          reference: @creditor_reference
+        },
+        subscriber: {
+          reference: reference
+        },
+        items: [
+          {
+            type: 'subscriberLogin'
+          }
+        ],
+        started: true
+      }
+      response = HTTParty.post("#{@endpoint}/#{url}", body: body_options.to_json, headers: options)
+      follow_up_api(response)
+    end
+
+    # POST
+    # This will send a create_order request with given signatory (subscriber Hash with infos)
+    #
+    # In case of success, this will generate a method accessible via the _.api_methods_ method.
+    # This method let you redirect the customer to the approval page : orders.api_methods['user_approval']
+    # ===== Arguments
+    #   reference: (String) The reference to your User in your application. Use a unique key. SlimpayClient will refer to it for future answers.
+    #   signatory: (Hash) Your customer informations. See API Order documentation for details.
+    # ===== Returns
+    #   a Hash representing the Mandate.
+    def sign_mandate(reference = 'subscriber01', signatory = default_signatory)
+      url = 'orders'
+      body_options = {
+        creditor: {
+          reference: @creditor_reference
+        },
+        subscriber: {
+          reference: reference
+        },
+        items: [
+          {
+            type: 'signMandate',
+            mandate: {
+              standard: 'SEPA',
+              signatory: signatory
+            }
+          }
+        ],
+        started: true
+      }
+      response = HTTParty.post("#{@endpoint}/#{url}", body: body_options.to_json, headers: options)
+      JSON.parse(follow_up_api(response))
+    end
+
+    private
+
+    def default_signatory
+      {
+        honorificPrefix: 'Mr',
+        familyName: 'Doe',
+        givenName: 'John',
+        telephone: '+33612345678',
+        email: 'john.doe@gmail.com',
+        billingAddress: {
+          street1: '27 rue des fleurs',
+          street2: 'Bat 2',
+          postalCode: '75008',
+          city: 'Paris',
+          country: 'FR'
+        }
+      }
+    end
+  end
+end

data/lib/slimpay_client/payment.rb

@@ -0,0 +1,39 @@
+module SlimpayClient
+  # An abstract Payment to be inherited from.
+  #
+  # Defines API Payment non-semantic methods.
+  class Payment < Resource
+    def initialize
+      @resource_name = self.class.to_s.demodulize.underscore.dasherize.pluralize
+      super
+    end
+
+    def get_one(id = 1)
+      url = "#{@endpoint}/payments/#{id}"
+      response = HTTParty.get(url, headers: options)
+      generate_api_methods(JSON.parse(response.body))
+      SlimpayClient.answer(response)
+    end
+
+    def issues(id = 1)
+      url = "#{@endpoint}/payments/#{id}/issues"
+      response = HTTParty.get(url, headers: options)
+      generate_api_methods(JSON.parse(response.body))
+      SlimpayClient.answer(response)
+    end
+
+    def refund(id, amount)
+      url = "payments/#{id}/refund"
+      body_options = {amount: amount}
+      response = HTTParty.post("#{@endpoint}/#{url}", body: body_options.to_json, headers: options)
+      follow_up_api(response)
+    end
+
+    def cancel(id)
+      url = "payments/#{id}/cancellation"
+      body_options = {}
+      response = HTTParty.post("#{@endpoint}/#{url}", body: body_options.to_json, headers: options)
+      follow_up_api(response)
+    end
+  end
+end

data/lib/slimpay_client/recurrent_card_transaction.rb

@@ -0,0 +1,25 @@
+module SlimpayClient
+  # An abstract CardAlias to be inherited from.
+  #
+  # Defines API CardAlias non-semantic methods.
+  class RecurrentCardTransaction < Resource
+    def initialize
+      @resource_name = self.class.to_s.demodulize.underscore.dasherize.pluralize
+      super
+    end
+
+    def get_one(id = 1)
+      url = "#{@endpoint}/recurrent_card_transaction/#{id}"
+      response = HTTParty.get(url, headers: options)
+      generate_api_methods(JSON.parse(response.body))
+      SlimpayClient.answer(response)
+    end
+
+    def cancel(id = 'card-transac-1')
+      url = "recurrent-card-transactions/#{id}/cancellation"
+      body_options = {}
+      response = HTTParty.post("#{@endpoint}/#{url}", body: body_options.to_json, headers: options)
+      follow_up_api(response)
+    end
+  end
+end

data/lib/slimpay_client/recurrent_direct_debit.rb

@@ -0,0 +1,25 @@
+module SlimpayClient
+  # An abstract CardAlias to be inherited from.
+  #
+  # Defines API CardAlias non-semantic methods.
+  class RecurrentDirectDebit < Resource
+    def initialize
+      @resource_name = self.class.to_s.demodulize.underscore.dasherize.pluralize
+      super
+    end
+
+    def get_one(id = 1)
+      url = "#{@endpoint}/recurrent-direct-debits/#{id}"
+      response = HTTParty.get(url, headers: options)
+      generate_api_methods(JSON.parse(response.body))
+      SlimpayClient.answer(response)
+    end
+
+    def cancel(id = 'rec-direct-debit1')
+      url = "recurrent-direct-debits/#{id}/cancellation"
+      body_options = {}
+      response = HTTParty.post("#{@endpoint}/#{url}", body: body_options.to_json, headers: options)
+      follow_up_api(response)
+    end
+  end
+end

data/lib/slimpay_client/resource.rb

@@ -0,0 +1,29 @@
+module SlimpayClient
+  # An abstract resource to be inherited from.
+  #
+  # Defines API resource non-semantic methods.
+  class Resource < Base
+    def initialize
+      @resource_name = self.class.to_s.demodulize.underscore.dasherize.pluralize
+      super
+    end
+
+    # Shortcut method to get a resource with only resource's reference.
+    #
+    # The above example shall return the same result as
+    #   mandates = SlimpayClient::Mandate.new
+    #   mandates.get_mandates({creditorReference: @creditor_reference, reference: 1})
+    #
+    # ===== Example:
+    #   mandates = SlimpayClient::Mandate.new
+    #   mandates.get_one(1)
+    # ===== Arguments:
+    #   reference: (String)
+    def get_one(reference = 1)
+      url = "#{@endpoint}/creditors/#{@creditor_reference}/#{@resource_name}/#{reference}"
+      response = HTTParty.get(url, headers: options)
+      generate_api_methods(JSON.parse(response.body))
+      SlimpayClient.answer(response)
+    end
+  end
+end

data/lib/slimpay_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SlimpayClient
+  VERSION = "0.1.0"
+end

data/lib/slimpay_client.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "slimpay_client/version"
+require 'oauth2'
+require 'httparty'
+
+require 'active_support/core_ext/string/inflections'
+
+require 'slimpay_client/configuration'
+require 'slimpay_client/error'
+require 'slimpay_client/base'
+require 'slimpay_client/resource'
+require 'slimpay_client/app'
+require 'slimpay_client/mandate'
+require 'slimpay_client/order'
+require 'slimpay_client/direct_debit'
+require 'slimpay_client/creditor'
+require 'slimpay_client/card_alias'
+require 'slimpay_client/card'
+require 'slimpay_client/recurrent_card_transaction'
+require 'slimpay_client/recurrent_direct_debit'
+require 'slimpay_client/payment'
+
+# SlimpayClient module defines Simpay's HAPI constants and require dependencies.
+# TODO: If-None-Match support. (next answer ?= 304)
+# TODO: wiki/doc full worflow: 1. App to change URls, 2. Order to sign mandate, 3. DirectDebit to pay with mandate.
+module SlimpayClient
+  PRODUCTION_ENDPOINT = 'https://api.slimpay.net'.freeze
+  SANDBOX_ENDPOINT = 'https://api.preprod.slimpay.com'.freeze
+  SANDBOX_CLIENT_ID = 'democreditor01'.freeze
+  SANDBOX_SECRET_ID = 'demosecret01'.freeze
+  SANDBOX_CREDITOR = 'democreditor'.freeze
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Sets the initial configuration for client_id, client_secret and creditor_reference
+  # ===== Usage:
+  #   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'
+  #     config.return_url = 'your_return_url'
+  #   end
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # Used to display HTTP requests responses nicely in case of error.
+  #
+  # ===== Arguments:
+  #   http_response: (HTTParty::Response)
+  def self.answer(http_response)
+    # return SlimpayClient::Error.empty if http_response.try(:body).nil?
+    return SlimpayClient::Error.empty if ( http_response.blank? || http_response.body.blank? )
+
+    if http_response.code >= 400
+      SlimpayClient::Error.new(http_response)
+    else
+      http_response.body
+    end
+  end
+end

data/sig/slimpay_client.rbs

@@ -0,0 +1,4 @@
+module SlimpayClient
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end