slimpay 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da6174b556ef0ad19597db53786c756bb69f45cc
+  data.tar.gz: 2359c26e53cdab82ee2b14c88710465cc3485dca
+SHA512:
+  metadata.gz: 2c7a087742b691ad7b73477dafb57c970d25131d93ddad0d44e17c5858790eae2f16de1e7ecbf2875a23f80a1a3c88a812df61e1addf3327fc58bdc7d1734257
+  data.tar.gz: 7de499353a64bd599284e87854305c86fbccd26399268d99433f25eea67a8bc1a79d22ac185e3c00bd41a676bd8619b382af55d32b24a03fc591738c7e6932a1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+builds/
+*.DS_Store

data/.gitlab-ci.yml

@@ -0,0 +1,12 @@
+before_script:
+  - gem install bundler -v 1.10.4
+  - bundle install
+
+rspec:
+  script:
+    - 'rake spec'
+    - 'rubocop --config .rubocop.yml --force-exclusion'
+  tags:
+    - ruby
+  only:
+    - branches

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,134 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+  RunRailsCops: false
+
+LineLength:
+  Max: 160
+  Severity: error
+
+MethodLength:
+  Max: 40
+  Severity: error
+
+AbcSize:
+  Max:  35
+
+PerceivedComplexity:
+  Max: 8
+
+TrailingBlankLines:
+  Severity: error
+
+EndOfLine:
+  Severity: error
+
+TrailingComma:
+  EnforcedStyleForMultiline: no_comma
+  Severity: error
+
+EmptyLines:
+  Severity: error
+
+### Disabled checks
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+AccessModifierIndentation:
+  Enabled: false
+
+EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+RedundantBegin:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+RedundantSelf:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+PredicateName:
+  Enabled: false
+
+BlockComments:
+  Enabled: false
+
+UnusedBlockArgument:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  Enabled: false
+
+### Following checks should be enabled once we decide on the style to use
+
+IfUnlessModifier:
+  Enabled: false
+
+AlignArray:
+  Enabled: false
+
+AlignHash:
+  Enabled: false
+
+AlignParameters:
+  Enabled: false
+
+SpaceBeforeBlockBraces:
+  Enabled: false
+
+SpaceInsideBlockBraces:
+  Enabled: false
+
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+HashSyntax:
+  Enabled: false
+
+ParenthesesAroundCondition:
+  Enabled: false
+
+CollectionMethods:
+  Enabled: false
+
+AndOr:
+  Enabled: false
+
+RescueModifier:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+IndentationWidth:
+  Enabled: false
+
+EndAlignment:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+
+language: ruby
+cache: bundler
+rvm:
+  - "2.2.3"
+script:
+  - bundle exec rspec
+  - bundle exec rubocop -R --config .rubocop.yml --fail-level error --force-exclusion

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slimpay.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Gregory Durelle
+
+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,172 @@
+[![Build Status](https://travis-ci.org/novagile/slimpay.svg)](https://travis-ci.org/novagile/slimpay)
+
+# Slimpay
+
+Ruby implementation of the Slimpay Hypermedia API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slimpay'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slimpay
+
+
+## Usage
+
+**API Docs: https://api-sandbox.slimpay.net/docs/**
+
+### Configuration
+
+If you use _Rails_ place this code in _config/initializers/slimpay.rb_:
+
+```ruby
+Slimpay.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.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://api-sandbox.slimpay.net/docs/alps/v1/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
+```
+:warning: If you call ```Slimpay::Base.new``` without arguments, the _Sandbox_ credentials will be used.
+
+Result will be a Hash:
+
+```ruby
+{"self"=>"https://api-sandbox.slimpay.net/"
+"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"}
+```
+
+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-sandbox.slimpay.net/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-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}
+```
+
+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 rspec` 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/novagile/slimpay. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.formatters = ['progress']
+  task.fail_on_error = false
+  task.options = ["--config", ".rubocop.yml", "--force-exclusion"]
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'slimpay'
+
+# 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

data/bin/setup

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

data/lib/slimpay/app.rb

@@ -0,0 +1,54 @@
+module Slimpay
+  # Used only to get and set callback URLs.
+  class App < Resource
+    # Prepare an admin token for app requests.
+    #
+    # Arguments:
+    #   username: Your Slimpay admin username
+    #   password: Your Slimpay admin password
+    def initialize(username = nil, password = nil)
+      init_config
+      @username = username || Slimpay.configuration.username
+      @password = password || Slimpay.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 returnUrl
+    # ===== Example:
+    #   app = Slimpay::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)
+      Slimpay.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)
+      Slimpay.answer(response)
+    end
+
+    # Change the notification and return URLs.
+    #
+    # ===== Arguments:
+    #   returnUrl: (String) URL to your app the customer is gonna be redirected to when leaving Slimpay platform.
+    #   notifyUrl: (String) URL to your app Slimpay 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)
+      Slimpay.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/base.rb

@@ -0,0 +1,176 @@
+module Slimpay
+  # Defines constants, main variables, requests options.
+  #
+  # Connect to the HAPI through OAuth2 and generates HAPI's first resources GET methods.
+  # ===== Usage:
+  #   slimpay = Slimpay::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
+      Slimpay.configuration ||= Slimpay::Configuration.new
+      @client_id = Slimpay.configuration.client_id
+      @client_secret = Slimpay.configuration.client_secret
+      @creditor_reference = Slimpay.configuration.creditor_reference
+      @sandbox = Slimpay.configuration.sandbox
+      @return_url = Slimpay.configuration.return_url
+      @notify_url = Slimpay.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)
+      Slimpay.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)
+      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')
+        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)
+          follow_up_api(response)
+        else
+          clean_url = url.gsub(/{\?.*/, '')
+          url_args = format_html_arguments(api_args, method_arguments)
+          response = HTTParty.get("#{clean_url}?#{url_args}", headers: options)
+          follow_up_api(response)
+        end
+      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) Slimpay 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|
+        url_args += "#{arg}=#{method_arguments[arg.to_sym]}"
+        url_args += '&' if (index + 1) < api_args.size
+      end
+      url_args
+    end
+
+    # Create the 'api_methods' instance method to retrieve an array of API methods previously created.
+    #
+    # ===== Usage:
+    #   slim = Slimpay::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 = Slimpay.answer(response)
+      generate_api_methods(JSON.parse(response))
+      answer
+    end
+
+    def oauth_options
+      {
+        'Accept' => @sandbox ? SANDBOX_API_HEADER : API_HEADER,
+        'Content-type' => 'application/hal+json',
+        'grant_type' => 'client_credentials',
+        'scope' => 'api_admin'
+      }
+    end
+
+    def options
+      { 'Authorization' => "Bearer #{@token}", 'Content-type' => 'application/json' }
+    end
+
+    def sandbox?
+      @sandbox || @client_id.eql?('democreditor01') ? true : false
+    end
+  end
+end

data/lib/slimpay/configuration.rb

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

data/lib/slimpay/direct_debit.rb

@@ -0,0 +1,38 @@
+module Slimpay
+  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))
+      Slimpay.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/error.rb

@@ -0,0 +1,80 @@
+module Slimpay
+  # To display Slimpay error messages with the HTTP code.
+  #
+  # ==== Possible HAPI 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
+      { 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)
+      end
+      fail self, @message
+    end
+
+    def to_s
+      @message
+    end
+
+    private
+
+    def display_http_error(http_response)
+      case http_response.code
+      when 400
+        @message = bad_request(http_response)
+      when 401
+        @message = unauthorized(http_response)
+      when 403
+        @message = forbidden(http_response)
+      when 404
+        @message = not_found
+      when 406
+        @message = not_acceptable(http_response)
+      else
+        @message = 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)
+      slimpay_code = slimpay_error['code']
+      slimpay_message = slimpay_error['message'] || slimpay_error['error_description']
+      "Slimpay #{slimpay_code} : #{slimpay_message}"
+    end
+  end
+end

data/lib/slimpay/mandate.rb

@@ -0,0 +1,4 @@
+module Slimpay
+  class Mandate < Resource
+  end
+end

data/lib/slimpay/order.rb

@@ -0,0 +1,104 @@
+module Slimpay
+  # 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 = Slimpay::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. Slimpay 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/resource.rb

@@ -0,0 +1,29 @@
+module Slimpay
+  # An abstract resource to be inherited from.
+  #
+  # Defines HAPI 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 = Slimpay::Mandate.new
+    #   mandates.get_mandates({creditorReference: @creditor_reference, reference: 1})
+    #
+    # ===== Example:
+    #   mandates = Slimpay::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))
+      Slimpay.answer(response)
+    end
+  end
+end

data/lib/slimpay/version.rb

@@ -0,0 +1,3 @@
+module Slimpay
+  VERSION = '1.0.0'
+end

data/lib/slimpay.rb

@@ -0,0 +1,61 @@
+require 'slimpay/version'
+require 'oauth2'
+require 'httparty'
+
+require 'active_support/core_ext/string/inflections'
+
+require 'slimpay/configuration'
+require 'slimpay/error'
+require 'slimpay/base'
+require 'slimpay/resource'
+require 'slimpay/app'
+require 'slimpay/mandate'
+require 'slimpay/order'
+require 'slimpay/direct_debit'
+
+# :main: README.md
+
+# Slimpay 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 Slimpay
+  PRODUCTION_ENDPOINT = 'https://api.slimpay.net'
+  API_HEADER = "application/hal+json; profile='https://api.slimpay.net/alps/v1'"
+  SANDBOX_API_HEADER = "application/hal+json; profile='https://api-sandbox.slimpay.net/alps/v1'"
+  SANDBOX_ENDPOINT = 'https://api-sandbox.slimpay.net'
+  SANDBOX_CLIENT_ID = 'democreditor01'
+  SANDBOX_SECRET_ID = 'demosecret01'
+  SANDBOX_CREDITOR = 'democreditor'
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Sets the initial configuration for client_id, client_secret and creditor_reference
+  # ===== Usage:
+  #   Slimpay.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.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 Slimpay::Error.empty if http_response.nil?
+    if http_response.code >= 400
+      Slimpay::Error.new(http_response)
+    else
+      http_response
+    end
+  end
+end

data/slimpay.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slimpay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'slimpay'
+  spec.version       = Slimpay::VERSION
+  spec.authors       = ['Gregory Durelle']
+  spec.email         = ['gregory.durelle@gmail.com']
+
+  spec.summary       = %(Slimpay HAPI for Ruby.)
+  spec.description   = %(Ruby library for Slimpay's Hypermedia API.)
+  spec.homepage      = "https://github.com/novagile/slimpay"
+  spec.license       = 'MIT'
+
+  spec.post_install_message = %(Please refer to Slimpay's API https://api-sandbox.slimpay.net/docs for more informations.)
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'oauth2', '~> 0.9.0'
+  spec.add_dependency 'httparty', '~> 0.13.5'
+  spec.add_dependency 'activesupport', '~> 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3.0'
+  spec.add_development_dependency 'vcr', '~> 2.9.0'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+  spec.add_development_dependency 'rubocop', '~> 0.32.1'
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: slimpay
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gregory Durelle
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+description: Ruby library for Slimpay's Hypermedia API.
+email:
+- gregory.durelle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slimpay.rb
+- lib/slimpay/app.rb
+- lib/slimpay/base.rb
+- lib/slimpay/configuration.rb
+- lib/slimpay/direct_debit.rb
+- lib/slimpay/error.rb
+- lib/slimpay/mandate.rb
+- lib/slimpay/order.rb
+- lib/slimpay/resource.rb
+- lib/slimpay/version.rb
+- slimpay.gemspec
+homepage: https://github.com/novagile/slimpay
+licenses:
+- MIT
+metadata: {}
+post_install_message: Please refer to Slimpay's API https://api-sandbox.slimpay.net/docs
+  for more informations.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Slimpay HAPI for Ruby.
+test_files: []