merchant-paypal 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fafb219995ad1ea99a7cfdc2fd98c150f95e9d465f49af48dae413f53ae28db7
-  data.tar.gz: c77faaac7ab11fca83ca653a9cf18248a3ac1d30266de1e83e1412d9028dbf42
+  metadata.gz: af420e90d6c2f33c1d7125d91288ad1fb19f7f047e7465c427e335f001f56b49
+  data.tar.gz: 3a58efbc723b57db059b1e23ef876e8d10737ce90cb5c5b41f27ef3c36254c44
 SHA512:
-  metadata.gz: 229e92148ecafa0ceb15c6d1ea1a21eab0c932216bc369e75ff801912bf52a801a12623cc824e52dd8105bc6a4e3b046b59b9529d22be2e234b45f0c49daf092
-  data.tar.gz: cb3fd490ece01f155a0614c7dcdb75c8bdbf7dbbe30e281ea2a2e7e1e263a3cd4e996becbc325d32e5c19dfd90f2c1a7db4bc7435bb189d93fbafa74d3891c79
+  metadata.gz: 282a10d292486eb105ce49246e0cbcda2ebe7b8d4b60bbdb1f501971ab846e34623185aea780522db46071115253778891776d127205aa3a3ef851f9b573be61
+  data.tar.gz: 60ac8fb74b0c640d4fd8445f64d41fde0088c2fc2e35d9296d8596a00c461047754ef898f1ba9d32bbcad6cd4bc5eeabe70bb8e7897f1fd04db63eeca0da57e5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 DevHub
+
+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/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "irb"
+require_relative "../lib/merchant-paypal"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+IRB.start(__FILE__)

data/lib/merchant-paypal/api_resource.rb

@@ -0,0 +1,9 @@
+module MerchantPaypal
+  class ApiResource
+    include MerchantPaypal::Operations::Request
+
+    def self.class_name
+      self.name.split('::')[-1]
+    end
+  end
+end

data/lib/merchant-paypal/client.rb

@@ -0,0 +1,109 @@
+require "forwardable"
+
+module MerchantPaypal
+  class Client
+    extend Forwardable
+
+    DEFAULT_API_MODE     = :live
+    API_MODES            = [:live, :sandbox]
+    DEFAULT_API_ENDPOINT = {
+      sandbox: "https://api-m.sandbox.paypal.com",
+      live: "https://api-m.paypal.com"
+    }
+
+    attr_reader :config
+
+    def_delegators :@config, :client_id, :client_id=
+    def_delegators :@config, :client_secret, :client_secret=
+    def_delegators :@config, :mode, :mode=
+    def_delegators :@config, :access_token, :access_token=
+
+    def initialize(config = {})
+      @config = case config
+                when Hash
+                  MerchantPaypal.config.reverse_duplicate_merge(config)
+                when MerchantPaypal::Configuration
+                  config
+                else
+                  MerchantPaypal.config.dup
+                end
+    end
+
+    def api_mode
+      if API_MODES.include?(mode&.to_sym)
+        mode.to_sym
+      else
+        DEFAULT_API_MODE
+      end
+    end
+
+    def api_base
+      DEFAULT_API_ENDPOINT[api_mode]
+    end
+
+    def execute_request(method, url, params = {}, opts = {})
+      retries = 2
+
+      begin
+        request_opts = opts
+        headers = {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{access_token}",
+          "Prefer" => "return=minimal",
+        }
+
+        headers.merge!({ "PayPal-Request-Id" => opts[:request_id] }) if opts[:request_id].present?
+
+        request_url = api_base + url.to_s
+
+        case method.to_s.downcase.to_sym
+        when :get, :head, :delete
+          # Make params into GET parameters
+          request_url += "#{URI.parse(url).query ? '&' : '?'}#{Util.encode_parameters(params)}" if params && params.any?
+          payload = nil
+        else
+          payload = params
+        end
+
+        payload = payload.to_json if payload.is_a?(Hash)
+
+        request_opts.update(method: method,
+                            headers: headers,
+                            payload: payload,
+                            url: request_url)
+
+        response = RestClient::Request.execute(request_opts)
+
+        JSON.parse(response.body, object_class: OpenStruct)
+      rescue RestClient::Unauthorized
+        if retries.positive?
+          retries -= 1
+          authenticate!
+          retry
+        end
+        raise
+      rescue => e
+        puts e.response
+        raise
+      end
+    end
+
+    def authenticate!
+      request_opts = {
+        method: :post,
+        url: api_base + "/v1/oauth2/token",
+        payload: { grant_type: "client_credentials" },
+        user: client_id,
+        password: client_secret,
+      }
+
+      response = RestClient::Request.execute(request_opts)
+      result = JSON.parse(response.body, object_class: OpenStruct)
+
+      MerchantPaypal.access_token = result.access_token
+      self.access_token = result.access_token
+
+      result
+    end
+  end
+end

data/lib/merchant-paypal/configuration.rb

@@ -0,0 +1,28 @@
+module MerchantPaypal
+  class Configuration
+    attr_accessor :client_id
+    attr_accessor :client_secret
+    attr_accessor :mode
+    attr_accessor :access_token
+
+    def self.setup
+      new.tap do |instance|
+        yield(instance) if block_given?
+      end
+    end
+
+    # Create a new config based off an existing one. This is useful when the
+    # caller wants to override the global configuration
+    def reverse_duplicate_merge(hash)
+      dup.tap do |instance|
+        hash.each do |option, value|
+          instance.public_send("#{option}=", value)
+        end
+      end
+    end
+
+    def initialize
+      @mode = :live
+    end
+  end
+end

data/lib/merchant-paypal/operations/create.rb

@@ -0,0 +1,9 @@
+module MerchantPaypal
+  module Operations
+    module Create
+      def create(params = {}, opts = {})
+        request(:post, resource_url, params, opts)
+      end
+    end
+  end
+end

data/lib/merchant-paypal/operations/get.rb

@@ -0,0 +1,9 @@
+module MerchantPaypal
+  module Operations
+    module Get
+      def get(id, params = {})
+        request(:get, "#{resource_url}/#{CGI.escape(id)}", params)
+      end
+    end
+  end
+end

data/lib/merchant-paypal/operations/request.rb

@@ -0,0 +1,22 @@
+module MerchantPaypal
+  module Operations
+    module Request
+      module ClassMethods
+        def request(method, url, params = {}, opts = {})
+          MerchantPaypal::Client.new.execute_request(method, url, params, opts)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      protected
+
+      def request(method, url, params = {}, opts = {})
+        opts = @opts.merge(opts)
+        self.class.request(method, url, params, opts)
+      end
+    end
+  end
+end

data/lib/merchant-paypal/order.rb

@@ -0,0 +1,48 @@
+module MerchantPaypal
+  class Order < ApiResource
+    extend MerchantPaypal::Operations::Get
+
+    def self.resource_url
+      "/v2/checkout/#{CGI.escape(class_name.tableize)}"
+    end
+
+    def self.create(params = {}, opts = {})
+      payload = {
+        intent: "CAPTURE",
+        processing_instruction: "NO_INSTRUCTION",
+        purchase_units: [{
+          amount: {
+            currency_code:  params[:currency] || "AUD",
+            value: params[:amount],
+          }
+        }],
+        application_context: {
+          landing_page: "NO_PREFERENCE",
+          user_action: "PAY_NOW",
+          return_url: params[:return_url],
+          cancel_url:  params[:cancel_url],
+        }
+      }
+
+      request(:post, resource_url, payload, opts)
+    end
+
+    def self.create_for_redirection_url(params = {}, opts = {})
+      response = self.create(params, opts)
+      response.links.find { |link| link.rel == "approve"}&.href
+    end
+
+    def self.capture(id, opts = {})
+      payload = {
+        payment_source: {
+          token: {
+            id: id,
+            type: "BILLING_AGREEMENT",
+          }
+        }
+      }
+
+      request(:post, "#{resource_url}/#{CGI.escape(id)}/capture", payload, opts)
+    end
+  end
+end

data/lib/merchant-paypal/util.rb

@@ -0,0 +1,57 @@
+module MerchantPaypal
+  module Util
+    # Encodes a hash of parameters in a way that's suitable for use as query
+    # parameters in a URI or as form parameters in a request body. This mainly
+    # involves escaping special characters from parameter keys and values (e.g.
+    # `&`).
+    def self.encode_parameters(params)
+      Util.flatten_params(params).
+        map { |k,v| "#{url_encode(k)}=#{url_encode(v)}" }.join('&')
+    end
+
+    # Encodes a string in a way that makes it suitable for use in a set of
+    # query parameters in a URI or in a set of form parameters in a request
+    # body.
+    def self.url_encode(key)
+      CGI.escape(key.to_s).
+        # Don't use strict form encoding by changing the square bracket control
+        # characters back to their literals. This is fine by the server, and
+        # makes these parameter strings easier to read.
+        gsub('%5B', '[').gsub('%5D', ']')
+    end
+
+    def self.flatten_params(params, parent_key=nil)
+      result = []
+
+      # do not sort the final output because arrays (and arrays of hashes
+      # especially) can be order sensitive, but do sort incoming parameters
+      params.each do |key, value|
+        calculated_key = parent_key ? "#{parent_key}[#{key}]" : "#{key}"
+        if value.is_a?(Hash)
+          result += flatten_params(value, calculated_key)
+        elsif value.is_a?(Array)
+          check_array_of_maps_start_keys!(value)
+          result += flatten_params_array(value, calculated_key)
+        else
+          result << [calculated_key, value]
+        end
+      end
+
+      result
+    end
+
+    def self.flatten_params_array(value, calculated_key)
+      result = []
+      value.each do |elem|
+        if elem.is_a?(Hash)
+          result += flatten_params(elem, "#{calculated_key}[]")
+        elsif elem.is_a?(Array)
+          result += flatten_params_array(elem, calculated_key)
+        else
+          result << ["#{calculated_key}[]", elem]
+        end
+      end
+      result
+    end
+  end
+end

data/lib/merchant-paypal/version.rb

@@ -0,0 +1,3 @@
+module MerchantPaypal
+  VERSION = "0.0.3"
+end

data/lib/merchant-paypal.rb

@@ -0,0 +1,38 @@
+require "forwardable"
+
+require "merchant-paypal/operations/request"
+require "merchant-paypal/operations/create"
+require "merchant-paypal/operations/get"
+require "merchant-paypal/api_resource"
+require "merchant-paypal/configuration"
+require "merchant-paypal/version"
+require "merchant-paypal/util"
+
+module MerchantPaypal
+  autoload :Client, "merchant-paypal/client"
+  autoload :Authentication, "merchant-paypal/authentication"
+  autoload :Order, "merchant-paypal/order"
+
+  @config = Configuration.setup
+
+  class << self
+    extend Forwardable
+
+    attr_reader :config
+
+    # User configurable options
+    def_delegators :@config, :client_id, :client_id=
+    def_delegators :@config, :client_secret, :client_secret=
+    def_delegators :@config, :mode, :mode=
+    def_delegators :@config, :access_token, :access_token=
+
+    def configure(client_id: nil, client_secret: nil, mode: :live)
+      @config = Configuration.setup.reverse_duplicate_merge(
+        client_id: client_id,
+        client_secret: client_secret,
+        mode: mode,
+        access_token: nil,
+      )
+    end
+  end
+end

data/merchant-paypal.gemspec

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+require "merchant-paypal/version"
+
+Gem::Specification.new do |s|
+  s.name          = "merchant-paypal"
+  s.version       = MerchantPaypal::VERSION
+  s.authors       = ["Devhub"]
+  s.email         = ["info@devhub.co"]
+  s.summary       = "Ruby Library for Paypal API"
+  s.description   = "Merchant Paypal provides Ruby APIs dealing with Palpal transactions."
+  s.homepage      = "https://github.com/DevHubCo/merchant-paypal"
+  s.license       = 'MIT'
+
+  ignored = Regexp.union(
+    /\A\.editorconfig/,
+    /\A\.git/,
+    /\A\.rubocop/,
+    /\A\.travis.yml/,
+    /\A\.vscode/,
+    /\Atest/
+  )
+  s.files         = `git ls-files`.split("\n").reject { |f| ignored.match(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n")
+                                           .map { |f| ::File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rest-client', '~> 2.0', '>= 2.0.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merchant-paypal
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Devhub
@@ -33,12 +33,27 @@ dependencies:
 description: Merchant Paypal provides Ruby APIs dealing with Palpal transactions.
 email:
 - info@devhub.co
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE
+- bin/console
+- lib/merchant-paypal.rb
+- lib/merchant-paypal/api_resource.rb
+- lib/merchant-paypal/client.rb
+- lib/merchant-paypal/configuration.rb
+- lib/merchant-paypal/operations/create.rb
+- lib/merchant-paypal/operations/get.rb
+- lib/merchant-paypal/operations/request.rb
+- lib/merchant-paypal/order.rb
+- lib/merchant-paypal/util.rb
+- lib/merchant-paypal/version.rb
+- merchant-paypal.gemspec
 homepage: https://github.com/DevHubCo/merchant-paypal
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message:
 rdoc_options: []