paypro 1.0.0 → 2.0.0

data/lib/pay_pro/api_client.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module PayPro
+  class ApiClient
+    def initialize(config)
+      @config = config
+    end
+
+    # rubocop:disable Metrics/ParameterLists
+    def request(method:, uri:, params: {}, headers: {}, body: nil, options: {})
+      options = merge_options(options)
+
+      check_api_key!(options)
+
+      response = connection(options).public_send(method, uri) do |req|
+        req.params = params
+        req.headers = headers.merge(request_headers(options[:api_key]))
+        req.body = body
+      end
+
+      default_params = {
+        http_status: response.status,
+        http_body: response.body,
+        http_headers: response.headers
+      }
+
+      if response.status >= 400
+        handle_error_response(response, **default_params)
+      else
+        handle_response(response, **default_params)
+      end
+    rescue Faraday::ConnectionFailed, Faraday::TimeoutError
+      raise PayPro::ConnectionError.new(
+        message: 'Failed to make a connection to the PayPro API. ' \
+                 'This could indicate a DNS issue or because you have no internet connection.'
+      )
+    rescue Faraday::SSLError
+      raise PayPro::ConnectionError.new(
+        message: 'Failed to create a secure connection with the PayPro API. ' \
+                 'Please check your OpenSSL version supports TLS 1.2+.'
+      )
+    rescue Faraday::Error => e
+      raise PayPro::Error.new(message: "Failed to connect to the PayPro API. Message: #{e.message}")
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    private
+
+    def check_api_key!(options)
+      return unless options[:api_key].nil?
+
+      raise AuthenticationError.new(
+        message: 'API key not set. ' \
+                 'Make sure to set the API key with "PayPro.api_key = <API_KEY>". ' \
+                 'You can find your API key in the PayPro dashboard at "https://app.paypro.nl/developers/api-keys".'
+      )
+    end
+
+    def handle_response(response, **default_params)
+      PayPro::Response.from_response(response)
+    rescue JSON::ParserError
+      raise PayPro::Error.new(
+        message: 'Invalid response from API. ' \
+                 'The JSON returned in the body is not valid.',
+        **default_params
+      )
+    end
+
+    def handle_error_response(response, **default_params)
+      pay_pro_response = PayPro::Response.from_response(response)
+
+      case pay_pro_response.status
+      when 401
+        raise AuthenticationError.new(
+          message: 'Invalid API key supplied. ' \
+                   'Make sure to set a correct API key without any whitespace around it. ' \
+                   'You can find your API key in the PayPro dashboard at "https://app.paypro.nl/developers/api-keys".',
+          **default_params
+        )
+      when 404
+        raise ResourceNotFoundError.new(message: 'Resource not found', **default_params)
+      when 422
+        raise ValidationError.new(
+          param: pay_pro_response.data['error']['param'],
+          message: pay_pro_response.data['error']['message'],
+          code: pay_pro_response.data['error']['type'],
+          **default_params
+        )
+      end
+    rescue JSON::ParserError
+      raise PayPro::Error.new(
+        message: 'Invalid response from API. ' \
+                 'The JSON returned in the body is not valid.',
+        **default_params
+      )
+    end
+
+    def request_headers(api_key)
+      {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{api_key}",
+        'User-Agent' => user_agent
+      }
+    end
+
+    def user_agent
+      @user_agent ||= "PayPro #{PayPro::VERSION} / Ruby #{RUBY_VERSION} / OpenSSL #{OpenSSL::VERSION}"
+    end
+
+    def connection(options)
+      Faraday.new(
+        request: {
+          open_timeout: @config.timeout,
+          timeout: @config.timeout
+        },
+        ssl: {
+          ca_path: @config.ca_bundle_path,
+          verify: @config.verify_ssl
+        },
+        url: options[:api_url]
+      )
+    end
+
+    def merge_options(options)
+      {
+        api_key: options[:api_key] || @config.api_key,
+        api_url: options[:api_url] || @config.api_url
+      }
+    end
+  end
+end

data/lib/pay_pro/client.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Client
+    attr_accessor :config
+
+    attr_reader :chargebacks,
+                :customers,
+                :events,
+                :installment_plan_periods,
+                :installment_plans,
+                :mandates,
+                :pay_methods,
+                :payments,
+                :refunds,
+                :subscription_periods,
+                :subscriptions,
+                :webhooks
+
+    def initialize(config = {})
+      @config = case config
+                when Hash
+                  PayPro.config.merge(config)
+                when String
+                  PayPro.config.merge(api_key: config)
+                when PayPro::Config
+                  config
+                else
+                  raise ConfigurationError.new(message: "Invalid argument: #{config}")
+                end
+
+      check_api_key!
+      setup_endpoints
+    end
+
+    private
+
+    def check_api_key!
+      return unless @config.api_key.nil? || @config.api_key == ''
+
+      raise ConfigurationError.new(
+        message: 'API key not set or given. ' \
+                 'Make sure to pass an API key or set a default with "PayPro.api_key=". ' \
+                 'You can find your API key in the PayPro dashboard at "https://app.paypro.nl/developers/api-keys".'
+      )
+    end
+
+    def setup_endpoints
+      @chargebacks = Endpoints::Chargebacks.new(api_client: api_client)
+      @customers = Endpoints::Customers.new(api_client: api_client)
+      @events = Endpoints::Events.new(api_client: api_client)
+      @installment_plan_periods = Endpoints::InstallmentPlanPeriods.new(api_client: api_client)
+      @installment_plans = Endpoints::InstallmentPlans.new(api_client: api_client)
+      @mandates = Endpoints::Mandates.new(api_client: api_client)
+      @pay_methods = Endpoints::PayMethods.new(api_client: api_client)
+      @payments = Endpoints::Payments.new(api_client: api_client)
+      @refunds = Endpoints::Refunds.new(api_client: api_client)
+      @subscription_periods = Endpoints::SubscriptionPeriods.new(api_client: api_client)
+      @subscriptions = Endpoints::Subscriptions.new(api_client: api_client)
+      @webhooks = Endpoints::Webhooks.new(api_client: api_client)
+    end
+
+    def api_client
+      @api_client ||= ApiClient.new(@config)
+    end
+  end
+end

data/lib/pay_pro/config.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module PayPro
+  # Config saves the configuration options
+  class Config
+    DEFAULT_CA_BUNDLE_PATH = File.join(__dir__, 'data/cacert.pem')
+    DEFAULT_TIMEOUT = 30
+    DEFAULT_VERIFY_SSL = true
+
+    ATTRIBUTES = %i[api_key api_url ca_bundle_path timeout verify_ssl].freeze
+
+    attr_accessor(*ATTRIBUTES)
+
+    def initialize
+      @api_key = nil
+      @api_url = API_URL
+      @ca_bundle_path = DEFAULT_CA_BUNDLE_PATH
+      @timeout = DEFAULT_TIMEOUT
+      @verify_ssl = DEFAULT_VERIFY_SSL
+    end
+
+    def merge(hash)
+      dup.tap do |instance|
+        hash.slice(*ATTRIBUTES).each do |key, value|
+          instance.public_send("#{key}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoint.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Endpoint
+    include PayPro::Operations::Requestable
+
+    attr_reader :api_client
+
+    def initialize(api_client:)
+      @api_client = api_client
+    end
+
+    private
+
+    def resource_url
+      "/#{resource_path}"
+    end
+  end
+end

data/lib/pay_pro/endpoints/chargebacks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class Chargebacks < Endpoint
+      include PayPro::Operations::Getable
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'chargebacks'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/customers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class Customers < Endpoint
+      include PayPro::Operations::Creatable
+      include PayPro::Operations::Getable
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'customers'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/events.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class Events < Endpoint
+      include PayPro::Operations::Getable
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'events'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/installment_plan_periods.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class InstallmentPlanPeriods < Endpoint
+      include PayPro::Operations::Getable
+
+      def resource_path
+        'installment_plan_periods'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/installment_plans.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class InstallmentPlans < Endpoint
+      include PayPro::Operations::Creatable
+      include PayPro::Operations::Getable
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'installment_plans'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/mandates.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class Mandates < Endpoint
+      include PayPro::Operations::Creatable
+      include PayPro::Operations::Getable
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'mandates'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/pay_methods.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class PayMethods < Endpoint
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'pay_methods'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/payments.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class Payments < Endpoint
+      include PayPro::Operations::Creatable
+      include PayPro::Operations::Getable
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'payments'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/refunds.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class Refunds < Endpoint
+      include PayPro::Operations::Getable
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'refunds'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/subscription_periods.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class SubscriptionPeriods < Endpoint
+      include PayPro::Operations::Getable
+
+      def resource_path
+        'subscription_periods'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/subscriptions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class Subscriptions < Endpoint
+      include PayPro::Operations::Creatable
+      include PayPro::Operations::Getable
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'subscriptions'
+      end
+    end
+  end
+end

data/lib/pay_pro/endpoints/webhooks.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PayPro
+  module Endpoints
+    class Webhooks < Endpoint
+      include PayPro::Operations::Creatable
+      include PayPro::Operations::Getable
+      include PayPro::Operations::Listable
+
+      def resource_path
+        'webhooks'
+      end
+    end
+  end
+end

data/lib/pay_pro/entities/chargeback.rb

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

data/lib/pay_pro/entities/customer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Customer < Resource
+    include PayPro::Operations::Deletable
+    include PayPro::Operations::Updatable
+
+    RESOURCE_PATH = 'customers'
+  end
+end

data/lib/pay_pro/entities/entity.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Entity
+    attr_reader :api_client
+
+    def self.create_from_data(data, api_client:)
+      attributes = Util.normalize_api_attributes(data)
+      new(attributes: attributes, api_client: api_client)
+    end
+
+    private_class_method :new
+
+    def initialize(api_client:, attributes: {})
+      @api_client = api_client
+      @attributes = attributes
+
+      generate_accessors(attributes)
+    end
+
+    def inspect
+      "#<#{self.class}> #{JSON.pretty_generate(@attributes)}"
+    end
+
+    private
+
+    def generate_accessors(attributes)
+      attributes.each do |name, value|
+        self.class.instance_eval do
+          define_method(name) { instance_variable_get("@#{name}") }
+
+          define_method("#{name}=") do |v|
+            instance_variable_set("@#{name}", v)
+          end
+        end
+
+        send("#{name}=", Util.to_entity(value, api_client: api_client))
+      end
+    end
+  end
+end

data/lib/pay_pro/entities/event.rb

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

data/lib/pay_pro/entities/installment_plan.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PayPro
+  class InstallmentPlan < Resource
+    include PayPro::Operations::Updatable
+
+    RESOURCE_PATH = 'installment_plans'
+
+    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 installment_plan_periods(**options)
+      api_request(
+        method: 'get',
+        uri: "#{resource_url}/installment_plan_periods",
+        options: options
+      )
+    end
+  end
+end

data/lib/pay_pro/entities/installment_plan_period.rb

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

data/lib/pay_pro/entities/list.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module PayPro
+  class List < Entity
+    include Enumerable
+
+    attr_accessor :filters
+
+    def [](key)
+      data[key]
+    end
+
+    def each(&block)
+      data.each(&block)
+    end
+
+    def next(params: {})
+      return List.create_from_data({ data: [] }, api_client: api_client) if next_link.nil?
+
+      params = filters.merge(params).merge(cursor: next_id)
+
+      response = api_client.request(method: 'get', uri: next_uri.path, params: params)
+      Util.to_entity(response.data, api_client: api_client)
+    end
+
+    def previous(params: {})
+      return List.create_from_data({ data: [] }, api_client: api_client) if previous_link.nil?
+
+      params = filters.merge(params).merge(cursor: previous_id)
+
+      response = api_client.request(method: 'get', uri: previous_uri.path, params: params)
+      Util.to_entity(response.data, api_client: api_client)
+    end
+
+    def empty?
+      data.empty?
+    end
+
+    private
+
+    def next_id
+      CGI.parse(next_uri.query)['cursor'].first
+    end
+
+    def next_uri
+      @next_uri ||= URI.parse(next_link)
+    end
+
+    def next_link
+      links['next']
+    end
+
+    def previous_id
+      CGI.parse(previous_uri.query)['cursor'].first
+    end
+
+    def previous_uri
+      @previous_uri ||= URI.parse(previous_link)
+    end
+
+    def previous_link
+      @previous_link ||= links['prev']
+    end
+  end
+end

data/lib/pay_pro/entities/mandate.rb

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

data/lib/pay_pro/entities/pay_method.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PayPro
+  class PayMethod < Entity
+  end
+end

data/lib/pay_pro/entities/payment.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Payment < Resource
+    RESOURCE_PATH = 'payments'
+
+    def cancel(**options)
+      api_request(method: 'delete', uri: resource_url, options: options)
+    end
+
+    def refund(body = {}, **options)
+      api_request(method: 'post', uri: "#{resource_url}/refunds", body: body.to_json, options: options)
+    end
+
+    def refunds(params = {}, **options)
+      api_request(method: 'get', uri: "#{resource_url}/refunds", params: params, options: options)
+    end
+
+    def chargebacks(params = {}, **options)
+      api_request(method: 'get', uri: "#{resource_url}/chargebacks", params: params, options: options)
+    end
+  end
+end

data/lib/pay_pro/entities/refund.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Refund < Resource
+    RESOURCE_PATH = 'refunds'
+
+    def cancel(**options)
+      api_request(method: 'delete', uri: resource_url, options: options)
+    end
+  end
+end

data/lib/pay_pro/entities/resource.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PayPro
+  class Resource < Entity
+    include PayPro::Operations::Requestable
+
+    private
+
+    def resource_url
+      "/#{self.class::RESOURCE_PATH}/#{CGI.escape(id)}"
+    end
+  end
+end