afterpay 0.1.0

data/lib/afterpay/components/courier.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module Components
+    class Courier < Base
+      # @attribute shipped_at
+      # @return [String]
+      # The time at which the order was shipped (ISO 8601 UTC/Zulu time).
+      attr_accessor :shipped_at
+
+      # @attribute name
+      # @return [String]
+      # The name of the courier.
+      attr_accessor :name
+
+      # @attribute tracking
+      # @return [String]
+      # The tracking number provided by the courier.
+      attr_accessor :tracking
+
+      # @attribute priority
+      # @return [String]
+      # The shipping priority. If provided, must be either 'STANDARD' or 'EXPRESS'.
+      attr_accessor :priority
+    end
+  end
+end

data/lib/afterpay/components/discount.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module Components
+    class Discount < Base
+      # @attribute display_name
+      # @return [String]
+      # A display name for the discount.
+      attr_accessor :display_name
+
+      # @attribute amount
+      # @return [Afterpay::Components::Money]
+      # The discount amount.
+      attr_accessor :amount
+    end
+  end
+end

data/lib/afterpay/components/item.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module Components
+    class Item < Base
+      # @attribute name
+      # @return [String]
+      # Product's name
+      attr_accessor :name
+
+      # @attribute sku
+      # @return [String]
+      # Product's SKU
+      attr_accessor :sku
+
+      # @attribute page_url
+      # @return [String]
+      # The canonical URL for the item's Product Detail Page. Limited to 2048 characters.
+      attr_accessor :page_url
+
+      # @attribute image_url
+      # @return [String]
+      # A URL for a web-optimised photo of the item, suitable for use directly as the src attribute of an img tag. Limited to 2048 characters.
+      attr_accessor :image_url
+
+      # @attribute quantity
+      # @return [Integer]
+      # The quantity of the item.
+      attr_accessor :quantity
+
+      # @attribute price
+      # @return [Afterpay::Components::Money]
+      # The unit price of the individual item. Must be a positive value.
+      attr_accessor :price
+
+      # @attribute categories
+      # @return [Array]
+      # An array of arrays to accommodate multiple categories that apply to the item.
+      # Each array represents a hierarchical path to a category, with the left-most category being the top-level parent category.
+      attr_accessor :categories
+
+      # @attribute estimated_shipment_date
+      # @return [String]
+      # The estimated date when the order will be shipped, in YYYY-MM or YYYY-MM-DD format
+      attr_accessor :estimated_shipment_date
+    end
+  end
+end

data/lib/afterpay/components/merchant.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module Components
+    class Merchant < Base
+      # @attribute redirect_confirm_url
+      # @return [String]
+      # The user is redirected to this URL on confirmation.
+      attr_accessor :redirect_confirm_url
+
+      # @attribute redirect_cancel_url
+      # @return [String]
+      # The user to redirected to this URL if the payment process is cancelled.
+      attr_accessor :redirect_cancel_url
+    end
+  end
+end

data/lib/afterpay/components/money.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module Components
+    class Money < Base
+      # @attribute amount
+      # @return [String]
+      # The amount should be a string representation of a decimal number, rounded to 2 decimal places.
+      attr_accessor :amount
+
+      # @attribute currency
+      # @return [String]
+      # The currency is a ISO 4217 format value. Currently only USD is supported.
+      attr_accessor :currency
+    end
+  end
+end

data/lib/afterpay/components/order.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module Components
+    class Order < Base
+      # @attribute amount
+      # @return [Afterpay::Components::Money]
+      # Total amount for order to be charged to consumer.
+      attr_accessor :amount
+
+      # @attribute consumer
+      # @return [Afterpay::Components::Consumer]
+      # The consumer requesting the order.
+      attr_accessor :consumer
+
+      # @attribute billing
+      # @return [Afterpay::Components::Contact]
+      # Billing address.
+      attr_accessor :billing
+
+      # @attribute shipping
+      # @return [Afterpay::Components::Contact]
+      # Shipping address.
+      attr_accessor :shipping
+
+      # @attribute courier
+      # @return [Afterpay::Components::Courier]
+      # Shipping Courier details.
+      attr_accessor :courier
+
+      # @attribute items
+      # @return [Array<Afterpay::Components::Item>]
+      # An array of order items.
+      attr_accessor :items
+
+      # @attribute discounts
+      # @return [Array<Afterpay::Components::Discount>]
+      # An array of discounts.
+      attr_accessor :discounts
+
+      # @attribute merchant
+      # @return [Afterpay::Components::Merchant]
+      # Merchant's redirection links..
+      attr_accessor :merchant
+
+      # @attribute payment_type
+      # @return [String]
+      # Supported payment types: 'PAY_BY_INSTALLMENT'. Default is 'PAY_BY_INSTALLMENT'.
+      attr_accessor :payment_type
+
+      # @attribute merchant_reference
+      # @return [String]
+      # The merchant's id / reference that this order corresponds to.
+      attr_accessor :merchant_reference
+
+      # @attribute tax_amount
+      # @return [Afterpay::Components::Money]
+      # The included tax amount after applying all discounts.
+      attr_accessor :tax_amount
+
+      # @attribute shipping_amount
+      # @return [Afterpay::Components::Money]
+      # The shipping amount.
+      attr_accessor :shipping_amount
+    end
+  end
+end

data/lib/afterpay/components/payment.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module Components
+    class Payment < Base
+      # @attribute token
+      # @return [String]
+      # The token returned in the order creation request.
+      attr_accessor :token
+
+      # @attribute merchant_reference
+      # @return [String]
+      # The merchant's order id / reference that this payment corresponds to
+      attr_accessor :merchant_reference
+
+      # @attribute amount
+      # @return [Afterpay::Components::Money]
+      # The refund amount.
+      attr_accessor :amount
+    end
+  end
+end

data/lib/afterpay/components/payment_event.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module Components
+    class PaymentEvent < Base
+      # @attribute created
+      # @return [String]
+      # The payment event creation time (ISO 8601 UTC/Zulu time).
+      attr_accessor :created
+
+      # @attribute type
+      # @return [String]
+      # The payment event type of {'AUTHORISE', 'CAPTURE', 'VOID'}
+      attr_accessor :type
+    end
+  end
+end

data/lib/afterpay/components/refund.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module Components
+    class Refund < Base
+      # @attribute request_id
+      # @return [String]
+      # A unique request ID, required for safe retries. It is recommended that the merchant generate a UUID for each
+      # unique refund.
+      attr_accessor :request_id
+
+      # @attribute merchant_reference
+      # @return [String]
+      # The merchant's refund id / reference that this refund corresponds to.
+      attr_accessor :merchant_reference
+
+      # @attribute refund_merchant_reference
+      # @return [String]
+      # A unique reference for the individual refund event. If provided, the value will appear in the daily settlement
+      # file as "Payment Event ID". Limited to 128 characters.
+      attr_accessor :refund_merchant_reference
+
+      # @attribute amount
+      # @return [Afterpay::Components::Money]
+      # The refund amount.
+      attr_accessor :amount
+    end
+  end
+end

data/lib/afterpay/error_handler.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'afterpay/errors'
+
+module Afterpay
+  module ErrorHandler
+    class << self
+      # Returns a response if request was successful, raises an error otherwise
+      # @param [Afterpay::HTTPService::Response] response
+      # @return [Afterpay::HTTPService::Response] if request was successful
+      def inspect(response)
+        return response if response.ok?
+
+        raise ERRORS[response.status], response_message(response)
+      end
+
+      def response_message(response)
+        response.body.is_a?(String) ? JSON.parse(response.body)['message'] : response.message
+      end
+
+      ERRORS = {
+        400 => BadRequestError,
+        401 => UnathorizedError,
+        402 => PaymentRequiredError,
+        404 => NotFoundError,
+        405 => MethodNotAllowedError,
+        406 => NotAcceptableError,
+        409 => ConflictError,
+        410 => GoneError,
+        412 => PreconditionFailedError,
+        422 => UnprocessableEntityError,
+        429 => TooManyRequestsError,
+        500 => InternalServerError,
+        503 => ServiceUnavailableError
+      }.freeze
+    end
+  end
+end

data/lib/afterpay/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Afterpay
+  class BaseError                 < StandardError; end
+
+  class BadRequestError           < BaseError;     end
+
+  class UnathorizedError          < BaseError;     end
+
+  class PaymentRequiredError      < BaseError;     end
+
+  class NotFoundError             < BaseError;     end
+
+  class MethodNotAllowedError     < BaseError;     end
+
+  class NotAcceptableError        < BaseError;     end
+
+  class ConflictError             < BaseError;     end
+
+  class GoneError                 < BaseError;     end
+
+  class PreconditionFailedError   < BaseError;     end
+
+  class UnprocessableEntityError  < BaseError;     end
+
+  class TooManyRequestsError      < BaseError;     end
+
+  class InternalServerError       < BaseError;     end
+
+  class ServiceUnavailableError   < BaseError;     end
+end

data/lib/afterpay/http_service/request.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Afterpay
+  module HTTPService
+    class Request
+      # @attribute middleware
+      # @return [Proc] A proc containing Faraday configuration
+      attr_reader :middleware
+
+      # @attribute server
+      # @return [String] an API endpoint
+      attr_reader :server
+
+      # Creates Afterpay::HTTPService::Request instance
+      # @param  [Hash] params hash of parameters
+      # @return [Afterpay::HTTPService::Request] Request instance
+      def initialize(params = {})
+        @middleware = params[:middleware]
+        @server     = params[:server]
+      end
+
+      # Performs an HTTP request to the specified endpoint with given body
+      # @param  [Hash] params hash of parameters.
+      # @return [Farday::Response] Faraday::Response instance
+      def perform(params = {})
+        adapter.send(*params.values_at(:action, :endpoint, :body))
+      end
+
+      private
+
+      # Creates memoized Faraday::Connection instance
+      # @return [Faraday::Connection] Faraday::Connection instance
+      def adapter
+        @adapter ||= Faraday.new(server, faraday_options, &middleware)
+      end
+
+      def faraday_options
+        return {} unless ::Afterpay.user_agent
+
+        { "headers" => { "User-Agent" => ::Afterpay.user_agent } }
+      end
+    end
+  end
+end

data/lib/afterpay/http_service/response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Afterpay
+  module HTTPService
+    class Response
+      extend Forwardable
+      # @attribute status
+      # @return [Integer] HTTP response status
+      attr_reader :status
+
+      # @attribute body
+      # @return [Hash] HTTP response body
+      attr_reader :body
+
+      # @attribute headers
+      # @return [Hash] HTTP response headers
+      attr_reader :headers
+
+      def_delegators :body, :message
+      # Creates Afterpay::HTTPService::Response instance
+      # @param  [Hash] params hash of parameters
+      # @return [Afterpay::HTTPService::Response] Response instance
+      def initialize(params = {})
+        @status  = params[:status]
+        @body    = params[:body]
+        @headers = params[:headers]
+      end
+
+      def ok?
+        (200..201).cover?(status.to_i)
+      end
+    end
+  end
+end

data/lib/afterpay/http_service.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module Afterpay
+  module HTTPService
+    class << self
+      # @return [Hash] default HTTPService configuration
+      def configuration
+        {
+          middleware: DEFAULT_MIDDLEWARE,
+          server: ::Afterpay.server
+        }
+      end
+    end
+
+    # Afterpay default middleware stack
+    DEFAULT_MIDDLEWARE = proc do |builder|
+      builder.request    :json
+
+      builder.basic_auth(*::Afterpay.configuration.values)
+
+      builder.response   :mashify
+      builder.response   :json, content_type: /\bjson$/
+
+      builder.adapter    Faraday.default_adapter
+    end
+  end
+end