paypal-checkout-sdk 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ee716ace7840674afcd0477b2ee4ffbde1c8b4629d7a9db46d71326e8689a1ae
-  data.tar.gz: 327dfa22b4ab4835c58f94be87a4302c3fafff90bff56d4b66170f9e5ed7972a
+SHA1:
+  metadata.gz: 38e281fa12bbbb378d86b9ae0d71a13d56e5a9f8
+  data.tar.gz: aa923060847b3cfec201bd8ee54c61e92839a660
 SHA512:
-  metadata.gz: 27cced12caeb404bbc21f6dde4d11c578b86687e66a79643a7c710059e4aeaac1150bb5371eb09661910304f851e96b8453c34cab2c015f6e8ce7dbe5b38ae02
-  data.tar.gz: de3ed48cbc4c40f98ffa1863f2e6a297abb6ee8ab619e650ea23e0c5ade4c5c4eff117af9b98496940c58b7a8d66d81f300235cbdb6d3c380473699708d43bba
+  metadata.gz: 951fa80875cc60e3d108356e87dba686e4f28082c99e90fb79511b34336f14602066046f3d8b2180cc4398fc3a384c18857cf0bae02eecda0d8f2437ff3b745d
+  data.tar.gz: 7efdcd17f89d40c7bd7906be72ff3769a74961f48ffb9a5804fd18a6e1f097cac8b83d61fe4f1e4c754a4d060ffa37557bc21d632f613cb2f6937ca94082220f

data/.gitignore

@@ -0,0 +1,139 @@
+
+# Created by https://www.gitignore.io/api/ruby,rubymine+all
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### RubyMine+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+#Visual Studio Code Files
+.vscode/
+
+#Eclipse Files
+.project
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+### RubyMine+all Patch ###
+# Ignores the whole .idea folder and all .iml files
+# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
+
+.idea/
+
+# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
+
+*.iml
+modules.xml
+.idea/misc.xml
+*.ipr
+
+
+# End of https://www.gitignore.io/api/ruby,rubymine+all
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    paypal-checkout-sdk (1.0.2)
+      braintreehttp (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    braintreehttp (0.5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.7)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  paypal-checkout-sdk!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,86 @@
+The PayPal Node SDK is released under the following license:
+
+    Copyright (c) 2013-2019 PAYPAL, INC.
+
+    SDK LICENSE
+
+    NOTICE TO USER:  PayPal, Inc. is providing the Software and Documentation for use under the terms of 
+    this Agreement. Any use, reproduction, modification or distribution of the Software or Documentation, 
+    or any derivatives or portions hereof, constitutes your acceptance of this Agreement.
+
+    As used in this Agreement, "PayPal" means PayPal, Inc.  "Software" means the software code accompanying
+    this agreement. "Documentation" means the documents, specifications and all other items accompanying 
+    this Agreement other than the Software.   
+
+    1.  LICENSE GRANT Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, 
+    worldwide, royalty free license to use, reproduce, prepare derivative works from, publicly display, 
+    publicly perform, distribute and sublicense the Software for any purpose, provided the copyright notice
+    below appears in a conspicuous location within the source code of the distributed Software and this 
+    license is distributed in the supporting documentation of the Software you distribute. Furthermore, 
+    you must comply with all third party licenses in order to use the third party software contained in the 
+    Software.
+
+    Subject to the terms of this Agreement, PayPal hereby grants you a non-exclusive, worldwide, royalty free
+    license to use, reproduce, publicly display, publicly perform, distribute and sublicense the Documentation 
+    for any purpose.  You may not modify the Documentation.
+
+    No title to the intellectual property in the Software or Documentation is transferred to you under the 
+    terms of this Agreement. You do not acquire any rights to the Software or the Documentation except as 
+    expressly set forth in this Agreement.
+
+    If you choose to distribute the Software in a commercial product, you do so with the understanding that 
+    you agree to defend, indemnify and hold harmless PayPal and its suppliers against any losses, damages and 
+    costs arising from the claims, lawsuits or other legal actions arising out of such distribution.  You may 
+    distribute the Software in object code form under your own license, provided that your license agreement:
+
+    (a)     complies with the terms and conditions of this license agreement; 
+
+    (b)     effectively disclaims all warranties and conditions, express or implied, on behalf of PayPal;
+
+    (c)     effectively excludes all liability for damages on behalf of PayPal;
+
+    (d)     states that any provisions that differ from this Agreement are offered by you alone and not PayPal; and
+
+    (e)     states that the Software is available from you or PayPal and informs licensees how to obtain it in a 
+    reasonable manner on or through a medium customarily used for software exchange.  
+
+    2.  DISCLAIMER OF WARRANTY
+    PAYPAL LICENSES THE SOFTWARE AND DOCUMENTATION TO YOU ONLY 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.  PAYPAL MAKES NO WARRANTY THAT THE 
+    SOFTWARE OR DOCUMENTATION WILL BE ERROR-FREE. Each user of the Software or Documentation is solely responsible 
+    for determining the appropriateness of using and distributing the Software and Documentation and assumes all 
+    risks associated with its exercise of rights under this Agreement, including but not limited to the risks and 
+    costs of program errors, compliance with applicable laws, damage to or loss of data, programs, or equipment, 
+    and unavailability or interruption of operations.  Use of the Software and Documentation is made with the 
+    understanding that PayPal will not provide you with any technical or customer support or maintenance.  Some 
+    states or jurisdictions do not allow the exclusion of implied warranties or limitations on how long an implied 
+    warranty may last, so the above limitations may not apply to you.  To the extent permissible, any implied 
+    warranties are limited to ninety (90) days.
+
+
+    3.  LIMITATION OF LIABILITY
+    PAYPAL AND ITS SUPPLIERS SHALL NOT BE LIABLE FOR LOSS OR DAMAGE ARISING OUT OF THIS AGREEMENT OR FROM THE USE 
+    OF THE SOFTWARE OR DOCUMENTATION.  IN NO EVENT WILL PAYPAL OR ITS SUPPLIERS BE LIABLE TO YOU OR ANY THIRD PARTY 
+    FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, INCIDENTAL, OR SPECIAL DAMAGES INCLUDING LOST PROFITS, LOST SAVINGS, 
+    COSTS, FEES, OR EXPENSES OF ANY KIND ARISING OUT OF ANY PROVISION OF THIS AGREEMENT OR THE USE OR THE INABILITY 
+    TO USE THE SOFTWARE OR DOCUMENTATION, HOWEVER CAUSED AND UNDER ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
+    STRICT LIABILITY OR TORT INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 
+    PAYPAL'S AGGREGATE LIABILITY AND THAT OF ITS SUPPLIERS UNDER OR IN CONNECTION WITH THIS AGREEMENT SHALL BE 
+    LIMITED TO THE AMOUNT PAID BY YOU FOR THE SOFTWARE AND DOCUMENTATION. 
+
+    4.  TRADEMARK USAGE
+    PayPal is a trademark PayPal, Inc. in the United States and other countries.  Such trademarks may not be used 
+    to endorse or promote any product unless expressly permitted under separate agreement with PayPal.  
+
+    5.  TERM
+    Your rights under this Agreement shall terminate if you fail to comply with any of the material  terms or 
+    conditions of this Agreement and do not cure such failure in a reasonable period of time after becoming 
+    aware of such noncompliance.  If all your rights under this Agreement terminate, you agree to cease use 
+    and distribution of the Software and Documentation as soon as reasonably practicable. 
+
+    6. GOVERNING LAW AND JURISDICTION. This Agreement is governed by the statutes and laws of the State of 
+    California, without regard to the conflicts of law principles thereof.  If any part of this Agreement is 
+    found void and unenforceable, it will not affect the validity of the balance of the Agreement, which shall 
+    remain valid and enforceable according to its terms.  Any dispute arising out of or related to this Agreement 
+    shall be brought in the courts of Santa Clara County, California, USA. 

data/README.md

@@ -0,0 +1,142 @@
+# REST API SDK for Ruby V2
+
+![Home Image](homepage.jpg)
+
+__Welcome to PayPal Ruby SDK__. This repository contains PayPal's Ruby SDK and samples for [v2/checkout/orders](https://developer.paypal.com/docs/api/orders/v2/) and [v2/payments](https://developer.paypal.com/docs/api/payments/v2/) APIs.
+
+This is a part of the next major PayPal SDK. It includes a simplified interface to only provide simple model objects and blueprints for HTTP calls. This repo currently contains functionality for PayPal Checkout APIs which includes [Orders V2](https://developer.paypal.com/docs/api/orders/v2/) and [Payments V2](https://developer.paypal.com/docs/api/payments/v2/).
+
+Please refer to the [PayPal Checkout Integration Guide](https://developer.paypal.com/docs/checkout/) for more information. Also refer to [Setup your SDK](https://developer.paypal.com/docs/checkout/reference/server-integration/setup-sdk/) for additional information about setting up the SDK's. 
+
+
+## Prerequisites
+
+- Ruby 2.0.0 or above
+- Bundler
+
+## Usage
+### Binaries
+
+It is not mandatory to fork this repository for using the PayPal SDK. You can refer [PayPal Checkout Server SDK](https://developer.paypal.com/docs/checkout/reference/server-integration) for configuring and working with SDK without forking this code.
+
+For contirbuting or referrring the samples, You can fork/refer this repository. 
+
+### Setting up credentials
+Get client ID and client secret by going to https://developer.paypal.com/developer/applications and generating a REST API app. Get <b>Client ID</b> and <b>Secret</b> from there.
+
+```ruby
+require 'paypal-checkout-sdk'
+  
+
+# Creating Access Token for Sandbox
+client_id = "PAYPAL-CLIENT-ID"
+client_secret = "PAYPAL-CLIENT-SECRET"
+# Creating an environment
+environment = PayPal::SandboxEnvironment.new(client_id, client_secret)
+client = PayPal::PayPalHttpClient.new(environment)
+```
+
+## Examples
+
+### Creating an Order
+
+#### Code: 
+```ruby
+
+# Construct a request object and set desired parameters
+# Here, OrdersCreateRequest::new creates a POST request to /v2/checkout/orders
+request = PayPalCheckoutSdk::Orders::OrdersCreateRequest::new
+request.request_body({
+                        intent: "CAPTURE",
+                        purchase_units: [
+                            {
+                                amount: {
+                                    currency_code: "USD",
+                                    value: "100.00"
+                                }
+                            }
+                        ]
+                      })
+
+begin
+    # Call API with your client and get a response for your call
+    response = client.execute(request)
+
+    # If call returns body in response, you can get the deserialized version from the result attribute of the response
+    order = response.result
+    puts order
+rescue BraintreeHttp::HttpError => ioe
+    # Something went wrong server-side
+    puts ioe.status_code
+    puts ioe.headers["debug_id"]
+end
+```
+
+#### Example Output:
+```
+Status Code:  201
+Status:  CREATED
+Order ID:  7F845507FB875171H
+Intent:  CAPTURE
+Links:
+	self: https://api.sandbox.paypal.com/v2/checkout/orders/7F845507FB875171H	Call Type: GET
+	approve: https://www.sandbox.paypal.com/checkoutnow?token=7F845507FB875171H	Call Type: GET
+	authorize: https://api.sandbox.paypal.com/v2/checkout/orders/7F845507FB875171H/authorize	Call Type: POST
+Gross Amount: USD 230.00
+```
+
+### Capturing an Order
+After approving order above using `approve` link
+
+#### Code:
+```ruby
+# Here, OrdersCaptureRequest::new() creates a POST request to /v2/checkout/orders
+# order.id gives the orderId of the order created above
+request = PayPalCheckoutSdk::Orders::OrdersCaptureRequest::new("APPROVED-ORDER-ID")
+
+begin
+    # Call API with your client and get a response for your call
+    response = client.execute(request) 
+    
+    # If call returns body in response, you can get the deserialized version from the result attribute of the response
+    order = response.result
+    puts order
+rescue BraintreeHttp::HttpError => ioe
+    # Something went wrong server-side
+    puts ioe.status_code
+    puts ioe.headers["debug_id"]
+end
+```
+
+#### Example Output:
+```
+Status Code:  201
+Status:  COMPLETED
+Order ID:  7F845507FB875171H
+Links: 
+	self: https://api.sandbox.paypal.com/v2/checkout/orders/70779998U8897342J	Call Type: GET
+Buyer:
+	Email Address: ganeshramc-buyer@live.com
+	Name: test buyer
+	Phone Number: 408-411-2134
+```
+
+## Running tests
+
+To run integration tests using your client id and secret, clone this repository and run the following command:
+```sh
+$ bundle install
+$ PAYPAL_CLIENT_ID=YOUR_SANDBOX_CLIENT_ID PAYPAL_CLIENT_SECRET=YOUR_SANDBOX_CLIENT_SECRET rspec spec
+```
+
+## Samples
+
+You can start off by trying out [creating and capturing an order](/samples/capture_intent_examples/run_all.rb)
+
+To try out different samples for both create and authorize intent check [this link](/samples)
+
+Note: Update the `paypal_client.rb` with your sandbox client credentials or pass your client credentials as environment variable whie executing the samples.
+
+
+## License
+Code released under [SDK LICENSE](LICENSE)  

data/Rakefile

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

data/gen.yml

@@ -0,0 +1,6 @@
+---
+projectName: PayPalCheckoutSdk
+language: ruby
+sourcePath: lib
+testPath: spec
+apiVersioning: false