freeagentrb 0.1.4 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/.env.example +3 -1
  3. data/CHANGELOG.md +65 -0
  4. data/Gemfile +3 -3
  5. data/Gemfile.lock +78 -61
  6. data/README.md +747 -3
  7. data/bin/console +2 -0
  8. data/bin/fixtures +148 -0
  9. data/freeagentrb.gemspec +4 -5
  10. data/lib/free_agent/client.rb +164 -4
  11. data/lib/free_agent/error_generator.rb +4 -3
  12. data/lib/free_agent/oauth.rb +48 -0
  13. data/lib/free_agent/object.rb +113 -17
  14. data/lib/free_agent/objects/account_lock.rb +4 -0
  15. data/lib/free_agent/objects/account_manager.rb +4 -0
  16. data/lib/free_agent/objects/balance_sheet.rb +4 -0
  17. data/lib/free_agent/objects/bank_feed.rb +4 -0
  18. data/lib/free_agent/objects/bank_transaction.rb +7 -12
  19. data/lib/free_agent/objects/bill.rb +1 -0
  20. data/lib/free_agent/objects/capital_asset.rb +4 -0
  21. data/lib/free_agent/objects/capital_asset_type.rb +4 -0
  22. data/lib/free_agent/objects/cashflow.rb +5 -0
  23. data/lib/free_agent/objects/cis_band.rb +4 -0
  24. data/lib/free_agent/objects/cis_settings.rb +4 -0
  25. data/lib/free_agent/objects/corporation_tax_return.rb +5 -0
  26. data/lib/free_agent/objects/credit_note.rb +1 -0
  27. data/lib/free_agent/objects/credit_note_reconciliation.rb +5 -0
  28. data/lib/free_agent/objects/estimate.rb +1 -0
  29. data/lib/free_agent/objects/expense.rb +5 -0
  30. data/lib/free_agent/objects/final_accounts_report.rb +4 -0
  31. data/lib/free_agent/objects/hire_purchase.rb +4 -0
  32. data/lib/free_agent/objects/invoice.rb +1 -9
  33. data/lib/free_agent/objects/journal_set.rb +4 -0
  34. data/lib/free_agent/objects/note.rb +4 -0
  35. data/lib/free_agent/objects/payroll_period.rb +4 -0
  36. data/lib/free_agent/objects/payroll_profile.rb +5 -0
  37. data/lib/free_agent/objects/practice.rb +4 -0
  38. data/lib/free_agent/objects/practice_client.rb +4 -0
  39. data/lib/free_agent/objects/price_list_item.rb +5 -0
  40. data/lib/free_agent/objects/profit_and_loss.rb +6 -0
  41. data/lib/free_agent/objects/property.rb +4 -0
  42. data/lib/free_agent/objects/recurring_invoice.rb +5 -0
  43. data/lib/free_agent/objects/sales_tax_period.rb +4 -0
  44. data/lib/free_agent/objects/self_assessment_return.rb +4 -0
  45. data/lib/free_agent/objects/stock_item.rb +5 -0
  46. data/lib/free_agent/objects/tax_timeline_item.rb +5 -0
  47. data/lib/free_agent/objects/timeline_item.rb +5 -0
  48. data/lib/free_agent/objects/transaction.rb +5 -0
  49. data/lib/free_agent/objects/trial_balance_item.rb +5 -0
  50. data/lib/free_agent/objects/vat_return.rb +4 -0
  51. data/lib/free_agent/rate_limiter.rb +67 -0
  52. data/lib/free_agent/resource.rb +6 -2
  53. data/lib/free_agent/resources/account_locks.rb +24 -0
  54. data/lib/free_agent/resources/account_managers.rb +19 -0
  55. data/lib/free_agent/resources/balance_sheet.rb +15 -0
  56. data/lib/free_agent/resources/bank_accounts.rb +5 -7
  57. data/lib/free_agent/resources/bank_feeds.rb +13 -0
  58. data/lib/free_agent/resources/bank_transaction_explanations.rb +41 -1
  59. data/lib/free_agent/resources/bank_transactions.rb +1 -1
  60. data/lib/free_agent/resources/capital_asset_types.rb +28 -0
  61. data/lib/free_agent/resources/capital_assets.rb +14 -0
  62. data/lib/free_agent/resources/cashflow.rb +8 -0
  63. data/lib/free_agent/resources/categories.rb +33 -0
  64. data/lib/free_agent/resources/cis_bands.rb +8 -0
  65. data/lib/free_agent/resources/cis_settings.rb +15 -0
  66. data/lib/free_agent/resources/clients.rb +8 -0
  67. data/lib/free_agent/resources/company.rb +12 -0
  68. data/lib/free_agent/resources/contacts.rb +2 -2
  69. data/lib/free_agent/resources/corporation_tax_returns.rb +34 -0
  70. data/lib/free_agent/resources/credit_note_reconciliations.rb +31 -0
  71. data/lib/free_agent/resources/credit_notes.rb +0 -10
  72. data/lib/free_agent/resources/email_addresses.rb +9 -0
  73. data/lib/free_agent/resources/estimate_items.rb +3 -4
  74. data/lib/free_agent/resources/estimates.rb +30 -3
  75. data/lib/free_agent/resources/expenses.rb +45 -0
  76. data/lib/free_agent/resources/final_accounts_reports.rb +24 -0
  77. data/lib/free_agent/resources/hire_purchases.rb +13 -0
  78. data/lib/free_agent/resources/invoices.rb +22 -0
  79. data/lib/free_agent/resources/journal_sets.rb +37 -0
  80. data/lib/free_agent/resources/notes.rb +37 -0
  81. data/lib/free_agent/resources/payroll.rb +32 -0
  82. data/lib/free_agent/resources/payroll_profiles.rb +9 -0
  83. data/lib/free_agent/resources/practice.rb +10 -0
  84. data/lib/free_agent/resources/price_list_items.rb +30 -0
  85. data/lib/free_agent/resources/profit_and_loss.rb +10 -0
  86. data/lib/free_agent/resources/projects.rb +2 -2
  87. data/lib/free_agent/resources/properties.rb +29 -0
  88. data/lib/free_agent/resources/recurring_invoices.rb +23 -0
  89. data/lib/free_agent/resources/sales_tax_periods.rb +37 -0
  90. data/lib/free_agent/resources/self_assessment_returns.rb +36 -0
  91. data/lib/free_agent/resources/stock_items.rb +13 -0
  92. data/lib/free_agent/resources/tasks.rb +5 -4
  93. data/lib/free_agent/resources/timeslips.rb +20 -3
  94. data/lib/free_agent/resources/transactions.rb +15 -0
  95. data/lib/free_agent/resources/trial_balance.rb +13 -0
  96. data/lib/free_agent/resources/users.rb +3 -3
  97. data/lib/free_agent/resources/vat_returns.rb +35 -0
  98. data/lib/free_agent/version.rb +1 -1
  99. data/lib/free_agent.rb +67 -0
  100. metadata +83 -24
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5473733076facbdedb88e6611fd961a9c27efe923a2b75f26008a82a9b91f1ae
4
- data.tar.gz: 0b8b542adf3b2f1930dbf20194db64e85180ae7f6a212e2e78fb89674d7a7732
3
+ metadata.gz: e4004e24e75ac4d4b972d0fd65c9a6fbf8a90375565de47432174dec200d7e0f
4
+ data.tar.gz: c0acca1a91acddaa50f7bb7137d5d97a4746552944d74b92df1971fe5087035f
5
5
  SHA512:
6
- metadata.gz: bf351b2bc6721d5760436ad1166ed6dd0846fec9a77bb2489c01cf3d272c13654784a5c81b26a5ac3009e1ed4ec5f0939a8d87788d77f02dcd353a5f4babbe0b
7
- data.tar.gz: a88e3ad85c91138071366f611716f6daaabbf31c96a1a9cb61f43b1a9cae9ff4c37a2c7ce4c46b283736d1115b9e7b434e2a18d68db95e6dce649c90eeaddf18
6
+ metadata.gz: 004e0bdaa4ed06f69b88216c2f25d6f5e3b1dd1695a3df03e4b9416404ca07ad39d671b84b9435e9c7f15dfed8064c5a9d530536c3b26f527f13e8d45957ba6e
7
+ data.tar.gz: e94d1459e540b4b9979db405becc7646a1944d9528542eff952bcc66e6f7d627844ce7c74f9bb578685e17b6dba0ab3981a500f819186e6b5e11cd04058280f4
data/.env.example CHANGED
@@ -1 +1,3 @@
1
- ACCESS_TOKEN=
1
+ FREEAGENT_ACCESS_TOKEN=
2
+ FREEAGENT_CLIENT_ID=
3
+ FREEAGENT_CLIENT_SECRET=
data/CHANGELOG.md ADDED
@@ -0,0 +1,65 @@
1
+ # Changelog
2
+
3
+ ## 1.0.0
4
+
5
+ FreeAgentRB now covers the whole FreeAgent v2 API. See
6
+ [MISSING_ENDPOINTS.md](MISSING_ENDPOINTS.md) for the one remaining gap.
7
+
8
+ ### Upgrading from 0.1.x
9
+
10
+ - **Ruby 3.3 or later is required.**
11
+ - **Faraday 2.14.3 or later is required**, to avoid known security advisories.
12
+ - **Responses are `FreeAgent::Object` rather than `OpenStruct`.** Dot access,
13
+ `[]` with a string or symbol, `to_h`, `dig`, `each_pair` and `nil` for
14
+ unknown attributes all work as before. Code that checks
15
+ `is_a?(OpenStruct)` or uses OpenStruct-only methods such as `delete_field`
16
+ needs updating.
17
+ - **Monetary attributes on bills, credit notes and estimates are floats** rather
18
+ than strings, matching invoices. Expenses work the same way.
19
+ - **`credit_notes.mark_as_cancelled` has been removed**, as FreeAgent no longer
20
+ supports it.
21
+ - Create and update requests are now wrapped in the root element the docs
22
+ describe (e.g. `{ contact: { ... } }`), so pass attributes directly. If you
23
+ wrapped them yourself to work around the old behaviour, remove the wrapping.
24
+
25
+ ### Added
26
+
27
+ - Expenses
28
+ - Recurring invoices, price list items, credit note reconciliations and stock
29
+ items
30
+ - Journal sets, transactions, notes, bank feeds, email addresses and account
31
+ locks
32
+ - Capital assets, capital asset types and hire purchases
33
+ - Balance sheet, profit and loss, trial balance, cashflow and final accounts
34
+ reports
35
+ - VAT, corporation tax and self assessment returns, sales tax periods, CIS bands
36
+ and CIS settings
37
+ - Payroll, payroll profiles and properties
38
+ - The accountancy practice API: practice, clients and account managers,
39
+ including the current account manager
40
+ - `subdomain:` on `Client`, and `Client#on_behalf_of`, to act on behalf of a
41
+ practice client
42
+ - `api_version:` on `Client`, sent as the `X-Api-Version` header
43
+ - `logger:` on `Client`
44
+ - `Client#rate_limiter`, which tracks FreeAgent's `Retry-After` after a 429 and
45
+ can wait it out with `wait_if_rate_limited`
46
+ - `enable_rate_limit_test:` on `Client`, to test rate limiting in the sandbox
47
+ - Categories: retrieve, create, update and delete
48
+ - Company: business categories and tax timeline
49
+ - Invoices: timeline and default additional text
50
+ - Estimates: duplicate, convert to invoice and default additional text
51
+ - Timeslips: create several at once, and start and stop timers
52
+ - Bank transaction explanations: update, and list, add, update and delete
53
+ attachments
54
+ - `bank_accounts.list` accepts any query parameters, and `bank_accounts.create`
55
+ defaults `type:` to `StandardBankAccount`
56
+
57
+ ### Fixed
58
+
59
+ - Methods that received a 204 No Content response raised `NoMethodError`
60
+ - IDs were missing for single-digit URLs, and nested URLs got the parent's ID
61
+ - `estimates.mark_as_sent` and `mark_as_draft` requested the wrong URL
62
+ - Upload requests could share the JSON connection and lose their headers
63
+ - Errors without a response body, or with a non-JSON body, now raise with a
64
+ readable message
65
+ - Bank statement uploads are sent as `application/octet-stream`
data/Gemfile CHANGED
@@ -2,11 +2,11 @@
2
2
 
3
3
  source "https://rubygems.org"
4
4
 
5
- # Specify your gem's dependencies in igdbrb.gemspec
5
+ # Specify your gem's dependencies in freeagentrb.gemspec
6
6
  gemspec
7
7
 
8
8
  gem "rake", "~> 13.0"
9
+ gem "minitest", "~> 6.0"
9
10
  gem "dotenv"
10
- gem "minitest", "~> 5.0"
11
- gem "vcr"
11
+ gem "webmock"
12
12
  gem "rubocop-rails-omakase", require: false
data/Gemfile.lock CHANGED
@@ -1,100 +1,117 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- freeagentrb (0.1.4)
5
- faraday (~> 2.11)
4
+ freeagentrb (1.0.0)
5
+ faraday (>= 2.14.3, < 3)
6
6
  faraday-multipart (~> 1.0)
7
- ostruct (~> 0.6.0)
8
7
 
9
8
  GEM
10
9
  remote: https://rubygems.org/
11
10
  specs:
12
- activesupport (8.0.1)
11
+ activesupport (8.1.4.1)
13
12
  base64
14
- benchmark (>= 0.3)
15
13
  bigdecimal
16
14
  concurrent-ruby (~> 1.0, >= 1.3.1)
17
15
  connection_pool (>= 2.2.5)
18
16
  drb
19
17
  i18n (>= 1.6, < 2)
18
+ json
20
19
  logger (>= 1.4.2)
21
20
  minitest (>= 5.1)
22
21
  securerandom (>= 0.3)
23
22
  tzinfo (~> 2.0, >= 2.0.5)
24
23
  uri (>= 0.13.1)
25
- ast (2.4.2)
26
- base64 (0.2.0)
27
- benchmark (0.4.0)
28
- bigdecimal (3.1.9)
29
- concurrent-ruby (1.3.5)
30
- connection_pool (2.5.0)
31
- dotenv (3.1.7)
32
- drb (2.2.1)
33
- faraday (2.12.2)
34
- faraday-net_http (>= 2.0, < 3.5)
24
+ addressable (2.9.2)
25
+ public_suffix (>= 2.0.2, < 8.0)
26
+ ast (2.4.3)
27
+ base64 (0.3.0)
28
+ bigdecimal (4.1.3)
29
+ concurrent-ruby (1.3.8)
30
+ connection_pool (3.0.3)
31
+ crack (1.0.1)
32
+ bigdecimal
33
+ rexml
34
+ dotenv (3.2.0)
35
+ drb (2.2.3)
36
+ faraday (2.15.1)
37
+ faraday-net_http (>= 2.0, < 3.6)
35
38
  json
36
39
  logger
37
- faraday-multipart (1.1.0)
40
+ faraday-multipart (1.2.0)
38
41
  multipart-post (~> 2.0)
39
- faraday-net_http (3.4.0)
40
- net-http (>= 0.5.0)
41
- i18n (1.14.7)
42
+ faraday-net_http (3.5.0)
43
+ net-http (~> 0.5)
44
+ hashdiff (1.2.2)
45
+ i18n (1.15.2)
42
46
  concurrent-ruby (~> 1.0)
43
- json (2.9.1)
44
- language_server-protocol (3.17.0.4)
45
- logger (1.6.5)
46
- minitest (5.25.4)
47
+ json (3.1.0)
48
+ language_server-protocol (3.17.0.6)
49
+ lint_roller (1.1.0)
50
+ logger (1.7.0)
51
+ minitest (6.1.0)
52
+ drb (~> 2.0)
53
+ prism (>= 1.5, < 3)
47
54
  multipart-post (2.4.1)
48
- net-http (0.6.0)
49
- uri
50
- ostruct (0.6.1)
51
- parallel (1.26.3)
52
- parser (3.3.7.0)
55
+ net-http (0.10.0)
56
+ net-protocol (>= 0.3.0)
57
+ uri (>= 0.11.1)
58
+ net-protocol (0.4.0)
59
+ timeout
60
+ parallel (2.3.0)
61
+ parser (3.3.14.0)
53
62
  ast (~> 2.4.1)
54
63
  racc
64
+ prism (2.1.0-x86_64-linux-gnu)
65
+ public_suffix (7.0.5)
55
66
  racc (1.8.1)
56
- rack (3.1.8)
67
+ rack (3.2.8)
57
68
  rainbow (3.1.1)
58
- rake (13.2.1)
59
- regexp_parser (2.10.0)
60
- rubocop (1.71.0)
61
- json (~> 2.3)
62
- language_server-protocol (>= 3.17.0)
63
- parallel (~> 1.10)
69
+ rake (13.4.2)
70
+ regexp_parser (2.13.4)
71
+ rexml (3.4.4)
72
+ rubocop (1.92.3)
73
+ json (>= 2.3)
74
+ language_server-protocol (~> 3.17.0.2)
75
+ lint_roller (~> 1.1.0)
76
+ parallel (>= 1.10)
64
77
  parser (>= 3.3.0.2)
65
78
  rainbow (>= 2.2.2, < 4.0)
66
- regexp_parser (>= 2.9.3, < 3.0)
67
- rubocop-ast (>= 1.36.2, < 2.0)
79
+ regexp_parser (>= 2.11.3, < 3.0)
80
+ rubocop-ast (>= 1.49.0, < 2.0)
68
81
  ruby-progressbar (~> 1.7)
69
82
  unicode-display_width (>= 2.4.0, < 4.0)
70
- rubocop-ast (1.38.0)
71
- parser (>= 3.3.1.0)
72
- rubocop-minitest (0.36.0)
73
- rubocop (>= 1.61, < 2.0)
74
- rubocop-ast (>= 1.31.1, < 2.0)
75
- rubocop-performance (1.23.1)
76
- rubocop (>= 1.48.1, < 2.0)
77
- rubocop-ast (>= 1.31.1, < 2.0)
78
- rubocop-rails (2.29.1)
83
+ rubocop-ast (1.53.0)
84
+ ast (~> 2.4)
85
+ parser (>= 3.3.7.2)
86
+ prism (>= 1.7)
87
+ racc
88
+ rubocop-performance (1.27.0)
89
+ lint_roller (~> 1.1)
90
+ rubocop (>= 1.89.0, < 2.0)
91
+ rubocop-ast (>= 1.47.1, < 2.0)
92
+ rubocop-rails (2.38.0)
79
93
  activesupport (>= 4.2.0)
94
+ lint_roller (~> 1.1)
80
95
  rack (>= 1.1)
81
- rubocop (>= 1.52.0, < 2.0)
82
- rubocop-ast (>= 1.31.1, < 2.0)
83
- rubocop-rails-omakase (1.0.0)
84
- rubocop
85
- rubocop-minitest
86
- rubocop-performance
87
- rubocop-rails
96
+ rubocop (>= 1.89.0, < 2.0)
97
+ rubocop-ast (>= 1.44.0, < 2.0)
98
+ rubocop-rails-omakase (1.1.0)
99
+ rubocop (>= 1.72)
100
+ rubocop-performance (>= 1.24)
101
+ rubocop-rails (>= 2.30)
88
102
  ruby-progressbar (1.13.0)
89
103
  securerandom (0.4.1)
104
+ timeout (0.6.1)
90
105
  tzinfo (2.0.6)
91
106
  concurrent-ruby (~> 1.0)
92
- unicode-display_width (3.1.4)
93
- unicode-emoji (~> 4.0, >= 4.0.4)
94
- unicode-emoji (4.0.4)
95
- uri (1.0.2)
96
- vcr (6.3.1)
97
- base64
107
+ unicode-display_width (3.3.0)
108
+ unicode-emoji (~> 4.3)
109
+ unicode-emoji (4.3.0)
110
+ uri (1.1.2)
111
+ webmock (3.35.0)
112
+ addressable (>= 2.8.0)
113
+ crack (>= 0.3.2)
114
+ hashdiff (>= 0.4.0, < 2.0.0)
98
115
 
99
116
  PLATFORMS
100
117
  x86_64-linux
@@ -102,10 +119,10 @@ PLATFORMS
102
119
  DEPENDENCIES
103
120
  dotenv
104
121
  freeagentrb!
105
- minitest (~> 5.0)
122
+ minitest (~> 6.0)
106
123
  rake (~> 13.0)
107
124
  rubocop-rails-omakase
108
- vcr
125
+ webmock
109
126
 
110
127
  BUNDLED WITH
111
128
  2.6.3