ethikdo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69e3c079fa419a6f528b987b6fd27532bbe32c13fc2edf835a2935b00d57e306
+  data.tar.gz: 36ba7a4fff07e5be5122067fda892a6dd2075c992f1f42e05ebb441e63773cb2
+SHA512:
+  metadata.gz: 81e308089d0537a5bf6f9ee25ac3820beb314b5b9ab1b64bde9b9aa11352008ed48439c526f40216b298a5ce9616e46bb8d0d149ce176e770e24e8b2eca078cc
+  data.tar.gz: f3b88b0ebe7307840a433e584557f28962c6e38b7392d25542cbbdd3c8b942f06ca5515d4a985dea0a50e50658cfc4ae406900a6e0df3c8ca3d75789cab74a0a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    ethikdo (0.0.1)
+      httparty (~> 0.16.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.2.2)
+      actionview (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.2.2)
+      activesupport (= 6.0.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    hashdiff (1.0.0)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.5.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    multi_xml (0.6.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (4.0.3)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    webmock (3.8.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ethikdo!
+  generator_spec (~> 0.9)
+  rake (~> 12)
+  rspec (~> 3.2)
+  webmock (~> 3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Benoit Baumann
+
+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,202 @@
+# Ethikdo
+
+This gem provides an easy way to manage transactions for Ethi'kdo card holders through the Ethi'kdo v1 REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ethikdo'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ethikdo
+
+## Usage
+
+__Configuration__
+
+The gem needs to be configured with your private API key. To do so, execute:
+
+```
+rails generate ethikdo:install
+```
+
+This will generate a file named `ethikdo.rb` in `config/initializers/` with the following content:
+
+```ruby
+Ethikdo.configure do |config|
+  config.api_key = ENV["ETHIKDO_API_KEY"]
+  config.environment = Rails.env.production? ? :production : :development
+end
+```
+
+Now, set up your private key as an environment variable in your `.env` file:
+
+```
+ETHIKDO_API_KEY = "Token XXXXXXX"
+```
+
+The gem can be configured for two environments: _production_ and _development_. By default, the gem's environment is set to _production_ if Rails is in _production_, else it is set to _development_.
+
+In _development_, the requests are sent to a test API provided by Ethi'kdo. The test API's url is:
+```
+https://recette.ethikdo.co/api/v1/
+```
+
+In _production_, the requests are sent to the real API:
+```
+https://www.ethikdo.co/api/v1
+```
+
+
+__Capture a paiement__
+
+The first step to capture a paiement is to obtain a capture token. This is done through the `Ethikdo::Provision` class and requires the card's number (16 digits) and card's secret key (3 digits):
+
+```ruby
+provision = Ethikdo::Provision.create(
+    card_number: card_number,
+    card_crypto: card_crypto
+)
+```
+If the card's credentials are correct, an `Ethikdo::Provision` object is returned:
+
+```ruby
+# Ethikdo::Provision:0x0000555a80009698
+ @capture_token = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+ @card_number = "1234123412341234",
+ @card_value = 500000,
+ @date_created = "2020-04-16T16:36:46.128007+02:00",
+ @date_used = nil,
+ @url = "https://recette.ethikdo.co/api/v1/provisions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/"
+```
+
+Once you have obtained the capture token, you can now use the `Ethikdo::Transaction` class to capture the paiement:
+
+```ruby
+transaction = Ethikdo::Transaction.create(
+    capture_token: capture_token,
+    amount_requested: order.total_price_cents,
+    amount_purchased: order.total_price_cents,
+    transaction_id: order.id,
+    customer_email: nil
+)
+```
+
+If the transaction succeeds, an `Ethikdo::Transaction` object is returned:
+
+```ruby
+# Ethikdo::Transaction:0x0000555a82216f38
+ @amount_debited = 100000,
+ @amount_purchased = 100000,
+ @cancelled = false,
+ @card_number = "1234123412341234",
+ @date = "2020-04-16T15:25:56.451488Z",
+ @transaction_id = "1",
+ @url = "https://recette.ethikdo.co/api/v1/sales/1/" #/1 being the transaction id
+```
+
+__Cancel a transaction__
+
+You can cancel a transaction through the `Ethikdo::Transaction` class:
+
+```ruby
+Ethikdo::Transaction.cancel(transaction_id: transaction_id)
+```
+
+If the cancellation is successful, an `Ethikdo::Transaction` object is returned with a success message and the amount refunded:
+
+```ruby
+# Ethikdo::Transaction:0x0000555a846ccb48
+ @message = "La vente a bien été annulée et la carte a été recréditée de 1000,00€.",
+ @refund_amount = 100000
+```
+
+__List the provisions and transactions associated to your API key__
+
+List all the provisions:
+```ruby
+Ethikdo::Provision.all
+```
+
+Example of an `Ethikdo::Provision` object returned:
+
+```ruby
+# Ethikdo::Provision:0x0000555a82909390
+ @count = 1,
+ @next = nil,
+ @previous = nil,
+ @results =
+    [
+        {
+            "url"=>"https://recette.ethikdo.co/api/v1/provisions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/",
+            "capture_token"=>"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+            "card_number"=>"1234123412341234",
+            "card_value"=>400000,
+            "date_created"=>"2020-04-16T16:36:46.128007+02:00",
+            "date_used"=>"2020-04-16T15:25:56.451488Z"
+        }
+    ]
+```
+
+Similarly, list all the transactions:
+
+```ruby
+Ethikdo::Transaction.all
+```
+
+Example of an `Ethikdo::Transaction` object returned:
+
+```ruby
+# Ethikdo::Transaction:0x0000555a835d68c0
+ @count = 1,
+ @next = nil,
+ @previous = nil,
+ @results =
+    [
+        {
+            "url"=>"https://recette.ethikdo.co/api/v1/sales/1/",
+            "transaction_id"=>"1",
+            "customer_email"=>nil,
+            "card_number"=>"1234123412341234",
+            "amount_purchased"=>100000,
+            "amount_debited"=>100000,
+            "cancelled"=>false,
+            "date"=>"2020-04-16T15:25:56.451488Z"
+        }
+    ]
+```
+
+__Errors__
+
+If a request returns an error (invalid card number, amount requested greater than card value, invalid capture token, etc.), an `Ethikdo::Error` is raised. This can be simply handled by a `begin/rescue` block:
+
+```ruby
+begin
+    Ethikdo::transaction.cancel(transaction_id: 1)
+rescue Ethikdo::Error => e
+    e.inspect
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Don't forget to add tests and run rspec before creating a pull request :)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ethikdo/version'
+
+Gem::Specification.new do |s|
+  s.name          = "ethikdo"
+  s.version       = Ethikdo::VERSION
+  s.authors       = ["Benoit Baumann", "Kevin Chavanne"]
+  s.email         = ["baumann.benoit@gmail.com", "kevin.chavanne@gmail.com"]
+
+  s.summary       = "A ruby wrapper for Ethikdo REST API "
+  s.description   = "This gem provides an easy way to manage transactions for Ethi'kdo card holders through the Ethi'kdo REST API"
+  s.homepage      = "https://github.com/wedressfair/ethikdo"
+  s.license       = "MIT"
+  s.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/wedressfair/ethikdo"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 3.2"
+  s.add_development_dependency 'rake', '~> 12'
+  s.add_development_dependency 'webmock', '~> 3'
+  s.add_development_dependency 'generator_spec', '~> 0.9'
+  s.add_runtime_dependency 'httparty', '~> 0.16.2'
+end

data/lib/ethikdo.rb

@@ -0,0 +1,22 @@
+require 'ethikdo/configuration'
+require 'ethikdo/provision'
+require 'ethikdo/transaction'
+require 'ethikdo/version'
+
+module Ethikdo
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset_configuration
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/ethikdo/base_model.rb

@@ -0,0 +1,65 @@
+require_relative 'error'
+require 'httparty'
+
+module Ethikdo
+  class BaseModel
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        m = "#{key}=".to_sym
+        send(m, value) if respond_to?(m)
+      end
+    end
+
+    private
+
+    BASE_TEST_URL = "https://recette.ethikdo.co/api/v1"
+    BASE_URL = "https://www.ethikdo.co/api/v1"
+
+    def self.api_key
+      Ethikdo::configuration.api_key
+    end
+
+    def self.execute(method, path, options = {})
+      begin
+        response = request(method, path, options)
+      rescue *Error::NET_HTTP_ERRORS => err
+        raise ConnectionError.new, err.message
+      end
+
+      case response.code
+      when 200..299
+        response
+      when 400
+        raise BadRequestError.new(response)
+      when 401
+        raise AuthenticationError.new(response)
+      when 404
+        raise NotFoundError.new(response)
+      when 400..499
+        raise ResponseError.new(response)
+      when 500
+        raise InternalServerError.new(response)
+      when 500..599
+        raise ServerError.new(response)
+      end
+    end
+
+    def self.request(method, path, options = {})
+      HTTParty.send(method, base_url + path, base_options.merge(options))
+    end
+
+    def self.base_url
+      Ethikdo::configuration.environment == :production ? BASE_URL : BASE_TEST_URL
+    end
+
+    def self.base_options
+      {
+        format: :json,
+        headers: {
+          'Accept' => 'application/json',
+          'Authorization' => api_key
+        }
+      }
+    end
+  end
+end

data/lib/ethikdo/configuration.rb

@@ -0,0 +1,16 @@
+module Ethikdo
+  class Configuration
+    attr_accessor :api_key
+    attr_reader :environment
+
+    def initialize
+      @api_key = nil
+      @environment = :production
+    end
+
+    def environment=(env)
+      env = env.to_sym
+      @environment = [:production, :development].include?(env)? env : nil
+    end
+  end
+end

data/lib/ethikdo/error.rb

@@ -0,0 +1,84 @@
+require 'net/http'
+
+module Ethikdo
+  class Error < StandardError
+    NET_HTTP_ERRORS = [
+      EOFError,
+      Errno::ECONNABORTED,
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Errno::EHOSTUNREACH,
+      Errno::EINVAL,
+      Errno::ENETUNREACH,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      Net::OpenTimeout,
+      Net::ReadTimeout,
+      SocketError,
+      Zlib::GzipFile::Error,
+      OpenSSL::SSL::SSLError
+    ]
+
+    attr_reader :http_response
+
+    def initialize(response = nil)
+      @http_response = response
+      super(build_error_message)
+    end
+
+    def http_request
+      http_response.request
+    end
+
+    private
+
+    def build_error_message
+      return nil if http_response.nil?
+
+      message = "#{http_request_method} "
+      message << "#{http_request.path} : "
+      message << "#{http_response.code} - "
+      message << response_message unless response_message.nil?
+      message
+    end
+
+    def http_request_method
+      http_request.http_method.name.split('::').last.upcase
+    end
+
+    def response_message
+      content_type = http_response.headers['Content-Type']
+      if content_type && content_type.start_with?('application/json')
+        http_response.parsed_response['message'] || http_response.parsed_response['detail']
+      else
+        net_http_response = http_response.response
+        "#{net_http_response.code} #{net_http_response.message}"
+      end
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ResponseError < Error; end
+
+  # Raised when the API returns a 400 HTTP status code
+  class BadRequestError < ResponseError; end
+
+  # Raised when the API returns a 401 HTTP status code
+  class AuthenticationError < ResponseError; end
+
+  # Raised when the API returns a 402 HTTP status code
+  class PaymentRequiredError < ResponseError; end
+
+  # Raised when the API returns a 404 HTTP status code
+  class NotFoundError < ResponseError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when the API returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when we can't establish a connection to the API or if reading the reponse times out
+  class ConnectionError < Error; end
+end

data/lib/ethikdo/provision.rb

@@ -0,0 +1,29 @@
+require_relative 'base_model'
+
+module Ethikdo
+  class Provision < BaseModel
+    attr_accessor :card_number
+    attr_accessor :capture_token
+    attr_accessor :card_value
+    attr_accessor :date_created
+    attr_accessor :date_used
+    attr_accessor :url
+    attr_accessor :status_code
+    attr_accessor :error_code
+    attr_accessor :message
+    attr_accessor :count
+    attr_accessor :next
+    attr_accessor :previous
+    attr_accessor :results
+
+    def self.create(card_number:, card_crypto:)
+      response = execute("post", '/provisions/', body: { card_number: card_number, card_crypto: card_crypto })
+      self.new(response.parsed_response)
+    end
+
+    def self.all
+      response = execute('get', '/provisions/')
+      self.new(response.parsed_response)
+    end
+  end
+end

data/lib/ethikdo/transaction.rb

@@ -0,0 +1,41 @@
+require_relative 'base_model'
+
+module Ethikdo
+  class Transaction < BaseModel
+    attr_accessor :url
+    attr_accessor :transaction_id
+    attr_accessor :card_number
+    attr_accessor :amount_purchased
+    attr_accessor :amount_debited
+    attr_accessor :cancelled
+    attr_accessor :date
+    attr_accessor :refund_amount
+    attr_accessor :message
+    attr_accessor :count
+    attr_accessor :next
+    attr_accessor :previous
+    attr_accessor :results
+    attr_accessor :customer_email
+
+    def self.create(capture_token:, amount_requested:, amount_purchased: 0, transaction_id:, customer_email: nil)
+      response = execute('post', '/sales/', body: {
+                            capture_token: capture_token,
+                            amount_requested: amount_requested,
+                            amount_purchased: amount_purchased,
+                            transaction_id: transaction_id,
+                            customer_email: customer_email
+                          })
+      self.new(response.parsed_response)
+    end
+
+    def self.cancel(transaction_id:)
+      response = execute('get', "/sales/#{transaction_id}/cancel")
+      self.new(response.parsed_response)
+    end
+
+    def self.all
+      response = execute('get', '/sales/')
+      self.new(response.parsed_response)
+    end
+  end
+end

data/lib/ethikdo/version.rb

@@ -0,0 +1,3 @@
+module Ethikdo
+  VERSION = "0.0.1"
+end

data/lib/generators/ethikdo/install_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+module Ethikdo
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates an initializer file at config/initializers"
+      source_root File.expand_path('../templates', __dir__)
+
+      def create_initializer_file
+        copy_file "initializer.rb", "config/initializers/ethikdo.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,4 @@
+Ethikdo.configure do |config|
+  config.api_key = ENV["ETHIKDO_API_KEY"]
+  config.environment = Rails.env.production? ? :production : :development
+end

data/spec/base_model_spec.rb

@@ -0,0 +1,34 @@
+describe Ethikdo::BaseModel do
+  describe '.execute' do
+    it 'sends the request with the correct headers' do
+      stub_request(:get, /test/)
+      Ethikdo::configuration.api_key = '1234'
+
+      Ethikdo::BaseModel.execute('get', '/test/')
+
+      expect(WebMock).to have_requested(
+        :get,
+        'https://www.ethikdo.co/api/v1/test/'
+      ).with(headers: {
+        'Accept' => 'application/json',
+        'Authorization' => '1234'
+      })
+    end
+
+    it 'raises a custom error when no api key is submitted' do
+      stub_request(:get, /test/).to_return(read_http_fixture('forbidden/no_token.http'))
+
+      expect do
+        Ethikdo::BaseModel.execute('get', '/test/')
+      end.to raise_error(Ethikdo::ResponseError)
+    end
+
+    it 'raises a custom when a wrong api key is submitted' do
+      stub_request(:get, /test/).to_return(read_http_fixture('forbidden/wrong_token.http'))
+
+      expect do
+        Ethikdo::BaseModel.execute('get', '/test/')
+      end.to raise_error(Ethikdo::ResponseError)
+    end
+  end
+end

data/spec/ethikdo_spec.rb

@@ -0,0 +1,35 @@
+describe Ethikdo do
+  after(:all) do
+    Ethikdo.reset_configuration
+  end
+
+  it "has a version number" do
+    expect(Ethikdo::VERSION).not_to be nil
+  end
+
+  describe Ethikdo::Configuration do
+    it 'has a configurable api key' do
+      Ethikdo.configuration.api_key = "42"
+      expect(Ethikdo.configuration.api_key).to eq("42")
+    end
+
+    it 'accepts only 2 values for its instance variable "environment": "production" and "development"' do
+      Ethikdo.configuration.environment = :development
+      expect(Ethikdo.configuration.environment).to eq(:development)
+
+      Ethikdo.configuration.environment = :foo
+      expect(Ethikdo.configuration.environment).to eq(nil)
+
+      Ethikdo.configuration.environment = :production
+      expect(Ethikdo.configuration.environment).to eq(:production)
+    end
+
+    it 'has different base url for the development and production environment' do
+      Ethikdo.configuration.environment = :development
+      expect(Ethikdo::BaseModel.base_url).to eq(Ethikdo::BaseModel::BASE_TEST_URL)
+
+      Ethikdo.configuration.environment = :production
+      expect(Ethikdo::BaseModel.base_url).to eq(Ethikdo::BaseModel::BASE_URL)
+    end
+  end
+end

data/spec/http_fixtures/forbidden/no_token.http

@@ -0,0 +1,8 @@
+HTTP 403 Forbidden
+Allow: GET, POST, HEAD, OPTIONS
+Content-Type: application/json
+Vary: Accept
+
+{
+    "detail": "Informations d'authentification non fournies."
+}

data/spec/http_fixtures/forbidden/wrong_token.http

@@ -0,0 +1,8 @@
+HTTP 403 Forbidden
+Allow: GET, POST, HEAD, OPTIONS
+Content-Type: application/json
+Vary: Accept
+
+{
+    "detail": "Token non valide."
+}

data/spec/http_fixtures/provisions/create_success.http

@@ -0,0 +1,11 @@
+HTTP/1.1 200
+Content-Type: application/json; charset=utf-8
+
+{
+  "url": "https://recette.ethikdo.co/api/v1/provisions/2faac91c-ffec-4329-b851-8695020faeee/",
+  "capture_token": "2faac91c-ffec-4329-b851-8695020faeee",
+  "card_number": "1234123412341234",
+  "card_value": 500000,
+  "date_created": "2020-02-27T12:30:58.760332+01:00",
+  "date_used": null
+}

data/spec/http_fixtures/provisions/get_provisions_success.http

@@ -0,0 +1,26 @@
+HTTP/1.1 200
+Content-Type: application/json; charset=utf-8
+
+{
+  "count": 2,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+    "url": "https://recette.ethikdo.co/api/v1/provisions/2faac91c-ffec-4329-b851-8695020faeee/",
+    "capture_token": "2faac91c-ffec-4329-b851-8695020faeee",
+    "card_number": "1234123412341234",
+    "card_value": 500000,
+    "date_created": "2020-02-27T12:30:58.760332+01:00",
+    "date_used": null
+    },
+    {
+    "url": "https://recette.ethikdo.co/api/v1/provisions/f93f0deb-1bdf-4c40-a19f-8bacf831f529/",
+    "capture_token": "f93f0deb-1bdf-4c40-a19f-8bacf831f529",
+    "card_number": "1234123412341234",
+    "card_value": 496000,
+    "date_created": "2020-02-27T11:06:34.285773+01:00",
+    "date_used": null
+    }
+  ]
+}

data/spec/http_fixtures/transactions/cancel_success.http

@@ -0,0 +1,7 @@
+HTTP/1.1 200
+Content-Type: application/json; charset=utf-8
+
+{
+    "message": "La vente a bien été annulée et la carte a été recréditée de 10,00 €.",
+    "refund_amount": 1000
+}

data/spec/http_fixtures/transactions/create_success.http

@@ -0,0 +1,13 @@
+HTTP/1.1 200
+Content-Type: application/json; charset=utf-8
+
+{
+  "url": "https://recette.ethikdo.co/api/v1/sales/1/",
+  "transaction_id": "1",
+  "customer_email": null,
+  "card_number": "1010101010101010",
+  "amount_purchased": 1000,
+  "amount_debited": 1000,
+  "cancelled": false,
+  "date": "2020-02-27T11:38:19.684349Z"
+}

data/spec/http_fixtures/transactions/get_transactions_success.http

@@ -0,0 +1,40 @@
+HTTP/1.1 200
+Content-Type: application/json; charset=utf-8
+
+{
+  "count": 3,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+    "url": "https://recette.ethikdo.co/api/v1/sales/113/",
+    "transaction_id": "3",
+    "customer_email": null,
+    "card_number": "1234123412341234",
+    "amount_purchased": 0,
+    "amount_debited": 2000,
+    "cancelled": false,
+    "date": "2020-02-27T09:47:24.711443Z"
+    },
+    {
+    "url": "https://recette.ethikdo.co/api/v1/sales/112/",
+    "transaction_id": "2",
+    "customer_email": null,
+    "card_number": "1234123412341234",
+    "amount_purchased": 0,
+    "amount_debited": 2000,
+    "cancelled": false,
+    "date": "2020-02-27T09:25:21.702039Z"
+    },
+    {
+    "url": "https://recette.ethikdo.co/api/v1/sales/111/",
+    "transaction_id": "1",
+    "customer_email": null,
+    "card_number": "1234123412341234",
+    "amount_purchased": 0,
+    "amount_debited": 2000,
+    "cancelled": true,
+    "date": "2020-02-27T09:18:40.351488Z"
+    }
+  ]
+}

data/spec/install_generator_spec.rb

@@ -0,0 +1,16 @@
+describe Ethikdo::Generators::InstallGenerator, type: :generator do
+  destination File.expand_path('../tmp', __FILE__)
+
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+
+  after(:all) do
+    FileUtils.rm_rf destination_root
+  end
+
+  it "creates correctly the initializer file" do
+    assert_file "config/initializers/ethikdo.rb"
+  end
+end

data/spec/provision_spec.rb

@@ -0,0 +1,54 @@
+describe Ethikdo::Provision do
+  describe '.all' do
+    before do
+      stub_request(:get, /provisions/).to_return(read_http_fixture('provisions/get_provisions_success.http'))
+    end
+
+    it 'builds the correct request' do
+      Ethikdo::Provision.all
+
+      expect(WebMock).to have_requested(
+        :get,
+        'https://www.ethikdo.co/api/v1/provisions/'
+      )
+    end
+
+    it 'returns the correct response' do
+      provisions = Ethikdo::Provision.all
+
+      expect(provisions).to be_a(Ethikdo::Provision)
+      expect(provisions.count).to eq(2)
+      expect(provisions.results[0]['card_number']).to eq('1234123412341234')
+    end
+  end
+
+  describe '.create' do
+    before do
+      Ethikdo::configuration.api_key = '1234'
+      stub_request(:post, /provisions/).to_return(read_http_fixture('provisions/create_success.http'))
+    end
+
+    it 'builds the correct request' do
+      Ethikdo::Provision.create(card_number: 1234123412341234, card_crypto: 123)
+
+      expect(WebMock).to have_requested(
+        :post,
+        'https://www.ethikdo.co/api/v1/provisions/'
+      ).with(headers: {
+        'Accept' => 'application/json',
+        'Authorization' => '1234',
+        }, body: {
+          'card_number' => '1234123412341234',
+          'card_crypto' => '123'
+      })
+    end
+
+    it 'returns the correct response' do
+      provision = Ethikdo::Provision.create(card_number: 1234123412341234, card_crypto: 123)
+
+      expect(provision).to be_a(Ethikdo::Provision)
+      expect(provision.card_number).to eq('1234123412341234')
+      expect(provision.card_value).to eq(500000)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "bundler/setup"
+require "ethikdo"
+require "generator_spec"
+require 'generators/ethikdo/install_generator'
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end
+
+unless defined?(SPEC_ROOT)
+  SPEC_ROOT = File.expand_path('../', __FILE__)
+end
+
+Dir[File.join(SPEC_ROOT, 'support/**/*.rb')].each { |f| require f }

data/spec/support/helpers.rb

@@ -0,0 +1,15 @@
+module RSpecSupportHelpers
+
+  def http_fixture(*names)
+    File.join(SPEC_ROOT, 'http_fixtures', *names)
+  end
+
+  def read_http_fixture(*names)
+    File.read(http_fixture(*names))
+  end
+
+end
+
+RSpec.configure do |config|
+  config.include RSpecSupportHelpers
+end

data/spec/support/webmock.rb

@@ -0,0 +1,11 @@
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    WebMock.disable_net_connect!
+  end
+
+  config.after(:suite) do
+    WebMock.allow_net_connect!
+  end
+end

data/spec/transaction_spec.rb

@@ -0,0 +1,84 @@
+describe Ethikdo::Transaction do
+  describe '.all' do
+    before do
+      stub_request(:get, /sales/).to_return(read_http_fixture('transactions/get_transactions_success.http'))
+    end
+
+    it 'builds the correct request' do
+      Ethikdo::Transaction.all
+
+      expect(WebMock).to have_requested(
+        :get,
+        'https://www.ethikdo.co/api/v1/sales/'
+      )
+    end
+
+    it 'returns the correct response' do
+      transactions = Ethikdo::Transaction.all
+
+      expect(transactions).to be_a(Ethikdo::Transaction)
+      expect(transactions.count).to eq(3)
+      expect(transactions.results[0]['card_number']).to eq('1234123412341234')
+    end
+  end
+
+  describe '.create' do
+    before do
+      Ethikdo::configuration.api_key = '1234'
+      stub_request(:post, /sales/).to_return(read_http_fixture('transactions/create_success.http'))
+    end
+
+    it 'builds the correct request' do
+      Ethikdo::Transaction.create(capture_token: 'foo', amount_requested: 10000, amount_purchased: 10000, transaction_id: 1, customer_email: 'foo@bar.com')
+
+      expect(WebMock).to have_requested(
+        :post,
+        'https://www.ethikdo.co/api/v1/sales/'
+      ).with(headers: {
+        'Accept' => 'application/json',
+        'Authorization' => '1234',
+        }, body: {
+          'capture_token' => 'foo',
+          'amount_requested' => '10000',
+          'amount_purchased' => '10000',
+          'transaction_id' => '1',
+          'customer_email' => 'foo@bar.com'
+      })
+    end
+
+    it 'returns the correct response' do
+      transaction = Ethikdo::Transaction.create(capture_token: 'foo', amount_requested: 10000, amount_purchased: 10000, transaction_id: 1)
+
+      expect(transaction).to be_a(Ethikdo::Transaction)
+      expect(transaction.transaction_id).to eq('1')
+      expect(transaction.amount_purchased).to eq(1000)
+    end
+  end
+
+  describe '.cancel' do
+    before do
+      Ethikdo::configuration.api_key = '1234'
+      stub_request(:get, /sales/).to_return(read_http_fixture('transactions/cancel_success.http'))
+    end
+
+    it 'builds the correct request' do
+      Ethikdo::Transaction.cancel(transaction_id: 1)
+
+      expect(WebMock).to have_requested(
+        :get,
+        'https://www.ethikdo.co/api/v1/sales/1/cancel'
+      ).with(headers: {
+        'Accept' => 'application/json',
+        'Authorization' => '1234',
+        })
+    end
+
+    it 'returns the correct response' do
+      transaction = Ethikdo::Transaction.cancel(transaction_id: 1)
+
+      expect(transaction).to be_a(Ethikdo::Transaction)
+      expect(transaction.message).to eq('La vente a bien été annulée et la carte a été recréditée de 10,00 €.')
+      expect(transaction.refund_amount).to eq(1000)
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: ethikdo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benoit Baumann
+- Kevin Chavanne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+description: This gem provides an easy way to manage transactions for Ethi'kdo card
+  holders through the Ethi'kdo REST API
+email:
+- baumann.benoit@gmail.com
+- kevin.chavanne@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ethikdo.gemspec
+- lib/ethikdo.rb
+- lib/ethikdo/base_model.rb
+- lib/ethikdo/configuration.rb
+- lib/ethikdo/error.rb
+- lib/ethikdo/provision.rb
+- lib/ethikdo/transaction.rb
+- lib/ethikdo/version.rb
+- lib/generators/ethikdo/install_generator.rb
+- lib/generators/templates/initializer.rb
+- spec/base_model_spec.rb
+- spec/ethikdo_spec.rb
+- spec/http_fixtures/forbidden/no_token.http
+- spec/http_fixtures/forbidden/wrong_token.http
+- spec/http_fixtures/provisions/create_success.http
+- spec/http_fixtures/provisions/get_provisions_success.http
+- spec/http_fixtures/transactions/cancel_success.http
+- spec/http_fixtures/transactions/create_success.http
+- spec/http_fixtures/transactions/get_transactions_success.http
+- spec/install_generator_spec.rb
+- spec/provision_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/webmock.rb
+- spec/transaction_spec.rb
+homepage: https://github.com/wedressfair/ethikdo
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wedressfair/ethikdo
+  source_code_uri: https://github.com/wedressfair/ethikdo
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for Ethikdo REST API
+test_files: []