paypal-checkout-sdk 1.0.1 → 1.0.2

data/lib/core/version.rb

@@ -1,3 +1,3 @@
 module PayPal
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

data/paypal-checkout-sdk.gemspec

@@ -1,13 +1,27 @@
-Gem::Specification.new do |s|
-  s.name        = 'paypal-checkout-sdk'
-  s.version     = '1.0.1'
-  s.date        = '2018-02-04'
-  s.summary     = "This repository contains PayPal's Ruby SDK for Checkout REST API"
-  s.description = "This repository contains PayPal's Ruby SDK for Checkout REST API"
-  s.authors     = ["http://developer.paypal.com"]
-  s.email       = 'dl-paypal-checkout-api@paypal.com'
-  s.files       = Dir.glob ["lib/**/*.{rb}", "spec/**/*", "*.gemspec"]
-  s.homepage    =
-    'https://github.com/paypal/Checkout-Ruby-SDK'
-  s.license       = 'MIT'
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'core/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'paypal-checkout-sdk'
+  spec.version     = PayPal::VERSION
+  spec.summary     = "This repository contains PayPal's Ruby SDK for Checkout REST API"
+  spec.description = "This repository contains PayPal's Ruby SDK for Checkout REST API"
+  spec.authors     = ["http://developer.paypal.com"]
+  spec.email       = 'dl-paypal-checkout-api@paypal.com'
+  spec.homepage    = 'https://github.com/paypal/Checkout-Ruby-SDK'
+  spec.license     = 'https://github.com/paypal/Checkout-Ruby-SDK/blob/master/LICENSE'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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_dependency 'braintreehttp', '~> 0.5'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock'
 end

data/samples/authorize_intent_examples/authorize_order.rb

@@ -0,0 +1,52 @@
+require_relative '../paypal_client'
+include PayPalCheckoutSdk::Orders
+module Samples
+  module AuthorizeIntentExamples
+    class AuthorizeOrder
+
+      # This function can be used to authorize an approved order.
+      def authorize_order (order_id, debug=false)
+        request = OrdersAuthorizeRequest::new(order_id)
+        request.prefer("return=representation")
+        # This request body can be updated with fields as per requirement. Please refer API docs for more info.
+        request.request_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 "Authorization ID: #{response.result.purchase_units[0].payments.authorizations[0].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 "Authorization Links:"
+            for link in response.result.purchase_units[0].payments.authorizations[0].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 "Buyer:"
+            buyer = response.result.payer
+            puts "\tEmail Address: #{buyer.email_address}\n\tName: #{buyer.name.given_name} #{buyer.name.surname}\n\tPhone Number: #{buyer.phone.phone_number.national_number}"
+            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 authorize_order function with approved order id 
+# Order Id should be replaced with an valid approved order id.
+if __FILE__ == $0
+  Samples::AuthorizeIntentExamples::AuthorizeOrder::new::authorize_order('0CT41921GV4167455',true)
+end

data/samples/authorize_intent_examples/capture_order.rb

@@ -0,0 +1,44 @@
+require_relative '../paypal_client'
+include PayPalCheckoutSdk::Payments
+module Samples
+  module AuthorizeIntentExamples
+    class CaptureOrder
+
+      # This function can be used to perform capture on an authorization.
+      # An valid authorization id dhould be passed as an argument.
+      def capture_order (authorization_id, debug=false)
+        request = AuthorizationsCaptureRequest::new(authorization_id)
+        request.prefer("return=representation")
+        #Below request bodyn can be updated with fields as per business need. Please refer API docs for more info.
+        request.request_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 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 capture_order function with valid authorization id 
+# Authorization Id should be replaced with an valid authorization id.
+if __FILE__ == $0
+  Samples::AuthorizeIntentExamples::CaptureOrder::new::capture_order('4KH16819Y83216409',true)
+end

data/samples/authorize_intent_examples/create_order.rb

@@ -0,0 +1,191 @@
+require_relative '../paypal_client'
+require 'json'
+include PayPalCheckoutSdk::Orders
+
+module Samples
+  module AuthorizeIntentExamples
+    class CreateOrder
+
+      # This is the sample function which can be used to create an order with complete body. 
+      # The Intent in the request body should be set as "AUTHORIZE" for authorize intent flow.
+      def create_order (debug=false)
+        body = {
+            intent: 'AUTHORIZE',
+            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'
+                            },
+                            gift_wrap: {
+                                currency_code: 'USD',
+                                value: '10.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 "Order with the complete required payload"
+                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
+
+      # This is the sample function which can be used to create an order with minimum required body. 
+      # The Intent in the request body should be set as "AUTHORIZE" for authorize intent flow.
+      def create_order_with_minimum_body (debug=false)
+        body = {
+            intent: 'AUTHORIZE',
+            application_context: {
+                return_url: 'https://www.example.com',
+                cancel_url: 'https://www.example.com'
+            },
+            purchase_units: [
+                {
+                    amount: {
+                        currency_code: 'USD',
+                        value: '220.00'
+                        }
+                }
+            ]
+        }
+
+        request = OrdersCreateRequest::new
+        request.headers["prefer"] = "return=representation"
+        request.request_body(body)
+        begin
+            response = PayPalClient::client.execute(request)
+            if debug
+                puts "Order with the minimum required payload"
+                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::AuthorizeIntentExamples::CreateOrder::new::create_order(true)
+  Samples::AuthorizeIntentExamples::CreateOrder::new::create_order_with_minimum_body(true)
+end

data/samples/authorize_intent_examples/run_all.rb

@@ -0,0 +1,57 @@
+require_relative '../paypal_client'
+require_relative './create_order'
+require_relative './authorize_order'
+require_relative './capture_order'
+require_relative '../refund_capture'
+include BraintreeHttp
+
+puts "Creating Order..."
+create_resp = Samples::AuthorizeIntentExamples::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 "Authorizing Order..."
+authorize_resp = Samples::AuthorizeIntentExamples::AuthorizeOrder::new::authorize_order(create_resp.result.id)
+authorization_id = authorize_resp.result.purchase_units[0].payments.authorizations[0].id
+puts "Authorized Successfully"
+
+puts "Capturing Order..."
+capture_resp = Samples::AuthorizeIntentExamples::CaptureOrder::new::capture_order(authorization_id)
+puts "Captured Successfully\n"
+puts "Status Code: #{capture_resp.status_code}"
+puts "Status: #{capture_resp.result.status}"
+puts "Capture 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
+
+puts "Refunding Capture..."
+begin
+  refund_response = Samples::RefundCapture::new::refund_capture(capture_resp.result.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/capture_intent_examples/capture_order.rb

@@ -0,0 +1,50 @@
+require_relative '../paypal_client' #PayPal SDK dependency
+include PayPalCheckoutSdk::Orders
+module Samples
+  module CaptureIntentExamples
+    class CaptureOrder
+
+      # This is the sample function performing payment capture on the order. 
+      # Approved Order id should be passed as an argument to this function
+      def capture_order (order_id, debug=false)
+        request = OrdersCaptureRequest::new(order_id)
+        request.prefer("return=representation")
+        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 "Capture Ids: "
+            for purchase_unit in response.result.purchase_units
+                for capture in purchase_unit.payments.captures
+                    puts "\t #{capture.id}"
+                end
+            end
+            puts "Buyer:"
+            buyer = response.result.payer
+            puts "\tEmail Address: #{buyer.email_address}\n\tName: #{buyer.name.full_name}\n\tPhone Number: #{buyer.phone.phone_number.national_number}"
+            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 capture order function.
+# Order Id value should be replaced with the approved order id.
+if __FILE__ == $0
+  Samples::CaptureIntentExamples::CaptureOrder::new::capture_order('4BH32103UX0864942', true)
+end