papierkram_api_client 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 149edeeed9ee09d36a1c017a9a831eb00dcf347c507d89b37c498bef24ff87f6
-  data.tar.gz: 48e326b8fc0c92af833e8e928daba56ca0b8f9d28e3d2490af07ffad5cf317de
+  metadata.gz: 77097da5dce8525d4a7919296181df43b34d6bf19cb56c200b154dfce3248e48
+  data.tar.gz: 8afcef52acb835ad559c9e8ff8f3ea50c87b463006a4f444428c6cee9cb74615
 SHA512:
-  metadata.gz: fc5b3801503c34095ae1cad9695e78eb749ba8b1c65f2704978bda859640f8e342339aaa1a7b0354a672be2433366bee7436ec6d57b42eaa560216dde9f025e8
-  data.tar.gz: 669678b6e1cc39a506c95ad3d05ab705acbc3ee51f0377ef682ad06b7b1b0daacceb58b8c3da7a9e692f7d7960a7faeac51e2af11c9d79be3d735feb26b31304
+  metadata.gz: 3118ca30193f803e5b200793575e980aaa8999b2fcd03109cb2ad9027dae64b4d8e5f635bf77164e0d90b400727476e0e877d61167f6aa97fa1a143c8765d6ef
+  data.tar.gz: e0c0a77efebb42ceb71dc478e3d4d106783bce3c4d29335ef34a93254a089a5e8453bbe5edd10a1ccfb105bebdae03b9213f7d0ee2c52d155fead33fb8417171

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # Changelog
 
-[0.2.4] - 2023-06-30
+## [0.3.0] - 2023-09-10
 
-#### Fixed
+### Changes (BREAKING! ⚠️)
+
+- [#63](https://github.com/simonneutert/papierkram_api_client/pull/63) Cleaner abstraction for the API client to return a certain item by id. [@simonneutert](https://github.com/simonneutert)
+
+### Added
+
+- [#61](https://github.com/simonneutert/papierkram_api_client/pull/61) Adds ENV to make Minitest pass ([follow Alice](https://github.com/ordinaryzelig/minispec-metadata/pull/18)). [@simonneutert](https://github.com/simonneutert)
+- [#55](https://github.com/simonneutert/papierkram_api_client/pull/55) Adds missing chapter for Transactions. [@simonneutert](https://github.com/simonneutert)
+
+## [0.2.4] - 2023-06-30
+
+### Fixed
 
 - [#48](https://github.com/simonneutert/papierkram_api_client/pull/48) Arguments weren't truly optional when possible. [@simonneutert](https://github.com/simonneutert)
 

data/Gemfile

@@ -5,12 +5,13 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in papierkram_api_client.gemspec
 gemspec
 
-gem 'minitest', '~> 5.18'
+gem 'minitest', '~> 5.17'
 gem 'minitest-vcr', '~> 1.4'
 gem 'pry', '~> 0.14.2'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '~> 1.53', require: false
+gem 'rubocop', '~> 1.56', require: false
 gem 'rubocop-minitest', '~> 0.31.0', require: false
-gem 'rubocop-performance', '~> 1.18', require: false
+gem 'rubocop-performance', '~> 1.19', require: false
 gem 'rubocop-rake', '~> 0.6.0', require: false
 gem 'vcr', '~> 6.2'
+gem 'webmock', '~> 3.19'

data/Gemfile.lock

@@ -1,28 +1,34 @@
 PATH
   remote: .
   specs:
-    papierkram_api_client (0.2.4)
+    papierkram_api_client (0.3.0)
       faraday (~> 2.7)
       httpx (>= 0.22.5, < 0.25.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.1.1)
     coderay (1.1.3)
-    faraday (2.7.7)
+    crack (0.4.5)
+      rexml
+    faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
     http-2-next (0.5.1)
-    httpx (0.24.0)
+    httpx (0.24.4)
       http-2-next (>= 0.4.1)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
     minispec-metadata (2.0.0)
       minitest
-    minitest (5.18.1)
+    minitest (5.20.0)
     minitest-vcr (1.4.0)
       minispec-metadata (~> 2.0)
       minitest (>= 4.7.5)
@@ -34,12 +40,14 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (5.0.3)
     racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.1)
-    rexml (3.2.5)
-    rubocop (1.53.1)
+    rexml (3.2.6)
+    rubocop (1.56.2)
+      base64 (~> 0.1.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -47,14 +55,14 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-minitest (0.31.0)
+    rubocop-minitest (0.31.1)
       rubocop (>= 1.39, < 2.0)
-    rubocop-performance (1.18.0)
+    rubocop-performance (1.19.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
@@ -63,6 +71,10 @@ GEM
     ruby2_keywords (0.0.5)
     unicode-display_width (2.4.2)
     vcr (6.2.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-22
@@ -70,16 +82,17 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  minitest (~> 5.18)
+  minitest (~> 5.17)
   minitest-vcr (~> 1.4)
   papierkram_api_client!
   pry (~> 0.14.2)
   rake (~> 13.0)
-  rubocop (~> 1.53)
+  rubocop (~> 1.56)
   rubocop-minitest (~> 0.31.0)
-  rubocop-performance (~> 1.18)
+  rubocop-performance (~> 1.19)
   rubocop-rake (~> 0.6.0)
   vcr (~> 6.2)
+  webmock (~> 3.19)
 
 BUNDLED WITH
-   2.4.12
+   2.4.19

data/README.md

@@ -10,10 +10,6 @@ Der erste ~~illegale~~ inoffizielle API Client in [Ruby](https://www.ruby-lang.o
 
 ---
 
-Hol mehr aus deinen Daten raus! Dieser Client bietet dir bald einige Features im Bereich [Business Intelligence](#business-intelligence)!
-
----
-
 **WERBUNG** (es ist ein Aufruf zur Mitarbeit 🫠)
 JETZT NEU! Ohne Lack und frei von Glamour!  
 Das Gleiche, nur in grün, also für [NodeJS](https://github.com/simonneutert/papierkram-api-client). Und als Mega-Baustelle 😬
@@ -24,16 +20,16 @@ Das Gleiche, nur in grün, also für [NodeJS](https://github.com/simonneutert/pa
 
 > 🚨 **Bitte beachte**, dass DU UNBEDINGT die Requests/Responses der VCR Cassettes (die ausschliesslich bei Nutzung der Testsuite angelegt werden) von privaten Daten befreien musst, bevor du einen Pull Request erstellst oder einen Commit ins Web lädst! Ich werde die Cassettes auch nochmal durchgehen, bevor ich die Version 1.0.0 veröffentliche. ABER BITTE, BITTE, BITTE, mach das selbst auch! Ich habe keine Lust, dass irgendwelche Daten von dir oder deinen Kunden auf Github landen. Danke! 🙏
 
-Check das [CHANGELOG.md](CHANGELOG.md), Baby!
+Check das [CHANGELOG.md](CHANGELOG.md), Baby!  
+Schau in [UPGRADING.md](UPGRADING.md), 💃🕺!
 
 Hier geht es zu den [offiziellen API Docs](https://demo.papierkram.de/api/v1/api-docs/index.html).  
-Schau bitte dort um alle Rückgabefelder/-werte zu checken, bis ich die Dokumentation hier komplett habe.
+Schau bitte dort um alle Rückgabefelder/-werte zu checken, bis ich (oder du mit deiner Zeit und Hingabe) die Dokumentation hier komplett habe.
 
 ---
 
 ## Aktuell unterstützte Endpunkte der Papierkram API (V1)<!-- omit in toc -->
 
-
 - [x] Banking::BankConnection
 - [x] Banking::BankTransaction
 - [x] Contact::Company (Unternehmen)
@@ -66,6 +62,8 @@ Ziele:
     - [alle Bankverbindungen](#alle-bankverbindungen)
     - [eine Bankverbindung](#eine-bankverbindung)
   - [Banking::Transaction (Kontoumsatz)](#bankingtransaction-kontoumsatz)
+    - [alle Kontoumsätze einer Bankverbindung](#alle-kontoumsätze-einer-bankverbindung)
+    - [einen Kontoumsatz](#einen-kontoumsatz)
   - [Contact::Company (Unternehmen)](#contactcompany-unternehmen)
     - [alle Unternehmen](#alle-unternehmen)
     - [ein Unternehmen](#ein-unternehmen)
@@ -226,7 +224,7 @@ puts bank_connections.body
 #### eine Bankverbindung
 
 ```ruby
-bank_connection = client.banking_bank_connections.by(id: 1)
+bank_connection = client.banking_bank_connections.find_by(id: 1)
 puts bank_connection.headers
 puts bank_connection.body
 ```
@@ -263,9 +261,28 @@ puts bank_connection.body
 
 ### Banking::Transaction (Kontoumsatz)
 
-WORK IN PROGRESS
+Der Endpunkt `/papierkram_api/v1/endpoints/banking/transactions` liefert Informationen über die Kontoumsätze. Die Informationen werden als `Faraday::Response` zurückgegeben.
 
-[Transactions](lib/papierkram_api/v1/endpoints/banking/transactions.rb)
+Siehe [Transactions](lib/papierkram_api/v1/endpoints/banking/transactions.rb) für mögliche Parameter.
+
+#### alle Kontoumsätze einer Bankverbindung
+
+```ruby
+bank_connection_id = 4
+transactions = client.banking_transactions.all(bank_connection_id: bank_connection_id,
+                                               page: 1,
+                                               page_size: 2)
+puts transactions.headers
+puts transactions.body
+```
+
+#### einen Kontoumsatz
+
+```ruby
+transactions = client.banking_transactions.find_by(id: bank_connection_id)
+puts transactions.headers
+puts transactions.body
+```
 
 ### Contact::Company (Unternehmen)
 
@@ -284,7 +301,7 @@ puts companies.body
 #### ein Unternehmen
 
 ```ruby
-company = client.contact_companies.by(id: 1)
+company = client.contact_companies.find_by(id: 1)
 puts company.headers
 puts company.body
 ```
@@ -355,7 +372,7 @@ puts companies.body
 #### eine Kontaktperson (eines Unternehmens)
 
 ```ruby
-company = client.contact_companies_persons.by(company_id: 1, id: 1)
+company = client.contact_companies_persons.find_by(company_id: 1, id: 1)
 puts company.headers
 puts company.body
 ```
@@ -412,7 +429,7 @@ puts vouchers.body
 #### einen Ausgabe Beleg
 
 ```ruby
-voucher = client.expense_vouchers.by(id: 1)
+voucher = client.expense_vouchers.find_by(id: 1)
 puts voucher.headers
 puts voucher.body
 ```
@@ -420,7 +437,7 @@ puts voucher.body
 #### einen Ausgabe Beleg als PDF
 
 ```ruby
-voucher = client.expense_vouchers.by(id: 1, pdf: true)
+voucher = client.expense_vouchers.find_by(id: 1, pdf: true)
 puts PapierkramApi::V1::Helpers::PdfFromResponse.new(voucher).to_pdf
 # => {response: Faraday::Response, path_to_pdf_file: 'path/to/tempfile_pdf.pdf'}
 ```
@@ -442,7 +459,7 @@ puts estimates.body
 #### ein Angebot
 
 ```ruby
-estimate = client.income_estimates.by(id: 1)
+estimate = client.income_estimates.find_by(id: 1)
 puts estimate.headers
 puts estimate.body
 ```
@@ -450,7 +467,7 @@ puts estimate.body
 #### ein Angebot als PDF
 
 ```ruby
-estimate = client.income_estimates.by(id: 1, pdf: true)
+estimate = client.income_estimates.find_by(id: 1, pdf: true)
 puts PapierkramApi::V1::Helpers::PdfFromResponse.new(estimate).to_pdf
 # => {response: Faraday::Response, path_to_pdf_file: 'path/to/tempfile_pdf.pdf'}
 ```
@@ -472,7 +489,7 @@ puts invoices.body
 #### eine Rechnung
 
 ```ruby
-invoice = client.income_invoices.by(id: 1)
+invoice = client.income_invoices.find_by(id: 1)
 puts invoice.headers
 puts invoice.body
 ```
@@ -480,7 +497,7 @@ puts invoice.body
 #### eine Rechnung als PDF
 
 ```ruby
-invoice = client.income_invoices.by(id: 1, pdf: true)
+invoice = client.income_invoices.find_by(id: 1, pdf: true)
 puts PapierkramApi::V1::Helpers::PdfFromResponse.new(invoice).to_pdf
 # => {response: Faraday::Response, path_to_pdf_file: 'path/to/tempfile_pdf.pdf'}
 ```
@@ -502,7 +519,7 @@ puts propositions.body
 #### eine Ware / Dienstleistung
 
 ```ruby
-proposition = client.income_propositions.by(id: 1)
+proposition = client.income_propositions.find_by(id: 1)
 puts proposition.headers
 puts proposition.body
 ```
@@ -586,7 +603,7 @@ puts projects.body
 #### ein Projekt
 
 ```ruby
-project = client.projects.by(id: 1)
+project = client.projects.find_by(id: 1)
 puts project.headers
 puts project.body
 ```
@@ -652,7 +669,7 @@ puts tasks.body
 #### eine Aufgabe
 
 ```ruby
-task = client.tracker_tasks.by(id: 1)
+task = client.tracker_tasks.find_by(id: 1)
 puts task.headers
 puts task.body
 ```
@@ -674,7 +691,7 @@ puts time_entries.body
 #### einen Zeiteintrag
 
 ```ruby
-time_entry = client.tracker_time_entries.by(id: 1)
+time_entry = client.tracker_time_entries.find_by(id: 1)
 puts time_entry.headers
 puts time_entry.body
 ```
@@ -697,6 +714,8 @@ quota = client.info.remaining_quota(response)
 
 ## Business Intelligence
 
+Ich lasse diesen ersten Ausflug in Auswertungen erstmal hier im Gem. Aber sollte ich die Zeit finden und weitere KPIs wichtig finden, dann gehören die Auswertungen eigentlich in ein eigenes Package.
+
 TODO ergänzen wie man `SmartQueries` erstellt und verwendet.  
 TODO ergänzen wie man `SmartQueries` funktioneren.  
 TODO ergänzen wie die Rückgabewerte von `SmartQueries` gestaltet werden sollten.
@@ -787,7 +806,7 @@ Unterstützte Endpunkte sind beispielsweise: `Income::Estimate`, `Income::Invoic
 [Api::V1::Helpers::PdfFromResponse](lib/papierkram_api/v1/helper/pdf_from_response.rb)
 
 ```ruby
-response = client.income_invoices.by(id: 1, pdf: true)
+response = client.income_invoices.find_by(id: 1, pdf: true)
 pdf = PapierkramApi::V1::Helpers::PdfFromResponse.new(response).to_pdf("Rechnung Nummer XXX")
 puts pdf
 ```

data/UPGRADING.md

@@ -0,0 +1,8 @@
+## From 0.2 to 0.3
+
+Finding specific records has changed. Instead of `by(id: 123)` you now use `find_by(id: 123)`.
+
+```ruby
+banking_transaction = client.banking_transactions.find_by(id: 123)
+```
+

data/lib/papierkram_api/v1/business_intelligence/smart_queries/expense_vouchers_for_month_in_year.rb

@@ -24,7 +24,7 @@ module PapierkramApi
 
           def collect_expense_vouchers
             all_expense_vouchers_in_date_range.map do |voucher|
-              @expense_voucher_api.by(id: voucher['id']).body
+              @expense_voucher_api.find_by(id: voucher['id']).body
             end
           end
 
@@ -49,7 +49,7 @@ module PapierkramApi
           end
 
           def expense_voucher(id)
-            @expense_voucher_api.by(id: id)
+            @expense_voucher_api.find_by(id: id)
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/banking/bank_connections.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
+require_relative '../base'
+
 module PapierkramApi
   module V1
     module Endpoints
       module Banking
         # This class is responsible for all the API calls related to banking bank connections.
         class BankConnections < PapierkramApi::V1::Endpoints::Base
-          def by(id:)
-            get("#{@url_api_path}/banking/bank_connections/#{id}")
+          def find_by(id:)
+            http_get("#{@url_api_path}/banking/bank_connections/#{id}")
           end
 
           def all(page: 1,
@@ -21,7 +23,7 @@ module PapierkramApi
             query[:order_by] = order_by if order_by
             query[:order_direction] = order_direction if order_direction
 
-            get("#{@url_api_path}/banking/bank_connections", query)
+            http_get("#{@url_api_path}/banking/bank_connections", query)
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/banking/transactions.rb

@@ -6,8 +6,8 @@ module PapierkramApi
       module Banking
         # This class is responsible for all the API calls related to banking transactions.
         class Transactions < PapierkramApi::V1::Endpoints::Base
-          def by(id:)
-            get("#{@url_api_path}/banking/transactions/#{id}")
+          def find_by(id:)
+            http_get("#{@url_api_path}/banking/transactions/#{id}")
           end
 
           def all(bank_connection_id:,
@@ -23,7 +23,7 @@ module PapierkramApi
             query[:order_by] = order_by if order_by
             query[:order_direction] = order_direction if order_direction
 
-            get("#{@url_api_path}/banking/transactions", query)
+            http_get("#{@url_api_path}/banking/transactions", query)
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/base.rb

@@ -22,24 +22,24 @@ module PapierkramApi
           raise ArgumentError, "No remaining quota found in response: #{response}"
         end
 
-        def get(url, params = {}, headers = {})
+        def http_get(url, params = {}, headers = {})
           validate_get!(params)
           call_wrapper!(:get, url, params, headers)
         end
 
-        def post(url, params = {}, headers = {})
+        def http_post(url, params = {}, headers = {})
           call_wrapper!(:post, url, params, headers)
         end
 
-        def put(url, params = {}, headers = {})
+        def http_put(url, params = {}, headers = {})
           call_wrapper!(:put, url, params, headers)
         end
 
-        def patch(url, params = {}, headers = {})
+        def http_patch(url, params = {}, headers = {})
           call_wrapper!(:patch, url, params, headers)
         end
 
-        def delete(url, params = {}, headers = {})
+        def http_delete(url, params = {}, headers = {})
           call_wrapper!(:delete, url, params, headers)
         end
 

data/lib/papierkram_api/v1/endpoints/contact/companies.rb

@@ -6,8 +6,8 @@ module PapierkramApi
       module Contact
         # This class is responsible for all the API calls related to banking bank connections.
         class Companies < PapierkramApi::V1::Endpoints::Base
-          def by(id:)
-            get("#{@url_api_path}/contact/companies/#{id}")
+          def find_by(id:)
+            http_get("#{@url_api_path}/contact/companies/#{id}")
           end
 
           def all(page: 1,
@@ -21,7 +21,7 @@ module PapierkramApi
             query[:order_by] = order_by if order_by
             query[:order_direction] = order_direction if order_direction
 
-            get("#{@url_api_path}/contact/companies", query)
+            http_get("#{@url_api_path}/contact/companies", query)
           end
 
           def create_supplier( # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
@@ -76,7 +76,7 @@ module PapierkramApi
             body[:notes] = notes if notes
             body[:color] = color if color
 
-            post("#{@url_api_path}/contact/companies", body)
+            http_post("#{@url_api_path}/contact/companies", body)
           end
 
           def create_customer( # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
@@ -131,32 +131,32 @@ module PapierkramApi
             body[:notes] = notes if notes
             body[:color] = color if color
 
-            post("#{@url_api_path}/contact/companies", body)
+            http_post("#{@url_api_path}/contact/companies", body)
           end
 
           def update_by(id:, attributes: {})
             raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
             raise ArgumentError, 'attributes must be a Hash' unless attributes.is_a?(Hash)
 
-            put("#{@url_api_path}/contact/companies/#{id}", attributes)
+            http_put("#{@url_api_path}/contact/companies/#{id}", attributes)
           end
 
           def delete_by(id:)
             raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
 
-            delete("#{@url_api_path}/contact/companies/#{id}")
+            http_delete("#{@url_api_path}/contact/companies/#{id}")
           end
 
           def archive_by(id:)
             raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
 
-            post("#{@url_api_path}/contact/companies/#{id}/archive")
+            http_post("#{@url_api_path}/contact/companies/#{id}/archive")
           end
 
           def unarchive_by(id:)
             raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
 
-            post("#{@url_api_path}/contact/companies/#{id}/unarchive")
+            http_post("#{@url_api_path}/contact/companies/#{id}/unarchive")
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/contact/companies_persons.rb

@@ -6,8 +6,8 @@ module PapierkramApi
       module Contact
         # This class is responsible for all the API calls related to companies' persons connections.
         class CompaniesPersons < PapierkramApi::V1::Endpoints::Base
-          def by(company_id:, id:)
-            get("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}")
+          def find_by(company_id:, id:)
+            http_get("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}")
           end
 
           def all(company_id:, page: 1, page_size: 100, order_by: nil, order_direction: nil)
@@ -19,7 +19,7 @@ module PapierkramApi
             query[:order_by] = order_by if order_by
             query[:order_direction] = order_direction if order_direction
 
-            get("#{@url_api_path}/contact/companies/#{company_id}/persons", query)
+            http_get("#{@url_api_path}/contact/companies/#{company_id}/persons", query)
           end
 
           def create( # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -51,7 +51,7 @@ module PapierkramApi
             body[:skype] = skype if skype
             body[:comment] = comment if comment
 
-            post("#{@url_api_path}/contact/companies/#{company_id}/persons", body)
+            http_post("#{@url_api_path}/contact/companies/#{company_id}/persons", body)
           end
 
           def update_by(company_id:, id:, attributes: {})
@@ -59,14 +59,14 @@ module PapierkramApi
             raise ArgumentError, 'company_id must be an Integer' unless company_id.is_a?(Integer)
             raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
 
-            put("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}", attributes)
+            http_put("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}", attributes)
           end
 
           def delete_by(company_id:, id:)
             raise ArgumentError, 'company_id must be an Integer' unless company_id.is_a?(Integer)
             raise ArgumentError, 'id must be an Integer' unless id.is_a?(Integer)
 
-            delete("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}")
+            http_delete("#{@url_api_path}/contact/companies/#{company_id}/persons/#{id}")
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/expense/vouchers.rb

@@ -6,12 +6,12 @@ module PapierkramApi
       module Expense
         # This class is responsible for all the API calls related to expense vouchers.
         class Vouchers < PapierkramApi::V1::Endpoints::Base
-          def by(id:, pdf: false)
+          def find_by(id:, pdf: false)
             if pdf == true
               return get("#{@url_api_path}/expense/vouchers/#{id}/pdf", nil,
                          { headers: { 'Content-Type' => 'application/pdf' } })
             end
-            get("#{@url_api_path}/expense/vouchers/#{id}")
+            http_get("#{@url_api_path}/expense/vouchers/#{id}")
           end
 
           def all(page: 1, # rubocop:disable Metrics/CyclomaticComplexity
@@ -36,7 +36,7 @@ module PapierkramApi
                 document_date_range_end
             end
 
-            get("#{@url_api_path}/expense/vouchers", query)
+            http_get("#{@url_api_path}/expense/vouchers", query)
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/income/estimates.rb

@@ -6,13 +6,16 @@ module PapierkramApi
       module Income
         # This class is responsible for all the API calls related to income estimates.
         class Estimates < PapierkramApi::V1::Endpoints::Base
-          def by(id:, pdf: false)
+          def find_by(id:, pdf: false)
             if pdf == true
-              return get("#{@url_api_path}/income/estimates/#{id}/pdf", nil,
-                         { headers: { 'Content-Type' => 'application/pdf' } })
+              return http_get(
+                "#{@url_api_path}/income/estimates/#{id}/pdf",
+                nil,
+                { headers: { 'Content-Type' => 'application/pdf' } }
+              )
             end
 
-            get("#{@url_api_path}/income/estimates/#{id}")
+            http_get("#{@url_api_path}/income/estimates/#{id}")
           end
 
           def all(page: 1, # rubocop:disable Metrics/CyclomaticComplexity
@@ -37,7 +40,7 @@ module PapierkramApi
                 document_date_range_end
             end
 
-            get("#{@url_api_path}/income/estimates", query)
+            http_get("#{@url_api_path}/income/estimates", query)
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/income/invoices.rb

@@ -6,13 +6,16 @@ module PapierkramApi
       module Income
         # This class is responsible for all the API calls related to income invoices.
         class Invoices < PapierkramApi::V1::Endpoints::Base
-          def by(id:, pdf: false)
+          def find_by(id:, pdf: false)
             if pdf == true
-              return get("#{@url_api_path}/income/invoices/#{id}/pdf", nil,
-                         { headers: { 'Content-Type' => 'application/pdf' } })
+              return http_get(
+                "#{@url_api_path}/income/invoices/#{id}/pdf",
+                nil,
+                { headers: { 'Content-Type' => 'application/pdf' } }
+              )
             end
 
-            get("#{@url_api_path}/income/invoices/#{id}")
+            http_get("#{@url_api_path}/income/invoices/#{id}")
           end
 
           def all(page: 1, # rubocop:disable Metrics/CyclomaticComplexity
@@ -37,7 +40,7 @@ module PapierkramApi
                 document_date_range_end
             end
 
-            get("#{@url_api_path}/income/invoices", query)
+            http_get("#{@url_api_path}/income/invoices", query)
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/income/propositions.rb

@@ -6,12 +6,12 @@ module PapierkramApi
       module Income
         # This class is responsible for all the API calls related to income propositions.
         class Propositions < PapierkramApi::V1::Endpoints::Base
-          def by(id:)
-            get("#{@url_api_path}/income/propositions/#{id}")
+          def find_by(id:)
+            http_get("#{@url_api_path}/income/propositions/#{id}")
           end
 
           def all
-            get("#{@url_api_path}/income/propositions")
+            http_get("#{@url_api_path}/income/propositions")
           end
 
           def create(
@@ -33,7 +33,7 @@ module PapierkramApi
             body[:price] = price if price
             body[:vat_rate] = vat_rate if vat_rate
 
-            post("#{@url_api_path}/income/propositions", body)
+            http_post("#{@url_api_path}/income/propositions", body)
           end
 
           def update_by(id:, attributes: {})
@@ -41,19 +41,19 @@ module PapierkramApi
               raise ArgumentError, 'vat_rate must be a percentage and include a % sign'
             end
 
-            put("#{@url_api_path}/income/propositions/#{id}", attributes)
+            http_put("#{@url_api_path}/income/propositions/#{id}", attributes)
           end
 
           def delete_by(id:)
-            delete("#{@url_api_path}/income/propositions/#{id}")
+            http_delete("#{@url_api_path}/income/propositions/#{id}")
           end
 
           def archive_by(id:)
-            post("#{@url_api_path}/income/propositions/#{id}/archive")
+            http_post("#{@url_api_path}/income/propositions/#{id}/archive")
           end
 
           def unarchive_by(id:)
-            post("#{@url_api_path}/income/propositions/#{id}/unarchive")
+            http_post("#{@url_api_path}/income/propositions/#{id}/unarchive")
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/info.rb

@@ -6,7 +6,7 @@ module PapierkramApi
       # This class is responsible for all the API calls related to info connections.
       class Info < PapierkramApi::V1::Endpoints::Base
         def details
-          get("#{@url_api_path}/info")
+          http_get("#{@url_api_path}/info")
         end
       end
     end

data/lib/papierkram_api/v1/endpoints/projects.rb

@@ -5,8 +5,8 @@ module PapierkramApi
     module Endpoints
       # This class is responsible for all the API calls related to projects connections.
       class Projects < PapierkramApi::V1::Endpoints::Base
-        def by(id:)
-          get("#{@url_api_path}/projects/#{id}")
+        def find_by(id:)
+          http_get("#{@url_api_path}/projects/#{id}")
         end
 
         def all(page: 1, per_page: 100, order_by: nil, order_direction: nil, company_id: nil)
@@ -18,7 +18,7 @@ module PapierkramApi
           query[:order_direction] = order_direction if order_direction
           query[:company_id] = company_id if company_id
 
-          get("#{@url_api_path}/projects", query)
+          http_get("#{@url_api_path}/projects", query)
         end
 
         def create( # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -52,25 +52,25 @@ module PapierkramApi
           body[:default_proposition] = default_proposition if default_proposition
           body[:team_members] = team_members if team_members
 
-          post("#{@url_api_path}/projects", body)
+          http_post("#{@url_api_path}/projects", body)
         end
 
         def update_by(id:, attributes: {})
           raise ArgumentError, 'attributes must be a Hash' unless attributes.is_a?(Hash)
 
-          put("#{@url_api_path}/projects/#{id}", attributes)
+          http_put("#{@url_api_path}/projects/#{id}", attributes)
         end
 
         def delete_by(id:)
-          delete("#{@url_api_path}/projects/#{id}")
+          http_delete("#{@url_api_path}/projects/#{id}")
         end
 
         def archive_by(id:)
-          post("#{@url_api_path}/projects/#{id}/archive")
+          http_post("#{@url_api_path}/projects/#{id}/archive")
         end
 
         def unarchive_by(id:)
-          post("#{@url_api_path}/projects/#{id}/unarchive")
+          http_post("#{@url_api_path}/projects/#{id}/unarchive")
         end
       end
     end

data/lib/papierkram_api/v1/endpoints/tracker/tasks.rb

@@ -6,8 +6,8 @@ module PapierkramApi
       module Tracker
         # This class is responsible for all the API calls related to tracker tasks connections.
         class Tasks < PapierkramApi::V1::Endpoints::Base
-          def by(id:)
-            get("#{@url_api_path}/tracker/tasks/#{id}")
+          def find_by(id:)
+            http_get("#{@url_api_path}/tracker/tasks/#{id}")
           end
 
           def all(page: 1,
@@ -24,7 +24,7 @@ module PapierkramApi
             query[:order_direction] = order_direction if order_direction
             query[:project_id] = project_id if project_id
             query[:proposition_id] = proposition_id if proposition_id
-            get("#{@url_api_path}/tracker/tasks", query)
+            http_get("#{@url_api_path}/tracker/tasks", query)
           end
         end
       end

data/lib/papierkram_api/v1/endpoints/tracker/time_entries.rb

@@ -6,8 +6,8 @@ module PapierkramApi
       module Tracker
         # This class is responsible for all the API calls related to tracker time entries connections.
         class TimeEntries < PapierkramApi::V1::Endpoints::Base
-          def by(id:)
-            get("#{@url_api_path}/tracker/time_entries/#{id}")
+          def find_by(id:)
+            http_get("#{@url_api_path}/tracker/time_entries/#{id}")
           end
 
           def all(page: 1, # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/ParameterLists
@@ -38,7 +38,8 @@ module PapierkramApi
             query[:billing_state] = billing_state if billing_state
             query[:start_time_range_start] = start_time_range_start if start_time_range_start
             query[:start_time_range_end] = start_time_range_end if start_time_range_end
-            get("#{@url_api_path}/tracker/time_entries", query)
+
+            http_get("#{@url_api_path}/tracker/time_entries", query)
           end
 
           private

data/lib/papierkram_api_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PapierkramApiClient
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papierkram_api_client
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Simon Neutert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-30 00:00:00.000000000 Z
+date: 2023-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -63,6 +63,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- UPGRADING.md
 - lib/papierkram_api/client.rb
 - lib/papierkram_api/v1/business_intelligence/base.rb
 - lib/papierkram_api/v1/business_intelligence/expenses_by_category.rb
@@ -111,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Papierkram API Client