banks_api 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1529cbe2e354b29a0433fc0701ab66513fc7941b8b268c6378c9620e6da5f9ca
+  data.tar.gz: ddf6fbe34637f863799859ede4fc1b790c1a90ebf98af6886b82e2fa880054ec
+SHA512:
+  metadata.gz: 0d401d9300cd8157ffcce98bfb37b75d71ed16ab82a42a9eecd5c8eb53fdd3da97071b0ea95faa959f866d87209beb47a26abd50ceea6bd4a4dd520b58416f10
+  data.tar.gz: 5f1cdf2c856aab0ba3ba63211e09d193f95db43f12f71b9cea18294cd882fa665d96f10b6761d13865596e1899e89dc6323b221b3375178fa33959a3983e0000

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.5

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 david.stosik+git-noreply@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 banks_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 David Stosik
+
+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,159 @@
+# Banks API
+
+## Usage
+
+### Authentication
+
+```rb
+require "banks_api-bankname"
+
+user_account = BanksApi::UserAccount.new(
+  "bankname",
+  credential_hash
+)
+```
+
+### Fetching accounts information
+
+A user's account in a bank may have access to multiple bank accounts.
+
+```rb
+bank_accounts = user_account.bank_accounts
+puts bank_accounts.first.inspect
+#<BanksApi::BankName::BankAccount
+  id: "1234567890",
+  description: "...",
+  balance: #<Money fractional:987654 currency:JPY>
+>
+```
+
+### Fetching transactions for a specific bank account
+
+```rb
+transactions = bank_accounts.first.transactions(
+  from: Date.today.prev_month,
+  to: Date.today
+)
+puts transactions.first.inspect
+#<BanksApi::BankName::Transaction
+  date: #<Date: 2018-09-25 ((2458387j,0s,0n),+0s,2299161j)>,
+  description: "a description of the transaction",
+  amount: #<Money fractional:200 currency:JPY>
+>
+```
+
+## Project
+
+### Classes
+
+#### `Bank` (unnecessary?)
+
+Specific bank classes (eg. `ShinseiBank`) inherit from this. (Maybe using
+duck-typing is enough?)
+
+#### `UserAccount`
+
+This represents a user account in a specific bank, with its credentials.
+
+```rb
+attr_accessor :bank           # Class? Symbol?
+attr_accessor :credentials    # Hash? CredentialSet?
+has_many :bank_accounts, class_name: "BankAccount"
+```
+
+#### `BankAccount`
+
+A bank account that has a balance and a list of transactions.
+(There may be multiple bank accounts in a unique user account.)
+
+```rb
+attr_accessor :name           # String
+attr_accessor :balance        # Money?
+has_many :transactions, class_name: "Transaction"
+```
+
+#### `Transaction`
+
+A credit or a debit transaction, with an amount, a date and a description.
+(How about a payee, only on the YNAB side?)
+
+```rb
+attr_accessor :type           # Symbol? (:credit, :debit)
+attr_accessor :amount         # Money?
+attr_accessor :description    # String
+attr_accessor :date           # Date
+```
+
+### gems
+
+#### Base gem (`banks_api`)
+
+Provides:
+
+- coding guidelines
+- public API
+- basic `Bank` class?
+
+#### Command-line gem (`banks_api-cli`)
+
+Provides:
+
+- command-line tool (with Thor?)
+
+#### Specific bank gem (eg. `banks_api-shinsei`)
+
+Implements:
+
+- user credential format (`Hash` or custom class?)
+- list accounts
+- getting balance per account
+- getting transactions per account
+- transfering money?
+
+#### Sync gem (`banks_api-ynab`)
+
+Takes a `BankAccount` and syncs its transactions with a specific account in
+a budget.
+## gem README
+
+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/banks_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 'banks_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install banks_api
+
+### Usage
+
+TODO: Write usage instructions here
+
+### Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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]/banks_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 BanksApi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/banks_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/banks_api.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "banks_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "banks_api"
+  spec.version       = BanksApi::VERSION
+  spec.authors       = ["David Stosik"]
+  spec.email         = ["david.stosik+git-noreply@gmail.com"]
+
+  spec.summary       = %q{Banks API gem}
+  spec.description   = %q{Core code used by Banks API implementations for banks.}
+  spec.homepage      = "https://github.com/davidstosik/banks_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('..', __FILE__)) 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 "money", "~> 6.12"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "banks_api"
+
+# 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
+
+require "irb"
+IRB.start(__FILE__)

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/lib/banks_api.rb

@@ -0,0 +1,8 @@
+require "banks_api/version"
+require "banks_api/bank"
+require "banks_api/user_account"
+require "banks_api/bank_account"
+require "banks_api/transaction"
+
+module BanksApi
+end

data/lib/banks_api/bank.rb

@@ -0,0 +1,37 @@
+require "forwardable"
+require "monitor"
+require "singleton"
+
+module BanksApi
+  class Bank
+    include Singleton
+    extend SingleForwardable
+
+    def_single_delegators :instance, :register_bank, :get_bank_api
+
+    def initialize
+      @registry = {}
+      @mutex = Monitor.new
+    end
+
+    def register_bank(bank_name, api_class)
+      with_mutex do
+        registry[bank_name.to_s] = api_class
+      end
+    end
+
+    def get_bank_api(bank_name)
+      with_mutex do
+        registry.fetch(bank_name.to_s)
+      end
+    end
+
+    private
+
+      attr_reader :registry, :mutex
+
+      def with_mutex
+        mutex.synchronize { yield }
+      end
+  end
+end

data/lib/banks_api/bank_account.rb

@@ -0,0 +1,17 @@
+require "money"
+require "banks_api/inspectable_builder"
+
+module BanksApi
+  class BankAccount
+    include InspectableBuilder.new(%i(id description balance))
+
+    attr_reader :id, :description, :currency, :balance
+
+    def initialize(id:, description:, currency:, balance:)
+      @id = id
+      @description = description
+      @currency = Money::Currency.find(currency)
+      @balance = Money.from_amount(balance, @currency)
+    end
+  end
+end

data/lib/banks_api/inspectable_builder.rb

@@ -0,0 +1,20 @@
+module BanksApi
+  class InspectableBuilder < Module
+    def initialize(accessors)
+      define_inspect(accessors)
+      freeze
+    end
+
+    private
+
+      def define_inspect(accessors)
+        define_method(:inspect) do
+          attributes_string = accessors.map do |accessor|
+            "  #{accessor}: #{send(accessor).inspect}"
+          end.join(",\n")
+
+          "#<#{self.class.name}\n#{attributes_string}\n>"
+        end
+      end
+  end
+end

data/lib/banks_api/transaction.rb

@@ -0,0 +1,15 @@
+require "banks_api/inspectable_builder"
+
+module BanksApi
+  class Transaction
+    include InspectableBuilder.new(%i(date description amount))
+
+    attr_reader :date, :description, :amount
+
+    def initialize(date:, description:, amount:, currency:)
+      @date = date
+      @description = description
+      @amount = Money.from_amount(amount, currency)
+    end
+  end
+end

data/lib/banks_api/user_account.rb

@@ -0,0 +1,30 @@
+module BanksApi
+  class UserAccount
+    def initialize(bank_name, credentials)
+      @bank_name = bank_name
+      @credentials = credentials
+    end
+
+    def accounts
+      @accounts ||= api.fetch_accounts
+    end
+
+    def account(id)
+      accounts.find do |account|
+        account.id == id
+      end
+    end
+
+    private
+
+      attr_reader :bank_name, :credentials
+
+      def api
+        @_api ||= api_class.new(credentials)
+      end
+
+      def api_class
+        Bank.get_bank_api(bank_name)
+      end
+  end
+end

data/lib/banks_api/version.rb

@@ -0,0 +1,3 @@
+module BanksApi
+  VERSION = "0.1.5"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: banks_api
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- David Stosik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Core code used by Banks API implementations for banks.
+email:
+- david.stosik+git-noreply@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- banks_api.gemspec
+- bin/console
+- bin/setup
+- lib/banks_api.rb
+- lib/banks_api/bank.rb
+- lib/banks_api/bank_account.rb
+- lib/banks_api/inspectable_builder.rb
+- lib/banks_api/transaction.rb
+- lib/banks_api/user_account.rb
+- lib/banks_api/version.rb
+homepage: https://github.com/davidstosik/banks_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Banks API gem
+test_files: []