banks_api-ynab 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f6ca9c79f5050c98cc16576ee7d3205d059ac4ef19d1e4a2d88b6a6481f1898c
4
+ data.tar.gz: 2a64cbeacbe2b4d29db2e4168fe34cbe38aff0ab84e4b3c91dff77b346a48d2e
5
+ SHA512:
6
+ metadata.gz: 2426a4d80619689716828d8fa67e3f71f4c4d461e89ca0469d019971af4d062433294965583bd5c91adf989f4e885c43d2150ad5a714c8fce6520c7f9e4a84c9
7
+ data.tar.gz: f7e990c329eaad7e9f7920d99e757e0e9574655fba2868fcf701c8f96886fcbbb966e3cefb116d9d596a590258653ca9e607a220c9cd7b233738a8260d8b19cf
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ Gemfile.lock
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.5.1
7
+ before_install: gem install bundler -v 1.16.5
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at david.stosik+git-noreply@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in banks_api-ynab.gemspec
6
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 David Stosik
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # BanksApi::Ynab
2
+
3
+ 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/ynab`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'banks_api-ynab'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install banks_api-ynab
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ 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.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/banks_api-ynab. 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.
36
+
37
+ ## License
38
+
39
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
+
41
+ ## Code of Conduct
42
+
43
+ Everyone interacting in the BanksApi::Ynab project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/banks_api-ynab/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,31 @@
1
+ lib = File.expand_path("../lib", __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require "banks_api/ynab/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "banks_api-ynab"
7
+ spec.version = BanksApi::Ynab::VERSION
8
+ spec.authors = ["David Stosik"]
9
+ spec.email = ["david.stosik+git-noreply@gmail.com"]
10
+
11
+ spec.summary = %q{Banks API to YNAB}
12
+ spec.description = %q{Synchronize transactions from your bank account to YNAB}
13
+ spec.homepage = "https://github.com/davidstosik/banks_api-ynab"
14
+ spec.license = "MIT"
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_dependency "banks_api", "~> 0.1"
26
+ spec.add_dependency "ynab", "~> 1.5.0"
27
+
28
+ spec.add_development_dependency "bundler", "~> 1.16"
29
+ spec.add_development_dependency "rake", "~> 10.0"
30
+ spec.add_development_dependency "minitest", "~> 5.0"
31
+ end
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "banks_api/ynab"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,10 @@
1
+ require "banks_api/ynab/version"
2
+ require "banks_api"
3
+ require "ynab"
4
+ require "banks_api/ynab/sync"
5
+
6
+ module BanksApi
7
+ module Ynab
8
+ # Your code goes here...
9
+ end
10
+ end
@@ -0,0 +1,38 @@
1
+ require "banks_api/ynab/save_transaction_converter"
2
+
3
+ module BanksApi
4
+ module Ynab
5
+ class BulkTransactions < YNAB::BulkTransactions
6
+ def initialize(banks_api_transactions, account_id:)
7
+ @banks_api_transactions = banks_api_transactions
8
+ @account_id = account_id
9
+ reset_occurrences
10
+ @transactions = ynab_save_transactions
11
+ end
12
+
13
+ private
14
+
15
+ attr_reader :banks_api_transactions, :account_id, :occurrences
16
+
17
+ def ynab_save_transactions
18
+ banks_api_transactions.map do |transaction|
19
+ transaction_converter = SaveTransactionConverter.new(
20
+ transaction,
21
+ account_id: account_id
22
+ )
23
+ transaction_converter.occurrence = occurrence_for(transaction_converter)
24
+
25
+ transaction_converter.convert
26
+ end
27
+ end
28
+
29
+ def occurrence_for(transaction_converter)
30
+ occurrences[transaction_converter.import_id_without_occurrence] += 1
31
+ end
32
+
33
+ def reset_occurrences
34
+ @occurrences = Hash.new(0)
35
+ end
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,57 @@
1
+ require "banks_api/transaction"
2
+
3
+ module BanksApi
4
+ module Ynab
5
+ class SaveTransactionConverter < SimpleDelegator
6
+ attr_accessor :occurrence
7
+
8
+ def initialize(transaction, **extra_params)
9
+ super(transaction)
10
+ @extra_params = extra_params
11
+ end
12
+
13
+ def convert
14
+ YNAB::SaveTransaction.new(attributes.merge(extra_params))
15
+ end
16
+
17
+ def import_id_without_occurrence
18
+ [
19
+ "YNAB",
20
+ amount_milliunits,
21
+ date.iso8601
22
+ ].join(":")
23
+ end
24
+
25
+ private
26
+
27
+ attr_reader :extra_params
28
+
29
+ def attributes
30
+ {
31
+ #account_id: nil,
32
+ date: date,
33
+ amount: amount_milliunits,
34
+ #payee_id: nil,
35
+ #payee_name: nil,
36
+ #category_id: nil,
37
+ memo: description,
38
+ #cleared: false,
39
+ #approved: false,
40
+ #flag_color: nil,
41
+ import_id: import_id
42
+ }
43
+ end
44
+
45
+ def amount_milliunits
46
+ (amount.amount * 1000).to_i
47
+ end
48
+
49
+ def import_id
50
+ [
51
+ import_id_without_occurrence,
52
+ occurrence
53
+ ].join(":")
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,49 @@
1
+ require "banks_api/ynab/bulk_transactions_converter"
2
+
3
+ module BanksApi
4
+ module Ynab
5
+ class Sync
6
+ def self.run(*args)
7
+ new(*args).run
8
+ end
9
+
10
+ def initialize(ynab_budget_id:, ynab_account_id:, bank_name:, credentials:, bank_account_id:, date_from:, date_to:)
11
+ @ynab_budget_id = ynab_budget_id
12
+ @ynab_account_id = ynab_account_id
13
+ @bank_name = bank_name
14
+ @credentials = credentials
15
+ @bank_account_id = bank_account_id
16
+ @date_from = date_from
17
+ @date_to = date_to
18
+ end
19
+
20
+ def run
21
+ ynab_api.transactions.bulk_create_transactions(ynab_budget_id, bulk_transactions)
22
+ end
23
+
24
+ private
25
+
26
+ attr_reader :ynab_budget_id, :ynab_account_id, :bank_name, :credentials, :bank_account_id, :date_from, :date_to
27
+
28
+ def bulk_transactions
29
+ BanksApi::Ynab::BulkTransactions.new(banks_api_transactions, account_id: ynab_account_id)
30
+ end
31
+
32
+ def banks_api_transactions
33
+ bank_account.transactions(from: date_from, to: date_to)
34
+ end
35
+
36
+ def bank_account
37
+ @_bank_account ||= user_account.account(bank_account_id)
38
+ end
39
+
40
+ def user_account
41
+ @_user_account ||= BanksApi::UserAccount.new(bank_name, credentials)
42
+ end
43
+
44
+ def ynab_api
45
+ @_ynab_api ||= YNAB::API.new(ENV["YNAB_API_TOKEN"])
46
+ end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,5 @@
1
+ module BanksApi
2
+ module Ynab
3
+ VERSION = "0.1.1"
4
+ end
5
+ end
metadata ADDED
@@ -0,0 +1,129 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: banks_api-ynab
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - David Stosik
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-09-30 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: banks_api
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.1'
27
+ - !ruby/object:Gem::Dependency
28
+ name: ynab
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 1.5.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 1.5.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.16'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.16'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: minitest
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '5.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '5.0'
83
+ description: Synchronize transactions from your bank account to YNAB
84
+ email:
85
+ - david.stosik+git-noreply@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".travis.yml"
92
+ - CODE_OF_CONDUCT.md
93
+ - Gemfile
94
+ - LICENSE.txt
95
+ - README.md
96
+ - Rakefile
97
+ - banks_api-ynab.gemspec
98
+ - bin/console
99
+ - bin/setup
100
+ - lib/banks_api/ynab.rb
101
+ - lib/banks_api/ynab/bulk_transactions_converter.rb
102
+ - lib/banks_api/ynab/save_transaction_converter.rb
103
+ - lib/banks_api/ynab/sync.rb
104
+ - lib/banks_api/ynab/version.rb
105
+ homepage: https://github.com/davidstosik/banks_api-ynab
106
+ licenses:
107
+ - MIT
108
+ metadata: {}
109
+ post_install_message:
110
+ rdoc_options: []
111
+ require_paths:
112
+ - lib
113
+ required_ruby_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ required_rubygems_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ requirements: []
124
+ rubyforge_project:
125
+ rubygems_version: 2.7.6
126
+ signing_key:
127
+ specification_version: 4
128
+ summary: Banks API to YNAB
129
+ test_files: []