bayonet_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ed9d0a860656422bcd61a74b7f1f066c47af17f
+  data.tar.gz: 0e9170b2c397ce7b0c7683990b8012f34c34a004
+SHA512:
+  metadata.gz: ca8532de822ef2514d6ac322a14fb9e49a545d46ce2c6a01a58d23593bb2ea93acd80af4e9993a4b5705531dfce8922a28f63e94445fb0c68bd02401ae1a62dc
+  data.tar.gz: 01fed1dad20b252ea759630c350fa19a0297854878f85c6cd43f4ecc56191154901d56c3681afc5be63eaa6a5f967ccb6349d23ffbae4d4e200c66decd5b453f

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 imran-bayonet
+
+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,132 @@
+## Bayonet
+Bayonet enables companies to feed and consult a global database about online consumers’ reputation, based on historic payments. Start making smarter business decisions today.
+
+### Introduction
+Bayonet’s API is organized around REST and exposes endpoints for HTTP requests. It is designed to have predictable, resource-oriented URLs and uses standard HTTP response codes to indicate the outcome of operations. Request and response payloads are formatted as JSON.
+
+### About the service
+Bayonet provides an Ecosystem of Trust and Protection where companies can colaborate with each other to combat online fraud together. We provide a secure platform to share and consult data to understand when a consumer is related to fraudulent activity or has a fraud-free record. Different technologies that run algorithms to link parameters seen in different transactions, fed by companies connected to the ecosystem are employed in order to build consumer profiles. By consulting Bayonet’s API, a response with data provided by companies themselves is available in real-time for your risk assesment process to analyze it and take better decisions.
+
+### Bayonet's API details
+To know more about Bayonet's API and its domain and technical details, please see the "Integration Specs V 1.0" document provided by the Bayonet team.
+
+## Getting started
+To use this SDK, please make sure:
+  * You have Ruby 2.0 or superior installed on your system.
+  * You have an API KEY (sandbox and/or live) provided by Bayonet's team.
+  * Install the 'bayonet_client' package on your system
+  
+    ```sh
+    gem install bayonet_client
+    ```
+    Or if you want to build the gem from source:
+    
+    ```sh
+    gem build bayonet_client.gemspec
+    ```
+  * Require 'bayonet_client' in your file
+
+    ```ruby
+    require 'bayonet_client'
+    ```
+  * Create config options, with parameters (api_key, api_version).
+
+    ```ruby
+    client = BayonetClient::Client.new(api_key, api_version)
+    ```
+    
+## Usage
+Once you have Bayonet's SDK configured, you can call the three APIs with the following syntax:
+  * Consulting API
+  
+    ```ruby
+    client.consulting({
+        channel: 'mpos',
+        email: 'example@bayonet.io',
+        consumer_name: 'Example name',
+        cardholder_name: 'Example name',
+        payment_method: 'card',
+        card_number: '4111111111111111',
+        transaction_amount: '999',
+        currency_code: 'MXN',
+        transaction_time: '1476012879',
+        coupon: false,
+        payment_gateway: 'stripe',
+        shipping_address : {
+            address_line_1 : 'example line 1',
+            address_line_2 : 'example line 2',
+            city : 'Mexico City',
+            state : 'Mexico DF',
+            country : 'MEX',
+            zip_code : '64000'
+        }
+    })
+    ```
+  * Feedback API
+  
+    ```ruby
+    client.feedback({
+        transaction_status: 'success',
+        transaction_id: 'uhffytd65rds56yt',
+        ...
+    })
+    ```
+  * Feedback-historical API
+  
+    ```ruby
+    client.feedback_historical({
+        channel: 'mpos',
+        type: 'transaction',
+        email: 'example@bayonet.io',
+        consumer_name: 'Example name',
+        payment_method: 'card',
+        card_number: '4111111111111111',
+        transaction_amount: '999',
+        currency_code: 'MXN',
+        transaction_time: '1423823404',
+        transaction_status: 'bank_decline',
+        transaction_id: 'uhffytd65rds56yt',
+        coupon: false,
+        payment_gateway: 'stripe',
+        device_fingerprint: 'AF567GHGJJJ87JH',
+        bank_auth_code: '5353888',
+        telephone: '0000000000',
+        expedited_shipping: false,
+        bank_decline_reason: 'stolen_card',
+        shipping_address: {
+            address_line_1: 'example line 1',
+            address_line_2: 'example line 2',
+            city: 'Mexico City',
+            state: 'Mexico DF',
+            country: 'MEX',
+            zip_code: '64000'
+        }
+    })
+    ```
+ 
+## Error handling
+Bayonet's SDK raises exceptions both when setting up the client object and executing functions:
+```ruby
+begin
+    client = bayonet.BayonetClient(api_key, api_version)
+rescue BayonetClient::InvalidClientSetupError => e
+    puts e.message
+end
+```
+
+```ruby
+begin
+    client.consulting(params)   # Or, client.feedback(params) Or, client.feedback_historical(params)
+rescue BayonetClient::BayonetError => e
+  puts e.reason_code
+  puts e.reason_message
+end
+```
+
+For a full list of error codes and their messages, please refer to the Bayonet API documentation.
+
+## Testing
+You can run the test suite with the following command:
+```sh
+bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/bayonet_client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bayonet_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bayonet_client'
+  spec.version       = BayonetClient::VERSION
+  spec.authors       = ['Bayonet']
+  spec.email         = ['support@bayonet.io']
+
+  spec.summary       = %q{Bayonet Ruby API Gem}
+  spec.description   = %q{Bayonet Ruby API. See https://bayonet.io for details.}
+  spec.homepage      = 'https://bayonet.io'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rake'
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'bayonet_client'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/bayonet_client.rb

@@ -0,0 +1,81 @@
+require 'httparty'
+require_relative './bayonet_client/version'
+require_relative './bayonet_client/response.rb'
+require_relative './bayonet_client/exceptions.rb'
+
+module BayonetClient
+
+  class Client
+
+    def initialize(api_key, version)
+
+      if version.nil? || version.empty?
+        message = 'Please specify Api version'
+        raise BayonetClient::InvalidClientSetupError.new message
+      elsif !BayonetClient::SUPPORTED_API_VERSIONS.include?(version)
+        message = 'This library does not support version specified. Consider updating your dependencies'
+        raise BayonetClient::InvalidClientSetupError.new message
+      end
+
+      @api_key = api_key
+      @version = version
+    end
+
+    def consulting(params)
+      if validate_params(params)
+        serialized = json_from_params(params)
+        request('/consulting', serialized)
+      else
+        raise BayonetClient::BayonetError.new(params, '', '', 'Invalid params. Please make sure you pass a params hash')
+      end
+    end
+
+    def feedback(params)
+      serialized = json_from_params(params)
+      request('/feedback', serialized)
+    end
+
+    def feedback_historical(params)
+      serialized = json_from_params(params)
+      request('/feedback-historical', serialized)
+    end
+
+    def validate_params(params)
+      params.class == Hash
+    end
+
+    def json_from_params(params)
+      # Add api_key to params
+      params[:api_key] = @api_key
+      params.to_json
+    end
+
+    def request(route, json_params)
+      request_json_string(route, json_params)
+    end
+
+    def request_json_string(route, request_json_args)
+      fq_hostname = fully_qualified_api_host_name
+      url = "#{fq_hostname}#{route}"
+
+      headers = {'User-Agent' => 'OfficialBayonetRubySDK',
+                 'Content-Type' => 'application/json', 'Accept' => 'application/json'}
+
+      raw_resp = HTTParty.post(
+          url, body: request_json_args, headers: headers, verify: false)
+
+      if raw_resp.code == 200
+        BayonetClient::BayonetResponse.new(raw_resp)
+      else
+        raise BayonetClient::BayonetError.new(request_json_args, headers, raw_resp.code, raw_resp)
+      end
+    end
+
+    def fully_qualified_api_host_name
+      default_domain = 'api.bayonet.io'
+      api_version_namespace = 'v' + @version
+      "https://#{default_domain}/#{api_version_namespace}"
+    end
+  end
+
+end

data/lib/bayonet_client/exceptions.rb

@@ -0,0 +1,31 @@
+require 'json'
+
+module BayonetClient
+
+  class BayonetError < Exception
+    attr_accessor :request_body, :request_headers, :http_response_code, :http_response_json,
+                  :reason_code, :reason_message
+
+    def initialize(request_body, request_headers,
+                   http_response_code, http_response_json)
+      self.request_body = request_body
+      self.request_headers = request_headers
+      self.http_response_code = http_response_code
+      self.http_response_json = http_response_json
+
+      # Get reason_code and reason_message from response
+      if http_response_json.class == HTTParty::Response && http_response_json.key?('reason_code')
+        self.reason_code = http_response_json['reason_code']
+      end
+      if http_response_json.class == HTTParty::Response && http_response_json.key?('reason_message')
+        self.reason_message = http_response_json['reason_message']
+      else
+        self.reason_message = http_response_json
+      end
+    end
+  end
+
+  class InvalidClientSetupError < Exception
+  end
+
+end

data/lib/bayonet_client/response.rb

@@ -0,0 +1,35 @@
+require 'json'
+
+module BayonetClient
+
+  class BayonetResponse
+    attr_accessor :feedback_api_trans_code, :rules_triggered,
+                  :risk_level, :payload, :reason_code,
+                  :reason_message, :request_body
+
+    def initialize(parsed_response)
+
+      if parsed_response.key?('feedback_api_trans_code')
+        self.feedback_api_trans_code = parsed_response['feedback_api_trans_code']
+      end
+      if parsed_response.key?('rules_triggered')
+        self.rules_triggered = parsed_response['rules_triggered']
+      end
+      if parsed_response.key?('risk_level')
+        self.risk_level = parsed_response['risk_level']
+      end
+      if parsed_response.key?('payload')
+        self.payload = parsed_response['payload']
+      end
+      if parsed_response.key?('reason_code')
+        self.reason_code = parsed_response['reason_code']
+      end
+      if parsed_response.key?('reason_message')
+        self.reason_message = parsed_response['reason_message']
+      end
+      if parsed_response.key?('request_body')
+        self.request_body = parsed_response['request_body']
+      end
+    end
+  end
+end

data/lib/bayonet_client/version.rb

@@ -0,0 +1,4 @@
+module BayonetClient
+  VERSION = '0.1.0'
+  SUPPORTED_API_VERSIONS = ['1']
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: bayonet_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bayonet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bayonet Ruby API. See https://bayonet.io for details.
+email:
+- support@bayonet.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bayonet_client.gemspec
+- bin/console
+- bin/setup
+- lib/bayonet_client.rb
+- lib/bayonet_client/exceptions.rb
+- lib/bayonet_client/response.rb
+- lib/bayonet_client/version.rb
+homepage: https://bayonet.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.1
+signing_key: 
+specification_version: 4
+summary: Bayonet Ruby API Gem
+test_files: []