tide-api 0.2.0

data/lib/tide/api/company.rb

@@ -0,0 +1,60 @@
+module Tide
+  module API
+    # A business company owned by the account holder
+    class Company < Dry::Struct::Value
+      # Tide's unique ID of the company.
+      #
+      # @return [Integer]
+      #
+      attribute :company_id, Types::Strict::Integer
+
+      # Registration number in Companies House.
+      #
+      # @return [String]
+      #
+      attribute :number, Types::Strict::String
+
+      # Legal name of the company.
+      #
+      # @return [Integer]
+      #
+      attribute :name, Types::Strict::String
+
+      # Trading name of the company.
+      #
+      # @return [Integer]
+      #
+      attribute :trading_name, Types::Strict::String
+
+      # SIC code.
+      #
+      # @return [Integer|nil]
+      #
+      attribute :sic_code, Types::Strict::Integer.optional
+
+      # VAT number.
+      #
+      # @return [String|nil]
+      #
+      attribute :vat_number, Types::Strict::String.optional
+
+      # Wether the company is registered or not? TODO
+      #
+      # @return [Boolean]
+      #
+      attribute :registered, Types::Strict::Bool
+
+      # Date when the company was created in Tide.
+      #
+      # @return [DateTime]
+      #
+      attribute :iso_created_on, Types::Params::DateTime
+
+      # Date when the company was was updated in Tide.
+      #
+      # @return [DateTime]
+      #
+      attribute :iso_updated_on, Types::Params::DateTime
+    end
+  end
+end

data/lib/tide/api/error.rb

@@ -0,0 +1,24 @@
+module Tide
+  module API
+    # An error resulting from an API call
+    class Error < Dry::Struct::Value
+      # A code that uniquely identifies the error
+      #
+      # @return [Integer]
+      #
+      attribute :code, Types::Strict::Integer
+
+      # A human readable description of the code
+      #
+      # @return [String]
+      #
+      attribute :message, Types::Strict::String
+
+      # A long description of the error. Unfortunately, it is null most of the time.
+      #
+      # @return [String|nil]
+      #
+      attribute :details, Types::Strict::String.optional
+    end
+  end
+end

data/lib/tide/api/http_client.rb

@@ -0,0 +1,42 @@
+require 'http'
+require 'tide/api/response'
+
+module Tide
+  module API
+    # Responsible for the HTTP interactions. The only entity aware of HTTP concerns such as status codes and headers.
+    #
+    # @api private
+    #
+    class HTTPClient
+      # An OAuth2 access token
+      attr_accessor :access_token
+
+      # An OAuth2 refresh token
+      attr_accessor :refresh_token
+
+      # Performs a GET request to Tide's API. Every request returns the status code 200.
+      #
+      # @example Retrieving a resource
+      #   client = HTTPClient.new
+      #   result = client.get('https://api.tide.co/tide-backend/rest/api/v1/oauth2/tokens')
+      #
+      # @param [String] endpoint URL of the API endpoint of the GET request
+      #
+      # @return [Response] Generic response of a request to Tide's API
+      #
+      def get(endpoint)
+        response = HTTP.headers(headers).get(endpoint)
+
+        Response.new(JSON.parse(response.body), response.status != 200)
+      end
+
+      private
+
+      def headers
+        return {} if access_token.nil?
+
+        { Authorization: "Bearer #{access_token}" }
+      end
+    end
+  end
+end

data/lib/tide/api/mapper.rb

@@ -0,0 +1,34 @@
+require 'tide/api/util'
+
+module Tide
+  module API
+    # Transforms arrays of hashes into concrete instances of classes.
+    #
+    # @api private
+    #
+    class Mapper
+      # Creates objects from an API response. The objects will be an instance of +object_class+.
+      #
+      # @param [Class] object_class Class of the final objects
+      # @param [Array<Hash>] items Array of attributes to instantiate the final objects
+      #
+      # @return An array of objects of the given class
+      #
+      def map(items, object_class)
+        items.map { |item| map_one(item, object_class) }
+      end
+
+      # Creates a single object from an API response. The object will be an instance of +object_class+.
+      #
+      # @param [Class] object_class Class of the final object
+      # @param [Hash] item Attributes to instantiate the final object
+      #
+      # @return An object of the given class
+      #
+      def map_one(item, object_class)
+        attributes = item.transform_keys { |attribute| Util.underscore(attribute) }
+        object_class.new(attributes)
+      end
+    end
+  end
+end

data/lib/tide/api/response.rb

@@ -0,0 +1,33 @@
+module Tide
+  module API
+    # Generic response of a request to Tide's API
+    #
+    # @api private
+    #
+    class Response
+      # Hash or array of hashes representing each item in the response body.
+      #
+      # @return [Hash|Array<Hash>]
+      #
+      attr_reader :payload
+
+      # Instantiates a new API response
+      #
+      # @param [Hash|Array<Hash>] payload Hash or array of hashes representing each item in the response body.
+      # @param [Boolean] error Whether the request failed
+      #
+      def initialize(payload, error)
+        @payload = payload
+        @error = error
+      end
+
+      # Whether the response contains errors
+      #
+      # @return [Boolean] true if the response has errors and false otherwise
+      #
+      def error?
+        @error
+      end
+    end
+  end
+end

data/lib/tide/api/tokens.rb

@@ -0,0 +1,18 @@
+module Tide
+  module API
+    # OAuth2 access and refresh tokens
+    class Tokens < Dry::Struct::Value
+      # OAuth2 Access Token
+      #
+      # @return [String]
+      #
+      attribute :access_token, Types::Strict::String
+
+      # OAuth2 Refresh Token
+      #
+      # @return [String]
+      #
+      attribute :refresh_token, Types::Strict::String
+    end
+  end
+end

data/lib/tide/api/transaction.rb

@@ -0,0 +1,127 @@
+module Tide
+  module API
+    # Bank account transaction
+    class Transaction < Dry::Struct::Value
+      # Categories of the transaction
+      CategoryType = Types::Strict::String.enum('EXPENDITURE', 'INCOME')
+
+      # Statuses of the transaction
+      Status = Types::Strict::String.enum('cleared', 'pending')
+
+      # Payment type codes
+      Type = Types::Strict::String.enum(
+        'PYI',     # Faster Payment In
+        'PYI_REV', # Faster Payment In Reversal
+        'PYO',	   # Faster Payment Out
+        'TRD',	   # Inter-Account Transfer Out
+        'TRC',	   # Inter-Account Transfer In
+        'RED',	   # Card Payment Out
+        'RED_REV', # Card Payment Reversal
+        'WTH',     # Cash Withdrawal
+        'WTH_REV', # Cash Withdrawal Reversal
+        'REF',     # Refund
+        'REF_REV', # Refund Reversal
+        'FEE',	   # Fee
+        'TOP',	   # Tide Credit
+        'TOP_REV'  # Tide Credit Reversal
+      )
+
+      # Tide's unique transaction ID.
+      #
+      # @return [Integer]
+      #
+      attribute :transaction_id, Types::Strict::Integer
+
+      # ID of the parent account.
+      #
+      # @return [Integer]
+      #
+      attribute :account_id, Types::Strict::Integer
+
+      # Transaction amount. Can be positive or negative.
+      #
+      # @return [BigDecimal]
+      #
+      attribute :amount, Types::Params::Decimal
+
+      # Transaction Type code.
+      #
+      # @see +Type+.
+      # @return [String]
+      #
+      attribute :type, Type
+
+      # Unique reference of the transaction.
+      #
+      # @return [String]
+      #
+      attribute :txn_ref, Types::Strict::String
+
+      # Time of the transaction.
+      #
+      # @return [DateTime]
+      #
+      attribute :iso_transaction_date_time, Types::Params::DateTime
+
+      # Time when the transaction was applied
+      #
+      # @return [DateTime]
+      #
+      attribute :iso_applied_date_time, Types::Params::DateTime
+
+      # Time when the transaction was cleared.
+      #
+      # @return [DateTime]
+      #
+      attribute :iso_cleared_date_time, Types::Params::DateTime
+
+      # Masked debit/credit card number.
+      #
+      # @return [String]
+      #
+      attribute :masked_pan, Types::Strict::String.optional
+
+      # TODO
+      #
+      # @return [String]
+      #
+      attribute :status, Status
+
+      # TODO
+      #
+      # @return [String]
+      #
+      attribute :description, Types::Strict::String
+
+      # TODO
+      #
+      # @return [DateTime]
+      #
+      attribute :iso_created_on, Types::Params::DateTime
+
+      # TODO
+      #
+      # @return [DateTime]
+      #
+      attribute :iso_updated_on, Types::Params::DateTime
+
+      # TODO
+      #
+      # @return [Integer]
+      #
+      attribute :category_id, Types::Strict::Integer
+
+      # TODO
+      #
+      # @return [String|String]
+      #
+      attribute :category_name, Types::Strict::String.optional
+
+      # TODO
+      #
+      # @return [String|nil]
+      #
+      attribute :category_type, CategoryType.optional
+    end
+  end
+end

data/lib/tide/api/types.rb

@@ -0,0 +1,14 @@
+require 'dry/types'
+require 'dry/struct'
+
+module Tide
+  module API
+    # Dry-types container.
+    #
+    # @api private
+    #
+    module Types
+      include Dry.Types
+    end
+  end
+end

data/lib/tide/api/util.rb

@@ -0,0 +1,41 @@
+module Tide
+  module API
+    # Provides methods for string manipulation
+    #
+    # @api private
+    #
+    module Util
+      module_function
+
+      # Converts a string to snake case
+      #
+      # @param [String|Symbol] term The term to be converted.
+      #
+      # @return [String] A snake-cased version of the input
+      #
+      def underscore(term)
+        term
+          .to_s
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
+          .to_sym
+      end
+
+      # Converts a string to camel case
+      #
+      # @param [String|Symbol] term The term to be converted.
+      #
+      # @return [String] A camel-cased version of the input
+      #
+      def camelize(term)
+        string = term.to_s
+        string = string.sub(/^[a-z\d]*/, &:capitalize)
+        string.gsub!(%r{(?:_|(\/))([a-z\d]*)}) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
+        string.gsub!('/'.freeze, '::'.freeze)
+        string
+      end
+    end
+  end
+end

data/lib/tide/api/version.rb

@@ -0,0 +1,5 @@
+module Tide
+  module API
+    VERSION = '0.2.0'.freeze
+  end
+end

data/lib/tide/api.rb

@@ -0,0 +1,10 @@
+require 'tide/api/version'
+require 'tide/api/types'
+require 'tide/api/client'
+
+# Encapsulates all the code of the gem in a meaningful namespace.
+module Tide
+  # Operations related to Tide's API.
+  module API
+  end
+end

data/tide-api.gemspec

@@ -0,0 +1,49 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tide/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tide-api'
+  spec.version       = Tide::API::VERSION
+  spec.authors       = ['Wilson Silva']
+  spec.email         = ['me@wilsonsilva.net']
+
+  spec.summary       = "Client for Tide's bank RESTful API"
+  spec.description   = "Client for Tide's bank RESTful API"
+  spec.homepage      = 'https://github.com/wilsonsilva/tide-api'
+  spec.license       = 'MIT'
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-struct', '~> 1.0'
+  spec.add_dependency 'http', '~> 4.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler-audit', '~> 0.6'
+  spec.add_development_dependency 'guard', '~> 2.15'
+  spec.add_development_dependency 'guard-bundler', '~> 2.2'
+  spec.add_development_dependency 'guard-bundler-audit', '~> 0.1'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.3'
+  spec.add_development_dependency 'overcommit', '~> 0.48'
+  spec.add_development_dependency 'pry', '~> 0.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.72'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.33'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'simplecov-console', '~> 0.5'
+  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 3.5'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'yard-junk', '~> 0.0.7'
+  spec.add_development_dependency 'yardstick', '~> 0.9'
+end