fractal_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff9de86ce971b3c40aefed88d6e77ca424eaafe40398464c48419846f4b5868b
+  data.tar.gz: f46953463f071c7c92c55ce7f0b2b2f41f1a03e5d1b73ea9cf01d0ffa3dd434a
+SHA512:
+  metadata.gz: daa456d15d21972278cb559ada7bfe98c9ef69039c54a99b42c66a28dba38ad866d79e953c2a9786cdbe4287a79050e5712149c5cc1bb791db9c3e8a013a99a7
+  data.tar.gz: 99a49eb766f98d98acdf9267a3f14f6d216625d6c6c33e1b9c129ef4f9ecc5255d5d148781ecef5e5e955e1bdf017b5934e9bf807d5895e56c120d955e24659f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.rspec_status

data/.rubocop.yml

@@ -0,0 +1,96 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  Exclude:
+    - 'db/**/*'
+    - 'ansible/**/*'
+    - 'vendor/**/*'
+    - 'bin/**/*'
+    - 'node_modules/**/*'
+
+# Don't force top level comments in every class
+Style/Documentation:
+  Enabled: false
+
+# A good line length is 100 chars, comments are ignored
+Layout/LineLength:
+  Max: 100
+  AllowURI: true
+  IgnoredPatterns: ['\A(\s+)?#']
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 30
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/RepeatedExample:
+  Exclude:
+    - 'spec/policies/**/*'
+
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/policies/**/*'
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+# TODO: we should rename our fields from line_1, address_line_2, etc
+Naming/VariableNumber:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 8

data/.ruby-gemset

@@ -0,0 +1 @@
+finpoint-app

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fractal_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    fractal_api (0.1.0)
+      faraday
+      faraday_middleware
+      faraday_middleware-multi_json
+      multi_json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    faraday_middleware-multi_json (0.0.6)
+      faraday_middleware
+      multi_json
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.4)
+    vcr (6.0.0)
+    webmock (3.12.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  dotenv
+  fractal_api!
+  pry
+  rake
+  rspec
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.2.11

data/README.md

@@ -0,0 +1,35 @@
+# FractalApi
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fractal_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fractal_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fractal_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fractal_api.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fractal_api'
+require 'json'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fractal_api.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fractal_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fractal_api'
+  spec.version       = FractalApi::VERSION
+  spec.authors       = ['Finpoint']
+  spec.email         = ['nenad@finpoint.co.uk']
+
+  spec.summary       = 'FractalApi client'
+  spec.description   = 'Client for FractalApi https://docs.askfractal.com'
+  spec.homepage      = 'https://www.finpoint.co.uk'
+
+  # 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.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'faraday_middleware-multi_json'
+  spec.add_dependency 'multi_json'
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

data/lib/fractal_api.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'fractal_api/version'
+require 'fractal_api/authenticate'
+require 'fractal_api/client'
+require 'fractal_api/configuration'
+require 'fractal_api/company'
+require 'fractal_api/bank'
+require 'fractal_api/consent'
+require 'fractal_api/bank_account'
+require 'fractal_api/balance'
+require 'fractal_api/transaction'
+
+module FractalApi
+  module_function
+
+  def configure
+    yield(configuration)
+  end
+
+  def client
+    @client ||= Client.new
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Sets global token for the duration of the block
+  # Token is set in Thread local variable,
+  # so it's usable in the current Thread only (sidekiq job, rails request, etc.)
+  #
+  # MUST not be nested in another +with_global_token+ block
+  def with_global_token
+    Thread.current[:fractal_api_token] = Authenticate.new.call(
+      configuration.api_key, configuration.partner_id
+    )
+
+    yield
+
+    Thread.current[:fractal_api_token] = nil
+  end
+
+  def global_token
+    Thread.current[:fractal_api_token]
+  end
+end

data/lib/fractal_api/authenticate.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'fractal_api/configuration'
+require 'fractal_api/errors'
+require 'fractal_api/version'
+
+module FractalApi
+  class Authenticate
+    def call(api_key, partner_id)
+      response = post(
+        '/token',
+        api_key: api_key,
+        partner_id: partner_id
+      )
+
+      if response.success?
+        response.body[:access_token]
+      elsif response.status == 403
+        raise UnauthorizedError, response.body
+      else
+        raise GenericError, response.body
+      end
+    end
+
+    private
+
+    def post(path, api_key:, partner_id:)
+      connection.post(path, nil, { 'X-Api-Key' => api_key, 'X-Partner-Id' => partner_id })
+    end
+
+    def connection
+      auth_url = FractalApi.configuration.auth_url
+
+      @connection ||= Faraday.new(url: auth_url) do |conn|
+        conn.headers.merge!(
+          content_type: 'application/json',
+          user_agent: "finpoint/#{FractalApi::VERSION}"
+        )
+        conn.response :multi_json, symbolize_keys: true
+        conn.response :logger if FractalApi.configuration.debug
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/fractal_api/balance.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'fractal_api/base_model'
+require 'fractal_api/paginator'
+
+module FractalApi
+  class Balance < BaseModel
+    attributes :id, :bank_id, :account_id, :date,
+               :amount, :currency, :type, :status,
+               :external_id, :source
+
+    def self.all(company_id, filters = {})
+      filters = filters.transform_keys { |key| key_transformer.transform(key) }
+
+      Paginator.new('/banking/v2/balances', self) do |url|
+        get(
+          url,
+          params: filters,
+          headers: { 'X-Company-Id' => company_id }
+        )
+      end
+    end
+
+    def self.build(json:)
+      super.tap do |record|
+        record.date = Time.parse(record.date) if record.date
+      end
+    end
+  end
+end

data/lib/fractal_api/bank.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'fractal_api/base_model'
+require 'fractal_api/paginator'
+
+module FractalApi
+  class Bank < BaseModel
+    attributes :id, :name, :logo, :logo_url
+
+    def self.all(filters = {})
+      Paginator.new('/banking/v2/banks', self) do |url|
+        get(url, params: filters)
+      end
+    end
+  end
+end

data/lib/fractal_api/bank_account.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'fractal_api/base_model'
+require 'fractal_api/bank_account_scheme'
+require 'fractal_api/paginator'
+
+module FractalApi
+  class BankAccount < BaseModel
+    attributes :id, :bank_id, :currency, :nickname,
+               :account, :external_id, :source
+
+    def self.all(company_id, filters = {})
+      filters = filters.transform_keys { |key| key_transformer.transform(key) }
+
+      Paginator.new('/banking/v2/accounts', self) do |url|
+        get(
+          url,
+          params: filters,
+          headers: { 'X-Company-Id' => company_id }
+        )
+      end
+    end
+
+    def self.build(json:)
+      super.tap do |record|
+        record.account = (record.account || []).compact.map do |acs|
+          BankAccountScheme.build(json: acs)
+        end
+      end
+    end
+  end
+end

data/lib/fractal_api/bank_account_scheme.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'fractal_api/base_model'
+
+module FractalApi
+  class BankAccountScheme < BaseModel
+    attributes :scheme_name, :name, :identification, :secondary_identification
+  end
+end

data/lib/fractal_api/base_model.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'fractal_api/errors'
+require 'fractal_api/camelizer_lower'
+
+module FractalApi
+  class BaseModel
+    class << self
+      def get(path, params: {}, headers: {})
+        result = FractalApi.client.get(path.strip, params: params, headers: headers)
+
+        raise APIKeyError, result.body[:error] if result.status == 401
+
+        result
+      end
+
+      def post(path, params: {}, headers: {})
+        result = FractalApi.client.post(path.strip, params: params, headers: headers)
+
+        raise APIKeyError, result.body[:error] if result.status == 401
+
+        result
+      end
+
+      def put(path, params: {}, headers: {})
+        result = FractalApi.client.put(path.strip, params: params, headers: headers)
+
+        raise APIKeyError, result.body[:error] if result.status == 401
+
+        result
+      end
+
+      def attributes(*attributes)
+        @attributes ||= []
+
+        return @attributes unless attributes
+
+        attr_accessor(*attributes)
+
+        @attributes += attributes
+      end
+
+      def attribute_aliases(aliases = nil)
+        @attribute_aliases ||= {}
+
+        return @attribute_aliases unless aliases
+
+        @attribute_aliases.merge!(aliases)
+      end
+
+      def format_url(url, params)
+        formatted = url.dup.strip
+
+        params.each { |key, value| formatted.sub!(":#{key}", value) }
+
+        formatted
+      end
+
+      def key_transformer
+        CamelizerLower
+      end
+
+      # Sets all the instance variables by reading the JSON from FractalApi and converting the keys from
+      # PascalCase to snake_case, as it's the standard in Ruby.
+      def build(json: {}, key_transformer: self.key_transformer)
+        new.tap do |record|
+          attributes.each do |attr|
+            key = attribute_aliases.key?(attr) ? attribute_aliases[attr] : attr
+            record.public_send("#{attr}=", json[key_transformer.transform(key)])
+          end
+        end
+      end
+    end
+
+    def initialize(attributes = {})
+      attributes.each do |attr, value|
+        public_send("#{attr}=", value)
+      end
+    end
+
+    def get(path, params: {}, headers: {})
+      self.class.get(path, params: params, headers: headers)
+    end
+
+    def post(path, params: {}, headers: {})
+      self.class.post(path, params: params, headers: headers)
+    end
+
+    def put(path, params: {}, headers: {})
+      self.class.put(path, params: params, headers: headers)
+    end
+
+    def format_url(url, params)
+      self.class.format_url(url, params)
+    end
+
+    def as_json
+      self.class.attributes.each_with_object({}) do |attr, hash|
+        value = public_send(attr)
+
+        value = value.as_json if value.respond_to?(:as_json)
+        if value.is_a?(Array)
+          value = value.map { |v| v.respond_to?(:as_json) ? v.as_json : v }
+        end
+        value = value.iso8601 if value.respond_to?(:iso8601)
+
+        key = self.class.key_transformer.transform(attr)
+
+        hash[key] = value
+      end
+    end
+  end
+end

data/lib/fractal_api/camelizer_lower.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FractalApi
+  class CamelizerLower
+    # Converts this_is_my_string to thisIsMyString and returns it as a symbol.
+    def self.transform(underscore_string)
+      parts = underscore_string.to_s.split('_')
+
+      rest = parts[1..-1].map(&:capitalize)
+
+      rest.unshift(parts[0]).join.to_sym
+    end
+  end
+end

data/lib/fractal_api/category.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'fractal_api/base_model'
+
+module FractalApi
+  class Category < BaseModel
+    attributes :id, :name, :details
+  end
+end

data/lib/fractal_api/client.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware/multi_json'
+require 'fractal_api/configuration'
+require 'fractal_api/faraday_auth'
+
+module FractalApi
+  class Client
+    def initialize
+      Faraday::Request.register_middleware fractal_api_auth: -> { FractalApi::FaradayAuth }
+    end
+
+    def get(path, params: {}, headers: {})
+      connection.get(path, params, headers).tap do |response|
+        handle_response(response)
+      end
+    end
+
+    def post(path, params: {}, headers: {})
+      connection.post(path, MultiJson.dump(params), headers).tap do |response|
+        handle_response(response)
+      end
+    end
+
+    def put(path, params: {}, headers: {})
+      connection.put(path, MultiJson.dump(params), headers).tap do |response|
+        handle_response(response)
+      end
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: api_url) do |conn|
+        conn.request :fractal_api_auth,
+                     FractalApi.configuration.api_key,
+                     FractalApi.configuration.partner_id
+        conn.response :multi_json, symbolize_keys: true
+        conn.response :logger if FractalApi.configuration.debug
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def api_url
+      FractalApi.configuration.base_url
+    end
+
+    def handle_response(response)
+      return if response.success?
+
+      case response.status
+      when 400
+        raise InvalidRequestError, response.body
+      when 401
+        raise APIKeyError, response.body
+      when 403
+        raise UnauthorizedError, response.body
+      else
+        raise GenericError, response.body
+      end
+    end
+  end
+end

data/lib/fractal_api/company.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'fractal_api/base_model'
+
+module FractalApi
+  class Company < BaseModel
+    attributes :id, :name, :description, :website, :industry,
+               :address, :external_id, :crn, :created_at
+
+    def self.create(company)
+      result = post('/company/v2/companies', params: company.as_json)
+
+      build(json: result.body)
+    end
+
+    def self.build(json:)
+      super.tap do |record|
+        record.created_at = Time.parse(record.created_at) if record.created_at
+      end
+    end
+  end
+end

data/lib/fractal_api/configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module FractalApi
+  class Configuration
+    BASE_URLS = {
+      production: '',
+      sandbox: 'https://apis.julia-laces.co.uk'
+    }.freeze
+    AUTH_URLS = {
+      production: '',
+      sandbox: 'https://auth.julia-laces.co.uk'
+    }.freeze
+
+    attr_accessor :api_key, :partner_id, :environment, :debug
+
+    def initialize
+      @api_key = ''
+      @partner_id = ''
+      @environment = :sandbox # can be either :sandbox or :production
+      @debug = false
+    end
+
+    def base_url
+      BASE_URLS[environment.to_sym]
+    end
+
+    def auth_url
+      AUTH_URLS[environment.to_sym]
+    end
+  end
+end

data/lib/fractal_api/consent.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'base64'
+require 'json'
+require 'fractal_api/base_model'
+
+module FractalApi
+  class Consent < BaseModel
+    attributes :consent_id, :company_id, :bank_id, :permission,
+               :date_created, :consent_type, :status, :type, :signin_url
+
+    def self.create(bank_id, company_id, redirect_url)
+      params = { redirect: redirect_url, permission: 'ReadAllBankData' }
+      url = format_url(
+        '/banking/v2/banks/:bank_id/consents',
+        bank_id: bank_id.to_s
+      )
+      result = post(url, params: params, headers: { 'X-Company-Id' => company_id })
+
+      build(json: result.body)
+    end
+
+    def self.build(json:)
+      super.tap do |record|
+        record.date_created = Time.parse(record.date_created) if record.date_created
+      end
+    end
+
+    def self.build_from_state(state)
+      decoded = JSON.parse(Base64.decode64(state), symbolize_names: true)
+
+      new(
+        consent_id: decoded[:accReq],
+        company_id: decoded[:cId],
+        bank_id: decoded[:bId]
+      )
+    rescue JSON::ParserError
+      nil
+    end
+
+    def update(code:, id_token:, state:)
+      url = format_url(
+        '/banking/v2/banks/:bank_id/consents/:consent_id',
+        bank_id: bank_id.to_s,
+        consent_id: consent_id
+      )
+
+      result = put(
+        url,
+        params: { code: code, id_token: id_token, state: state },
+        headers: { 'X-Company-Id' => company_id }
+      )
+
+      result.body
+    end
+  end
+end

data/lib/fractal_api/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module FractalApi
+  class APIKeyError < StandardError; end
+
+  class UnauthorizedError < StandardError; end
+
+  class GenericError < StandardError; end
+
+  class InvalidRequestError < StandardError; end
+end

data/lib/fractal_api/faraday_auth.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'fractal_api/authenticate'
+require 'fractal_api/version'
+require 'fractal_api/errors'
+
+module FractalApi
+  class FaradayAuth < Faraday::Middleware
+    def initialize(app, api_key, partner_id, options = {})
+      super(app)
+      @api_key = api_key
+      @partner_id = partner_id
+      @options = options
+    end
+
+    def call(env)
+      token = FractalApi.global_token || authenticate
+
+      env[:request_headers]['X-Api-Key'] = @api_key
+      env[:request_headers]['X-Partner-Id'] = @partner_id
+      env[:request_headers]['Authorization'] = "Bearer #{token}"
+      env[:request_headers]['Content-Type'] = 'application/json'
+      env[:request_headers]['User-Agent'] = "finpoint/#{FractalApi::VERSION}"
+
+      @app.call(env)
+    end
+
+    private
+
+    def authenticate
+      Authenticate.new.call(@api_key, @partner_id)
+    end
+  end
+end

data/lib/fractal_api/merchant.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'fractal_api/base_model'
+
+module FractalApi
+  class Merchant < BaseModel
+    attributes :id, :name, :category_code, :address_line, :details
+  end
+end

data/lib/fractal_api/paged_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module FractalApi
+  class PagedResponse
+    attr_accessor :results, :links, :result_class
+
+    def initialize(json:, result_class:)
+      @result_class = result_class
+
+      @links = json[:links] || {}
+      @results = json.fetch(:results, []).map do |result|
+        result_class.build(json: result)
+      end
+    end
+
+    def next_page_url
+      return unless links[:next]
+
+      links[:next]
+    end
+  end
+end

data/lib/fractal_api/paginator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'fractal_api/paged_response'
+
+module FractalApi
+  class Paginator
+    attr_reader :initial_url, :result_class
+
+    def initialize(initial_url, result_class, &block)
+      @initial_url = initial_url
+      @result_class = result_class
+      @next_page_block = block
+    end
+
+    def first_page
+      load_page(initial_url)
+    end
+
+    def each_page(&block)
+      response = first_page
+
+      loop do
+        block.call(response.results)
+
+        next_page_url = response.next_page_url
+
+        break unless next_page_url
+
+        response = load_page(next_page_url)
+      end
+    end
+
+    private
+
+    attr_reader :next_page_block
+
+    def load_page(url)
+      raw_response = next_page_block.call(url)
+
+      PagedResponse.new(
+        json: raw_response.body,
+        result_class: result_class
+      )
+    end
+  end
+end

data/lib/fractal_api/transaction.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'fractal_api/base_model'
+require 'fractal_api/category'
+require 'fractal_api/merchant'
+require 'fractal_api/paginator'
+
+module FractalApi
+  class Transaction < BaseModel
+    attributes :id, :bank_id, :account_id, :booking_date, :value_date,
+               :reference, :transaction_code, :transaction_sub_code,
+               :proprietary_code, :proprietary_sub_code, :description, :amount, :currency,
+               :type, :status, :merchant, :category, :external_id, :source
+
+    def self.all(company_id, filters = {})
+      filters = filters.transform_keys { |key| key_transformer.transform(key) }
+
+      Paginator.new('/banking/v2/transactions', self) do |url|
+        get(
+          url,
+          params: filters,
+          headers: { 'X-Company-Id' => company_id }
+        )
+      end
+    end
+
+    def self.build(json:)
+      super.tap do |record|
+        record.merchant = Merchant.build(json: (record.merchant || {}))
+        record.category = Category.build(json: (record.category || {}))
+        record.booking_date = Time.parse(record.booking_date) if record.booking_date
+        record.value_date = Time.parse(record.value_date) if record.value_date
+      end
+    end
+  end
+end

data/lib/fractal_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FractalApi
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: fractal_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Finpoint
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware-multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client for FractalApi https://docs.askfractal.com
+email:
+- nenad@finpoint.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fractal_api.gemspec
+- lib/fractal_api.rb
+- lib/fractal_api/authenticate.rb
+- lib/fractal_api/balance.rb
+- lib/fractal_api/bank.rb
+- lib/fractal_api/bank_account.rb
+- lib/fractal_api/bank_account_scheme.rb
+- lib/fractal_api/base_model.rb
+- lib/fractal_api/camelizer_lower.rb
+- lib/fractal_api/category.rb
+- lib/fractal_api/client.rb
+- lib/fractal_api/company.rb
+- lib/fractal_api/configuration.rb
+- lib/fractal_api/consent.rb
+- lib/fractal_api/errors.rb
+- lib/fractal_api/faraday_auth.rb
+- lib/fractal_api/merchant.rb
+- lib/fractal_api/paged_response.rb
+- lib/fractal_api/paginator.rb
+- lib/fractal_api/transaction.rb
+- lib/fractal_api/version.rb
+homepage: https://www.finpoint.co.uk
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.11
+signing_key:
+specification_version: 4
+summary: FractalApi client
+test_files: []