papierkram_api_client 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecc4d14d9a0135d202a4e8b793c39e2e07bc793227805066d58d763b4d0ba83f
-  data.tar.gz: c908db9d494df6eaa1b893eef0b72963c653382294188c2954b279f2135aea2a
+  metadata.gz: c99716d33a07425d28d28395d3f428e2a3b3340faac0d5cf7a3bdd7a6d28cfd9
+  data.tar.gz: ce4b47ad13476cc988f326a337de4e5e5b2e7e90d94346c5cb2b1ec9cca30a21
 SHA512:
-  metadata.gz: 37d01c1402b38859b9cf189f9b40173f5801a553d772111fcaf9e198aa0c5e0b88db1d85ada4ef739e73097c658b305ad2a4940fc9ed5f0050c55cdac0038a1e
-  data.tar.gz: dc0260d1cded8a6a9aa14c415acda652adab27cf70f1764d9726c776923a1d0625243733a3ecfeb845b563534695ce88683afcc2449674ef030d8eb7389f05b3
+  metadata.gz: 0b8bca55f782b372ac64ef98eaa0a0a1c4d70e5ab558e3d123d53b356081550bd1f2e6a82a1d0d12a023dd457323780e673768c3572e8333227369edef2b497b
+  data.tar.gz: 4bc2662091a4a6df9574227a4101929f38dfb6fce877dfe01d5f263ea3707a3c01c307c198cfae51768858e53053343a8b015285e7484f340afd6feea940b8d8

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 
-## [next] - yyyy-mm-dd
+Schema for new entries:
+
+```markdown
+- [#<PR_NUMBER>](https://github.com/simonneutert/papierkram_api_client/pull/<PR_NUMBER>) Description. [@<username>](https://github.com/<username>)
+```
+
+## [0.4.2] - 2024-02-04
+
+- [#114](https://github.com/simonneutert/papierkram_api_client/pull/114) Public API of Papierkram changed, adapt your implementation of `vat_rate` attribute, please. [@simonneutert](https://github.com/simonneutert)
+
+Please see [UPGRADING.md](UPGRADING.md) for more information.
+
+## [0.4.1] - 2024-01-26
 
 - [#111](https://github.com/simonneutert/papierkram_api_client/pull/111) Updates dependencies via bundler. [@simonneutert](https://github.com/simonneutert)
 - [#110](https://github.com/simonneutert/papierkram_api_client/pull/110) Adds debug option to shoot against localhost:3000. [@simonneutert](https://github.com/simonneutert)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    papierkram_api_client (0.4.1)
+    papierkram_api_client (0.4.2)
       faraday (~> 2.7)
       faraday-multipart (= 1.0.4)
       httpx (>= 0.22.5, < 1.3.0)
@@ -25,7 +25,7 @@ GEM
     faraday-net_http (3.0.2)
     hashdiff (1.1.0)
     http-2-next (1.0.3)
-    httpx (1.2.1)
+    httpx (1.2.2)
       http-2-next (>= 1.0.3)
     json (2.7.1)
     language_server-protocol (3.17.0.3)

data/README.md

@@ -2,7 +2,7 @@
 
 [![Ruby](https://github.com/simonneutert/papierkram_api_client/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/simonneutert/papierkram_api_client/actions/workflows/main.yml)
 
-Der erste ~~illegale~~ inoffizielle API Client in [Ruby](https://www.ruby-lang.org/de/) für [Papierkram.de](https://www.papierkram.de) als [Gem](https://rubygems.org/gems/papierkram_api_client) in dein Projekt!
+Der erste ~~illegale~~ inoffizielle API Client in [Ruby](https://www.ruby-lang.org/de/) für [Papierkram.de](https://www.papierkram.de) als [Gem](https://rubygems.org/gems/papierkram_api_client) für dein Projekt!
 
 <div align="center">
   <img src="logo.svg" alt="PAC Logo, Zunge leckt an Karl Klammer und zieht Daten aus dem Papierkram-Account wie Frosch die Fliege vom Teich" width="300">
@@ -158,6 +158,7 @@ Ziele:
 - [Development / Mitentwickeln](#development--mitentwickeln)
   - [Localhost 3000! 🤫](#localhost-3000-)
 - [Contributing](#contributing)
+- [Releasing](#releasing)
 - [License](#license)
 
 ## Installation
@@ -215,6 +216,8 @@ client = PapierkramApi::Client.new('subdomain', "SUPER-LONG-API-KEY")
 
 Oder es werden die Umgebungsvariablen `PAPIERKRAM_API_SUBDOMAIN` und `PAPIERKRAM_API_KEY` gesetzt und der Client ohne Argumente initialisiert.
 
+Ich kann dir wärmstes https://direnv.net/ empfehlen, um die Umgebungsvariablen zu setzen. 🤓
+
 ```ruby
 # usage with environment variables
 client = PapierkramApi::Client.new
@@ -502,13 +505,13 @@ voucher = client.expense_vouchers.create(
     {
       amount: 150.8,
       name: "restaurant bill",
-      vat_rate: "19%",
+      vat_rate: 0.19,
       category: "Bewirtungskosten"
     },
     {
       amount: 15,
       name: "tip",
-      vat_rate: "19%",
+      vat_rate: 0.19,
       category: "Bewirtungskosten"
     }
   ]
@@ -528,7 +531,7 @@ voucher = client.expense_vouchers.update_by(
     {
       amount: 170.8,
       name: "restaurant bill",
-      vat_rate: "19%",
+      vat_rate: 0.19,
       category: "Bewirtungskosten",
       billing: null,
       depreciation: null
@@ -536,7 +539,7 @@ voucher = client.expense_vouchers.update_by(
     {
       amount: 15,
       name: "tip",
-      vat_rate: "19%",
+      vat_rate: 0.19,
       category: "Bewirtungskosten"
     }
   ]
@@ -695,7 +698,7 @@ invoice = client.income_invoices.create(
       description: 'Anlieferung der neuen Möbel',
       quantity: 1.25,
       unit: 'Stunden',
-      vat_rate: '19%',
+      vat_rate: 0.19,
       price: 100
     },
     {
@@ -703,7 +706,7 @@ invoice = client.income_invoices.create(
       description: 'Bestuhlung des Bürogebäudes',
       quantity: 1.25,
       unit: 'Arbeitstage',
-      vat_rate: '19%',
+      vat_rate: 0.19,
       price: 800
     },
     {
@@ -711,7 +714,7 @@ invoice = client.income_invoices.create(
       description: 'Neue Bürostühle',
       quantity: 200,
       unit: 'Stühle',
-      vat_rate: '19%',
+      vat_rate: 0.19,
       price: 125
     }
   ]
@@ -732,7 +735,7 @@ response = client.income_invoices.update_by(
       description: 'Anlieferung der neuen Möbel',
       quantity: 1.5,
       unit: 'Stunden',
-      vat_rate: '19%',
+      vat_rate: 0.19,
       price: 100
     },
     {
@@ -740,7 +743,7 @@ response = client.income_invoices.update_by(
       description: 'Bestuhlung des Bürogebäudes',
       quantity: 1.5,
       unit: 'Arbeitstage',
-      vat_rate: '19%',
+      vat_rate: 0.19,
       price: 800
     },
     {
@@ -748,7 +751,7 @@ response = client.income_invoices.update_by(
       description: 'Neue Bürostühle',
       quantity: 200,
       unit: 'Stühle',
-      vat_rate: '19%',
+      vat_rate: 0.19,
       price: 125
     }
   ]
@@ -866,7 +869,7 @@ proposition = client.income_propositions.create(
   time_unit: 'hour',
   proposition_type: 'service',
   price: '150.0',
-  vat_rate: '19%'
+  vat_rate: 0.19
 )
 puts proposition.headers
 puts proposition.body
@@ -880,7 +883,7 @@ Siehe [Propositions#create](lib/papierkram_api/v1/endpoints/income/propositions.
 client.income_propositions.update_by(
   id: 1,
   name: 'Software design',
-  vat_rate: '19%' # verpflichtend bei Änderung
+  vat_rate: 0.19 # verpflichtend bei Änderung
 )
 ```
 
@@ -1256,14 +1259,37 @@ puts pdf
 
 ## Development / Mitentwickeln
 
+🇬🇧/🇺🇸
+
 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.
 
 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+You need to have at least the following environment variables set to run the tests:
+
+- `MT_COMPAT=true` or `export MT_COMPAT=true` (when in .envrc)
+
+Please, see the [`.envrc.sample`](.envrc.sample) file for more (https://direnv.net/).
+
+🇩🇪
+
+Nachdem du das Repository überprüft hast, führe `bin/setup` aus, um Abhängigkeiten zu installieren. Anschließend führe `rake test` aus, um die Tests durchzuführen. Du kannst auch `bin/console` ausführen, um eine interaktive Konsole zu starten und Experimente durchzuführen.
+
+Um dieses Gem auf deinem lokalen Rechner zu installieren, führe `bundle exec rake install` aus. Um eine neue Version zu veröffentlichen, aktualisiere die Versionsnummer in `version.rb` und führe dann `bundle exec rake release` aus. Dadurch wird ein Git-Tag für die Version erstellt, Git-Commits und das erstellte Tag werden gepusht, und die `.gem`-Datei wird nach [rubygems.org](https://rubygems.org) gepusht.
+
+Um die Tests auszuführen, muss die Umgebungsvariable `MT_COMPAT=true` gesetzt sein.
+
+Bitte, schaue in die Datei [`.envrc.sample`](.envrc.sample) für mehr Details (https://direnv.net/).
+
 ### Localhost 3000! 🤫
 
+Es gibt Menschen da draußen, die können gegen direkt gegen die Papierkram API entwickeln. 🤯  
+Und wie das geht, verrate ich hier allen Lesern! 🤫
+
 `DEBUG_LOCALHOST=true bin/console`
 
+siehe: [test/test_api_v1_client.rb](test/test_api_v1_client.rb)
+
 OR to make it stick:  
 - Set `export DEBUG_LOCALHOST=true` in your `.env` or `.envrc` file.  
 - Enjoy the magic: `bin/setup && bin/console` 🎉
@@ -1280,6 +1306,23 @@ Bitte achte darauf, dass du die Tests ausführst und die Tests dann auch grün s
 
 Wenn du unsicher bist, sprich mich an oder erstelle ein Issue. Ich helfe dir gerne weiter. 🤗
 
+## Releasing
+
+1. checkout `main`
+2. close the changelog
+3. Set the correct/desired version number in `version.rb` and run `bundle install` just for sure
+4. commit if needed
+5. `bundle exec rake release`
+
+After a successful release, the gem is pushed to [rubygems.org](https://rubygems.org/gems/papierkram_api_client).
+
+Here are the steps you need to take after a successful release:
+
+1. edit `lib/papierkram_api_client/version.rb` and bump the version number to the next patch version
+2. run `bundle install`
+3. open the changelog again
+4. commit and push the changes
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/UPGRADING.md

@@ -1,3 +1,48 @@
+## From 0.4.2 onwards
+
+`vat_rate` attribute of line_items, were Strings, like "19%", but the public API of Papierkram changed and expects Floats/Decimals like `0.19`. Please update your code accordingly.
+
+**Create an invoice:**
+
+see [Invoices#create](lib/papierkram_api/v1/endpoints/income/invoices.rb) for possible params.
+
+```ruby
+invoice = client.income_invoices.create(
+  name: 'Neuausstattung des Büros',
+  supply_date: '01.01.2024 - 14.01.2024',
+  document_date: '2024-01-15',
+  payment_term_id: 46,
+  customer_id: 3,
+  project_id: 15,
+  line_items: [
+    {
+      name: 'Anlieferung',
+      description: 'Anlieferung der neuen Möbel',
+      quantity: 1.25,
+      unit: 'Stunden',
+      vat_rate: 0.19, # << here >>
+      price: 100
+    },
+    {
+      name: 'Bestuhlung',
+      description: 'Bestuhlung des Bürogebäudes',
+      quantity: 1.25,
+      unit: 'Arbeitstage',
+      vat_rate: 0.19, # << here >>
+      price: 800
+    },
+    {
+      name: 'Büroartikel',
+      description: 'Neue Bürostühle',
+      quantity: 200,
+      unit: 'Stühle',
+      vat_rate: 0.19, # << here >>
+      price: 125
+    }
+  ]
+)
+```
+
 ## From 0.3 to 0.4
 
 Some endpoints are calling `update` have changed. Instead of `update_by(id: 123, attributes: { ... })` you now use keywords e.g. `update_by(id: 123, name: 'New name')`.

data/lib/papierkram_api/v1/validators/expense_voucher.rb

@@ -68,7 +68,7 @@ module PapierkramApi
               name: 'restaurant bill',
               amount: 150.8,
               category: 'Bewirtungskosten',
-              vat_rate: '19%',
+              vat_rate: 0.19,
               billing: nil,
               depreciation: nil
             },
@@ -76,7 +76,7 @@ module PapierkramApi
               name: 'tip',
               amount: 15,
               category: 'Bewirtungskosten',
-              vat_rate: '19%',
+              vat_rate: 0.19,
               billing: nil,
               depreciation: nil
             }

data/lib/papierkram_api_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papierkram_api_client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Simon Neutert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-26 00:00:00.000000000 Z
+date: 2024-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday