fortnox-api 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02c5fbd6c659d3c6cc4e9ed8dfef6e739ded62fc33107623f4dddc13d33f6672
-  data.tar.gz: 14f0815a2fd32e98055d71ef231da2b6fac4b95ecfd9dfcda59b88d1c1445c63
+  metadata.gz: 843c49685ec54b6f9e9adb7f5a16a67dc827f0d7b5e58b3d8bd8bd9fccced0db
+  data.tar.gz: 306a7d66d0b820cc8250b887d14362a7117e8aebbffae5449ba277f30013a06d
 SHA512:
-  metadata.gz: 293665ff9e0b860e88c7c6c78fbcfdd0b8a8047444f23cd0560d504442e1a0ac3439c52349413cac63e0c5973d1db74dabcf7ebdd9c10bc3f1b7de922db58cbc
-  data.tar.gz: 011b4785ce46af9c4cd57939431f6b09dc6ab44d650023616fe7b0784dcde890727999eb918ac3c3db311afaaff8785d240c54e5c30f198a630b9a1bf41483b7
+  metadata.gz: 1da53b39993c540c59290b111cf30b7ed99b84da62606462671fe178a342dd136f0e64ad552646c2f66d3091088b5a1961c77f9bf18a16e655e9fdfff360bc8f
+  data.tar.gz: 293879cf697a4c9fde27fa6fa8e89d2f59d082bd983a00ee5c8b345bc5864a231c61dc4bb256e424d3c721706dd01f851c88ef886b7d8b611e34481a2558ccfe

data/.codeclimate.yml

@@ -12,6 +12,7 @@ engines:
     enabled: false
   rubocop:
     enabled: true
+    channel: rubocop-1-39-0
 ratings:
   paths:
   - "**.rb"

data/.env.template

@@ -0,0 +1,7 @@
+FORTNOX_API_REDIRECT_URI=https://example.com
+FORTNOX_API_CLIENT_SECRET=
+FORTNOX_API_SCOPES=article invoice settings customer order project
+FORTNOX_API_CLIENT_ID=
+FORTNOX_API_REFRESH_TOKEN=
+FORTNOX_API_ACCESS_TOKEN=
+

data/.env.test

@@ -1,3 +1,11 @@
-FORTNOX_API_BASE_URL=https://api.fortnox.se/3/
-FORTNOX_API_CLIENT_SECRET=9aBA8ZgsvR
-FORTNOX_API_ACCESS_TOKEN=ccaef817-d5d8-4b1c-a316-54f3e55c5c54
+DEBUG=false
+
+EXPIRED_ACCESS_TOKEN=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjIsInRlbmFudElkIjoxMzY4MjY3LCJjbGllbnRJZCI6ImR2UEE0Mnk0ME9XSiIsInJpZ2h0c0FzSnNvbiI6Ikg0c0lBQUFBQUFBQUE0MVgzVzdyTmd4K2wxNnZlWWVzUlE4SzdPd1VTSWZoWUJnQzJtSWN6WkpvU0hMYTdPbEhXWkl0MlUyd080dWt5SVwvXC84bDhQRmp2cHZMM3VHakQ5dm0xcE5ONDlcL1BMUWlKMDcwd2NvMVNxSk13MWFMeVwvZ3NTWUtMVTNRTWpPZ2JkRUZMblFXVVRObEYwaURcLzhPaDNXZGF1SDNhbmFRQjAwcFFQeEhzQWIyWHBuT1JkYUd4UGFPTmg5WWk2M2ZTWEVpMnlPcnNDS3BrZ2ZKb016OHlCcmdHUTI3c09uUmVrb2xrQVZKZFBmU0xwUThyUGI1SWhlOTB1RHFQK29XVVlHMUpQd05FVmF0TzJCeURicytnUTl5U2NsUVZiaWNSUHdleWlUMmdQWkhWRmY3SmV1MzZLV0N4WU53SlYwR1ozS3dzTkVSOURTNEdKQWxWcGhaMFVrT1h4QjFjc0ZZQW96K1RsZjlpME4wakRsK0JyMjhFV0ZzazZ1UXE5UFdwU053NlpsSXZNYk40UWV0Vms1bVYzVml6Rmx2aUtsSVNsalRQVHFReXlBaU1xRldVcUZtMHRzSktTQmRLcDFoVlR0UkIyV1NtSW1RZkZMVTkzNU1rN25qQnVVS2ZNSjY1djhoZUZYVTVKQzNLNGN1YUtwd2pxbUpNcDlNRUpKQUxIOEtSQzFCWEY4aUtXVGJXZjBrQklVcGx2dkZkZWQ3d2lxdnNWY2t1NFpVbUozTHR5YnBOTXBEaW11V1FnYXZBNTI5RlpsQ2p1OVZaK3ZxWWtzQktRTVFMWlpUQzBZN21HSkdWaERPMlwvVXIrR01wa2tVbGZQU2d1UHJCeTFNY3dYYjhpTFwvZHFzaEpVMkFUUG85QnZCUXVSd2tBYzhtaVBYQ2lPekRRTElqMzBHSVAxNExPTDZ5QUgybzJRVmFvZGgwRkRZVDkyVWo1NStDeE9vUzlZeVVwSEtHYmVRaWRFNFhielYwVU40VWxicXFJUDVQeUVNQ3lvcVZWVlo2ZDBhekRjRTgrb0pNOFFpYTVncFdMNWZsdGlVR0RlWW5NZFBMZnNPMlRZU1lEM1l4bVFSRVVoXC9hdHBHS1Y0b3BpbXhJbkY4MlpKakJQUUh6WnRtZGxpdEhaSElxcDROUzN4MXUyK0VZa3ZmTHJGSHNhd3JSeHV0SWFwK0hhTHFSbU1DbkdQUzMzZTJJOStDYm5iNVZYeE5QS28wbWlMZlB5UFc0ZHhHUGp0c0w3RnBXbjlPRHgyb3hRWXNubDlwdGRwS3JCM0J6OHRKblpWVDJVRUhHNDlnTGtXT1VuTXFheFwvZkpndFI0UHQwY2UwbHNKUDhpTGIzMGZkVElXWk9JcWE1cm9jNXlXMXN2SmtVZkRDWVdkTFE5UndIeTFuanJXZlkxb3FPR2kzNTlVVkZMUjU4eVIrYU9wbjZhQlJLUFpDXC9NYkQwYmhjc2pkcVwvWDZkMzYzeGJYMVwvWGR2ckNsSGJZYTF1dm1uNk1MYTVXRlBSOWF2aHZ6eGYrcmhNbHFYQUJNV1RnM2NtbDFUcjArVnBXVlZDaGo1ZFpZK25FV2RvekxNaWlzU242OEN2b2lRVnAxVHhMT2lyZFZXWmlQU01wR0tWRDhCb0tYNnNJOVRmaTFBWWZIY01iZ0JIQXFkbHNQUVBab0U2Q292UERDNUhPQlhMT243VmVYN3JWVlJwbUJxZTJaWHo5WE5wQTV5ZkhWeUFmc0hicHVtUjBsdStrM0ltamNnR3N5RlBnbmd5aGtYOFF2WTluSmdxWU5kWkdzT0lBS04yNEJpSU9cL0tMb1Nha2RWOVEwaEFPaW0xYWt0elU3MUpqSklVZTJDc1ZmbWJjUWsxd2ZnVW5IWE8zeERcLzVHWWo3NzVGUmQ1WmZ0ZERmXC93RTV2eUZHbWcwQUFBPT0iLCJzY29wZXMiOlsiYXJ0aWNsZSIsImludm9pY2UiLCJzZXR0aW5ncyIsImN1c3RvbWVyIiwib3JkZXIiLCJwcm9qZWN0Il0sImF1dGhzb3VyY2UiOiJPQVVUSDIiLCJpZCI6IjRiNThjM2M2ZDEwOTU3Njc0ZTQwNzE3Y2ZkODdkOGZkNzExMDQ0YTYiLCJqdGkiOiI0YjU4YzNjNmQxMDk1NzY3NGU0MDcxN2NmZDg3ZDhmZDcxMTA0NGE2IiwiaXNzIjoiaHR0cHM6XC9cL2FwaS5mb3J0bm94LnNlXC9vYXV0aDIiLCJhdWQiOiJkdlBBNDJ5NDBPV0oiLCJzdWIiOiIyQDEzNjgyNjciLCJleHAiOjE2NzUxMDI0MjEsImlhdCI6MTY3NTA5ODgyMSwidG9rZW5fdHlwZSI6ImJlYXJlciIsInNjb3BlIjoiYXJ0aWNsZSBpbnZvaWNlIHNldHRpbmdzIGN1c3RvbWVyIG9yZGVyIHByb2plY3QifQ.wW3fBY0ZkZkBNaGrNSwJlJzNa7EmSGCKhY_QLEAcmIA
+
+# VCR: Real credentials are required when renewing authentication cassettes
+FORTNOX_API_CLIENT_ID=test_client_id
+FORTNOX_API_CLIENT_SECRET=test_client_secret
+FORTNOX_API_REFRESH_TOKEN=test_refresh_token
+
+# VCR: Valid token is required for rerecording cassettes
+FORTNOX_API_ACCESS_TOKEN=test_access_token

data/.gitignore

@@ -7,8 +7,14 @@ Gemfile.lock
 # Vim swap files
 *.swp
 
-# rbenv Ruby version file
+# Ruby version files
 .ruby-version
 
 # Simplecov
 coverage/
+
+# Dotenv
+.env
+
+# Rake
+.rake_tasks~

data/.rubocop.yml

@@ -1,8 +1,9 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   DisplayCopNames: true
+  NewCops: enable
 
 RSpec/FilePath:
   Enabled: false
@@ -13,7 +14,7 @@ RSpec/NestedGroups:
 Style/Documentation:
   Enabled: false
   
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Metrics/BlockLength:
@@ -23,3 +24,18 @@ Metrics/BlockLength:
 Naming/PredicateName:
   Exclude:
     - 'spec/support/matchers/**/*'
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: exception
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 7
+
+Lint/RaiseException:
+  # You must specify the nearest module, not the fully qualified name
+  AllowedImplicitNamespaces:
+    - 'API'
+    - 'Repository'

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.0

data/.travis.yml

@@ -1,28 +1,31 @@
 env:
   global:
-  - CC_TEST_REPORTER_ID=43ea0acb059b164537ce31bf67e03e1cb552d63df1ad3e9bd95dc3d844697bb4
+    - CC_TEST_REPORTER_ID=43ea0acb059b164537ce31bf67e03e1cb552d63df1ad3e9bd95dc3d844697bb4
 language: ruby
+dist: focal
 rvm:
-- 2.5.8
-- 2.6.6
-- 2.7.1
+  - 2.7.7
+  - 3.0.5
+  - 3.1.3
+  - 3.2.0
+
 notifications:
   slack:
     secure: UEYDtwLaQgAoMRY7ct1y0Uu5HbInMwrLo+TiYRc3rjDrzqDfDyInEr3bpckyPJ79lnzccrFezMdY4jWzRjmsvQzvYMu+DWJ1mAWOa/9Ws4YZ8nHd5KqXxVQ0EqPWuWwMOyOdyy3DK/MjUOobGSc0//Pv5DeaAAEBKLJzN+e1BQM=
   email: false
 before_install:
-- gem update --system
-- gem install bundler
+  - gem update --system
+  - gem install bundler
 cache: bundler
 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"
+  - 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 rspec
+  - bundle exec rspec
 after_script:
-- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+  - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 branches:
   only:
   - master

data/CHANGELOG.md

@@ -1,44 +1,99 @@
 # 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).
+and this project adheres to
+[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.9.0]
+
+### Added
+
+- Script in `bin/get_tokens` to issue access and refresh tokens
+- Script in `bin/renew_tokens` (convenience feature for developers)
+- `Fortnox::API::Repository::Authentication.renew_token`, used for token renewal
+
+### Changed
+
+- **Breaking** The auth process is rewritten to support
+  [the new auth flow](https://developer.fortnox.se/general/authentication/) that
+  Fortnox has implemented. You also need to set the access token explicitly with
+  `Fortnox::API.access_token ' your token'`. See [README](README.md) for more
+  instructions.
+
+### Fixed
+
+- Missing runtime dependencies `dry-configurable` and `dry-container` is added.
+  Those were indirect dependencies before via other dry libs, but we use them
+  explicitly in the gem, so they should be included as real dependencies. Also,
+  newer versions of these gems did actually break the gem.
+- Not trying to update resource if diff against parent is an empty object
+  (#238).
+
+### Removed
+
+- **Breaking** Drops support for Ruby 2.6 since it's reached end of life
+- Token rotation is removed since Fortnox counts rate limit on tenant and client
+  id. Before, you could get around this by using multiple access tokens. That's
+  not possible anymore, so token rotation is simply removed.
+- **Breaking** Removes `client_id` and `client_secret` from configuration. These
+  value are only used for token renewal, so they are now arguments to the
+  `Authentication` repository. This means there are no longer any required
+  configuration to set in `Fortnox::API.configuration`.
 
 ## [0.8.0]
+
 ### Changed
+
 - `Fortnox::API::CURRENT_HOUSEWORK_TYPES` is now renamed to `HOUSEWORK_TYPES`
-  and is instead a Hash with keys for the different categories of types.
-  It also includes legacy types, which means `Fortnox::API::LEGACY_HOUSEWORK_TYPES` is removed.
+  and is instead a Hash with keys for the different categories of types. It also
+  includes legacy types, which means `Fortnox::API::LEGACY_HOUSEWORK_TYPES` is
+  removed.
 
 ### Removed
+
 - Drops support for Ruby < `2.5.0` since they are deprecated
 
 ## [0.7.2]
+
 ### Fixed
+
 - Invalid validation for Customer's account number attribute
 
 ## [0.7.1]
+
 ### Fixed
+
 - Invalid validation for Customer's country attributes
 
 ## [0.7.0]
+
 ### Added
+
 - Adds build test for Ruby `2.6.0`, `2.6.3` and `2.7.0-preview`.
 
 ### Removed
+
 - Drops support for Ruby < `2.4.0` since they are deprecated
 
 ### Fixed
+
 - Country attribute for `Invoice` and `Order` is now validated correctly.
 - Fixes deprecation warnings
 - Unlocks pinned `HTTParty` version
 - Invalid email validation
 
 ## [0.6.3]
+
 ### Changed
+
 - Pins `dry-types` to `< 0.13.0` due to breaking changes
 
 ### Fixed
+
 - Model attribute `url` is no longer null
 
 [0.8.0]: https://github.com/accodeing/fortnox-api/compare/v0.7.2...v0.8.0

data/CONTRIBUTE.md

@@ -1,24 +1,36 @@
-1. Fork it ( http://github.com/my-codeworks/fortnox-api/fork )
-2. Clone your fork (`git clone https://github.com/<your GitHub user
-   name>/fortnox-api.git`)
+# Contribute to the project
+
+If you want to participate in the development somehow, please send us an email
+at info@accodeing.com and let us know. Both small and large contributions are
+appreciated. We have a Slack channel where developers are more than welcome :)
+
+Please start with reading the [DEVELOPER_README](DEVELOPER_README.md).
+
+To contribute:
+
+1. Fork it ( http://github.com/accodeing/fortnox-api/fork )
+2. Clone your fork
+   (`git clone https://github.com/<your GitHub user name>/fortnox-api.git`)
 3. Create your feature branch (`git checkout -b my-new-feature`)
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
-6. Create new Pull Request
+6. Create new Pull Request against our `development` branch
 
-### Adding upstream remote
+# Adding upstream remote
 
 If you want to keep contributing, it is a good idea to add the original repo as
-remote server to your clone ( `git remote add upstream
-https://github.com/my-codeworks/fortnox-api` ). Then you can do something like
-this to update your fork:
+remote server to your clone (
+`git remote add upstream https://github.com/accodeing/fortnox-api` ). Then you
+can do something like this to update your fork:
 
 1. Fetch branches from upstream (`git fetch upstream`)
 2. Checkout your master branch (`git checkout master`)
 3. Update it (`git rebase upstream/master`)
-4. And push it to your fork (`git push origin master`)
+4. And push it to your fork (`git push origin master`) (might need a `--force`
+   if branches have diverged)
 
 If you want to update another branch:
+
 ```
 git checkout branch-name
 git rebase upstream/branch-name

data/DEVELOPER_README.md

@@ -0,0 +1,72 @@
+# Readme for Developers
+
+## Testing
+
+This gem has integration tests to verify the code against the real API. It uses
+[vcr](https://github.com/vcr/vcr) to record API endpoint responses. These
+responses are stored locally and are called vcr cassettes. If no cassettes are
+available, vcr will record new ones for you. Once in a while, it's good to throw
+away all cassettes and rerecord them. Fortnox updates their endpoints and we
+need to keep our code up to date with the reality. There's a handy rake task for
+removing all cassettes, see `rake -T`. Note that when rerecording all cassettes,
+do it one repository at a time, otherwise you'll definitely get
+`429 Too Many Requests` from Fortnox. Run them manually with something like
+`bundle exec rspec spec/fortnox/api/repositories/article_spec.rb`. Also, you
+will need to update some test data in specs, see notes in specs.
+
+### Test environment variables
+
+`.env.test` includes environment variables used for testing. If you want to run
+tests against a real (or test) Fortnox account you need to provide valid
+credentials in `.env`. See [Get tokens](get-tokens) for how to issue valid
+tokens and `.env.template` for which values you need to provide. Then, you must
+move these into `.env.test` since that's the environment file used for testing.
+
+If you want the gem to refresh your tokens during testing, you can enable that
+feature by setting the environment variable `REFRESH_TOKENS=true`.
+
+### Seeding
+
+There's a Rake task for seeding the Test Fortnox instance with data that the
+test suite needs. See `rake -T` to find the task.
+
+### Debug mode while running tests
+
+There's a `DEBUG` environment variable to set if you want to debug during
+testing.
+
+## Rubocop
+
+When updating Rubocop in `fortnox-api.gemspec`, you need to set the explicit
+version that codeclimate runs in `.codeclimate.yml`
+
+## Updating Ruby version
+
+When updating the required Ruby version, you need to do the following:
+
+- Bump Ruby version in `fortnox-api.gemspec`
+- Update gems if needed
+- Verify that the test suite is passing
+- Bump `TargetRubyVersion` in `.rubocop.yml` and verify that the Rubocop version
+  we are using is supporting that Ruby version. Otherwise you need to upgrade
+  Rubocop as well, see [Rubocop instructions](#rubocop). The version here should
+  be the lowest version we support.
+- Update `.tool-versions` to the **newest version we support**
+- Update `.travis.yml` with the new Ruby versions
+- Update required Ruby version in the readme
+- Verify that all GitHub integrations works in the pull request you are creating
+
+# Release
+
+1. Update `CHANGELOG.md`
+2. Bump version in `lib/fortnox/api/version.rb`
+3. Release gem with `gem build fortnox-api.gemspec` and
+   `gem push fortnox-api-[VERSION].gem`
+
+# Contributing
+
+See the [CONTRIBUTE](CONTRIBUTE.md) readme.
+
+# Dummy trigger
+
+A dummy trigger: 1

data/Guardfile

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
-guard :rspec, cmd: 'bundle exec rspec --color', all_after_pass: true do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb') { 'spec' }
+group :rspec do
+  guard :rspec, cmd: 'bundle exec rspec --color', all_after_pass: true do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
+end
+
+group :rubocop do
+  guard :rubocop, cli: ['--display-cop-names'] do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end