tide-api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ec2c251ba56f87e5ccbc4d970ec642f52ca04d98fcb739da167baa200c9436b
+  data.tar.gz: 1690057695f361604045fcc386bc2538a85add4f2d0db8549d6650a5d93d212d
+SHA512:
+  metadata.gz: f47db1720338256d0b8c9019aca314e2f18b72d97360b9ca6c1af6114983bbeccefb53c3153984371712026691287b3fc0dce657e02a6d89da490a492e04863b
+  data.tar.gz: a79c51198faa008060a14385a6934cb5542d73c402e06f3fe6736301ca91bd4aa864a274ce657ef168748e3978d7cb72be40b3a237b9d6e3101c6fbed93d6061

data/.editorconfig

@@ -0,0 +1,11 @@
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true
+
+# 2 space indentation
+[*.rb]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/measurements/
+
+# rspec failure tracking
+.rspec_status
+
+# Let Bundler resolve the dependency versions using the gemspec only
+Gemfile.lock

data/.overcommit.yml

@@ -0,0 +1,33 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+
+# ---------------------- Layout ----------------------
+
+Layout/ExtraSpacing:
+  Exclude:
+    - lib/tide/api/transaction.rb
+
+# ---------------------- Metrics ----------------------
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+    - tide-api.gemspec
+
+Metrics/LineLength:
+  Max: 120
+
+# ----------------------- RSpec -----------------------
+
+RSpec/ExampleLength:
+  Enabled: false
+
+# ----------------------- Style -----------------------
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.3

data/.travis.yml

@@ -0,0 +1,22 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+
+before_install: gem install bundler -v 1.17.2
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - bundle exec bundle-audit
+  - bundle exec rspec
+  - bundle exec rubocop
+  - bundle exec rake yard:junk
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/.yardopts

@@ -0,0 +1 @@
+--plugin junk

data/.yardstick.yml

@@ -0,0 +1,29 @@
+threshold: 100
+rules:
+  ApiTag::Presence:
+    enabled: false
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: false
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: true
+    exclude: []
+  ExampleTag:
+    enabled: false
+    exclude:
+  ReturnTag:
+    enabled: false
+  Summary::Presence:
+    enabled: false
+  Summary::Length:
+    enabled: false
+  Summary::Delimiter:
+    enabled: false
+    exclude: []
+  Summary::SingleLine:
+    enabled: false
+    exclude: []

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2019-06-30
+### Added
+- Initial core business logic
+
+## [0.1.0] - 2019-05-26
+### Added
+- Codebase maintenance tools

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wilson.dsigns@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,20 @@
+guard :bundler do
+  watch('tide-api.gemspec')
+end
+
+guard :bundler_audit, run_on_start: true do
+  watch('Gemfile.lock')
+end
+
+group :tests do
+  guard :rspec, all_on_start: true, cmd: 'COVERAGE=false bundle exec rspec --format progress' do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Wilson Silva
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# Tide::API
+
+[![Gem Version](https://badge.fury.io/rb/tide-api.svg)](https://badge.fury.io/rb/tide-api)
+[![Build Status](https://travis-ci.org/wilsonsilva/tide-api.svg?branch=master)](https://travis-ci.org/wilsonsilva/tide-api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/15feb9e5e8d4faeb9921/maintainability)](https://codeclimate.com/github/wilsonsilva/tide-api/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/15feb9e5e8d4faeb9921/test_coverage)](https://codeclimate.com/github/wilsonsilva/tide-api/test_coverage)
+[![Security](https://hakiri.io/github/wilsonsilva/tide-api/master.svg)](https://hakiri.io/github/wilsonsilva/tide-api/master)
+[![Inline docs](http://inch-ci.org/github/wilsonsilva/tide-api.svg?branch=master)](http://inch-ci.org/github/wilsonsilva/tide-api)
+
+Ruby interface to Tide's bank RESTful API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tide-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tide-api
+
+## Usage
+
+Tide uses `Access Tokens` to allow access to the API via OAuth 2. You can find more about authentication on 
+[the official API reference](https://tideapi.github.io/docs/#authentication).
+
+Follow the documentation until you have an `Authorization Grant Code`. I'm developing a command-line utility to
+automate the authentication process.
+
+```ruby
+require 'tide/api'
+
+client = Tide::API::Client.new
+
+# Authentication
+auth_grant_code = 'CBCAzT2L6A5oFZyE78R2TtYYtaJ60er0' 
+tokens = client.fetch_tokens(auth_grant_code)
+
+# Fetching companies
+companies = client.fetch_companies
+
+# Fetch accounts
+accounts = client.fetch_accounts(companies.first.id)
+
+# Fetch transactions 
+transactions = client.fetch_transactions(accounts.first.id)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies, configure git hooks and create support files.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+The health and maintainability of the codebase is ensured through a set of
+Rake tasks to test, lint and audit the gem for security vulnerabilities and documentation:
+
+```
+rake bundle:audit          # Checks for vulnerable versions of gems 
+rake qa                    # Test, lint and perform security and documentation audits
+rake rubocop               # Lint the codebase with RuboCop
+rake rubocop:auto_correct  # Auto-correct RuboCop offenses
+rake spec                  # Run RSpec code examples
+rake verify_measurements   # Verify that yardstick coverage is at least 100%
+rake yard                  # Generate YARD Documentation
+rake yard:junk             # Check the junk in your YARD Documentation
+rake yardstick_measure     # Measure docs in lib/**/*.rb with yardstick
+```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wilsonsilva/tide-api.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tide::API project’s codebases, issue trackers, chat rooms and mailing lists
+is expected to follow the [code of conduct](https://github.com/wilsonsilva/tide-api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,37 @@
+require 'bundler/gem_tasks'
+require 'bundler/audit/task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yaml'
+require 'yard/rake/yardoc_task'
+require 'yard-junk/rake'
+require 'yardstick/rake/measurement'
+require 'yardstick/rake/verify'
+
+yardstick_options = YAML.load_file('.yardstick.yml')
+
+Bundler::Audit::Task.new
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+YARD::Rake::YardocTask.new
+YardJunk::Rake.define_task
+Yardstick::Rake::Measurement.new(:yardstick_measure, yardstick_options)
+Yardstick::Rake::Verify.new
+
+task default: :spec
+
+# Remove the report on rake clobber
+CLEAN.include('measurements', 'doc', '.yardoc', 'tmp')
+
+# Delete these files and folders when running rake clobber.
+CLOBBER.include('coverage', '.rspec_status')
+
+desc 'Run spec with coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+  `open coverage/index.html`
+end
+
+desc 'Test, lint and perform security and documentation audits'
+task qa: %w[spec rubocop yard:junk verify_measurements bundle:audit]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tide/api'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+if ! which overcommit >/dev/null; then
+  echo 'The gem overcommit is not installed. It is necessary to lint the git history through git hooks.'
+  echo 'Please install overcommit and run this script again.'
+  exit 1
+fi
+
+overcommit --install

data/lib/tide/api/account.rb

@@ -0,0 +1,66 @@
+module Tide
+  module API
+    # A bank account
+    class Account < Dry::Struct::Value
+      # Tide's unique account ID.
+      #
+      # @return [Integer]
+      #
+      attribute :account_id, Types::Strict::Integer
+
+      # Tide's unique company ID.
+      #
+      # @return [Integer]
+      #
+      attribute :company_id, Types::Strict::Integer
+
+      # The company's bank account number.
+      #
+      # @return [String]
+      #
+      attribute :account_number, Types::Strict::String
+
+      # Account type.
+      #
+      # @return [String]
+      #
+      attribute :name, Types::Strict::String
+
+      # Account balance.
+      #
+      # @return [BigDecimal]
+      #
+      attribute :balance, Types::Params::Decimal
+
+      # Available account balance.
+      #
+      # @return [BigDecimal]
+      #
+      attribute :available_balance, Types::Params::Decimal
+
+      # ISO 4217 currency code.
+      #
+      # @return [String]
+      #
+      attribute :currency_code, Types::Strict::String
+
+      # Sort code of the bank account.
+      #
+      # @return [String]
+      #
+      attribute :sort_code, Types::Strict::String
+
+      # Date of creation of the account.
+      #
+      # @return [DateTime]
+      #
+      attribute :iso_created_on, Types::Params::DateTime
+
+      # Date when the account was last updated.
+      #
+      # @return [DateTime]
+      #
+      attribute :iso_updated_on, Types::Params::DateTime
+    end
+  end
+end

data/lib/tide/api/client.rb

@@ -0,0 +1,103 @@
+require 'tide/api/http_client'
+require 'tide/api/mapper'
+require 'tide/api/account'
+require 'tide/api/transaction'
+require 'tide/api/company'
+require 'tide/api/error'
+require 'tide/api/tokens'
+
+module Tide
+  module API
+    # Main interface to Tide API
+    class Client
+      # Base path to Tide API version 1
+      BASE_PATH = 'https://api.tide.co/tide-backend/rest/api/v1'.freeze
+
+      # Instantiates an API client
+      #
+      # @param [Mapper] mapper Converts JSON responses into concrete instances of Tide API concepts
+      # @param [HTTPClient] http_client Performs HTTP requests
+      #
+      def initialize(mapper: Mapper.new, http_client: HTTPClient.new)
+        @mapper = mapper
+        @http_client = http_client
+      end
+
+      # Exchanges an auth nonce for OAuth2 access and refresh tokens.
+      #
+      # @param [String] auth_grant_code An authentication nonce provided by the OAuth2 redirect callback.
+      #
+      def fetch_tokens(auth_grant_code)
+        response = http_client.get("#{BASE_PATH}/oauth2/tokens?code=#{auth_grant_code}")
+
+        return build_error_from(response) if response.error?
+
+        build_tokens_from(response).tap do |tokens|
+          http_client.refresh_token = tokens.refresh_token
+          http_client.access_token  = tokens.access_token
+        end
+      end
+
+      # Retrieves all companies of the authenticated user
+      #
+      # @return [Error|Array<Company>] A list of companies
+      #
+      def fetch_companies
+        response = http_client.get("#{BASE_PATH}/external/companies")
+        response.error? && build_error_from(response) || build_companies_from(response)
+      end
+
+      # Retrieves all accounts of a given company
+      #
+      # @param [Integer] company_id Tide's internal ID of the company
+      #
+      # @return [Error|Array<Transaction>]
+      #
+      def fetch_accounts(company_id)
+        response = http_client.get("#{BASE_PATH}/external/companies/#{company_id}/accounts")
+        response.error? && build_error_from(response) || build_accounts_from(response)
+      end
+
+      # Retrieves all transactions of a given account
+      #
+      # @param [Integer] account_id Tide's internal ID of the account
+      #
+      # @return [Error|Array<Transaction>]
+      #
+      def fetch_transactions(account_id)
+        response = http_client.get("#{BASE_PATH}/external/accounts/#{account_id}/transactions")
+        response.error? && build_error_from(response) || build_transactions_from(response)
+      end
+
+      private
+
+      # @api private
+      attr_reader :mapper, :http_client
+
+      # @api private
+      def build_tokens_from(response)
+        mapper.map_one(response.payload, Tokens)
+      end
+
+      # @api private
+      def build_companies_from(response)
+        mapper.map(response.payload, Company)
+      end
+
+      # @api private
+      def build_transactions_from(response)
+        mapper.map(response.payload, Transaction)
+      end
+
+      # @api private
+      def build_accounts_from(response)
+        mapper.map(response.payload, Account)
+      end
+
+      # @api private
+      def build_error_from(response)
+        mapper.map_one(response.payload, Error)
+      end
+    end
+  end
+end