distribution-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d85469e19b8fcfc2d55a940977022e2a04de424
+  data.tar.gz: 9ba0b2f6074e332ecdc6a928bf5e153db73fb989
+SHA512:
+  metadata.gz: 5b5093ef7c06e7d7b176f851735c5b1b8d119153840f4f58ac031856441022ae42a55da5fc7812c83b5b0353ded9df5ca60f429df07cd7cfd8fa2ac55064f4a4
+  data.tar.gz: 423d396379dab2fc008f4639476e6ff8c14c645e93f71e3b87eaab78ea154c18bd1ac998d81226b88f89109268bb33a67b07c04638745afb9157b25f4789fe47

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Wizypay - Chaker Nakhli
+
+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/Rakefile

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

data/lib/distribution-api-client.rb

@@ -0,0 +1,53 @@
+require 'time'
+require 'base64'
+require 'openssl'
+require 'securerandom'
+require 'rest-client'
+require 'simple-hmac'
+require 'json'
+
+module DistributionApi
+  class << self
+    attr_accessor :api_endpoint, :api_key, :api_secret
+  end
+
+  def self.setup(api_key, api_secret, api_endpoint='https://distribution.api.wizypay.com/v1')
+    self.api_endpoint   = api_endpoint
+    self.api_key    = api_key
+    self.api_secret = api_secret
+  end
+
+  def self.create_card(reference, amount, currency, merchant_id, user)
+    user       = user.to_json if user.is_a?(Hash)
+    payload    = { amount: amount, currency: currency, merchant_id: merchant_id, reference: reference, user: user }
+    req_params = { url: "#{api_endpoint}/cards", method: :post, headers: { accept: :json }, payload: payload }
+    req        = RestClient::Request.new(req_params)
+    req.sign!(api_key, api_secret)
+    parse_response req.execute
+  end
+
+  def self.cancel_card(reference)
+    req_params = { url: ("#{api_endpoint}/cards/#{URI::encode_www_form_component reference}/cancel"), method: :post, headers: { accept: :json }, payload: {} }
+    req        = RestClient::Request.new(req_params)
+    req.sign!(api_key, api_secret)
+    req.execute
+  end
+
+  def self.card_url(reference)
+    timestamp    = Time.now.utc.httpdate
+    security     = Base64.strict_encode64(OpenSSL::HMAC.digest('sha256', api_secret, "#{reference}\n#{timestamp}"))
+    query_string = {
+        key:       api_key,
+        timestamp: timestamp,
+        reference: reference,
+        security:  security
+    }.map { |k, v| "#{k}=#{URI::encode_www_form_component(v)}" }.join('&')
+    "#{api_endpoint}/widget?#{query_string}"
+  end
+
+  private
+
+  def self.parse_response(response)
+    Hash[JSON::parse(response).map { |k,v| [k.to_sym, v] }]
+  end
+end

data/lib/distribution-api/version.rb

@@ -0,0 +1,3 @@
+module DistributionApi 
+  VERSION = '0.1.0'
+end

data/spec/cancel_card_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.describe 'DistributionApi::cancel_card' do
+
+  let(:api_key) { 'key' }
+  let(:api_secret) { 'secret' }
+  let(:api_endpoint) { 'https://distribution.api.wizypay.com/v1' }
+  let(:reference) { '85fb584c-72cb-4f35-b307-ac5442ef7153' }
+  let(:cancel_request) { stub_request(:post, "#{api_endpoint}/cards/#{reference}/cancel").
+      with(headers: { 'Accept'        => 'application/json',
+                      'Authorization' => /WIZYPAY #{api_key}:.*/,
+                      'Content-Type'  => 'application/x-www-form-urlencoded' }) }
+  before do
+    DistributionApi::setup(api_key, api_secret, api_endpoint)
+  end
+
+  context 'success' do
+    it 'returns empty body' do
+      request  = cancel_request.to_return(status: 200, body: '')
+      response = DistributionApi::cancel_card(reference)
+      expect(request).to have_been_made
+      expect(response).to be_empty
+    end
+  end
+
+  context 'failure' do
+    context '4XX' do
+      it "throws #{RestClient::Exception}" do
+        request = cancel_request.to_return(status: 401, body: { errors: { base: ['authentication_failed'] } }.to_json)
+        expect do
+          DistributionApi::cancel_card(reference)
+        end.to raise_error(RestClient::Exception)
+        expect(request).to have_been_made
+      end
+    end
+
+    context 'timeout' do
+      it "throws #{RestClient::Exception}" do
+        request = cancel_request.to_timeout
+        expect do
+          DistributionApi::cancel_card(reference)
+        end.to raise_error(RestClient::Exception)
+        expect(request).to have_been_made
+      end
+    end
+  end
+end

data/spec/card_url_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'time'
+require 'URI'
+
+RSpec.describe 'DistributionApi::create_card' do
+
+  let(:api_key) { 'key' }
+  let(:api_secret) { 'secret' }
+  let(:api_endpoint) { 'https://distribution.api.wizypay.com/v1' }
+  let(:reference) { '85fb584c-72cb-4f35-b307-ac5442ef7153' }
+
+  before do
+    DistributionApi::setup(api_key, api_secret, api_endpoint)
+  end
+
+  it 'returns ' do
+    t = Time.new('2015-10-30T21:00:00+001')
+    Timecop.freeze(t) do
+      url = DistributionApi::card_url(reference)
+      expect(url).to eq("#{api_endpoint}/widget?key=#{URI::encode_www_form_component api_key}"+
+                            "&timestamp=#{URI::encode_www_form_component t.httpdate}" +
+                            "&reference=#{URI::encode_www_form_component reference}"+
+                            "&security=0fKNCz6hux0IjNCz31JHgzh35gqLTAIM8z3iNhSkC7g%3D")
+    end
+  end
+end

data/spec/create_card_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+RSpec.describe 'DistributionApi::create_card' do
+
+  let(:api_key) { 'key' }
+  let(:api_secret) { 'secret' }
+  let(:api_endpoint) { 'https://distribution.api.wizypay.com/v1' }
+  let(:user) { { id: 33, first_name: 'Nicolas', last_name: 'Cage' } }
+  let(:reference) { '85fb584c-72cb-4f35-b307-ac5442ef7153' }
+  let(:merchant_id) { '91' }
+  let(:amount) { '5000' }
+  let(:currency) { 'EUR' }
+  let(:create_request) { stub_request(:post, "#{api_endpoint}/cards").
+      with(body:    { amount:    amount, currency: currency, merchant_id: merchant_id,
+                      reference: reference, user: user.to_json },
+           headers: { 'Accept'        => 'application/json',
+                      'Authorization' => /WIZYPAY #{api_key}:.*/,
+                      'Content-Type'  => 'application/x-www-form-urlencoded' }) }
+  before do
+    DistributionApi::setup(api_key, api_secret, api_endpoint)
+  end
+
+  context 'success' do
+    it 'returns response as hash' do
+      response_body = {
+          reference:   reference,
+          type:        'Mastercard',
+          amount:      amount,
+          currency:    currency,
+          merchant_id: merchant_id,
+          user_id:     user[:id]
+      }
+      request       = create_request.to_return(status: 200, body: response_body.to_json)
+      response      = DistributionApi::create_card(reference, amount, currency, merchant_id, user)
+      expect(request).to have_been_made
+      expect(response).to match(response_body)
+    end
+  end
+
+  context 'failure' do
+    context '4XX' do
+      it "throws #{RestClient::Exception}" do
+        request = create_request.to_return(status: 401, body: { errors: { base: ['authentication_failed'] } }.to_json)
+        expect do
+          DistributionApi::create_card(reference, amount, currency, merchant_id, user)
+        end.to raise_error(RestClient::Exception)
+        expect(request).to have_been_made
+      end
+    end
+
+    context 'timeout' do
+      it "throws #{RestClient::Exception}" do
+        request = create_request.to_timeout
+        expect do
+          DistributionApi::create_card(reference, amount, currency, merchant_id, user)
+        end.to raise_error(RestClient::Exception)
+        expect(request).to have_been_made
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require 'distribution-api-client'
+require 'webmock/rspec'
+require 'timecop'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order            = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end
+
+Timecop.safe_mode = true

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: distribution-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chaker Nakhli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple-hmac
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- chaker@wizypay.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- Rakefile
+- lib/distribution-api-client.rb
+- lib/distribution-api/version.rb
+- spec/cancel_card_spec.rb
+- spec/card_url_spec.rb
+- spec/create_card_spec.rb
+- spec/spec_helper.rb
+homepage: http://developers.wizypay.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Programmatic API to access Wizypay's Distribution API.
+test_files:
+- spec/cancel_card_spec.rb
+- spec/card_url_spec.rb
+- spec/create_card_spec.rb
+- spec/spec_helper.rb