amazon_pay_sdk_ruby 2.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a011e5f19615809e2f2c509db59e3bea54a2eb2f862b93b4543e748cbef47615
+  data.tar.gz: 9f536bd179c9f41dd8bcee724ab7ec7a6820dbe20377183bcdd1979221f2256a
+SHA512:
+  metadata.gz: aa8002c583784b74bfcc6348f98637179596477f6272e8c6bc2cb6d0cb00ed841ad181bb790ac038a6aa3b8388167db34df58f0d4205a104e237951d6f5304f8
+  data.tar.gz: b31eb6a23d9a070163575e96b9314b57d4946929c69d900165dfc272ab1323dcafac7b1a24eba23813d008ffcd26401a341849cc59183a22b217155296d60e01

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.pem
+amzn.pem
+
+/spec/amzn.pem
+spec/amzn.pem

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.5.3
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at everistusolumese@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 amazon_pay_sdk_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    amazon_pay_sdk_ruby (2.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  amazon_pay_sdk_ruby!
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Everistus Olumese
+
+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,478 @@
+# Amazon Pay API SDK (Ruby)
+
+[![Gem Version](https://badge.fury.io/rb/amazon_pay_sdk_ruby.svg)](https://badge.fury.io/rb/amazon_pay_sdk_ruby)
+
+Amazon Pay Checkout v2 Integration
+
+Please note the Amazon Pay API SDK can only be used for API calls to the pay-api.amazon.com|eu|jp endpoint.
+
+If you need to make an Amazon Pay API call that uses the mws.amazonservices.com|jp or mws-eu.amazonservices.com endpoint, then you will need to use the original [Amazon Pay SDK (Ruby)](https://github.com/amzn/amazon-pay-sdk-ruby).
+
+## Requirements
+
+- Amazon Pay account: To register for Amazon Pay, go to https://pay.amazon.com, choose your region by selecting the flag icon in the upper right corner, and then click "Register".
+- Ruby 2.5.3 or higher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+    gem 'amazon_pay_sdk_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amazon_pay_sdk_ruby
+
+## Public and Private Keys
+
+MWS access keys, MWS secret keys, and MWS authorization tokens from previous MWS integrations cannot be used with this SDK.
+
+You will need to generate your own public/private key pair to make API calls with this SDK.
+
+In Windows 10 this can be done with ssh-keygen commands:
+
+```
+ssh-keygen -t rsa -b 2048 -f private.pem
+ssh-keygen -f private.pem -e -m PKCS8 > public.pub
+```
+
+In Linux or macOS this can be done using openssl commands:
+
+```
+openssl genrsa -out private.pem 2048
+openssl rsa -in private.pem -pubout > public.pub
+```
+
+The first command above generates a private key and the second line uses the private key to generate a public key.
+
+To associate the key with your account, follow the instructions here to
+[Get your Public Key ID](http://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-checkout/get-set-up-for-integration.html#4-get-your-public-key-id).
+
+## Configuration
+
+```ruby
+   config = {
+        'public_Key_id': 'ABC123DEF456XYZ', # RSA Public Key ID (this is not the Merchant or Seller ID)
+        'private_key': File.read(File.expand_path('tst/private.pem', __dir__)), # Path to RSA Private Key (or a string representation)
+        'region': 'us',                                                         # Must be one of: 'us', 'eu', 'jp'
+        'sandbox': true                                                         # true (Sandbox) or false (Production) boolean
+    }
+```
+
+# Versioning
+
+The pay-api.amazon.com|eu|jp endpoint uses versioning to allow future updates. The major version of this SDK will stay aligned with the API version of the endpoint.
+
+If you have downloaded version 2.x.y of this SDK, version in below examples would be "v2".
+
+# Convenience methods (Overview)
+
+Make use of the built-in convenience methods to easily make API calls. Scroll down further to see example code snippets.
+
+When using the convenience methods, the request payload will be signed using the provided private key, and a HTTPS request is made to the correct regional endpoint.
+In the event of request throttling, the HTTPS call will be attempted up to three times
+
+## Alexa Delivery Trackers API
+
+Please note that your merchant account must be whitelisted to use the [Delivery Trackers API](https://developer.amazon.com/docs/amazon-pay-onetime/delivery-order-notifications.html).
+
+- **delivery_trackers**(payload: nil, headers: nil) &#8594 POST to `#{version}/delivery_trackers`
+
+## Authorization Tokens API
+
+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 method.
+
+- **get_authorization_token**(mws_auth_token: nil, merchant_id: nil, headers: nil) &#8594 GET to `#{version}/authorizationTokens#{mws_auth_token}?merchantId=#{merchant_id}`
+
+## Amazon Checkout v2 API
+
+[Checkout v2 Integration Guide](https://amazonpaycheckoutintegrationguide.s3.amazonaws.com/amazon-pay-api-v2/introduction.html)
+
+The headers field is not optional for create/POST calls below because it requires, at a minimum, the x-amz-pay-idempotency-key header:
+
+```ruby
+   headers = {
+        'x-amz-pay-idempotency-key': SecureRandom.uuid.to_s.gsub(/-/, '')
+    }
+```
+
+### Amazon Checkout v2 Buyer Hash
+
+- **get_buyer**(buyer_token: nil, headers: nil) &#8594 GET to `#{version}/buyer/{$buyerToken}`
+
+### Checkout v2 CheckoutSession Hash
+
+- **create_checkout_session**(payload: nil, headers: nil) &#8594 POST to `#{version}/checkoutSessions`
+- **get_checkout_session**(checkout_session_id: nil, headers: nil) &#8594 GET to `#{version}/checkoutSessions/#{checkout_session_id}`
+- **update_checkout_session**(checkout_session_id: nil, payload: nil, headers: nil) &#8594 PATCH to `#{version}/checkoutSessions#{checkout_session_id}`
+- **complete_checkout_session**(checkout_session_id: nil, payload: nil, headers: nil) &#8594 POST to `#{version}/checkoutSessions#{checkout_session_id}/complete`
+
+### Checkout v2 ChargePermission Hash
+
+- **get_charge_permission**(charge_permission_id: nil, headers: nil) &#8594 GET to `#{version}/chargePermissions/#{charge_permission_id}`
+- **update_charge_permission**(charge_permission_id: nil, payload: nil, headers: nil) &#8594 PATCH to `#{version}/chargePermissions#{charge_permission_id}`
+- **close_charge_permission**(charge_permission_id: nil, payload: nil, headers: nil) &#8594 DELETE to `#{version}/chargePermissions#{charge_permission_id}/close`
+
+### Checkout v2 Charge Hash
+
+- **create_charge**(payload: nil, headers: nil) &#8594 POST to `#{version}/charges`
+- **get_charge**(charge_id: nil, headers: nil) &#8594 GET to `#{version}/charges/#{charge_id}`
+- **capture_charge**(charge_id: nil, payload: nil, headers: nil) &#8594 POST to `#{version}/charges/#{charge_id}/capture`
+- **cancel_charge**(charge_id: nil, payload: nil, headers: nil) &#8594 DELETE to `#{version}/charges/#{charge_id}/cancel`
+
+### Checkout v2 Refund Hash
+
+- **create_refund**(payload: nil, headers: nil) &#8594 POST to `#{version}/refunds`
+- **get_refund**(refund_id: nil, headers: nil) &#8594 GET to `#{version}/refunds/#{refund_id}`
+
+## In-Store API
+
+Please contact your Amazon Pay Account Manager before using the In-Store API calls in a Production environment to obtain a copy of the In-Store Integration Guide.
+
+- **instore_merchant_scan**(payload: nil, headers: nil) &#8594 POST to `#{version}/in-store/merchant_scan`
+- **instore_charge**(payload: nil, headers: nil) &#8594 POST to `#{version}/in-store/charge`
+- **instore_refund**(payload: nil, headers: nil) &#8594 POST to `#{version}/in-store/refund`
+
+# Using Convenience methods
+
+Four quick steps are needed to make an API call:
+
+Step 1. Construct a Client (using the previously defined Config Hash).
+
+```ruby
+   require 'amazon_pay_sdk_ruby'
+
+   client = AmazonPay::AmazonPayClient.new(config)
+    #-or-
+   client = AmazonPay::AmazonWebStoreClient.new(config)
+    #-or-
+   client = AmazonPay::AmazonInStoreClient.new(config)
+```
+
+Step 2. Generate the payload.
+
+```ruby
+   payload = {
+        scanData: 'UKhrmatMeKdlfY6b',
+        scanReferenceId: SecureRandom.uuid.to_s.gsub(/-/, ''),
+        merchantCOE: 'US',
+        ledgerCurrency: 'USD',
+        chargeTotal: {
+            currencyCode: 'USD',
+            amount: '2.00'
+        },
+        storeLocation: {
+            countryCode: 'US'
+        },
+        metadata: {
+            merchantNote: 'Merchant Name',
+            customInformation: 'in-store Software Purchase',
+            communicationContext: {
+                merchantStoreName: 'Store Name',
+                merchantOrderId: '789123'
+            }
+        }
+    }
+```
+
+Step 3. Execute the call.
+
+```ruby
+    response = client.merchant_scan(payload: payload)
+```
+
+If you are a Solution Provider and need to make an API call on behalf of a different merchant account, you will need to pass along an extra authentication token parameter into the API call.
+
+```ruby
+    test_headers = {
+        'x-amz-pay-authtoken': 'other_merchant_super_secret_token'
+    }
+   response = client.merchant_scan(payload: payload, headers: test_headers)
+```
+
+# Convenience methods Code Samples
+
+## Alexa Delivery Notifications
+
+```ruby
+   require 'amazon_pay_sdk_ruby'
+
+   config = {
+        public_key_id: 'ABC123DEF456XYZ',
+        private_key: File.read(File.expand_path('tst/private.pem', __dir__)),
+        region: 'us',
+        sandbox: true
+    }
+
+   payload = {
+        amazonOrderReferenceId: 'P00-0000000-0000000',
+        deliveryDetails: [{
+            trackingNumber: '1Z999AA10123456789',
+            carrierCode: 'UPS'
+        }]
+    }
+
+   client = AmazonPay::AmazonPayClient.new(config)
+   response = client.delivery_trackers(payload: payload)
+```
+
+## Checkout v2 - Create Checkout Session
+
+```ruby
+   require 'amazon_pay_sdk_ruby'
+
+   config = {
+        public_key_id: 'ABC123DEF456XYZ',
+        private_key: File.read(File.expand_path('tst/private.pem', __dir__)),
+        region: 'us',
+        sandbox: true
+    }
+
+   payload = {
+        webCheckoutDetails: {
+            checkoutReviewReturnUrl: 'https://localhost/store/checkoutReview',
+            checkoutResultReturnUrl: 'https://localhost/store/checkoutReturn'
+        },
+        storeId: 'amzn1.application-oa2-client.5cc4962582fd4025a2962fc5350582d9' # Enter Client ID
+    }
+   headers = {
+        'x-amz-pay-idempotency-key': SecureRandom.uuid.to_s.gsub(/-/, '')
+    }
+
+   client = AmazonPay::AmazonWebStoreClient.new(config)
+   response = client.create_checkout_session(payload: payload, headers: headers)
+```
+
+## Checkout v2 - Get Checkout Session
+
+```ruby
+   require 'amazon_pay_sdk_ruby'
+
+   config = {
+        public_key_id: 'ABC123DEF456XYZ',
+        private_key: File.read(File.expand_path('tst/private.pem', __dir__)),
+        region: 'us',
+        sandbox: true
+    }
+
+   headers = {
+        'x-amz-pay-idempotency-key': SecureRandom.uuid.to_s.gsub(/-/, '')
+    }
+
+   checkout_session_id = '00000000-0000-0000-0000-000000000000'
+   client = AmazonPay::AmazonWebStoreClient.new(config)
+   response = client.get_checkout_session(checkout_session_id: checkout_session_id, headers: headers)
+```
+
+## Checkout v2 - Update Checkout Session
+
+```ruby
+   require 'amazon_pay_sdk_ruby'
+
+   config = {
+        public_key_id: 'ABC123DEF456XYZ',
+        private_key: File.read(File.expand_path('tst/private.pem', __dir__)),
+        region: 'us',
+        sandbox: true
+    }
+
+   payload = {
+        webCheckoutDetails: {
+            checkoutResultReturnUrl: 'https://localhost/store/checkoutReturn'
+        },
+        paymentDetails: {
+            paymentIntent: 'Confirm',
+            canHandlePendingAuthorization: false,
+            chargeAmount: {
+                amount: 50,
+                currencyCode: 'USD'
+            }
+        },
+        merchantMetadata: {
+            merchantReferenceId: SecureRandom.uuid.to_s.gsub(/-/, ''),
+            merchantStoreName: 'AmazonTestStoreFront',
+            noteToBuyer: 'merchantNoteForBuyer',
+            customInformation: ''
+        }
+    }
+
+   checkout_session_id = '00000000-0000-0000-0000-000000000000'
+   client = AmazonPay::AmazonWebStoreClient.new(config)
+   response = client.updateCheckoutSession(checkout_session_id: checkout_session_id, payload: payload)
+```
+
+## Checkout v2 - Capture Charge
+
+```ruby
+   require 'amazon_pay_sdk_ruby'
+
+   config = {
+        public_key_id: 'ABC123DEF456XYZ',
+        private_key: File.read(File.expand_path('tst/private.pem', __dir__)),
+        region: 'us',
+        sandbox: true
+    }
+
+   payload = {
+        captureAmount: {
+            amount: '10.00',
+            currencyCode: 'USD'
+        },
+        softDescriptor: 'AMZN'
+    }
+   headers = {
+        'x-amz-pay-idempotency-key': SecureRandom.uuid.to_s.gsub(/-/, '')
+    }
+
+   charge_id = 'S01-0000000-0000000-C000000'
+   client = AmazonPay::AmazonWebStoreClient.new(config)
+   response = client.capture_charge(charge_id: charge_id, payload: payload, headers: headers)
+```
+
+## In Store MerchantScan
+
+```ruby
+   payload = {
+        scanData: '[scanData]',
+        scanReferenceId: '[scanReferenceId]',
+        merchantCOE: 'US',
+        ledgerCurrency: 'USD'
+    }
+
+    response = client.merchant_scan(payload: payload)
+    merchant_scan_charge_permission_id = response[:charge_permission_id]
+```
+
+## Generate Button Signature
+
+The signatures generated by this helper method are only valid for the Checkout v2 front-end buttons. Unlike API signing, no timestamps are involved, so the result of this method can be considered a static signature that can safely be placed in your website source files and used repeatedly (as long as your payload does not change).
+
+Example call to generate_button_signature method:
+
+```ruby
+   require 'amazon_pay_sdk_ruby'
+
+   config = {
+        public_key_id: 'ABC123DEF456XYZ',
+        private_key: File.read(File.expand_path('tst/private.pem', __dir__)),
+        region: 'us',
+        sandbox: true
+    }
+
+   client = AmazonPay::AmazonPayClient.new(config)
+   payload = {
+        webCheckoutDetails: {
+            checkoutReviewReturnUrl: 'https://localhosttst/checkoutReview.html',
+            checkoutResultReturnUrl: 'https://localhosttst/checkoutResult.html'
+        },
+        storeId: 'amzn1.application-oa2-client.xxxxx'
+    }
+   signature = client.generate_button_signature(payload: payload)
+```
+
+## Manual Signing (Advanced Use-Cases Only)
+
+This SDK provides the ability to help you manually sign your API requests if you want to use your own code for sending the HTTPS request over the Internet.
+
+Example call to api_call method with values:
+
+```ruby
+    /** 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 {String} [options.headers=nil] - The headers for the API Call
+```
+
+Example request method:
+
+```ruby
+   options = {
+        method: 'POST',
+        url_fragment: '#{version}/in-store/merchant_scan',
+        payload = {
+            scanData: 'UKhrmatMeKdlfY6b',
+            scanReferenceId: '0b8fb271-2ae2-49a5-b35d4',
+            merchantCOE: 'US',
+            ledgerCurrency: 'USD',
+            chargeTotal: {
+                currencyCode: 'USD',
+                amount: '2.00'
+            },
+            storeLocation: {
+                countryCode: 'US'
+            },
+            metadata: {
+                merchantNote: 'Merchant Name',
+                customInformation: 'in-store Software Purchase',
+                communicationContext: {
+                    merchantStoreName: 'Store Name',
+                    merchantOrderId: '789123'
+                }
+            }
+        }
+    }
+
+   client = AmazonPay::AmazonInStoreClient.new(config)
+   signed_headers = client.api_call(options: options)
+```
+
+Example call to get_signed_headers method with values:
+(This will only be used if you don't use api_call and want to create your own custom headers.)
+
+```ruby
+    /** 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 {String} [options.headers=nil] - The headers for the API Call
+     **/
+```
+
+Example request method:
+
+```ruby
+   options = {
+        method: 'POST',
+        url_fragment: '#{version}/in-store/merchant_scan',
+        payload = {
+            scanData: 'UKhrmatMeKdlfY6b',
+            scanReferenceId: '0b8fb271-2ae2-49a5-b35d4',
+            merchantCOE: 'US',
+            ledgerCurrency: 'USD',
+            chargeTotal: {
+                currencyCode: 'USD',
+                amount: '2.00'
+            },
+            storeLocation: {
+                countryCode: 'US'
+            },
+            metadata: {
+                merchantNote: 'Merchant Name',
+                customInformation: 'in-store Software Purchase',
+                communicationContext: {
+                    merchantStoreName: 'Store Name',
+                    merchantOrderId: '789123'
+                }
+            }
+        },
+        headers: {
+            'Accept': 'application/rubyon',
+            'Content-Type': 'application/rubyon'
+            'X-Amz-Pay-Region': 'us'
+        }
+    }
+
+   client = AmazonPay::AmazonPayClient.new(config)
+   signed_headers = client.get_signed_headers(options: options)
+```