amazon_pay 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fe8a7cb7c7d3bf5e8984213b08f09ac8efacc70
+  data.tar.gz: 742f3bf2b4c60bbe6c4fb68f877c7ac58be6415f
+SHA512:
+  metadata.gz: 68b3f8d645532fd264f6dfdc3450bf5d645534005376f98ab1f7437ba4240952f24e1205eb9aa0e6b1ef0bc3ed72baff9d663bd719784170eeed50e4e731b50c
+  data.tar.gz: d80bb0c8a923dfe4ceae7e7091d8b6f300e79a71f0f3ff9494d0fa5b88079e20348066961b8484949c5b5b82922345f608891d66c274ca0cbd02ce3eb723be88

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/NOTICE

@@ -0,0 +1,9 @@
+Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"). You may not use
+this file except in compliance with the License. A copy of the License is
+located at http://aws.amazon.com/apache2.0/ or in the "license" file
+accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or simplied. See the
+License for the specific language governing permissions and limitations under
+the License.

data/README.md

@@ -0,0 +1,428 @@
+# Amazon Pay Ruby SDK
+Amazon Pay API Integration
+
+# Install
+
+```
+gem install amazon_pay
+```
+or add the following in your Gemfile:
+
+```ruby
+gem 'amazon_pay'
+```
+```
+bundle install
+```
+
+## Requirements
+
+* Ruby 2.0.0 or higher
+
+## Quick Start
+
+Instantiating the client:
+
+```ruby
+require 'amazon_pay'
+
+# Your Amazon Pay keys are
+# available in your Seller Central account
+merchant_id = 'YOUR_MERCHANT_ID'
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+client = AmazonPay::Client.new(
+  merchant_id,
+  access_key,
+  secret_key
+)
+```
+
+### Testing in Sandbox Mode
+
+The sandbox parameter is defaulted to false if not specified:
+
+```ruby
+require 'amazon_pay'
+
+# Your Amazon Pay keys are
+# available in your Seller Central account
+merchant_id = 'YOUR_MERCHANT_ID'
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+client = AmazonPay::Client.new(
+  merchant_id,
+  access_key,
+  secret_key,
+  sandbox: true
+)
+```
+
+
+### Adjusting Region and Currency Code
+
+```ruby
+require 'amazon_pay'
+
+# Your Amazon Pay keys are
+# available in your Seller Central account
+merchant_id = 'YOUR_MERCHANT_ID'
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+client = AmazonPay::Client.new(
+  merchant_id,
+  access_key,
+  secret_key,
+  region: :eu,
+  currency_code: :gbp
+)
+```
+
+### Making an API Call
+
+Below is an example on how to make the GetOrderReferenceDetails API call:
+
+```ruby
+require 'amazon_pay'
+
+# Your Amazon Pay keys are
+# available in your Seller Central account
+merchant_id = 'YOUR_MERCHANT_ID'
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+client = AmazonPay::Client.new(
+  merchant_id,
+  access_key,
+  secret_key,
+  sandbox: true
+)
+
+# These values are grabbed from the Amazon Pay
+# Address and Wallet widgets
+amazon_order_reference_id = 'AMAZON_ORDER_REFERENCE_ID'
+address_consent_token = 'ADDRESS_CONSENT_TOKEN'
+
+client.get_order_reference_details(
+  amazon_order_reference_id,
+  address_consent_token: address_consent_token
+)
+
+```
+
+### Response Parsing
+
+```ruby
+# These values are grabbed from the Amazon Pay
+# Address and Wallet widgets
+amazon_order_reference_id = 'AMAZON_ORDER_REFERENCE_ID'
+address_consent_token = 'ADDRESS_CONSENT_TOKEN'
+
+response = client.get_order_reference_details(
+  amazon_order_reference_id,
+  address_consent_token: address_consent_token
+)
+
+# This will return the original response body as a String
+response.body
+
+# This will return a REXML object
+response.to_xml
+
+# The 'get_element' method allows quick conversion to REXML
+# and parsing for the xml element. This will return a
+# String value from the specified element.
+xpath = 'XPath for the node you would like to extract'
+element = 'Node/Element name you would like to extract the value from'
+response.get_element(xpath, element)
+
+# This will return the status code of the response
+response.code
+
+# This will return true or false depending on the status code
+response.success
+```
+
+### Instant Payment Notification Verification and Parsing
+
+```ruby
+# This can be placed in your controller for a method
+# that is configured to receive a "POST" IPN from Amazon.
+headers = request.headers
+body = request.body.read
+
+ipn = AmazonPay::IpnHandler.new(headers, body)
+
+# This will return "true" if the notification is a  
+# valid IPN from Amazon
+ipn.authentic?
+
+# The following are methods used to extract the necessary
+# data from the IPN
+ipn.type
+ipn.message_id
+ipn.topic_arn
+ipn.message
+ipn.timestamp
+ipn.signature
+ipn.signature_version
+ipn.signing_cert_url
+ipn.unsubscribe_url
+ipn.notification_type
+ipn.seller_id
+ipn.environment
+ipn.version
+ipn.notification_data
+ipn.message_timestamp
+
+```
+
+### Standard One Time Transaction API Flow
+
+```ruby
+require 'amazon_pay'
+
+# Your Amazon Pay keys are
+# available in your Seller Central account
+merchant_id = 'YOUR_MERCHANT_ID'
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+client = AmazonPay::Client.new(
+  merchant_id,
+  access_key,
+  secret_key,
+  sandbox: true
+)
+
+# These values are grabbed from the Amazon Pay
+# Address and Wallet widgets
+amazon_order_reference_id = 'AMAZON_ORDER_REFERENCE_ID'
+address_consent_token = 'ADDRESS_CONSENT_TOKEN'
+
+# To get the buyers full address if shipping/tax
+# calculations are needed you can use the following
+# API call to obtain the order reference details.
+client.get_order_reference_details(
+  amazon_order_reference_id,
+  address_consent_token: address_consent_token
+)
+
+amount = '10.00'
+
+# Make the SetOrderReferenceDetails API call to
+# configure the Amazon Order Reference Id.
+# There are additional optional parameters that
+# are not used below.
+client.set_order_reference_details(
+  amazon_order_reference_id,
+  amount,
+  currency_code: 'USD', # Default: USD
+  seller_note: 'Your Seller Note',
+  seller_order_id: 'Your Seller Order Id',
+  store_name: 'Your Store Name'
+)
+
+# Make the ConfirmOrderReference API call to
+# confirm the details set in the API call
+# above.
+client.confirm_order_reference(amazon_order_reference_id)
+
+# Set a unique id for your current authorization
+# of this payment.
+authorization_reference_id = 'Your Unique Id'
+
+# Make the Authorize API call to authorize the
+# transaction. You can also capture the amount
+# in this API call or make the Capture API call
+# separately. There are additional optional
+# parameters not used below.
+response = client.authorize(
+  amazon_order_reference_id,
+  authorization_reference_id,
+  amount,
+  currency_code: 'USD', # Default: USD
+  seller_authorization_note: 'Your Authorization Note',
+  transaction_timeout: 0, # Set to 0 for synchronous mode
+  capture_now: true # Set this to true if you want to capture the amount in the same API call
+)
+
+# You will need the Amazon Authorization Id from the
+# Authorize API response if you decide to make the
+# Capture API call separately.
+amazon_authorization_id = response.get_element('AuthorizeResponse/AuthorizeResult/AuthorizationDetails','AmazonAuthorizationId')
+
+# Set a unique id for your current capture of
+# this payment.
+capture_reference_id = 'Your Unique Id'
+
+# Make the Capture API call if you did not set the
+# 'capture_now' parameter to 'true'. There are
+# additional optional parameters that are not used
+# below.
+client.capture(
+  amazon_authorization_id,
+  capture_reference_id,
+  amount,
+  currency_code: 'USD', # Default: USD
+  seller_capture_note: 'Your Capture Note'
+)
+
+# Close the order reference once your one time
+# payment transaction is complete.
+client.close_order_reference(amazon_order_reference_id)
+
+```
+
+### Subscriptions API Flow
+
+```ruby
+require 'amazon_pay'
+
+# Your Amazon Pay keys are
+# available in your Seller Central account
+merchant_id = 'YOUR_MERCHANT_ID'
+access_key = 'YOUR_ACCESS_KEY'
+secret_key = 'YOUR_SECRET_KEY'
+
+client = AmazonPay::Client.new(
+  merchant_id,
+  access_key,
+  secret_key,
+  sandbox: true
+)
+
+# These values are grabbed from the Amazon Pay
+# Address and Wallet widgets
+amazon_billing_agreement_id = 'AMAZON_BILLING_AGREEMENT_ID'
+address_consent_token = 'ADDRESS_CONSENT_TOKEN'
+
+# To get the buyers full address if shipping/tax
+# calculations are needed you can use the following
+# API call to obtain the billing agreement details.
+client.get_billing_agreement_details(
+  amazon_billing_agreement_id,
+  address_consent_token
+)
+
+# Next you will need to set the various details
+# for this subscription with the following API call.
+# There are additional optional parameters that
+# are not used below.
+client.set_billing_agreement_details(
+  amazon_billing_agreement_id,
+  seller_note: 'Your Seller Note',
+  seller_billing_agreement_id: 'Your Transaction Id',
+  store_name: 'Your Store Name',
+  custom_information: 'Additional Information'
+)
+
+# Make the ConfirmBillingAgreement API call to confirm
+# the Amazon Billing Agreement Id with the details set above.
+# Be sure that everything is set correctly above before
+# confirming.
+client.confirm_billing_agreement(
+  amazon_billing_agreement_id
+)
+
+# The following API call is not needed at this point, but
+# can be used in the future when you need to validate that
+# the payment method is still valid with the associated billing
+# agreement id.
+client.validate_billing_agreement(
+  amazon_billing_agreement_id
+)
+
+# Set the amount for your first authorization.
+amount = '10.00'
+
+# Set a unique authorization reference id for your
+# first transaction on the billing agreement.
+authorization_reference_id = 'Your Unique Id'
+
+# Now you can authorize your first transaction on the
+# billing agreement id. Every month you can make the
+# same API call to continue charging your buyer
+# with the 'capture_now' parameter set to true. You can
+# also make the Capture API call separately. There are
+# additional optional parameters that are not used
+# below.
+client.authorize_on_billing_agreement(
+  amazon_billing_agreement_id,
+  authorization_reference_id,
+  amount,
+  currency_code: 'USD', # Default: USD
+  seller_authorization_note: 'Your Authorization Note',
+  transaction_timeout: 0, # Set to 0 for synchronous mode
+  capture_now: true, # Set this to true if you want to capture the amount in the same API call
+  seller_note: 'Your Seller Note',
+  seller_order_id: 'Your Order Id',
+  store_name: 'Your Store Name',
+  custom_information: 'Additional Information'
+)
+
+# You will need the Amazon Authorization Id from the
+# AuthorizeOnBillingAgreement API response if you decide
+# to make the Capture API call separately.
+amazon_authorization_id = res.get_element('AuthorizeOnBillingAgreementResponse/AuthorizeOnBillingAgreementResult/AuthorizationDetails','AmazonAuthorizationId')
+
+# Set a unique id for your current capture of
+# this payment.
+capture_reference_id = 'Your Unique Id'
+
+# Make the Capture API call if you did not set the
+# 'capture_now' parameter to 'true'. There are
+# additional optional parameters that are not used
+# below.
+client.capture(
+  amazon_authorization_id,
+  capture_reference_id,
+  amount,
+  currency_code: 'USD', # Default: USD
+  seller_capture_note: 'Your Capture Note'
+)
+
+# The following API call should not be made until you
+# are ready to terminate the billing agreement.
+client.close_billing_agreement(
+  amazon_billing_agreement_id,
+  closure_reason: 'Reason For Closing'
+)
+
+```
+
+
+### Get Login Profile API
+
+This API call allows you to obtain user profile information
+once a user has logged into your application using
+their Amazon credentials.
+
+```ruby
+require 'amazon_pay'
+
+# Your client id is located in your Seller
+# Central account.
+client_id = 'Your Client Id'
+
+login = AmazonPay::Login.new(
+  client_id,
+  region: :na, # Default: :na
+  sandbox: true # Default: false
+)
+
+# The access token is available in the return URL
+# parameters after a user has logged in.
+access_token = 'User Access Token'
+
+# Make the 'get_user_info' api call.
+profile = login.get_login_profile(access_token)
+
+name = profile['name']
+email = profile['email']
+user_id = profile['user_id']
+
+```