simpal 0.1.0

data/lib/simpal/middleware/headers.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Simpal
+  module Middleware
+    # Allows the use of convenience header names which are then mapped into the real header name.
+    #
+    class Headers < Faraday::Middleware
+      # @return [Array] The request headers which must have the 'PayPal-' prefix applied to them.
+      #
+      PAYPAL_HEADERS = %w[
+        Request-Id
+        Client-Metadata-Id
+        Partner-Attribution-Id
+        Auth-Assertion
+      ].freeze
+
+      def on_request(env)
+        headers = env[:request_headers]
+        return unless headers.is_a?(Hash)
+
+        # Prefer full representations, instead of the minimal response by default.
+        headers['Prefer'] = 'return=representation' unless headers.key?('Prefer')
+
+        PAYPAL_HEADERS.each do |header|
+          headers["PayPal-#{header}"] = headers.delete(header) if headers.key?(header)
+        end
+
+        env[:request_headers] = headers
+      end
+    end
+  end
+end

data/lib/simpal/order.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Simpal
+  # @see Simpal::API::Orders
+  #
+  module Order
+    # Create an order.
+    #
+    # @see Simpal::API::Orders.create
+    # @param  params  [Hash]                 The parameters for the create request.
+    # @param  headers [Hash]                 The custom headers to add to the request.
+    # @param  client  [Simpal::Client]       The API client to make the request with.
+    # @return         [Simpal::PayPalObject] An object representing the order.
+    #
+    def self.create(params = {}, headers: {}, client: nil)
+      resource = API::Orders.create(params, headers: headers, client: client)
+      PayPalObject.new(resource)
+    end
+
+    # Update an order.
+    #
+    # @see Simpal::API::Orders.update
+    # @param  id      [String]         The ID of an existing order.
+    # @param  params  [Array<Hash>]    The collection of patches to apply to the order.
+    # @param  headers [Hash]           The custom headers to add to the request.
+    # @param  client  [Simpal::Client] The API client to make the request with.
+    # @return         [Boolean]        `true` if the order was updated, else an exception is raised.
+    #
+    def self.update(id, params = [], headers: {}, client: nil)
+      API::Orders.update(id, params, headers: headers, client: client)
+      true
+    end
+
+    # Retrieve an order.
+    #
+    # @see Simpal::API::Orders.retrieve
+    # @param  id      [String]         The ID of an existing order.
+    # @param  headers [Hash]           The custom headers to add to the request.
+    # @param  client  [Simpal::Client] The API client to make the request with.
+    # @return         [Hash]           A Hash representing the order.
+    #
+    def self.retrieve(id, headers: {}, client: nil)
+      resource = API::Orders.retrieve(id, headers: headers, client: client)
+      PayPalObject.new(resource)
+    end
+
+    # Authorize the payment for an order.
+    #
+    # @see Simpal::API::Orders.authorize
+    # @param  id      [String]         The ID of an existing order.
+    # @param  params  [Hash]           The parameters for the authorize request.
+    # @param  headers [Hash]           The custom headers to add to the request.
+    # @param  client  [Simpal::Client] The API client to make the request with.
+    # @return         [Hash]           A Hash representing the order.
+    #
+    def self.authorize(id, params = {}, headers: {}, client: nil)
+      resource = API::Orders.authorize(id, params, headers: headers, client: client)
+      PayPalObject.new(resource)
+    end
+
+    # Capture the payment for an order.
+    #
+    # @see Simpal::API::Orders.capture
+    # @param  id      [String]         The ID of an existing order.
+    # @param  params  [Hash]           The parameters for the capture request.
+    # @param  headers [Hash]           The custom headers to add to the request.
+    # @param  client  [Simpal::Client] The API client to make the request with.
+    # @return         [Hash]           A Hash representing the order.
+    #
+    def self.capture(id, params = {}, headers: {}, client: nil)
+      resource = API::Orders.capture(id, params, headers: headers, client: client)
+      PayPalObject.new(resource)
+    end
+  end
+end

data/lib/simpal/pay_pal_object.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Simpal
+  # Represents an API resource.
+  #
+  class PayPalObject
+    # Create a new object representing the provided resource.
+    #
+    # @param resource [Hash] The resource to represent.
+    #
+    def initialize(resource = {})
+      transform = proc do |key, value|
+        case value
+        when Array then value.map { |v| transform.call(nil, v) }
+        when Hash  then PayPalObject.new(value)
+        else
+          if key && (key.end_with?('date') || key.end_with?('time'))
+            Time.parse(value)
+          else
+            value
+          end
+        end
+      end
+
+      @values = resource.each_with_object({}) do |(key, value), values|
+        values[key.to_s] = transform.call(key.to_s, value)
+        add_reader(key)
+      end
+    end
+
+    # @return [Hash] A hash representation of the PayPal object.
+    #
+    def to_hash
+      transform = proc do |value|
+        case value
+        when Array        then value.map { |v| transform.call(v) }
+        when PayPalObject then value.to_hash
+        else                   value.is_a?(Time) ? value.iso8601 : value
+        end
+      end
+
+      @values.transform_values(&transform)
+    end
+
+    # @see Simpal::PayPalObject#to_hash
+    #
+    alias to_h to_hash
+
+    # @return [String] A JSON string representation of the PayPal object.
+    #
+    def inspect
+      paypal_id = respond_to?(:id) && id ? " id=#{id}" : ''
+      json = JSON.pretty_generate(@values)
+      "#<#{self.class}:0x#{object_id.to_s(16)}#{paypal_id}> JSON: #{json}"
+    end
+
+    # @return [Boolean] `true` to indicate that all methods can be responded to.
+    #
+    def respond_to_missing?(_name, _include_all)
+      true
+    end
+
+    # @return [NilClass] `nil` instead of raising an exception.
+    #
+    def method_missing(_name, *args); end
+
+    private
+
+    # Add a read-only attribute for the specified value.
+    #
+    # @param name [String, Symbol] The name of the attribute to define.
+    #
+    def add_reader(name)
+      metaclass.instance_eval do
+        name = name.to_s
+        if name.to_sym == :method
+          define_method(name.to_sym) { |*args| args.empty? ? @values[name] : super(*args) }
+        else
+          define_method(name.to_sym) { @values[name] }
+        end
+      end
+    end
+
+    # @return [Class] The metaclass which can be used to define methods on this instance only.
+    #
+    def metaclass
+      class << self
+        self
+      end
+    end
+  end
+end

data/lib/simpal/payment/authorization.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Simpal
+  # @see Simpal::API::Payments
+  #
+  module Payment
+    # @see Simpal::API::Payments::Authorizations
+    #
+    module Authorization
+      # Retrieve an authorized payment.
+      #
+      # @param  id      [String]               The ID of an authorized payment.
+      # @param  headers [Hash]                 The custom headers to add to the request.
+      # @param  client  [Simpal::Client]       The API client to make the request with.
+      # @return         [Simpal::PayPalObject] An object representing the authorized payment.
+      #
+      def self.retrieve(id, headers: {}, client: nil)
+        resource = API::Payments::Authorizations.retrieve(id, headers: headers, client: client)
+        PayPalObject.new(resource)
+      end
+
+      # Capture an authorized payment.
+      #
+      # @param  id      [String]               The ID of an authorized payment.
+      # @param  params  [Hash]                 The parameters for the capture request.
+      # @param  headers [Hash]                 The custom headers to add to the request.
+      # @param  client  [Simpal::Client]       The API client to make the request with.
+      # @return         [Simpal::PayPalObject] An object representing the captured payment.
+      #
+      def self.capture(id, params = {}, headers: {}, client: nil)
+        resource = API::Payments::Authorizations.capture(id, params, headers: headers, client: client)
+        PayPalObject.new(resource)
+      end
+
+      # Reauthorize an authorized payment.
+      #
+      # @param  id      [String]               The ID of an authorized payment.
+      # @param  params  [Hash]                 The parameters for the reauthorize request.
+      # @param  headers [Hash]                 The custom headers to add to the request.
+      # @param  client  [Simpal::Client]       The API client to make the request with.
+      # @return         [Simpal::PayPalObject] An object representing the reauthorized payment.
+      #
+      def self.reauthorize(id, params = {}, headers: {}, client: nil)
+        resource = API::Payments::Authorizations.reauthorize(id, params, headers: headers, client: client)
+        PayPalObject.new(resource)
+      end
+
+      # Void an authorized payment.
+      #
+      # @param  id      [String]         The ID of an authorized payment.
+      # @param  headers [Hash]           The custom headers to add to the request.
+      # @param  client  [Simpal::Client] The API client to make the request with.
+      # @return         [Boolean]        `true` if the authorization was voided, else an exception is raised.
+      #
+      def self.void(id, headers: {}, client: nil)
+        API::Payments::Authorizations.void(id, headers: headers, client: client)
+        true
+      end
+    end
+  end
+end

data/lib/simpal/payment/capture.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Simpal
+  # @see Simpal::API::Payments
+  #
+  module Payment
+    # @see Simpal::API::Payments::Captures
+    #
+    module Capture
+      # Retrieve an captured payment.
+      #
+      # @param  id      [String]               The ID of a captured payment.
+      # @param  headers [Hash]                 The custom headers to add to the request.
+      # @param  client  [Simpal::Client]       The API client to make the request with.
+      # @return         [Simpal::PayPalObject] An object representing the captured payment.
+      #
+      def self.retrieve(id, headers: {}, client: nil)
+        resource = API::Payments::Captures.retrieve(id, headers: headers, client: client)
+        PayPalObject.new(resource)
+      end
+
+      # Refund a captured payment.
+      #
+      # @param  id      [String]               The ID of a captured payment.
+      # @param  params  [Hash]                 The parameters for the refund request.
+      # @param  headers [Hash]                 The custom headers to add to the request.
+      # @param  client  [Simpal::Client]       The API client to make the request with.
+      # @return         [Simpal::PayPalObject] An object representing the refunded payment.
+      #
+      def self.refund(id, params = {}, headers: {}, client: nil)
+        resource = API::Payments::Captures.capture(id, params, headers: headers, client: client)
+        PayPalObject.new(resource)
+      end
+    end
+  end
+end

data/lib/simpal/payment/refund.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Simpal
+  # @see Simpal::API::Payments
+  #
+  module Payment
+    # @see Simpal::API::Payments::Refunds
+    #
+    module Refund
+      # Retrieve a refund for a payment.
+      #
+      # @see Simpal::API::Payments::Refunds.retrieve
+      # @param  id      [String]               The ID of a refuned payment.
+      # @param  headers [Hash]                 The custom headers to add to the request.
+      # @param  client  [Simpal::Client]       The API client to make the request with.
+      # @return         [Simpal::PayPalObject] An object representing the refunded payment.
+      #
+      def self.retrieve(id, headers: {}, client: nil)
+        resource = API::Payments::Refunds.retrieve(id, headers: headers, client: client)
+        PayPalObject.new(resource)
+      end
+    end
+  end
+end

data/simpal.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/simpal/constants'
+
+Gem::Specification.new do |spec|
+  spec.name = 'simpal'
+  spec.version = Simpal::VERSION
+  spec.authors = ['Nialto Services']
+  spec.email = ['support@nialtoservices.co.uk']
+
+  spec.summary = "A simple, lightweight wrapper around PayPal's REST API."
+  spec.homepage = 'https://github.com/nialtoservices/simpal'
+  spec.license = 'Apache-2.0'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/nialtoservices/simpal'
+  spec.metadata['changelog_uri'] = 'https://github.com/NialtoServices/simpal/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 1.4'
+  spec.add_dependency 'faraday_middleware', '~> 1.0'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.7'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.3'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: simpal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nialto Services
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description:
+email:
+- support@nialtoservices.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simpal.rb
+- lib/simpal/api/orders.rb
+- lib/simpal/api/payments/authorizations.rb
+- lib/simpal/api/payments/captures.rb
+- lib/simpal/api/payments/refunds.rb
+- lib/simpal/client.rb
+- lib/simpal/client_error.rb
+- lib/simpal/constants.rb
+- lib/simpal/middleware/authorization.rb
+- lib/simpal/middleware/headers.rb
+- lib/simpal/order.rb
+- lib/simpal/pay_pal_object.rb
+- lib/simpal/payment/authorization.rb
+- lib/simpal/payment/capture.rb
+- lib/simpal/payment/refund.rb
+- simpal.gemspec
+homepage: https://github.com/nialtoservices/simpal
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/nialtoservices/simpal
+  source_code_uri: https://github.com/nialtoservices/simpal
+  changelog_uri: https://github.com/NialtoServices/simpal/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: A simple, lightweight wrapper around PayPal's REST API.
+test_files: []