amex_tokenization_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc1bed91ec19fe5de22c7ff1f400beb1194b3dedb786cdaf0b9d5508cec2517e
+  data.tar.gz: 1fda85c458678f521642fa5204bcab84a913b3f8a587bd27d29b0dccec06d2ea
+SHA512:
+  metadata.gz: 7f3c8728670b59815678f7801dc7cbf3d0640bf223d16cbf102c577b36ff6a66ca8dada4acb052da1533224fd0fe33b068b109f70cd2bd1e231ce5754ffe3bcb
+  data.tar.gz: 53ea08d13c512d49a99f126bd588fbae6c77ddad17576000b02f28a997ecacc29f9d14940fa8d99051b4053d5bdf2c0d95f5d53eff4f1758d219fb3db8bd6711

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 1.16.3

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in amex_tokenization_client.gemspec
+gemspec
+
+gem 'jwe', github: 'varyonic/ruby-jwe.git', branch: 'PR18' # Fix A256KW.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 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,35 @@
+# AmexTokenizationClient
+
+[![Travis CI Status](https://secure.travis-ci.org/varyonic/amex-api-ruby-client.svg)](https://travis-ci.org/varyonic/amex-api-ruby-client)
+
+Unofficial Ruby wrapper for the American Express Tokenization Service (AETS).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amex_tokenization_client'
+```
+
+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/varyonic/amex-api-ruby-client.
+
+## 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_tokenization_client.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "amex_tokenization_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "amex_tokenization_client"
+  spec.version       = AmexTokenizationClient::VERSION
+  spec.authors       = ["Piers Chambers"]
+  spec.email         = ["piers@varyonic.com"]
+
+  spec.summary       = "Unofficial Ruby wrapper for the American Express Tokenization Service (AETS)."
+  spec.homepage      = "https://github.com/varyonic/amex-api-ruby-client"
+  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_dependency "jwe"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  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_tokenization_client"
+
+# 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_tokenization_client/notifications_payload.rb

@@ -0,0 +1,16 @@
+class AmexTokenizationClient
+  class NotificationsPayload
+    attr_reader :token_ref_id, :notification_type
+
+    def initialize(token_ref_id:, notification_type:)
+      @token_ref_id, @notification_type = token_ref_id, notification_type
+    end
+
+    def to_json(_encryption_key_id, _encryption_key)
+      Hash[
+        token_ref_id: token_ref_id,
+        notification_type: notification_type
+      ].to_json
+    end
+  end
+end

data/lib/amex_tokenization_client/provisioning_payload.rb

@@ -0,0 +1,41 @@
+require 'json'
+
+class AmexTokenizationClient
+  class ProvisioningPayload
+    attr_reader :account_number, :expiry_month, :expiry_year
+    attr_reader :name, :email, :is_on_file, :ip_address
+
+    def initialize(account_number:, name:, expiry_month:, expiry_year:, email:, is_on_file:, ip_address: nil)
+      @account_number, @expiry_month, @expiry_year = account_number, expiry_month, expiry_year
+      @name, @email, @is_on_file, @ip_address = name, email, is_on_file, ip_address
+    end
+
+    def to_json(encryption_key_id, encryption_key)
+      Hash[
+        account_data: account_data(encryption_key_id, encryption_key),
+        user_data: { name: name, email: email },
+        risk_assessment_data: risk_assessment_data
+      ].to_json
+    end
+
+    protected
+
+    def account_data(encryption_key_id, encryption_key)
+       json = JSON.generate Hash[
+        account_type: 'credit_card',
+        credit_card: { account_number: account_number, expiry_month: expiry_month, expiry_year: expiry_year }
+      ]
+      jwe_encrypt(json, encryption_key_id, encryption_key)
+    end
+
+    def risk_assessment_data
+      data = { account_input_method: is_on_file ? 'On File' : 'User Input' }
+      data[:ip_address] = ip_address if ip_address
+      data
+    end
+
+    def jwe_encrypt(data, encryption_key_id, encryption_key)
+      JWE.encrypt(data, encryption_key, alg: 'A256KW', enc: 'A128GCM', kid: encryption_key_id)
+    end
+  end
+end

data/lib/amex_tokenization_client/request.rb

@@ -0,0 +1,66 @@
+require 'benchmark'
+require 'net/http'
+
+class AmexTokenizationClient
+  class Request
+    attr_reader :uri, :request
+    attr_reader :logger
+
+    def initialize(method, path, headers, logger:)
+      @logger = logger
+      @uri = URI(path)
+      @request = Net::HTTP.const_get(method.capitalize).new(uri)
+      headers.each_pair { |k, v| request[k] = v }
+    end
+
+    # Create HTTP request with provided headers.
+    # Invoke request over HTTPS.
+    # Return response on success or log failure and throw error.
+    def send(data = nil)
+      request.body = data if data
+      response = log_request_response(data) do
+        https(uri).request(request)
+      end
+      fail_unless_expected_response response, Net::HTTPSuccess
+      response.body
+    end
+
+    def https(uri)
+      Net::HTTP.new(uri.host, uri.port).tap do |http|
+        http.use_ssl = true
+      end
+    end
+
+    # Log URI, method, data
+    # Start timer.
+    # Yield URI, method, data.
+    # Log response and time taken.
+    def log_request_response(data = nil)
+      logger.info "[#{self.class.name}] request = #{request.method} #{uri}#{data ? '?' + data : ''}"
+      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
+
+    class UnexpectedHttpResponse < StandardError
+      def initialize(response)
+        super response.message || response.code
+      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_tokenization_client/version.rb

@@ -0,0 +1,3 @@
+class AmexTokenizationClient
+  VERSION = "0.1.0"
+end

data/lib/amex_tokenization_client.rb

@@ -0,0 +1,97 @@
+require 'base64'
+require 'json'
+require 'jwe'
+require 'logger'
+require 'openssl'
+require "amex_tokenization_client/notifications_payload"
+require "amex_tokenization_client/provisioning_payload"
+require "amex_tokenization_client/request"
+require "amex_tokenization_client/version"
+
+class AmexTokenizationClient
+  attr_reader :host
+  attr_reader :base_path
+  attr_reader :token_requester_id
+  attr_reader :client_id, :client_secret
+  attr_reader :encryption_key_id, :encryption_key
+  attr_accessor :logger
+
+  def initialize(host:,
+                 token_requester_id:,
+                 client_id:, client_secret:,
+                 encryption_key_id:, encryption_key:,
+                 logger: Logger.new('/dev/null'))
+    @host = host
+    @base_path = "/payments/digital/v2/tokens".freeze
+    @token_requester_id = token_requester_id
+    @client_id, @client_secret = client_id, client_secret
+    @encryption_key_id, @encryption_key = encryption_key_id, Base64.decode64(encryption_key)
+    @logger = logger
+  end
+
+  # @return [Hash] token_ref_id and other values.
+  def provisioning(kargs)
+    response = JSON.parse send_authorized_request('POST', 'provisioning', provisioning_payload(kargs))
+    response.merge! JSON.parse jwe_decrypt response.delete('secure_token_data')
+    response
+  end
+
+  def notifications(kargs)
+    send_authorized_request('POST', 'notifications', notifications_payload(kargs))
+  end
+
+  def status(token_ref_id)
+    JSON.parse send_authorized_request('GET', "#{token_ref_id}/status")
+  end
+
+  def metadata(token_ref_id)
+    JSON.parse send_authorized_request('GET', "#{token_ref_id}/metadata")
+  end
+
+  def provisioning_payload(kargs)
+    ProvisioningPayload.new(kargs).to_json(encryption_key_id, encryption_key)
+  end
+
+  def notifications_payload(kargs)
+    NotificationsPayload.new(kargs).to_json(encryption_key_id, encryption_key)
+  end
+
+  def jwe_decrypt(data)
+    JWE.decrypt(data, encryption_key)
+  end
+
+  def send_authorized_request(method, route, payload = nil)
+    resource_path = "#{base_path}/#{route}"
+    authorization = hmac_authorization(method, resource_path, payload)
+    new_request(method, resource_path, authorization).send(payload)
+  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
+
+  def new_request(method, resource_path, authorization)
+    Request.new(method, "https://#{host}/#{resource_path}", headers(authorization), logger: logger)
+  end
+
+  def headers(authorization)
+    Hash[
+      'Content-Type' => 'application/json',
+      'Content-Language' => 'en-US',
+      'x-amex-token-requester-id' => token_requester_id,
+      'x-amex-api-key' => client_id,
+      'x-amex-request-id' => SecureRandom.uuid,
+      'authorization' => authorization,
+    ]
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: amex_tokenization_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piers Chambers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwe
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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_tokenization_client.gemspec
+- bin/console
+- bin/setup
+- lib/amex_tokenization_client.rb
+- lib/amex_tokenization_client/notifications_payload.rb
+- lib/amex_tokenization_client/provisioning_payload.rb
+- lib/amex_tokenization_client/request.rb
+- lib/amex_tokenization_client/version.rb
+homepage: https://github.com/varyonic/amex-api-ruby-client
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Unofficial Ruby wrapper for the American Express Tokenization Service (AETS).
+test_files: []