tikkie-api 0.1.0 → 2.0.0

data/lib/tikkie/api/v1/requests/users.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module V1
+      module Requests
+        # Users operations at Tikkie.
+        class Users
+          def initialize(request)
+            @request = request
+          end
+
+          def list(platform_token)
+            response = @request.get("/tikkie/platforms/#{platform_token}/users")
+            Tikkie::Api::V1::Responses::Users.new(response)
+          end
+
+          def create(platform_token, options = {})
+            params = {
+              name: options.fetch(:name),
+              phoneNumber: options.fetch(:phone_number),
+              iban: options.fetch(:iban),
+              bankAccountLabel: options.fetch(:bank_account_label)
+            }
+            response = @request.post("/tikkie/platforms/#{platform_token}/users", params)
+
+            Tikkie::Api::V1::Responses::User.new(response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/bank_account.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Bank account of a user.
+        class BankAccount < Base
+          def bank_account_token
+            data[:bankAccountToken]
+          end
+
+          def bank_account_label
+            data[:bankAccountLabel]
+          end
+
+          def iban
+            data[:iban]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/base.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Base class for all responses.
+        class Base
+          attr_reader :response, :data
+
+          def initialize(response)
+            if response.respond_to?(:body)
+              @response = response
+              @data = parse_body(response.body)
+            else
+              @data = response
+            end
+          end
+
+          def response_code
+            response.code.to_i if response
+          end
+
+          def success?
+            (response_code == 200 || response_code == 201) && !@invalid
+          end
+
+          def error?
+            !success?
+          end
+
+          def trace_id
+            response["Trace-Id"] if response
+          end
+
+          def errors
+            @errors ||= begin
+              errors = []
+
+              if data[:errors]
+                data[:errors].each do |error|
+                  errors << Tikkie::Api::V1::Responses::Error.new(error)
+                end
+              end
+
+              errors
+            end
+          end
+
+          private
+
+          def parse_body(body)
+            body = body.respond_to?(:read) ? body.read : body
+
+            JSON.parse(body, symbolize_names: true)
+          rescue JSON::ParserError => ex
+            @invalid = true
+
+            {
+              message: "Unable to parse JSON: #{ex.message}"
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/error.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Error response from Tikkie.
+        class Error < Base
+          def code
+            data[:code]
+          end
+
+          def message
+            data[:message]
+          end
+
+          def reference
+            data[:reference]
+          end
+
+          def trace_id
+            data[:traceId]
+          end
+
+          def status
+            data[:status]
+          end
+
+          def category
+            data[:category]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/pagination.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Helper for paginated responses.
+        module Pagination
+          attr_accessor :offset, :limit, :elements, :total_elements
+
+          def more_elements?
+            @total_elements && @total_elements > @offset + @elements
+          end
+
+          def next_offset
+            @offset + @limit if more_elements?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/payment.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'time'
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Payment that is associated with a payment request.
+        class Payment < Base
+          def payment_token
+            data[:paymentToken]
+          end
+
+          def counter_party_name
+            data[:counterPartyName]
+          end
+
+          def amount
+            decimal = BigDecimal(data[:amountInCents])
+            decimal /= 100.0
+            decimal
+          end
+
+          def currency
+            data[:amountCurrency]
+          end
+
+          def description
+            data[:description]
+          end
+
+          def created_at
+            Time.parse(data[:created]) if data[:created]
+          end
+
+          # See PaymentStatus
+          def online_payment_status
+            data[:onlinePaymentStatus]
+          end
+
+          def paid?
+            online_payment_status == Tikkie::Api::V1::Types::PaymentStatus::PAID
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/payment_request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'time'
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Response for a payment request.
+        class PaymentRequest < Base
+          def payment_request_token
+            data[:paymentRequestToken]
+          end
+
+          def amount
+            decimal = BigDecimal(data[:amountInCents])
+            decimal /= 100.0
+            decimal
+          end
+
+          def currency
+            data[:currency]
+          end
+
+          def created_at
+            Time.parse(data[:created]) if data[:created]
+          end
+
+          def expired_at
+            Time.parse(data[:expired]) if data[:expired]
+          end
+
+          # see PaymentRequestStatus
+          def status
+            data[:status]
+          end
+
+          def expired?
+            status == Tikkie::Api::V1::Types::PaymentRequestStatus::EXPIRED
+          end
+
+          def bank_account_yielded_too_fast?
+            data[:bankAccountYieldedTooFast]
+          end
+
+          def external_id
+            data[:externalId]
+          end
+
+          def payments
+            @payments ||= begin
+              payments = []
+
+              if data[:payments]
+                data[:payments].each do |data|
+                  payments << Tikkie::Api::V1::Responses::Payment.new(data)
+                end
+              end
+
+              payments
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/payment_request_created.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Response when creating a payment request.
+        class PaymentRequestCreated < Base
+          def payment_request_url
+            data[:paymentRequestUrl]
+          end
+
+          def payment_request_token
+            data[:paymentRequestToken]
+          end
+
+          def external_id
+            data[:externalId]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/payment_requests.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Response when requesting payment requests (list).
+        class PaymentRequests < Base
+          include Enumerable
+          include Tikkie::Api::V1::Responses::Pagination
+
+          def initialize(response, options = {})
+            super(response)
+
+            @offset = options[:offset]
+            @limit = options[:limit]
+            @total_elements = data[:totalElements]
+            @elements = payment_requests.count
+          end
+
+          def each(&block)
+            payment_requests.each(&block)
+          end
+
+          private
+
+          def payment_requests
+            @payment_requests ||= begin
+              payment_requests = []
+
+              if data[:paymentRequests]
+                data[:paymentRequests].each do |payment_request|
+                  payment_requests << Tikkie::Api::V1::Responses::PaymentRequest.new(payment_request)
+                end
+              end
+
+              payment_requests
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/platform.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Response when requesting a platform.
+        class Platform < Base
+          def platform_token
+            data[:platformToken]
+          end
+
+          def name
+            data[:name]
+          end
+
+          def phone_number
+            data[:phoneNumber]
+          end
+
+          def email
+            data[:email]
+          end
+
+          def notification_url
+            data[:notificationUrl]
+          end
+
+          # see PlatformStatus
+          def status
+            data[:status]
+          end
+
+          def active?
+            status == Tikkie::Api::V1::Types::PlatformStatus::ACTIVE
+          end
+
+          # see PlatformUsage
+          def platform_usage
+            data[:platformUsage]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tikkie/api/v1/responses/platforms.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Tikkie
+  module Api
+    module V1
+      module Responses
+        # Response when requesting platforms (list).
+        class Platforms < Base
+          include Enumerable
+
+          def each(&block)
+            platforms.each(&block)
+          end
+
+          private
+
+          def platforms
+            @platforms ||= begin
+              platforms = []
+
+              unless error?
+                data.each do |platform|
+                  platforms << Tikkie::Api::V1::Responses::Platform.new(platform)
+                end
+              end
+
+              platforms
+            end
+          end
+        end
+      end
+    end
+  end
+end