tikkie-api 0.1.0 → 2.0.0

data/lib/tikkie/api/resources/base.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module Resources
+      # Base class for all resources.
+      class Base
+        attr_reader :config, :options
+
+        def initialize(config, options = {})
+          @config = config
+          @options = options
+          @body = options.delete(:body) if options.key?(:body)
+        end
+
+        def load
+          @response ||= load_resource
+
+          self
+        end
+
+        def save(attributes = {})
+          @response = create_resource(attributes)
+
+          self
+        end
+
+        def delete
+          delete_resource
+
+          nil
+        end
+
+        def loaded?
+          !@response.nil?
+        end
+
+        private
+
+        def load_resource
+          raise NotImplementedError
+        end
+
+        def create_resource
+          raise NotImplementedError
+        end
+
+        def delete_resource
+          raise NotImplementedError
+        end
+
+        def body
+          @body ||= begin
+            load unless loaded?
+
+            @response.body
+          end
+        end
+
+        def request
+          @request ||= Tikkie::Api::Request.new(config)
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/{responses → resources}/error.rb

@@ -2,9 +2,15 @@
 
 module Tikkie
   module Api
-    module Responses
-      # Error response from Tikkie.
-      class Error < Base
+    module Resources
+      # Error object in non-successful responses.
+      class Error
+        attr_reader :data
+
+        def initialize(data)
+          @data = data
+        end
+
         def code
           data[:code]
         end
@@ -17,16 +23,12 @@ module Tikkie
           data[:reference]
         end
 
-        def trace_id
-          data[:traceId]
-        end
-
         def status
           data[:status]
         end
 
-        def category
-          data[:category]
+        def trace_id
+          data[:traceId]
         end
       end
     end

data/lib/tikkie/api/resources/list.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+
+module Tikkie
+  module Api
+    module Resources
+      # Base class for all list resources.
+      class List < Base
+        attr_reader :page_number, :page_size
+
+        def initialize(config, options = {})
+          @page_number = options.fetch(:page_number, 0)
+          @page_size = options.fetch(:page_size, 50)
+          super(config, options)
+        end
+
+        def total_elements
+          body[:totalElementCount].to_i
+        end
+
+        def total_pages
+          (total_elements / BigDecimal(page_size)).ceil
+        end
+
+        def next_page
+          page_number + 1 if next_page?
+        end
+
+        def next_page?
+          page_number && (page_number + 1) < total_pages
+        end
+
+        def previous_page
+          page_number - 1 if previous_page?
+        end
+
+        def previous_page?
+          page_number && page_number.positive?
+        end
+
+        def next
+          self.class.new(config, options.merge(page_number: next_page)) if next_page?
+        end
+
+        def previous
+          self.class.new(config, options.merge(page_number: previous_page)) if previous_page?
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/resources/payment.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Tikkie
+  module Api
+    module Resources
+      # Resource for a Payment.
+      class Payment < Base
+        attr_reader :payment_request_token
+
+        def initialize(config, options = {})
+          @payment_request_token = options.delete(:payment_request_token)
+          @payment_token = options.delete(:payment_token)
+          super(config, options)
+        end
+
+        def payment_token
+          @payment_token || body[:paymentToken]
+        end
+
+        def tikkie_id
+          body[:tikkieId]
+        end
+
+        def counter_party_name
+          body[:counterPartyName]
+        end
+
+        def counter_party_account_number
+          body[:counterPartyAccountNumber]
+        end
+
+        def amount
+          Tikkie::Api::Amount.from_cents(body[:amountInCents]).to_d
+        end
+
+        def description
+          body[:description]
+        end
+
+        def created_at
+          Time.parse(body[:createdDateTime]) if body[:createdDateTime]
+        end
+
+        def refunds
+          @refunds ||= begin
+            refunds = []
+
+            if body[:refunds]
+              body[:refunds].each do |refund|
+                refunds << Tikkie::Api::Resources::Refund.new(config, body: refund)
+              end
+            end
+
+            refunds
+          end
+        end
+
+        private
+
+        def load_resource
+          request.get("paymentrequests/#{payment_request_token}/payments/#{payment_token}", options)
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/resources/payment_request.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Tikkie
+  module Api
+    module Resources
+      # Resource for a Payment Request.
+      class PaymentRequest < Base
+        STATUS_OPEN = "OPEN"
+        STATUS_CLOSED = "CLOSED"
+        STATUS_EXPIRED = "EXPIRED"
+        STATUS_MAX_YIELDED_REACHED = "MAX_YIELD_REACHED"
+        STATUS_MAX_SUCCESSFUL_PAYMENTS_REACHED = "MAX_SUCCESSFUL_PAYMENTS_REACHED"
+
+        def initialize(config, options = {})
+          @payment_request_token = options.delete(:payment_request_token)
+          super(config, options)
+        end
+
+        def payment_request_token
+          @payment_request_token || body[:paymentRequestToken]
+        end
+
+        def url
+          body[:url]
+        end
+
+        def amount
+          Tikkie::Api::Amount.from_cents(body[:amountInCents]).to_d
+        end
+
+        def description
+          body[:description]
+        end
+
+        def reference_id
+          body[:referenceId]
+        end
+
+        def created_at
+          Time.parse(body[:createdDateTime]) if body[:createdDateTime]
+        end
+
+        def expiry_date
+          Date.parse(body[:expiryDate]) if body[:expiryDate]
+        end
+
+        def status
+          body[:status]
+        end
+
+        def open?
+          status == STATUS_OPEN
+        end
+
+        def closed?
+          status == STATUS_CLOSED
+        end
+
+        def expired?
+          status == STATUS_EXPIRED
+        end
+
+        def number_of_payments
+          body[:numberOfPayments]
+        end
+
+        def total_amount_paid
+          Tikkie::Api::Amount.from_cents(body[:totalAmountPaidInCents]).to_d
+        end
+
+        def payments
+          @payments ||= Tikkie::Api::Resources::Payments.new(config, payment_request_token: payment_request_token)
+        end
+
+        private
+
+        def load_resource
+          request.get("paymentrequests/#{payment_request_token}", options)
+        end
+
+        def create_resource(attributes)
+          params = { description: attributes.fetch(:description) }
+          if attributes.key?(:amount)
+            amount = Tikkie::Api::Amount.new(attributes[:amount])
+            params[:amountInCents] = amount.to_cents
+          end
+          params[:expiryDate] = attributes[:expiry_date].respond_to?(:strftime) ? attributes[:expiry_date].strftime("%F") : attributes[:expiry_date] if attributes.key?(:expiry_date)
+          params[:referenceId] = attributes[:reference_id] if attributes.key?(:reference_id)
+
+          request.post("paymentrequests", options, params)
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/resources/payment_requests.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module Resources
+      # Resource for Payment Requests.
+      class PaymentRequests < List
+        include Enumerable
+
+        def each(&block)
+          payment_requests.each(&block)
+        end
+
+        private
+
+        def load_resource
+          params = { pageNumber: page_number, pageSize: page_size }
+          params[:fromDate] = options[:from_date].respond_to?(:utc) ? options[:from_date].utc.iso8601 : options[:from_date] if options.key?(:from_date)
+          params[:toDate] = options[:to_date].respond_to?(:utc) ? options[:to_date].utc.iso8601 : options[:to_date] if options.key?(:to_date)
+
+          request.get("paymentrequests", params)
+        end
+
+        def payment_requests
+          @payment_requests ||= begin
+            payment_requests = []
+
+            if body[:paymentRequests]
+              body[:paymentRequests].each do |payment_request|
+                payment_requests << Tikkie::Api::Resources::PaymentRequest.new(config, body: payment_request)
+              end
+            end
+
+            payment_requests
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/resources/payment_requests_subscription.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module Resources
+      # Resource for a Payment Request Subscription.
+      class PaymentRequestsSubscription < Base
+        def subscription_id
+          body[:subscriptionId]
+        end
+
+        private
+
+        def create_resource(attributes)
+          request.post("paymentrequestssubscription", options, attributes)
+        end
+
+        def delete_resource
+          request.delete("paymentrequestssubscription", options)
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/resources/payments.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module Resources
+      # Resource for Payments.
+      class Payments < List
+        include Enumerable
+
+        attr_reader :payment_request_token
+
+        def initialize(config, options = {})
+          @payment_request_token = options.delete(:payment_request_token)
+          super(config, options)
+        end
+
+        def each(&block)
+          payments.each(&block)
+        end
+
+        private
+
+        def load_resource
+          params = { pageNumber: page_number, pageSize: page_size }
+          params[:fromDate] = options[:from_date].respond_to?(:utc) ? options[:from_date].utc.iso8601 : options[:from_date] if options.key?(:from_date)
+          params[:toDate] = options[:to_date].respond_to?(:utc) ? options[:to_date].utc.iso8601 : options[:to_date] if options.key?(:to_date)
+          params[:includeRefunds] = options[:include_refunds] if options.key?(:include_refunds)
+
+          request.get("paymentrequests/#{payment_request_token}/payments", params)
+        end
+
+        def payments
+          @payments ||= begin
+            payments = []
+
+            if body[:payments]
+              body[:payments].each do |payment|
+                payments << Tikkie::Api::Resources::Payment.new(config, body: payment)
+              end
+            end
+
+            payments
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/resources/refund.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Tikkie
+  module Api
+    module Resources
+      # Resource for a Refund.
+      class Refund < Base
+        STATUS_PENDING = "PENDING"
+        STATUS_PAID = "PAID"
+
+        attr_reader :payment_request_token, :payment_token
+
+        def initialize(config, options = {})
+          @payment_request_token = options.delete(:payment_request_token)
+          @payment_token = options.delete(:payment_token)
+          @refund_token = options.delete(:refund_token)
+          super(config, options)
+        end
+
+        def refund_token
+          @refund_token || body[:refundToken]
+        end
+
+        def amount
+          Tikkie::Api::Amount.from_cents(body[:amountInCents]).to_d
+        end
+
+        def description
+          body[:description]
+        end
+
+        def reference_id
+          body[:referenceId]
+        end
+
+        def created_at
+          Time.parse(body[:createdDateTime]) if body[:createdDateTime]
+        end
+
+        def status
+          body[:status]
+        end
+
+        def pending?
+          status == STATUS_PENDING
+        end
+
+        def paid?
+          status == STATUS_PAID
+        end
+
+        private
+
+        def load_resource
+          request.get("paymentrequests/#{payment_request_token}/payments/#{payment_token}/refunds/#{refund_token}", options)
+        end
+
+        def create_resource(attributes)
+          params = { description: attributes.fetch(:description) }
+          amount = Tikkie::Api::Amount.new(attributes.fetch(:amount))
+          params[:amountInCents] = amount.to_cents
+          params[:referenceId] = attributes[:reference_id] if attributes.key?(:reference_id)
+
+          request.post("paymentrequests/#{payment_request_token}/payments/#{payment_token}/refunds", options, params)
+        end
+      end
+    end
+  end
+end