fortnox-api 0.9.2 → 1.0.0.rc2

data/.codeclimate.yml

@@ -1,20 +0,0 @@
----
-engines:
-  duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
-    exclude_fingerprints:
-      - e90f5ceaaaf6e613e221ffc4dd84fa37
-      - 1fca042e9b232b8f28944f0c89d5f34c
-  fixme:
-    enabled: false
-  rubocop:
-    enabled: true
-    channel: rubocop-1-39-0
-ratings:
-  paths:
-  - "**.rb"
-exclude_paths:
-- ".*"

data/.env.template

@@ -1,7 +0,0 @@
-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,11 +0,0 @@
-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

@@ -1,20 +0,0 @@
-.DS_Store
-.env
-.rspec
-*.gem
-Gemfile.lock
-
-# Vim swap files
-*.swp
-
-# Ruby version files
-.ruby-version
-
-# Simplecov
-coverage/
-
-# Dotenv
-.env
-
-# Rake
-.rake_tasks~

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress

data/.rubocop.yml

@@ -1,41 +0,0 @@
-require: rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 2.7
-  DisplayCopNames: true
-  NewCops: enable
-
-RSpec/FilePath:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Max: 4
-
-Style/Documentation:
-  Enabled: false
-  
-Layout/LineLength:
-  Max: 120
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-
-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

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

data/.travis.yml

@@ -1,32 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=43ea0acb059b164537ce31bf67e03e1cb552d63df1ad3e9bd95dc3d844697bb4
-language: ruby
-dist: focal
-rvm:
-  - 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
-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"
-script:
-  - bundle exec rspec
-after_script:
-  - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
-branches:
-  only:
-  - master
-  - development

data/CLAUDE.md

@@ -1,79 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Project Overview
-
-Ruby gem wrapping Fortnox AB's version 3 REST API. Uses the data mapper pattern (not ActiveRecord) with separate concerns for models, types, mappers, and repositories.
-
-## Common Commands
-
-```bash
-# Run all tests
-bundle exec rspec
-
-# Run a single test file
-bundle exec rspec spec/fortnox/api/repositories/customer_spec.rb
-
-# Run tests matching a pattern
-bundle exec rspec --example "Customer"
-
-# Run linter
-bundle exec rubocop
-
-# Run linter with auto-fix
-bundle exec rubocop -a
-
-# List rake tasks
-rake -T
-
-# Remove all VCR cassettes (for re-recording)
-rake throw_vcr_cassettes
-
-# Seed test Fortnox instance with required data
-rake seed_fortnox_test_instance
-
-# Get new OAuth tokens (requires credentials in .env)
-bin/get_tokens
-```
-
-## Architecture
-
-### Data Mapper Pattern
-
-Unlike Rails' ActiveRecord, this gem separates concerns:
-
-- **Models** (`lib/fortnox/api/models/`): Immutable data objects. Use `model.update(attr: value)` to get a new instance with changed attributes.
-- **Types** (`lib/fortnox/api/types/`): Enforce constraints on attribute values, lengths, and content.
-- **Mappers** (`lib/fortnox/api/mappers/`): Convert between Ruby objects and Fortnox JSON. Used internally by repositories.
-- **Repositories** (`lib/fortnox/api/repositories/`): Handle HTTP requests. Methods: `all`, `find(id)`, `find_by(attr: value)`, `save`.
-
-### Key Classes
-
-- `Fortnox::API` - Main module with configuration and thread-local access token
-- `Fortnox::API::Repository::Authentication` - Token renewal via `renew_tokens`
-- Available models: Article, Customer, Invoice, Label, Order, Project, TermsOfPayment, Unit
-
-### Exception Hierarchy
-
-- `Fortnox::API::AttributeError` - Invalid attribute value
-- `Fortnox::API::MissingAttributeError` - Required attribute missing
-- `Fortnox::API::RemoteServerError` - Server-side error from Fortnox
-
-## Testing
-
-- Uses VCR to record API responses as cassettes in `spec/vcr_cassettes/`
-- When re-recording cassettes, do one repository at a time to avoid 429 rate limits
-- Environment variables for testing go in `.env.test` (see `.env.template`)
-- Set `DEBUG=true` for debug output during tests
-- Set `REFRESH_TOKENS=true` to enable token refresh during testing
-
-## Fortnox API Gotchas
-
-See `docs/gotchas.md` for detailed API quirks including:
-- `SalesAccount` default values may reference non-existent accounts
-- Legacy `HouseWorkType` values that can't be used for new orders/invoices
-- `VATIncluded` affects all price fields (no VAT-inclusive fields when false)
-- `TermsOfPayments.code` is case-sensitive (`30DAYS` not `30days`)
-- Row descriptions limited to 255 characters (undocumented)
-- Only one active refresh token per Fortnox account per integration

data/CONTRIBUTE.md

@@ -1,38 +0,0 @@
-# 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 against our `development` branch
-
-# 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/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`) (might need a `--force`
-   if branches have diverged)
-
-If you want to update another branch:
-
-```
-git checkout branch-name
-git rebase upstream/branch-name
-git push origin branch-name
-```

data/DEVELOPER_README.md

@@ -1,69 +0,0 @@
-# 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
-
-See our separate guide for releasing Ruby gems.
-
-# Contributing
-
-See the [CONTRIBUTE](CONTRIBUTE.md) readme.
-
-# Dummy trigger
-
-A dummy trigger: 1

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in fortnox-api.gemspec
-gemspec

data/Guardfile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-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

data/Rakefile

@@ -1,140 +0,0 @@
-# frozen_string_literal: true
-
-# rubocop:disable Metrics/MethodLength
-
-require 'rspec/core/rake_task'
-require 'dotenv'
-
-require_relative 'lib/fortnox/api'
-
-Dotenv.load('.env.test')
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
-
-desc 'Remove all VCR cassettes so we can rerecord them'
-task :throw_vcr_cassettes do
-  FileUtils.rm_rf(Dir.glob('spec/vcr_cassettes/**'))
-end
-
-desc 'Seed Fortnox test instane with data required for the test suite'
-task :seed_fortnox_test_instance do
-  Fortnox::API.configure do |config|
-    config.client_id = ENV.fetch('FORTNOX_API_CLIENT_ID')
-    config.client_secret = ENV.fetch('FORTNOX_API_CLIENT_SECRET')
-    config.storage = Class.new do
-      def access_token
-        ENV.fetch('FORTNOX_API_ACCESS_TOKEN')
-      end
-
-      def refresh_token; end
-
-      def access_token=(token); end
-
-      def refresh_token=(token); end
-    end.new
-  end
-
-  puts 'Seeting Fortnox test instance account with data required for testing...'
-
-  seed_customer_data
-  seed_article_data
-  seed_invoice_data
-  seed_order_data
-
-  puts 'Done'
-end
-
-def seed_customer_data
-  customer_repository = Fortnox::API::Repository::Customer.new
-
-  customer_repository.save(
-    Fortnox::API::Model::Customer.new(
-      name: 'A customer from New York',
-      city: 'New York'
-    )
-  )
-  customer_repository.save(
-    Fortnox::API::Model::Customer.new(
-      name: 'Another customer from New York',
-      city: 'New York',
-      zip_code: '10001'
-    )
-  )
-end
-
-def seed_article_data
-  article_repository = Fortnox::API::Repository::Article.new
-
-  article_repository.save(
-    Fortnox::API::Model::Article.new(
-      article_number: 101,
-      description: 'Hammer'
-    )
-  )
-
-  article_repository.save(
-    Fortnox::API::Model::Article.new(
-      article_number: 102,
-      description: 'Hammer'
-    )
-  )
-
-  article_repository.save(
-    Fortnox::API::Model::Article.new(
-      description: 'Test article'
-    )
-  )
-
-  article_repository.save(
-    Fortnox::API::Model::Article.new(
-      description: 'Test article'
-    )
-  )
-end
-
-# TODO: When we have support for actions, we should set the states for
-#       Invoices required by the Invoice Repository spec.
-def seed_invoice_data
-  invoice_repository = Fortnox::API::Repository::Invoice.new
-
-  invoice_repository.save(
-    Fortnox::API::Model::Invoice.new(
-      customer_number: '1',
-      your_reference: 'Gandalf the Grey'
-    )
-  )
-
-  invoice_repository.save(
-    Fortnox::API::Model::Invoice.new(
-      customer_number: '1',
-      your_reference: 'Gandalf the Grey',
-      our_reference: 'Radagast the Brown'
-    )
-  )
-end
-
-# TODO: When we have support for actions, we should set the states for
-#       Order required by the Order Repository spec.
-#       Also, we should create Orders needed for search tests.
-def seed_order_data
-  order_repository = Fortnox::API::Repository::Order.new
-
-  order_repository.save(
-    Fortnox::API::Model::Order.new(
-      customer_number: '1',
-      our_reference: 'Belladonna Took'
-    )
-  )
-
-  order_repository.save(
-    Fortnox::API::Model::Order.new(
-      customer_number: '1',
-      our_reference: 'Belladonna Took',
-      your_reference: 'Bodo Proudfoot'
-    )
-  )
-end
-
-# rubocop:enable Metrics/MethodLength

data/bin/console

@@ -1,22 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-
-require 'pry'
-require 'fortnox/api'
-
-##
-# Starts a new copy of this script, replacing the current session.
-#
-# When run the current process, this script, will be replaced by the result from
-# exec, a new copy of this script.
-#
-# Together with Pry's history this makes it look like you basically just
-# reloaded the gem and all of it's dependancies with their latest versions.
-
-def reload!
-  exec([File.absolute_path(__FILE__), __FILE__], *ARGV)
-end
-
-Pry.start