amex_enhanced_authorization 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9eae2794641cb519d74cb5cd54fb67886e4137511e0cd8e27a4f9e132441c76
+  data.tar.gz: 520b3cfc160be5885d5da1e632e04fb16d4b9d7eff5a0e465eed88b96c40afd4
+SHA512:
+  metadata.gz: b4488bbe0aa4e996e3c7fac4f374fa457726ef34416a737dad4956f229d3d6f4bb061eb1eb7ca5cf03751bb1467c8e2196ffc6435a8647207d8706ccb56a60b8
+  data.tar.gz: d71769a9438f9b596f685e2d8a0afd140633861ff43a46376c7e1e8a1ec8e0bf6beef590240d755f85c44e140eef43dcba555544edb657f4a70b2bc84318a7df

data/.gitignore

@@ -0,0 +1,12 @@
+Gemfile.lock
+/.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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in amex_enhanced_authorization.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Piers Chambers
+
+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,37 @@
+# AmexEnhancedAuthorization
+
+[![Travis CI Status](https://secure.travis-ci.org/varyonic/amex_enhanced_authorization.svg)](https://travis-ci.org/varyonic/amex_enhanced_authorization)
+
+Unofficial Ruby wrapper for American Express Enhanced Authorization
+published via the [amex developer portal](https://developer.americanexpress.com/products/enhanced-authorization-v2/),
+see also [amex-api-java-client-core](https://github.com/americanexpress/amex-api-java-client-core).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amex_enhanced_authorization'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/amex_enhanced_authorization.
+
+## 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/amex_enhanced_authorization.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "amex_enhanced_authorization/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "amex_enhanced_authorization"
+  spec.version       = AmexEnhancedAuthorization::VERSION
+  spec.authors       = ["Piers Chambers"]
+  spec.email         = ["piers@varyonic.com"]
+
+  spec.summary       = %q{Unofficial Ruby wrapper for American Express Enhanced Authorization.}
+  spec.homepage      = "https://github.com/varyonic/amex_enhanced_authorization"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

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

@@ -0,0 +1,15 @@
+require 'base64'
+require 'json'
+require 'securerandom'
+require 'logger'
+require 'openssl'
+require 'amex_enhanced_authorization/online_purchase_payload'
+require "amex_enhanced_authorization/logged_request"
+require "amex_enhanced_authorization/request"
+require "amex_enhanced_authorization/connection"
+require "amex_enhanced_authorization/version"
+
+module AmexEnhancedAuthorization
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/amex_enhanced_authorization/connection.rb

@@ -0,0 +1,43 @@
+module AmexEnhancedAuthorization
+  class Connection
+    attr_reader :host
+    attr_reader :base_path
+    attr_reader :client_id, :client_secret
+    attr_accessor :logger
+
+    def initialize(host:,
+                   client_id:, client_secret:,
+                   logger: Logger.new('/dev/null'))
+      @host = host
+      @base_path = "/risk/fraud/v2/apiplatform/enhanced_authorizations".freeze
+      @client_id, @client_secret = client_id, client_secret
+      @logger = logger
+    end
+
+    def online_purchase(params)
+      payload = OnlinePurchasePayload.new(params).to_json
+      JSON.parse send_authorized_request('POST', 'online_purchases', payload)
+    end
+
+    def send_authorized_request(method, route, payload = nil)
+      resource_path = "#{base_path}/#{route}"
+      authorization = hmac_authorization(method, resource_path, payload)
+      request = Request.new(method, "https://#{host}#{resource_path}", client_id, logger)
+      request.send(payload, authorization)
+    end
+
+    # @param [String] method, e.g. 'POST'
+    # @param [String] resource_path, e.g. '/payments/digital/v2/tokens/provisioning'
+    # @param [String] JSON payload
+    # @return [String] Authorization: MAC id="gfFb4K8esqZgMpzwF9SXzKLCCbPYV8bR",ts="1463772177193",nonce="61129a8d-ca24-464b-8891-9251501d86f0", bodyhash="YJpz6NdGP0aV6aYaa+6qKCjQt46of+Cj4liBz90G6X8=", mac="uzybzLPj3fD8eBZaBzb4E7pZs+l+IWS0w/w2wwsExdo="
+    def hmac_authorization(method, resource_path, payload, nonce = SecureRandom.uuid, ts = (Time.now.to_r * 1000).to_i)
+      bodyhash = hmac_digest(payload)
+      mac = hmac_digest([ts, nonce, method, resource_path, host, 443, bodyhash, ''].join("\n"))
+      %(MAC id="#{client_id}",ts="#{ts}",nonce="#{nonce}",bodyhash="#{bodyhash}",mac="#{mac}")
+    end
+
+    def hmac_digest(s)
+      Base64.strict_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA256.new, client_secret, s.to_s))
+    end
+  end
+end

data/lib/amex_enhanced_authorization/logged_request.rb

@@ -0,0 +1,56 @@
+require 'benchmark'
+require 'net/http'
+
+module AmexEnhancedAuthorization
+
+  # An HTTPS request whose content, response and latency are logged.
+  class LoggedRequest
+    attr_reader :uri, :request
+    attr_reader :logger
+
+    def initialize(method, path, logger)
+      @uri = URI(path)
+      @request = Net::HTTP.const_get(method.capitalize).new(@uri)
+      @logger = logger
+    end
+
+    # Add provided headers and invoke request over HTTPS.
+    # @return response
+    def send(data)
+      headers.each_pair { |k, v| request[k] = v }
+      log_request_response(headers, data) do
+        https(uri).request(request)
+      end
+    end
+
+    # @return [Hash]
+    def headers
+      @headers ||= {}
+    end
+
+    protected
+
+    def https(uri)
+      Net::HTTP.new(uri.host, uri.port).tap { |http| http.use_ssl = true }
+    end
+
+    # Log URI, method, data
+    # Start timer.
+    # Yield to request block.
+    # Log response and time taken.
+    def log_request_response(headers, data = nil)
+      logger.info "[#{self.class.name}] request = #{request.method} #{uri}#{data ? '?' + data : ''}"
+      logger.info "[#{self.class.name}] headers = #{headers}"
+      response = nil
+      tms = Benchmark.measure do
+        response = yield
+      end
+      logger.info("[#{self.class.name}] response (#{ms(tms)}ms): #{response.inspect} #{response.body}")
+      response
+    end
+
+    def ms(tms)
+      (tms.real*1000).round(3)
+    end
+  end
+end

data/lib/amex_enhanced_authorization/online_purchase_payload.rb

@@ -0,0 +1,49 @@
+require 'json'
+
+module AmexEnhancedAuthorization
+  class OnlinePurchasePayload
+    attr_accessor :card_acceptor_id, :card_number, :currency_code, :amount, :timestamp
+    attr_accessor :customer_email
+    attr_accessor :billing_address, :billing_postal_code, :billing_first_name, :billing_last_name, :billing_phone_number
+    attr_accessor :shipto_address, :shipto_postal_code, :shipto_first_name, :shipto_last_name, :shipto_phone_number, :shipto_country_code
+
+    def initialize(params)
+      params.each_pair { |k, v| send "#{k}=", v }
+    end
+
+    def to_json
+      payload = {
+        timestamp: Time.now.utc.strftime('%Y-%m-%dT%H:%M:%S.%LZ'),
+        transaction_data: {
+          card_acceptor_id: card_acceptor_id, # aka. SE10 or Merchant code
+          card_number: card_number,
+          amount: amount,
+          currency_code: currency_code,
+          transaction_timestamp: timestamp.utc.strftime('%Y-%m-%dT%H:%M:%S.%LZ'),
+          additional_information: { risk_score: true },
+        }
+      }
+      payload[:purchaser_information] = purchaser_information if purchaser_information.any?
+      payload.to_json
+    end
+
+    protected
+
+    def purchaser_information
+      @purchaser_information ||= {
+        customer_email: customer_email,
+        billing_address: billing_address,
+        billing_postal_code: billing_postal_code,
+        billing_first_name: billing_first_name,
+        billing_last_name: billing_last_name,
+        billing_phone_number: billing_phone_number,
+        shipto_address: shipto_address,
+        shipto_postal_code: shipto_postal_code,
+        shipto_first_name: shipto_first_name,
+        shipto_last_name: shipto_last_name,
+        shipto_phone_number: shipto_phone_number,
+        shipto_country_code: shipto_country_code,
+      }.compact
+    end
+  end
+end

data/lib/amex_enhanced_authorization/request.rb

@@ -0,0 +1,49 @@
+module AmexEnhancedAuthorization
+
+  # Amex requests use extended headers and a JSON body.
+  class Request < LoggedRequest
+    attr_reader :client_id
+    attr_reader :authorization
+
+    def initialize(method, path, client_id, logger)
+      super(method, path, logger)
+      @client_id = client_id
+    end
+
+    # Return response on success or log failure and throw error.
+    def send(data, authorization)
+      @authorization = authorization
+      request.body = data if data
+      response = super(data)
+      fail_unless_expected_response response, Net::HTTPSuccess
+      response.body
+    end
+
+    def headers
+      Hash[
+        'Content-Type' => 'application/json',
+        'Content-Language' => 'en-US',
+        'x-amex-api-key' => client_id,
+        'x-amex-request-id' => SecureRandom.uuid,
+        'authorization' => authorization,
+      ]
+    end
+
+    class UnexpectedHttpResponse < StandardError
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+        super "#{response.message} (#{response.code}): #{response.body}"
+      end
+    end
+
+    def fail_unless_expected_response(response, *allowed_responses)
+      unless allowed_responses.any? { |allowed| response.is_a?(allowed) }
+        logger.error "#{response.inspect}: #{response.body}"
+        raise UnexpectedHttpResponse, response
+      end
+      response
+    end
+  end
+end

data/lib/amex_enhanced_authorization/version.rb

@@ -0,0 +1,3 @@
+module AmexEnhancedAuthorization
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: amex_enhanced_authorization
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piers Chambers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- piers@varyonic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amex_enhanced_authorization.gemspec
+- bin/console
+- bin/setup
+- lib/amex_enhanced_authorization.rb
+- lib/amex_enhanced_authorization/connection.rb
+- lib/amex_enhanced_authorization/logged_request.rb
+- lib/amex_enhanced_authorization/online_purchase_payload.rb
+- lib/amex_enhanced_authorization/request.rb
+- lib/amex_enhanced_authorization/version.rb
+homepage: https://github.com/varyonic/amex_enhanced_authorization
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Unofficial Ruby wrapper for American Express Enhanced Authorization.
+test_files: []