paypal-checkout-sdk 1.0.1 → 1.0.2

data/samples/capture_intent_examples/create_order.rb

@@ -0,0 +1,138 @@
+require_relative '../paypal_client'
+include PayPalCheckoutSdk::Orders
+
+module Samples
+  module CaptureIntentExamples
+    class CreateOrder
+
+      # This is the sample function which can be used to create an order. It uses the
+      # sample JSON body to create an new Order.
+      # The Intent in the request body should be set as "CAPTURE" for capture intent flow.
+      def create_order (debug=false)
+        body = {
+            intent: 'CAPTURE',
+            application_context: {
+                return_url: 'https://www.example.com',
+                cancel_url: 'https://www.example.com',
+                brand_name: 'EXAMPLE INC',
+                landing_page: 'BILLING',
+                shipping_preference: 'SET_PROVIDED_ADDRESS',
+                user_action: 'CONTINUE'
+            },
+            purchase_units: [
+                {
+                    reference_id: 'PUHF',
+                    description: 'Sporting Goods',
+
+                    custom_id: 'CUST-HighFashions',
+                    soft_descriptor: 'HighFashions',
+                    amount: {
+                        currency_code: 'USD',
+                        value: '220.00',
+                        breakdown: {
+                            item_total: {
+                                currency_code: 'USD',
+                                value: '180.00'
+                            },
+                            shipping: {
+                                currency_code: 'USD',
+                                value: '20.00'
+                            },
+                            handling: {
+                                currency_code: 'USD',
+                                value: '10.00'
+                            },
+                            tax_total: {
+                                currency_code: 'USD',
+                                value: '20.00'
+                            },
+                            shipping_discount: {
+                                currency_code: 'USD',
+                                value: '10'
+                            }
+                        }
+                    },
+                    items: [
+                        {
+                            name: 'T-Shirt',
+                            description: 'Green XL',
+                            sku: 'sku01',
+                            unit_amount: {
+                                currency_code: 'USD',
+                                value: '90.00'
+                            },
+                            tax: {
+                                currency_code: 'USD',
+                                value: '10.00'
+                            },
+                            quantity: '1',
+                            category: 'PHYSICAL_GOODS'
+                        },
+                        {
+                            name: 'Shoes',
+                            description: 'Running, Size 10.5',
+                            sku: 'sku02',
+                            unit_amount: {
+                                currency_code: 'USD',
+                                value: '45.00'
+                            },
+                            tax: {
+                                currency_code: 'USD',
+                                value: '5.00'
+                            },
+                            quantity: '2',
+                            category: 'PHYSICAL_GOODS'
+                        }
+                    ],
+                    shipping: {
+                        method: 'United States Postal Service',
+                        name: {
+                            full_name: 'John Doe'
+                        },
+                        address: {
+                            address_line_1: '123 Townsend St',
+                            address_line_2: 'Floor 6',
+                            admin_area_2: 'San Francisco',
+                            admin_area_1: 'CA',
+                            postal_code: '94107',
+                            country_code: 'US'
+                        }
+                    }
+                }
+            ]
+        }
+
+        request = OrdersCreateRequest::new
+        request.headers["prefer"] = "return=representation"
+        request.request_body(body)
+        begin
+            response = PayPalClient::client.execute(request)
+            if debug
+                puts "Status Code: #{response.status_code}"
+                puts "Status: #{response.result.status}"
+                puts "Order ID: #{response.result.id}"
+                puts "Intent: #{response.result.intent}"
+                puts "Links:"
+                for link in response.result.links
+                    # this could also be called as link.rel or link.href but as method is a reserved keyword for ruby avoid calling link.method
+                    puts "\t#{link["rel"]}: #{link["href"]}\tCall Type: #{link["method"]}"
+                end
+                puts "Gross Amount: #{response.result.purchase_units[0].amount.currency_code} #{response.result.purchase_units[0].amount.value}"
+                puts PayPalClient::openstruct_to_hash(response.result).to_json
+            end
+            return response
+        rescue BraintreeHttp::HttpError => ioe
+            # Exception occured while processing the refund.
+            puts " Status Code: #{ioe.status_code}"
+            puts " Debug Id: #{ioe.result.debug_id}"
+            puts " Response: #{ioe.result}"
+        end
+      end
+    end
+  end
+end
+
+# This is the driver function which invokes the createOrder function to create an sample order.
+if __FILE__ == $0
+  Samples::CaptureIntentExamples::CreateOrder::new::create_order(true)
+end

data/samples/capture_intent_examples/run_all.rb

@@ -0,0 +1,58 @@
+require_relative '../capture_intent_examples/create_order'
+require_relative '../capture_intent_examples/capture_order'
+require_relative '../refund_capture'
+include BraintreeHttp
+
+puts "Creating Order..."
+create_resp = Samples::CaptureIntentExamples::CreateOrder::new::create_order
+for link in create_resp.result.links
+  # this could also be called as link.rel or link.href but as method is a reserved keyword for ruby avoid calling link.method
+  puts "\t#{link["rel"]}: #{link["href"]}\tCall Type: #{link["method"]}"
+end
+puts "Created Successfully\n"
+puts "Copy approve link and paste it in browser. Login with buyer account and follow the instructions.\nOnce approved hit enter..."
+
+# Waiting for user input
+gets
+
+puts "Capturing Order..."
+begin
+  capture_resp = Samples::CaptureIntentExamples::CaptureOrder::new.capture_order(create_resp.result.id)
+  puts "Captured Successfully\n"
+  puts "Status Code: #{capture_resp.status_code}"
+  puts "Status: #{capture_resp.result.status}"
+  puts "Order ID: #{capture_resp.result.id}"
+  puts "Intent: #{capture_resp.result.intent}"
+  puts "Links:"
+  for link in capture_resp.result.links
+    # this could also be called as link.rel or link.href but as method is a reserved keyword for ruby avoid calling link.method
+    puts "\t#{link["rel"]}: #{link["href"]}\tCall Type: #{link["method"]}"
+  end
+rescue => e
+  if e.is_a? HttpError
+    puts e.message
+    puts e.status_code
+    puts e.result
+  end
+end
+
+puts "Refunding Capture..."
+begin
+  refund_response = Samples::RefundCapture::new::refund_capture(capture_resp.result.purchase_units[0].payments.captures[0].id)
+  puts "Refunded SuccessFully\n"
+  puts "Status Code: #{refund_response.status_code}"
+  puts "Status: #{refund_response.result.status}"
+  puts "Refund ID: #{refund_response.result.id}"
+  puts "Intent: #{refund_response.result.intent}"
+  puts "Links:"
+  for link in refund_response.result.links
+    # this could also be called as link.rel or link.href but as method is a reserved keyword for ruby avoid calling link.method
+    puts "\t#{link["rel"]}: #{link["href"]}\tCall Type: #{link["method"]}"
+  end
+rescue => e
+  puts e.message
+  if e.is_a? HttpError
+    puts e.status_code
+    puts e.result
+  end
+end

data/samples/get_order.rb

@@ -0,0 +1,43 @@
+require_relative './paypal_client'
+require_relative './authorize_intent_examples/create_order'
+require 'json'
+require 'ostruct'
+
+include PayPalCheckoutSdk::Orders
+module Samples
+  class GetOrder
+    
+    # This function can be used to retrieve an order by passing order id as argument
+    def get_order(order_id)
+      request = OrdersGetRequest::new(order_id)
+      begin
+        response = PayPalClient::client::execute(request)
+        puts "Status Code: #{response.status_code}"
+        puts "Status: #{response.result.status}"
+        puts "Order ID: #{response.result.id}"
+        puts "Intent: #{response.result.intent}"
+        puts "Links:"
+        for link in response.result.links
+          # this could also be called as link.rel or link.href but as method is a reserved keyword for ruby avoid calling link.method
+          puts "\t#{link["rel"]}: #{link["href"]}\tCall Type: #{link["method"]}"
+        end
+        puts "Gross Amount: #{response.result.purchase_units[0].amount.currency_code} #{response.result.purchase_units[0].amount.value}"
+        puts PayPalClient::openstruct_to_hash(response.result).to_json
+        return response
+      rescue BraintreeHttp::HttpError => ioe
+        # Exception occured while processing the refund.
+        puts " Status Code: #{ioe.status_code}"
+        puts " Debug Id: #{ioe.result.debug_id}"
+        puts " Response: #{ioe.result}"
+      end
+    end
+  end
+end
+
+# This is the driver function which invokes the get_order function with order id to retrieve
+# an sample order. For the order id, we invoke the create order to create an new order and then we are using 
+# the newly created order id for retrieving the order
+if __FILE__ == $0
+  id = Samples::AuthorizeIntentExamples::CreateOrder::new::create_order.result.id;
+   Samples::GetOrder::new::get_order(id)
+end

data/samples/patch_order.rb

@@ -0,0 +1,53 @@
+require_relative './paypal_client'
+require_relative './capture_intent_examples/create_order'
+require_relative './get_order'
+
+include PayPalCheckoutSdk::Orders
+
+module Samples
+  class PatchOrder
+    # Below function can be used to patch and order.
+    # Patch is supported on only specific set of fields.
+    # Please refer API docs for more info.
+    def patch_order(order_id)
+      body = [{
+        op:'replace',
+        path:"/purchase_units/@reference_id=='PUHF'/description",
+        value:'Sporting goods description'
+      },
+      {
+        op: 'replace',
+        path: "/purchase_units/@reference_id=='PUHF'/custom_id",
+        value: 'CUST-ID-HighFashions'
+        }
+      ]
+      request = OrdersPatchRequest::new(order_id)
+      request.request_body(body)
+      response = PayPalClient::client::execute(request)
+      return response
+    end
+  end
+end
+
+# Driver function which does below steps.
+# 1. Create an Order
+# 2. Patch fields in the newly created order.
+# 3. Print the updated fields by calling the get order.
+if __FILE__ == $0
+  begin
+    order= Samples::CaptureIntentExamples::CreateOrder::new::create_order.result
+    patch_response = Samples::PatchOrder::new::patch_order(order.id)
+    puts "patch_response status code ::: #{patch_response.status_code}"
+    if patch_response.status_code == 204
+      order = Samples::GetOrder::new::get_order(order.id)
+      puts "Updated Description: #{order.result.purchase_units[0].description}"
+      puts "Updated Custom Id: #{order.result.purchase_units[0].custom_id}"
+      puts PayPalClient::openstruct_to_hash(order.result).to_json
+    end
+  rescue BraintreeHttp::HttpError => ioe
+    # Exception occured while processing the refund.
+    puts " Status Code: #{ioe.status_code}"
+    puts " Debug Id: #{ioe.result.debug_id}"
+    puts " Response: #{ioe.result}"
+  end
+end

data/samples/paypal_client.rb

@@ -0,0 +1,40 @@
+require './lib/paypal-checkout-sdk'
+
+module PayPalClient
+  class << self
+
+    # Setting up and Returns PayPal SDK environment with PayPal Access credentials.
+    # For demo purpose, we are using SandboxEnvironment. In production this will be
+    # LiveEnvironment.
+    def environment
+      client_id = ENV['PAYPAL_CLIENT_ID'] || '<<PAYPAL-CLIENT-ID>>'
+      client_secret = ENV['PAYPAL_CLIENT_SECRET'] || '<<PAYPAL-CLIENT-SECRET>>'
+      
+      PayPal::SandboxEnvironment.new(client_id, client_secret)
+    end
+
+    # Returns PayPal HTTP client instance with environment which has access
+    # credentials context. This can be used invoke PayPal API's provided the
+    # credentials have the access to do so.
+    def client
+      PayPal::PayPalHttpClient.new(self.environment)
+    end
+
+    # Utility to convert Openstruct Object to JSON hash.
+    def openstruct_to_hash(object, hash = {})
+      object.each_pair do |key, value|
+        hash[key] = value.is_a?(OpenStruct) ? openstruct_to_hash(value) : value.is_a?(Array) ? array_to_hash(value) : value
+      end
+      hash
+    end
+
+    # Utility to convert Array of OpenStruct into Hash.
+    def array_to_hash(array, hash= [])
+      array.each do |item|
+        x = item.is_a?(OpenStruct) ? openstruct_to_hash(item) : item.is_a?(Array) ? array_to_hash(item) : item
+        hash << x
+      end
+      hash
+    end
+  end
+end

data/samples/refund_capture.rb

@@ -0,0 +1,46 @@
+require_relative './paypal_client' #PayPal SDK dependency
+include PayPalCheckoutSdk::Payments
+module Samples
+    class RefundCapture
+      
+      # This is the sample function performing capture refund. 
+      # Valid capture id should be passed as an argument to this function
+      def refund_capture (capture_id, debug=false)
+        request = CapturesRefundRequest::new(capture_id)
+        request.prefer("return=representation")
+        # below request body can be populated to perform partial refund.
+        request.request_body({
+          amount: {
+            value: '20.00',
+            currency_code: 'USD'
+          }
+        });
+        begin
+          response = PayPalClient::client::execute(request)
+        if debug
+          puts "Status Code: #{response.status_code}"
+          puts "Status: #{response.result.status}"
+          puts "Refund ID: #{response.result.id}"
+          puts "Intent: #{response.result.intent}"
+          puts "Links:"
+          for link in response.result.links
+            # this could also be called as link.rel or link.href but as method is a reserved keyword for ruby avoid calling link.method
+            puts "\t#{link["rel"]}: #{link["href"]}\tCall Type: #{link["method"]}"
+          end
+          puts PayPalClient::openstruct_to_hash(response.result).to_json
+        end
+        rescue BraintreeHttp::HttpError => ioe
+          # Exception occured while processing the refund.
+          puts " Status Code: #{ioe.status_code}"
+          puts " Debug Id: #{ioe.result.debug_id}"
+          puts " Response: #{ioe.result}"
+        end
+        return response
+      end
+    end
+end
+# This is the driver function which invokes the refund capture function.
+# Capture Id value should be replaced with the capture id.
+if __FILE__ == $0
+  Samples::RefundCapture::new::refund_capture('2WB02631FY659550C', true)
+end

metadata

@@ -1,21 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: paypal-checkout-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - http://developer.paypal.com
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2018-02-04 00:00:00.000000000 Z
-dependencies: []
+date: 2019-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: braintreehttp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This repository contains PayPal's Ruby SDK for Checkout REST API
 email: dl-paypal-checkout-api@paypal.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- gen.yml
+- homepage.jpg
+- init
 - lib/core/access_token.rb
 - lib/core/paypal_environment.rb
 - lib/core/paypal_http_client.rb
@@ -37,25 +102,20 @@ files:
 - lib/payments/refunds_get_request.rb
 - lib/paypal-checkout-sdk.rb
 - paypal-checkout-sdk.gemspec
-- spec/orders/orders_authorize_spec.rb
-- spec/orders/orders_capture_spec.rb
-- spec/orders/orders_create_spec.rb
-- spec/orders/orders_get_spec.rb
-- spec/orders/orders_helper.rb
-- spec/orders/orders_patch_spec.rb
-- spec/orders/orders_validate_spec.rb
-- spec/payments/authorizations_capture_spec.rb
-- spec/payments/authorizations_get_spec.rb
-- spec/payments/authorizations_reauthorize_spec.rb
-- spec/payments/authorizations_void_spec.rb
-- spec/payments/captures_get_spec.rb
-- spec/payments/captures_refund_spec.rb
-- spec/payments/refunds_get_spec.rb
-- spec/spec_helper.rb
-- spec/test_harness.rb
+- samples/authorize_intent_examples/authorize_order.rb
+- samples/authorize_intent_examples/capture_order.rb
+- samples/authorize_intent_examples/create_order.rb
+- samples/authorize_intent_examples/run_all.rb
+- samples/capture_intent_examples/capture_order.rb
+- samples/capture_intent_examples/create_order.rb
+- samples/capture_intent_examples/run_all.rb
+- samples/get_order.rb
+- samples/patch_order.rb
+- samples/paypal_client.rb
+- samples/refund_capture.rb
 homepage: https://github.com/paypal/Checkout-Ruby-SDK
 licenses:
-- MIT
+- https://github.com/paypal/Checkout-Ruby-SDK/blob/master/LICENSE
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -73,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: This repository contains PayPal's Ruby SDK for Checkout REST API