paypro 1.0.0 → 2.0.0

data/lib/pay_pro/entities/subscription.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Subscription < Resource
+    include PayPro::Operations::Updatable
+
+    RESOURCE_PATH = 'subscriptions'
+
+    def cancel(**options)
+      api_request(method: 'delete', uri: resource_url, options: options)
+    end
+
+    def pause(**options)
+      api_request(method: 'post', uri: "#{resource_url}/pause", options: options)
+    end
+
+    def resume(**options)
+      api_request(method: 'post', uri: "#{resource_url}/resume", options: options)
+    end
+
+    def subscription_periods(**options)
+      api_request(
+        method: 'get',
+        uri: "#{resource_url}/subscription_periods",
+        options: options
+      )
+    end
+
+    def create_subscription_period(body = {}, **options)
+      api_request(
+        method: 'post',
+        uri: "#{resource_url}/subscription_periods",
+        body: body.to_json,
+        options: options
+      )
+    end
+  end
+end

data/lib/pay_pro/entities/subscription_period.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PayPro
+  class SubscriptionPeriod < Entity; end
+end

data/lib/pay_pro/entities/webhook.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Webhook < Resource
+    include PayPro::Operations::Deletable
+    include PayPro::Operations::Updatable
+
+    RESOURCE_PATH = 'webhooks'
+
+    def self.create_event(
+      payload:,
+      signature:,
+      secret:,
+      timestamp:,
+      tolerance: PayPro::Signature::DEFAULT_TOLERANCE
+    )
+      signature_verifier = PayPro::Signature.new(
+        payload: payload,
+        timestamp: Time.at(timestamp),
+        secret: secret,
+        tolerance: tolerance
+      )
+
+      return unless signature_verifier.verify(signature: signature)
+
+      data = JSON.parse(payload)
+      PayPro::Event.create_from_data(data, api_client: nil)
+    end
+  end
+end

data/lib/pay_pro/errors.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Error < StandardError
+    def initialize(
+      message: nil,
+      http_status: nil,
+      http_body: nil,
+      http_headers: nil,
+      code: nil
+    )
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @http_headers = http_headers
+      @code = code
+
+      super(@message)
+    end
+  end
+
+  class ConfigurationError < Error; end
+  class ConnectionError < Error; end
+  class AuthenticationError < Error; end
+  class ResourceNotFoundError < Error; end
+  class SignatureVerificationError < Error; end
+
+  class ValidationError < Error
+    def initialize(param:, **kwargs)
+      @param = param
+      kwargs[:message] = "#{kwargs[:message]}, with param: \"#{@param}\""
+
+      super(**kwargs)
+    end
+  end
+end

data/lib/pay_pro/operations/creatable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Operations
+    module Creatable
+      def create(body = {}, **options)
+        api_request(method: 'post', uri: resource_url, body: body.to_json, options: options)
+      end
+    end
+  end
+end

data/lib/pay_pro/operations/deletable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Operations
+    module Deletable
+      def delete(**options)
+        api_request(method: 'delete', uri: resource_url, options: options)
+      end
+    end
+  end
+end

data/lib/pay_pro/operations/getable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Operations
+    module Getable
+      def get(id, **options)
+        api_request(method: 'get', uri: "#{resource_url}/#{CGI.escape(id)}", options: options)
+      end
+    end
+  end
+end

data/lib/pay_pro/operations/listable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Operations
+    module Listable
+      def list(params = {}, **options)
+        api_request(method: 'get', uri: resource_url, params: params, options: options)
+      end
+    end
+  end
+end

data/lib/pay_pro/operations/requestable.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Operations
+    module Requestable
+      def api_request(method:, uri:, params: {}, body: nil, options: {})
+        response = api_client.request(method: method, uri: uri, params: params, body: body, options: options)
+        Util.to_entity(response.data, params: params, api_client: api_client)
+      end
+    end
+  end
+end

data/lib/pay_pro/operations/updatable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Operations
+    module Updatable
+      def update(body = {}, **options)
+        api_request(method: 'patch', uri: resource_url, body: body.to_json, options: options)
+      end
+    end
+  end
+end

data/lib/pay_pro/response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Response
+    attr_accessor :request_id,
+                  :data,
+                  :raw_body,
+                  :status
+
+    def self.from_response(response_object)
+      response = new
+
+      response.data = JSON.parse(response_object.body)
+      response.raw_body = response_object.body
+      response.status = response_object.status
+      response.request_id = response_object.headers['x-request-id']
+
+      response
+    end
+  end
+end

data/lib/pay_pro/signature.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Signature
+    # Default timestamp tolerance is 10 minutes
+    DEFAULT_TOLERANCE = 600
+
+    def initialize(
+      payload:,
+      timestamp:,
+      secret:,
+      tolerance: DEFAULT_TOLERANCE
+    )
+      raise ArgumentError, 'timestamp must be an instance of Time' unless timestamp.is_a?(Time)
+      raise ArgumentError, 'payload must be a String' unless payload.is_a?(String)
+      raise ArgumentError, 'secret must be a String' unless secret.is_a?(String)
+      raise ArgumentError, 'tolerance must be an Integer' unless tolerance.is_a?(Integer)
+
+      @payload = payload
+      @timestamp = timestamp.utc
+      @secret = secret
+      @tolerance = tolerance
+    end
+
+    def generate_signature
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new('sha256'),
+        @secret,
+        signature_string
+      )
+    end
+
+    def verify(signature:)
+      unless OpenSSL.secure_compare(signature, generate_signature)
+        raise SignatureVerificationError.new(
+          message: 'Signature does not match',
+          http_body: @payload
+        )
+      end
+
+      if @timestamp < Time.now.utc - @tolerance
+        formatted_timestamp = @timestamp.strftime('%F %T')
+
+        raise SignatureVerificationError.new(
+          message: "Timestamp is outside the tolerance zone: #{formatted_timestamp}",
+          http_body: @payload
+        )
+      end
+
+      true
+    end
+
+    private
+
+    def signature_string
+      "#{@timestamp.to_i}.#{@payload}"
+    end
+  end
+end

data/lib/pay_pro/util.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Util
+    class << self
+      # Searches the entities folder for a valid entity class based on a string. This string will
+      # be returned in the API as the 'type' parameter.
+      #
+      # If the class cannot be found it will fallback to the base class Entity.
+      def entity_class(string)
+        parts = string.split('_')
+        class_name = parts.map { |part| part.downcase.capitalize }.join
+        PayPro.const_get(class_name, false)
+      rescue NameError
+        Entity
+      end
+
+      def normalize_api_attributes(attributes)
+        new_attributes = attributes.dup
+
+        new_attributes.delete('type')
+        new_attributes['links'] = new_attributes.delete('_links') if new_attributes['_links']
+        new_attributes
+      end
+
+      # Creates an Enity class or returns the data if the data cannot be converted to an entity.
+      #
+      # It will try to find an API entity class, if it cannot be found it will fallback to the
+      # default Entity class.
+      def to_entity(data, api_client:, params: {})
+        case data
+        when Array
+          data.map { |i| to_entity(i, api_client: api_client) }
+        when Hash
+          if data.key?('type')
+            entity = entity_class(data['type']).create_from_data(data, api_client: api_client)
+            entity.filters = params if entity.is_a?(PayPro::List)
+            entity
+          else
+            data.transform_values { |value| to_entity(value, api_client: api_client) }
+          end
+        else
+          data
+        end
+      end
+    end
+  end
+end

data/lib/{paypro → pay_pro}/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PayPro
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/pay_pro.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'pay_pro/version'
+
+require 'cgi'
+require 'faraday'
+require 'json'
+require 'uri'
+require 'openssl'
+
+require 'pay_pro/api_client'
+require 'pay_pro/client'
+require 'pay_pro/config'
+require 'pay_pro/errors'
+require 'pay_pro/response'
+require 'pay_pro/signature'
+require 'pay_pro/util'
+
+require 'pay_pro/operations/creatable'
+require 'pay_pro/operations/deletable'
+require 'pay_pro/operations/getable'
+require 'pay_pro/operations/listable'
+require 'pay_pro/operations/requestable'
+require 'pay_pro/operations/updatable'
+
+require 'pay_pro/endpoint'
+
+require 'pay_pro/endpoints/chargebacks'
+require 'pay_pro/endpoints/customers'
+require 'pay_pro/endpoints/events'
+require 'pay_pro/endpoints/installment_plan_periods'
+require 'pay_pro/endpoints/installment_plans'
+require 'pay_pro/endpoints/mandates'
+require 'pay_pro/endpoints/pay_methods'
+require 'pay_pro/endpoints/payments'
+require 'pay_pro/endpoints/refunds'
+require 'pay_pro/endpoints/subscription_periods'
+require 'pay_pro/endpoints/subscriptions'
+require 'pay_pro/endpoints/webhooks'
+
+require 'pay_pro/entities/entity'
+require 'pay_pro/entities/resource'
+
+require 'pay_pro/entities/chargeback'
+require 'pay_pro/entities/customer'
+require 'pay_pro/entities/event'
+require 'pay_pro/entities/installment_plan'
+require 'pay_pro/entities/installment_plan_period'
+require 'pay_pro/entities/list'
+require 'pay_pro/entities/mandate'
+require 'pay_pro/entities/pay_method'
+require 'pay_pro/entities/payment'
+require 'pay_pro/entities/refund'
+require 'pay_pro/entities/subscription'
+require 'pay_pro/entities/subscription_period'
+require 'pay_pro/entities/webhook'
+
+module PayPro
+  API_URL = 'https://api.paypro.nl'
+
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    # Shortcut method to directly set the API key
+    def api_key=(api_key)
+      configure do |config|
+        config.api_key = api_key
+      end
+    end
+  end
+end

data/paypro.gemspec

@@ -1,23 +1,30 @@
 # frozen_string_literal: true
 
-require File.expand_path('lib/paypro/version', __dir__)
+require File.expand_path('lib/pay_pro/version', __dir__)
 
 Gem::Specification.new do |s|
   s.name = 'paypro'
   s.version = PayPro::VERSION
-  s.license = 'MIT'
-  s.homepage = 'https://github.com/paypronl/paypro-ruby-v1'
   s.author = 'PayPro'
-  s.email = 'support@paypro.nl'
-  s.summary = 'Ruby client for PayPro API v1'
+  s.email = ['support@paypro.nl']
+
+  s.summary = 'Ruby library for the PayPro API'
+  s.description = 'Online payments for entrepreneurs that want maximum growth'
+  s.homepage = 'https://www.paypro.nl'
+  s.license = 'MIT'
+  s.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
 
-  s.required_ruby_version = '>= 2.4.0'
-  s.add_dependency 'faraday', '>= 0.13', '< 2'
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/paypronl/paypro-ruby'
+  s.metadata['rubygems_mfa_required'] = 'true'
 
-  s.add_development_dependency 'rspec', '~> 3.6'
+  # 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.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
 
-  s.files = `git ls-files`.split("\n")
-  s.test_files = Dir.glob('spec/**/*_spec.rb')
+  s.add_dependency 'faraday', '>= 1.10'
 
-  s.require_path = 'lib'
+  s.require_paths = ['lib']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypro
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - PayPro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,63 +16,84 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-description: 
-email: support@paypro.nl
+        version: '1.10'
+description: Online payments for entrepreneurs that want maximum growth
+email:
+- support@paypro.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/build.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
-- examples/create_payment.rb
-- lib/data/ca-bundle.crt
-- lib/paypro.rb
-- lib/paypro/client.rb
-- lib/paypro/errors.rb
-- lib/paypro/version.rb
+- bin/console
+- bin/setup
+- lib/data/cacert.pem
+- lib/pay_pro.rb
+- lib/pay_pro/api_client.rb
+- lib/pay_pro/client.rb
+- lib/pay_pro/config.rb
+- lib/pay_pro/endpoint.rb
+- lib/pay_pro/endpoints/chargebacks.rb
+- lib/pay_pro/endpoints/customers.rb
+- lib/pay_pro/endpoints/events.rb
+- lib/pay_pro/endpoints/installment_plan_periods.rb
+- lib/pay_pro/endpoints/installment_plans.rb
+- lib/pay_pro/endpoints/mandates.rb
+- lib/pay_pro/endpoints/pay_methods.rb
+- lib/pay_pro/endpoints/payments.rb
+- lib/pay_pro/endpoints/refunds.rb
+- lib/pay_pro/endpoints/subscription_periods.rb
+- lib/pay_pro/endpoints/subscriptions.rb
+- lib/pay_pro/endpoints/webhooks.rb
+- lib/pay_pro/entities/chargeback.rb
+- lib/pay_pro/entities/customer.rb
+- lib/pay_pro/entities/entity.rb
+- lib/pay_pro/entities/event.rb
+- lib/pay_pro/entities/installment_plan.rb
+- lib/pay_pro/entities/installment_plan_period.rb
+- lib/pay_pro/entities/list.rb
+- lib/pay_pro/entities/mandate.rb
+- lib/pay_pro/entities/pay_method.rb
+- lib/pay_pro/entities/payment.rb
+- lib/pay_pro/entities/refund.rb
+- lib/pay_pro/entities/resource.rb
+- lib/pay_pro/entities/subscription.rb
+- lib/pay_pro/entities/subscription_period.rb
+- lib/pay_pro/entities/webhook.rb
+- lib/pay_pro/errors.rb
+- lib/pay_pro/operations/creatable.rb
+- lib/pay_pro/operations/deletable.rb
+- lib/pay_pro/operations/getable.rb
+- lib/pay_pro/operations/listable.rb
+- lib/pay_pro/operations/requestable.rb
+- lib/pay_pro/operations/updatable.rb
+- lib/pay_pro/response.rb
+- lib/pay_pro/signature.rb
+- lib/pay_pro/util.rb
+- lib/pay_pro/version.rb
 - paypro.gemspec
-- spec/paypro/client_spec.rb
-- spec/paypro_spec.rb
-- spec/spec_helper.rb
-homepage: https://github.com/paypronl/paypro-ruby-v1
+homepage: https://www.paypro.nl
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://www.paypro.nl
+  source_code_uri: https://github.com/paypronl/paypro-ruby
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,17 +101,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
-summary: Ruby client for PayPro API v1
-test_files:
-- spec/paypro/client_spec.rb
-- spec/paypro_spec.rb
+summary: Ruby library for the PayPro API
+test_files: []

data/.circleci/config.yml

@@ -1,74 +0,0 @@
-defaults: &defaults
-  working_directory: ~/repo
-
-  resource_class: small
-
-  steps:
-    - checkout
-
-    - run:
-        name: install dependencies
-        command: |
-          bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-    - run:
-        name: run rubocop
-        command: bundle exec rubocop
-
-    - run:
-        name: run tests
-        command: |
-          mkdir /tmp/test-results
-          bundle exec rspec --format progress \
-                          --format RspecJunitFormatter \
-                          --out /tmp/test-results/rspec.xml \
-                          --format progress
-
-    - store_test_results:
-        path: /tmp/test-results
-    - store_artifacts:
-        path: /tmp/test-results
-        destination: test-results
-
-version: 2.1
-jobs:
-  build-ruby-3_1_2:
-    <<: *defaults
-    docker:
-      - image: cimg/ruby:3.1.2
-
-  build-ruby-3_0_4:
-    <<: *defaults
-    docker:
-      - image: cimg/ruby:3.0.4
-
-  build-ruby-2_7_6:
-    <<: *defaults
-    docker:
-      - image: cimg/ruby:2.7.6
-
-  build-ruby-2_6_10:
-    <<: *defaults
-    docker:
-      - image: cimg/ruby:2.6.10
-
-  build-ruby-2_5_9:
-    <<: *defaults
-    docker:
-      - image: cimg/ruby:2.5.9
-
-  build-ruby-2_4_10:
-    <<: *defaults
-    docker:
-      - image: cimg/ruby:2.4.10
-
-workflows:
-  version: 2
-  build:
-    jobs:
-      - build-ruby-3_1_2
-      - build-ruby-3_0_4
-      - build-ruby-2_7_6
-      - build-ruby-2_6_10
-      - build-ruby-2_5_9
-      - build-ruby-2_4_10

data/VERSION

@@ -1 +0,0 @@
-1.0.0