simpal 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da8d90b4b7d128563272f45a94b547cbd74e8529c40895a024b492e1137aa03e
-  data.tar.gz: 0ad90fffe64cd5cad8e9a06a344e31dfd7b8436e438712e6ec8ca3e120b028cc
+  metadata.gz: 7e18733eb9d27f1c0cb3f77f57ad6dba9c4d78902e975da88ba47f069d6408d5
+  data.tar.gz: e3c07a80dfaf0bebb18332d21b9b529e7247d6f5a2cb8e0bb62e57fba32fc541
 SHA512:
-  metadata.gz: 679cabc6fd8e5562ad682b715345ef3a468c0a30c6c2513b984a813bf9d5edd8420d58154e173b05b0ea10589891b9f534470690a2c74fe5f5e4022ddf5eed56
-  data.tar.gz: 48f700c2391ca1a281bf5fc7323786b5e75fd76686b95e1df67c59b3e21c191d980b9564de441bcf7c5e5bbe7489065e3dbc33530a4628576fea42c696903107
+  metadata.gz: d392b318c21364e89d3e815190814548cbe086c777f926a784091b9c90f27235d998af1cc0023cc7231b2c7469be31a9765adf66eaf4dab92b49d9d765f95c64
+  data.tar.gz: 3d38be42881dfdd5345ef5a64a4a355c035b904ef2a96bc5409ce7072300397637ab19cf50d1e1b9964942ffb15ccdfa5ebd9ee29931a6897bc9caf896f463e6

data/.rubocop.yml

@@ -34,3 +34,7 @@ Metrics/PerceivedComplexity:
 
 Naming/VariableNumber:
   EnforcedStyle: snake_case
+
+RSpec/FilePath:
+  Exclude:
+    - spec/lib/simpal/paypal_object_spec.rb

data/lib/simpal/constants.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module Simpal
-  VERSION = '1.0.2'
+  # @return [String] The gem's semantic version number.
+  #
+  VERSION = '1.1.0'
 end

data/lib/simpal/paypal_object.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Simpal
+  # Represents an API resource.
+  #
+  class PayPalObject
+    # @return [Regexp] A simple regular expression that matches the syntax of an ISO8601 date and time.
+    #
+    TIME_REGEXP = /\A[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(Z|\+[0-9]{2}:[0-9]{2}(\.[0-9]+)?)\z/.freeze
+
+    # Create an object representing a resource from the PayPal API.
+    #
+    # @param resource [Hash] The resource retrieved from the PayPal API.
+    #
+    def initialize(resource = {})
+      transform = proc do |value|
+        case value
+        when Array       then value.map { |v| transform.call(v) }
+        when Hash        then PayPalObject.new(value)
+        when TIME_REGEXP then Time.parse(value)
+        else                  value
+        end
+      end
+
+      @resource = resource.each_with_object({}) do |(key, value), hash|
+        hash[key.to_s] = transform.call(value)
+      end
+
+      @resource.each_key do |key|
+        define_singleton_method(key.to_sym) do |*args, &block|
+          return @resource[key] if args.empty?
+          return super(*args, &block) if defined?(super)
+
+          raise NoMethodError, "method '#{key}' doesn't support arguments in #{self}"
+        end
+      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
+        when Time         then value.iso8601
+        else                   value
+        end
+      end
+
+      @resource.transform_values(&transform)
+    end
+
+    # @return [String] A JSON representation of the PayPal object.
+    #
+    def inspect
+      resource_id = respond_to?(:id) && id ? " id=#{id}" : ''
+      json = JSON.pretty_generate(@resource)
+      "#<#{self.class}:0x#{object_id.to_s(16)}#{resource_id}> JSON: #{json}"
+    end
+
+    # Determines whether the object can respond to the specified method name.
+    #
+    # @param  name        [Symbol]  The name of the method to determine responsiveness of.
+    # @param  include_all [Boolean] `true` to search private and protected methods, `false` to search public only.
+    # @return             [Boolean] `true` if the method can be responded to, `false` otherwise.
+    #
+    def respond_to_missing?(name, _include_all)
+      @resource.key?(name.to_s)
+    end
+
+    # Returns `nil` when the method is missing instead of raising a `NoMethodError` exception.
+    #
+    # @param  name [Symbol]   The name of the invoked method.
+    # @param  args [Splat]    The arguments passed into the invoked method.
+    # @return      [NilClass]
+    #
+    def method_missing(_name, *_args)
+      nil
+    end
+
+    # @see Simpal::PayPalObject#to_hash
+    #
+    alias to_h to_hash
+  end
+end

data/lib/simpal.rb

@@ -10,7 +10,7 @@ require_relative 'simpal/middleware/authorization'
 require_relative 'simpal/middleware/headers'
 require_relative 'simpal/client_error'
 require_relative 'simpal/client'
-require_relative 'simpal/pay_pal_object'
+require_relative 'simpal/paypal_object'
 require_relative 'simpal/api/orders'
 require_relative 'simpal/api/payments/authorizations'
 require_relative 'simpal/api/payments/captures'

data/simpal.gemspec

@@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
   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.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['source_code_uri'] = 'https://github.com/NialtoServices/simpal'
   spec.metadata['changelog_uri'] = 'https://github.com/NialtoServices/simpal/blob/main/CHANGELOG.md'
   spec.metadata['rubygems_mfa_required'] = 'true'
 
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = %w[lib]
 
   spec.add_dependency 'faraday', '~> 2.0'
 
@@ -34,10 +34,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'pry', '~> 0.14'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.11'
-  spec.add_development_dependency 'rubocop', '~> 1.32'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.39'
   spec.add_development_dependency 'rubocop-rake', '~> 0.6'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.12'
-  spec.add_development_dependency 'sinatra', '~> 2.2'
-  spec.add_development_dependency 'webmock', '~> 3.14'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.15'
+  spec.add_development_dependency 'sinatra', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.18'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simpal
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Nialto Services
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.32'
+        version: '1.39'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,42 +128,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.14'
+        version: '3.18'
 description:
 email:
 - support@nialtoservices.co.uk
@@ -195,17 +195,17 @@ files:
 - 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
+- lib/simpal/paypal_object.rb
 - simpal.gemspec
-homepage: https://github.com/nialtoservices/simpal
+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
+  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
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -223,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: A simple, lightweight wrapper around PayPal's REST API.

data/lib/simpal/pay_pal_object.rb

@@ -1,92 +0,0 @@
-# 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