amazon_pay_sdk_ruby 2.0.2

data/Rakefile

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

data/amazon_pay_sdk_ruby.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amazon_pay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'amazon_pay_sdk_ruby'
+  spec.version       = AmazonPay::VERSION
+  spec.authors       = ['Everistus Olumese']
+  spec.email         = ['everistusolumese@gmail.com']
+
+  spec.summary       = 'AmazonPay Ruby SDK'
+  spec.description   = 'AmazonPay Ruby SDK'
+  spec.homepage      = 'https://github.com/bytenaija/amazon-pay-sdk-ruby'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_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 'amazon_pay_sdk_ruby'
+
+# 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/amazon_pay/amazon_in_store_client.rb

@@ -0,0 +1,53 @@
+module AmazonPay
+  # Class for Amazon Web Store
+  class AmazonInStoreClient < AmazonPayClient
+    def initialize(config_args)
+      super(config_args)
+    end
+
+    #  API to initiate a purchase with a merchant
+    #   - Initiates a purchase with a merchant.
+    # @see //TODO Update Live URL
+    # @param {Hash} payload - The payload for the request
+    # @param {Hash} [headers=nil] - The headers for the request
+    #
+    def merchant_scan(payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'POST',
+                 url_fragment: 'in-store/merchantScan',
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    # API to create Charge to the buyer
+    #   - Creates a charge to the buyer with the requested amount.
+    # @see //TODO Update Live URL
+    # @param {Hash} payload - The payload for the request
+    # @param {Hash} [headers=nil] - The headers for the request
+    #
+    def charge(payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'POST',
+                 url_fragment: 'in-store/charge',
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    #  API to create a Refund to the buyer
+    #   - Refunds an amount that was previously charged to the buyer.
+    # @see //TODO Update Live URL
+    # @param {Hash} payload - The payload for the request
+    # @param {Hash} [headers=nil] - The headers for the request
+    #
+    def refund(payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'POST',
+                 url_fragment: 'in-store/refund',
+                 payload: payload,
+                 headers: headers
+               })
+    end
+  end
+end

data/lib/amazon_pay/amazon_pay_client.rb

@@ -0,0 +1,85 @@
+require 'amazon_pay/client_helper'
+
+module AmazonPay
+  class AmazonPayClient
+    def initialize(config_args)
+      @config_args = config_args.freeze
+    end
+
+    # API to process a request
+    # - Makes an API Call using the specified options.
+    # @param {Hash} options - The options to make the API Call
+    # @param {String} options.method - The HTTP request method
+    # @param {String} options.url_fragment - The URI for the API Call
+    # @param {String} [options.payload=nil] - The payload for the API Call
+    # @param {Hash} [options.headers=nil] - The headers for the API Call
+    # @param {Hash} [options.queryParams=nil] - The headers for the API Call
+
+    def api_call(options: {})
+      prepared_options = AmazonPay::ClientHelper.prepare_options(config_args: @config_args, options: options)
+      prepared_options[:headers] = AmazonPay::ClientHelper.sign_headers(config_args: @config_args, options: prepared_options)
+      AmazonPay::ClientHelper.invoke_api(config_args: @config_args, api_options: prepared_options)
+    end
+
+    # Signs the request headers
+    #       - Signs the request provided and returns the signed headers Hash.
+    #     @param {Hash} options - The options to make the API Call
+    #     @param {String} options.method - The HTTP request method
+    #     @param {String} options.url_fragment - The URI for the API Call
+    #     @param {String} [options.payload=nil] - The payload for the API Call
+    #     @param {Hash} [options.headers=nil] - The headers for the API Call
+
+    def get_signed_headers(options: {})
+      prepared_options = AmazonPay::ClientHelper.prepare_options(@config_args, options)
+      AmazonPay::ClientHelper.sign_headers(config_args: @config_args, options: prepared_options)
+    end
+
+    #  Lets the solution provider get Authorization Token for their merchants if they are granted the delegation.
+    #       - Please note that your solution provider account must have a pre-existing relationship (valid and active MWS authorization token) with the merchant account in order to use this function.
+    #     @param {String} mws_auth_token - The mws_auth_token
+    #     @param {String} merchant_id - The merchant_id
+    #     @param {Hash} [headers=nil] - The headers for the request
+
+    def get_authorization_token(mws_auth_token: nil, merchant_id: nil, headers: nil)
+      api_call(options: {
+                 method: 'GET',
+                 url_fragment: "authorizationTokens/#{mws_auth_token}",
+                 headers: headers,
+                 query_params: {
+                   merchantId: merchant_id
+                 }
+               })
+    end
+
+    #  Generates static signature for amazon.Pay.renderButton used by checkout.js.
+    #     - Returns signature as string.
+    #   @param {Hash} payload - The payload for the request
+    #   @returns {String} signature
+
+    def generate_button_signature(payload: nil)
+      AmazonPay::ClientHelper.sign_payload(config_args: @config_args, payload: payload)
+    end
+
+    # Lets the solution provider make the DeliveryTrackers request with their auth token.
+    #     - Lets you provide shipment tracking information to Amazon Pay so that Amazon Pay will
+    #       be able to notify buyers on Alexa when shipments are delivered.
+    #   @see https://developer.amazon.com/docs/amazon-pay-onetime/delivery-notifications.html#api-reference
+    #   @param {Hash} payload - The payload for the request
+    #   @param {String} payload.amazonOrderReferenceId - The Amazon Order Reference ID or Charge
+    #                   Permission Id associated with the order for which the shipments need
+    #                   to be tracked
+    #   @param {String} payload.trackingNumber - The tracking number for the shipment provided by
+    #                   the shipping company
+    #   @param {Hash} payload.carrierCode - The shipping company code used for delivering goods to the customer
+    #   @param {Hash} [headers=nil] - The headers for the request
+
+    def delivery_trackers(payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'POST',
+                 url_fragment: 'deliveryTrackers',
+                 payload: payload,
+                 headers: headers
+               })
+    end
+  end
+end

data/lib/amazon_pay/amazon_web_store_client.rb

@@ -0,0 +1,215 @@
+# rubocop:disable Metrics/ClassLength
+
+module AmazonPay
+  # Class for Amazon Web Store
+  class AmazonWebStoreClient < AmazonPayClient
+    def initialize(config_args)
+      super(config_args)
+    end
+
+    #  API to get the Buyer Hash
+    #       - Get Buyer details can include buyer ID, name, email address, postal code,
+    #         and country code
+    #       - when used with the Amazon.Pay.renderButton 'SignIn' productType and corresponding
+    #         signInScopes
+    #     @param {String} buyer_token - The checkout session Id
+    #     @param {Hash} [headers=nil] - The headers for the request
+
+    def get_buyer(buyer_token: nil, headers: nil)
+      api_call(options:
+        {
+          method: 'GET',
+          url_fragment: "buyers/#{buyer_token}",
+          headers: headers
+        })
+    end
+
+    #  API to create a CheckoutSession Hash
+    #     - Creates a new CheckoutSession Hash.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/checkout-session.html#create-checkout-session
+    #   @param {Hash} payload - The payload for the request
+    #   @param {Hash} headers - The headers for the request
+    def create_checkout_session(payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'POST',
+                 url_fragment: 'checkoutSessions',
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    # API to get the CheckoutSession Hash
+    #     - Retrives details of a previously created CheckoutSession Hash.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/checkout-session.html#get-checkout-session
+    #   @param {String} checkout_session_id - The checkout session Id
+    #   @param {Hash} [headers=nil] - The headers for the request
+    def get_checkout_session(checkout_session_id: nil, headers: nil)
+      api_call(options: {
+                 method: 'GET',
+                 url_fragment: "checkoutSessions/#{checkout_session_id}",
+                 headers: headers
+               })
+    end
+
+    # API to update the CheckoutSession Hash
+    #     - Updates a previously created CheckoutSession Hash.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/checkout-session.html#update-checkout-session
+    #   @param {String} checkout_session_id - The checkout session Id
+    #   @param {Hash} payload - The payload for the request
+    #   @param {Hash} [headers=nil] - The headers for the request
+    def update_checkout_session(checkout_session_id: nil, payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'PATCH',
+                 url_fragment: "checkoutSessions/#{checkout_session_id}",
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    # API to complete a Checkout Session
+    #     - Confirms the completion of buyer checkout.
+    #   @see //TODO Update Live URL
+    #   @param {String} checkout_session_id - The checkout session Id
+    #   @param {Hash} payload - The payload for the request
+    #   @param {Hash} [headers=nil] - The headers for the request
+    def complete_checkout_session(checkout_session_id: nil, payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'POST',
+                 url_fragment: "checkoutSessions/#{checkout_session_id}/complete",
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    # API to get a ChargePermission Hash
+    #     - Retrives details of a previously created ChargePermission Hash.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/charge-permission.html#get-charge-permission
+    #   @param {String} charge_permission_id - The charge permission Id
+    #   @param {Hash} [headers=nil] - The headers for the request
+    def get_charge_permission(charge_permission_id: nil, headers: nil)
+      api_call(options: {
+                 method: 'GET',
+                 url_fragment: "chargePermissions/#{charge_permission_id}",
+                 headers: headers
+               })
+    end
+
+    # API to update a ChargePermission Hash
+    #     - Updates a previously created ChargePermission Hash.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/charge-permission.html#update-charge-permission
+    #   @param {String} charge_permission_id - The charge permission Id
+    #   @param {Hash} payload - The payload for the request
+    #   @param {Hash} [headers=nil] - The headers for the request
+    def update_charge_permission(charge_permission_id: nil, payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'PATCH',
+                 url_fragment: "chargePermissions/#{charge_permission_id}",
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    # API to close a ChargePermission Hash
+    #     - Closes a perviously created ChargePermission Hash.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/charge-permission.html#close-charge-permission
+    #   @param {String} charge_permission_id - The charge permission Id
+    #   @param {Hash} payload - The payload for the request
+    #   @param {Hash} [headers=nil] - The headers for the request
+    def close_charge_permission(charge_permission_id: nil, payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'DELETE',
+                 url_fragment: "chargePermissions/#{charge_permission_id}/close",
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    # API to create a Charge Hash
+    #     - Creates a new Charge Hash.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/charge.html#create-charge
+    #   @param {Hash} payload - The payload for the request
+    #   @param {Hash} headers - The headers for the request
+    def create_charge(payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'POST',
+                 url_fragment: 'charges',
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    # API to get the Charge Hash
+    #     - Retrieves a perviously created Charge Hash.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/charge.html#get-charge
+    #   @param {String} charge_id - The charge Id
+    #   @param {Hash} [headers=nil] - The headers for the request
+    def get_charge(charge_id: nil, headers: nil)
+      api_call(options: {
+                 method: 'GET',
+                 url_fragment: "charges/#{charge_id}",
+                 headers: headers
+               })
+    end
+
+    #  API to create a captureCharge request
+    #     - Captures an existing charge
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/charge.html#capture-charge
+    #   @param {String} charge_id - The charge Id
+    #   @param {Hash} payload - The payload for the request
+    #   @param {Hash} [headers=nil] - The headers for the request
+
+    def capture_charge(charge_id: nil, payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'POST',
+                 url_fragment: "charges/#{charge_id}/capture",
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    #  API to create a cancelCharge request
+    #     - Cancels an existing charge.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/charge.html#cancel-charge
+    #   @param {String} charge_id - The charge Id
+    #   @param {Hash} payload - The payload for the request
+    #   @param {Hash} [headers=nil] - The headers for the request
+
+    def cancel_charge(charge_id: nil, payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'DELETE',
+                 url_fragment: "charges/#{charge_id}/cancel",
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    #  API to create a Refund Hash
+    #       - Generates a refund.
+    #     @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/refund.html#create-refund
+    #     @param {Hash} payload - The payload for the request
+    #     @param {Hash} headers - The headers for the request
+
+    def create_refund(payload: nil, headers: nil)
+      api_call(options: {
+                 method: 'POST',
+                 url_fragment: 'refunds',
+                 payload: payload,
+                 headers: headers
+               })
+    end
+
+    #  API to get a Refund Hash
+    #     - Retreives details of an existing refund.
+    #   @see https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/refund.html#get-refund
+    #   @param {String} refundId - The refund Id
+    #   @param {Hash} [headers=nil] - The headers for the request
+
+    def get_refund(refund_id: nil, headers: nil)
+      api_call(options: {
+                 method: 'GET',
+                 url_fragment: "refunds/#{refund_id}",
+                 headers: headers
+               })
+    end
+  end
+end

data/lib/amazon_pay/client_helper.rb

@@ -0,0 +1,185 @@
+# rubocop:disable Metrics/MethodLength,  Metrics/ClassLength, Metrics/AbcSize
+
+require 'openssl'
+require 'base64'
+require 'json'
+require 'time'
+require 'date'
+require 'net/http'
+require 'amazon_pay/constants'
+
+module AmazonPay
+  # All the helper files
+  class ClientHelper
+    def self.fetch_timestamp
+      Time.now.utc.iso8601
+    end
+
+    def self.fetch_api_endpoint_base_url(config_args: {})
+      if config_args[:overrideServiceUrl]&.length&.positive?
+        config_args[:overrideServiceUrl]
+      else
+        region = config_args[:region].downcase.to_sym
+        region_map = AmazonPay::CONSTANTS[:REGION_MAP][region].to_sym
+
+        AmazonPay::CONSTANTS[:API_ENDPOINTS][region_map]
+      end
+    end
+
+    def self.invoke_api(config_args: {}, api_options: {})
+      options = {
+        method: api_options[:method],
+        json: false,
+        headers: api_options[:headers],
+        url: "https://#{fetch_api_endpoint_base_url(config_args: config_args)}/#{api_options[:url_fragment]}"\
+        "#{fetch_query_string(request_params: api_options[:query_params])}",
+        body: api_options[:payload]
+      }
+
+      retry_logic(options: options, count: 1)
+    end
+
+    def self.fetch_query_string(request_params: nil)
+      return "?#{fetch_parameters_as_string(request_params: request_params)}" if request_params
+
+      ''
+    end
+
+    def self.fetch_parameters_as_string(request_params: nil)
+      return '' if request_params.nil?
+
+      query_params = []
+      request_params.map do |key, value|
+        query_params << "#{key}=#{CGI.escape(value)}"
+      end
+      query_params.join('&')
+    end
+
+    def self.prepare_options(config_args: {}, options: {})
+      options[:headers] ||= {}
+
+      # if user doesn't pass in a string, assume it's a JS Hash and convert it to a JSON string
+      unless options[:payload].is_a?(String) || options[:payload].nil?
+        options[:payload] = JSON.generate(options[:payload])
+      end
+
+      options[:url_fragment] = if config_args[:sandbox] == true || config_args[:sandbox] == 'true'
+                                 "sandbox/#{AmazonPay::CONSTANTS[:API_VERSION]}/#{options[:url_fragment]}"
+                               else
+                                 "live/#{AmazonPay::CONSTANTS[:API_VERSION]}/#{options[:url_fragment]}"
+                               end
+
+      options
+    end
+
+    def self.sign(private_key: nil, data: nil)
+      sign_hash = OpenSSL::Digest.new('SHA256')
+      priv = OpenSSL::PKey::RSA.new(private_key)
+      signature = priv.sign_pss(sign_hash, data, salt_length: 20, mgf1_hash: 'SHA256')
+      Base64.strict_encode64(signature)
+    end
+
+    def self.retry_logic(options: {}, count: 0)
+      response = send_request(options: options, count: count)
+      return response if count > AmazonPay::CONSTANTS[:RETRIES]
+
+      return response unless response.nil?
+
+      count += 1
+      retry_logic(options: options, count: count)
+    end
+
+    def self.send_request(options: {}, count: 0)
+      delay_time = count == 1 ? 0 : (2**(count - 1)).seconds
+      sleep(delay_time)
+      begin
+        uri = URI(options[:url])
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+        case options[:method].to_sym
+        when :GET
+          response = http.get(uri, options[:headers])
+        when :DELETE
+          response = http.delete(uri.request_uri, options[:headers])
+        when :POST
+          request = Net::HTTP::Post.new(uri.path, options[:headers])
+          request.body = options[:body]
+          response = http.request(request)
+        when :PATCH
+          request = Net::HTTP::Patch.new(uri.path, options[:headers])
+          request.body = options[:body]
+          response = http.request(request)
+        end
+        JSON.parse(response.body)
+      rescue StandardError
+        nil
+      end
+    end
+
+    # Expected options:
+    #        options[:method]
+    #        options[:url_fragment]
+    #        options[:payload]
+    #        options[:headers]
+
+    def self.sign_headers(config_args: {}, options: {})
+      headers = options[:headers] || {}
+      headers['x-amz-pay-region'] = 'us'
+      headers['x-amz-pay-host'] = fetch_api_endpoint_base_url(config_args: config_args)
+      headers['x-amz-pay-date'] = fetch_timestamp
+      headers['content-type'] = 'application/json'
+      headers['accept'] = 'application/json'
+      headers[
+        'user-agent'
+      ] = "amazon-pay-api-sdk-ruby/#{AmazonPay::CONSTANTS[:SDK_VERSION]} (Ruby/#{RUBY_VERSION}; #{RUBY_PLATFORM})"
+
+      lower_case_sorted_header_keys = headers.keys.sort.map(&:downcase)
+      signed_headers = lower_case_sorted_header_keys.join(';')
+
+      payload = options[:payload]
+
+      if payload.nil? || options[:url_fragment].include?('/account-management/'\
+        "#{AmazonPay::CONSTANTS[:API_VERSION]}/accounts")
+        payload = '' # do not sign payload for payment critical data APIs
+      end
+
+      canonical_request =
+        options[:method] + "\n/" +
+        options[:url_fragment] + "\n" +
+        fetch_parameters_as_string(request_params: options[:query_params]) +
+        "\n"
+
+      lower_case_sorted_header_keys.each do |item|
+        str = item.downcase + ':' + headers[item] + "\n"
+
+        canonical_request += str
+      end
+
+      canonical_request += "\n" + signed_headers + "\n" +
+                           OpenSSL::Digest::SHA256.hexdigest(payload)
+
+      string_to_sign =
+        AmazonPay::CONSTANTS[:AMAZON_SIGNATURE_ALGORITHM] +
+        "\n" +
+        OpenSSL::Digest::SHA256.hexdigest(canonical_request)
+
+      signature = sign(private_key: config_args[:private_key], data: string_to_sign)
+
+      headers['authorization'] = "#{AmazonPay::CONSTANTS[:AMAZON_SIGNATURE_ALGORITHM]} "\
+      "PublicKeyId=#{config_args[:public_key_id]}, SignedHeaders=#{signed_headers}, Signature=#{signature}"
+
+      headers
+    end
+
+    def self.sign_payload(config_args: nil, payload: nil)
+      # if user doesn't pass in a string, assume it's a JS Hash and convert it to a JSON string
+      payload = JSON.generate(payload) unless payload.is_a?(String)
+      string_to_sign = AmazonPay::CONSTANTS[:AMAZON_SIGNATURE_ALGORITHM] + "\n" +
+                       OpenSSL::Digest::SHA256.hexdigest(payload)
+      sign(private_key: config_args[:private_key], data: string_to_sign)
+    end
+  end
+end