papierkram_api_client 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c711543eff8d01b4052e9de92dc9d3a4f436107c71c9944ab63d5943d28d73a9
-  data.tar.gz: 156999ce0d5031096ee95cf034849bc7f3b7bf29c3321daec47cd75f228391b7
+  metadata.gz: 149edeeed9ee09d36a1c017a9a831eb00dcf347c507d89b37c498bef24ff87f6
+  data.tar.gz: 48e326b8fc0c92af833e8e928daba56ca0b8f9d28e3d2490af07ffad5cf317de
 SHA512:
-  metadata.gz: 0104eda136279d4c82cf0671d1e5c64650f9eeda00a5b26813bd16f85756168747816b68a0a1c576f9a513a10d7e133b99055a9aab75240395ce0cfdc3867f2e
-  data.tar.gz: 377a731d8eaadc2016d264390963fcb995673815a35053c5ee9ee3c1bb83b783a77fda9568db2b15149df69f8c752636521bde07009ee773c46c301dd1fa6b50
+  metadata.gz: fc5b3801503c34095ae1cad9695e78eb749ba8b1c65f2704978bda859640f8e342339aaa1a7b0354a672be2433366bee7436ec6d57b42eaa560216dde9f025e8
+  data.tar.gz: 669678b6e1cc39a506c95ad3d05ab705acbc3ee51f0377ef682ad06b7b1b0daacceb58b8c3da7a9e692f7d7960a7faeac51e2af11c9d79be3d735feb26b31304

data/.rubocop.yml

@@ -33,6 +33,7 @@ Metrics/ParameterLists:
     - "lib/api/v1/**/*"
 
 Metrics/ClassLength:
+  Max: 150
   CountAsOne:
     - "array"
     - "hash"

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+[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)
+
+[0.2.3] - 2023-06-29
+
+### Added
+
+- [#47](https://github.com/simonneutert/papierkram_api_client/pull/47) Adds CRUD endpoint support for income propositions. [@simonneutert](https://github.com/simonneutert)
+- [#46](https://github.com/simonneutert/papierkram_api_client/pull/46) Adds CRUD endpoint support for projects. [@simonneutert](https://github.com/simonneutert)
+- [#45](https://github.com/simonneutert/papierkram_api_client/pull/45) Adds CRUD endpoint support for contact companies persons. [@simonneutert](https://github.com/simonneutert)
+
 ## [0.2.2] - 2023-06-28
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    papierkram_api_client (0.2.2)
+    papierkram_api_client (0.2.4)
       faraday (~> 2.7)
       httpx (>= 0.22.5, < 0.25.0)
 

data/README.md

@@ -77,6 +77,9 @@ Ziele:
   - [Contact::Company (Kontaktperson eines Unternehmens)](#contactcompany-kontaktperson-eines-unternehmens)
     - [alle Kontaktpersonen (eines Unternehmens)](#alle-kontaktpersonen-eines-unternehmens)
     - [eine Kontaktperson (eines Unternehmens)](#eine-kontaktperson-eines-unternehmens)
+    - [erstelle eine Kontaktperson (eines Unternehmens)](#erstelle-eine-kontaktperson-eines-unternehmens)
+    - [aktualisiere eine Kontaktperson (eines Unternehmens)](#aktualisiere-eine-kontaktperson-eines-unternehmens)
+    - [lösche eine Kontaktperson (eines Unternehmens)](#lösche-eine-kontaktperson-eines-unternehmens)
   - [Expense::Voucher (Ausgabe Beleg)](#expensevoucher-ausgabe-beleg)
     - [alle Ausgabe Belege](#alle-ausgabe-belege)
     - [einen Ausgabe Beleg](#einen-ausgabe-beleg)
@@ -92,10 +95,20 @@ Ziele:
   - [Income::Proposition (Waren / Dienstleistungen)](#incomeproposition-waren--dienstleistungen)
     - [alle Waren / Dienstleistungen](#alle-waren--dienstleistungen)
     - [eine Ware / Dienstleistung](#eine-ware--dienstleistung)
+    - [eine Ware / Dienstleistung erstellen](#eine-ware--dienstleistung-erstellen)
+    - [eine Ware / Dienstleistung aktualisieren](#eine-ware--dienstleistung-aktualisieren)
+    - [eine Ware / Dienstleistung löschen](#eine-ware--dienstleistung-löschen)
+    - [eine Ware / Dienstleistung archivieren](#eine-ware--dienstleistung-archivieren)
+    - [eine Ware / Dienstleistung unarchivieren](#eine-ware--dienstleistung-unarchivieren)
   - [Info](#info)
   - [Project::Project (Projekt)](#projectproject-projekt)
     - [alle Projekte](#alle-projekte)
     - [ein Projekt](#ein-projekt)
+    - [erstelle ein Projekt](#erstelle-ein-projekt)
+    - [aktualisiere ein Projekt](#aktualisiere-ein-projekt)
+    - [lösche ein Projekt](#lösche-ein-projekt)
+    - [archiviere ein Projekt](#archiviere-ein-projekt)
+    - [unarchiviere ein Projekt](#unarchiviere-ein-projekt)
   - [Tracker::Task (Aufgabe)](#trackertask-aufgabe)
     - [alle Aufgaben](#alle-aufgaben)
     - [eine Aufgabe](#eine-aufgabe)
@@ -347,6 +360,41 @@ puts company.headers
 puts company.body
 ```
 
+#### erstelle eine Kontaktperson (eines Unternehmens)
+
+```ruby
+company = client.contact_companies_persons.create(
+  company_id: 1, 
+  attributes: { 
+    first_name: 'Max',
+    last_name: 'Mustermann'
+  }
+)
+puts company.headers
+puts company.body
+```
+
+Siehe [CompaniesPersons#create](lib/papierkram_api/v1/endpoints/contact/companies_persons.rb) für mögliche Parameter.
+
+#### aktualisiere eine Kontaktperson (eines Unternehmens)
+
+```ruby
+company = client.contact_companies_persons
+                .update_by(company_id: 1, id: 1, attributes: { first_name: 'Moritz' })
+puts company.headers
+puts company.body
+```
+
+Siehe [CompaniesPersons#update_by](lib/papierkram_api/v1/endpoints/contact/companies_persons.rb) für mögliche Parameter.
+
+#### lösche eine Kontaktperson (eines Unternehmens)
+
+```ruby
+company = client.contact_companies_persons.delete_by(company_id: 1, id: 1)
+puts company.headers
+puts company.body
+```
+
 ### Expense::Voucher (Ausgabe Beleg)
 
 Der Endpunkt `/papierkram_api/v1/endpoints/expense/vouchers` liefert Informationen über die Ausgabe Belege. Die Informationen werden als `Faraday::Response` zurückgegeben.
@@ -459,6 +507,56 @@ puts proposition.headers
 puts proposition.body
 ```
 
+#### eine Ware / Dienstleistung erstellen
+
+```ruby
+proposition = client.income_propositions.create(
+  name: 'Software design',
+  article_no: '12345',
+  description: 'Here, we can describe what "Software design" actually entails.',
+  time_unit: 'hour',
+  proposition_type: 'service',
+  price: '150.0',
+  vat_rate: '19%'
+)
+puts proposition.headers
+puts proposition.body
+```
+
+Siehe [Propositions#create](lib/papierkram_api/v1/endpoints/income/propositions.rb) für mögliche Parameter.
+
+#### eine Ware / Dienstleistung aktualisieren
+
+```ruby
+client.income_propositions.update_by(
+  id: 1,
+  attributes: {
+    name: 'Software design',
+    vat_rate: '19%' # verpflichtend bei Änderung
+  }
+)
+```
+
+Siehe [Propositions#update_by](lib/papierkram_api/v1/endpoints/income/propositions.rb) für mögliche Parameter.
+
+#### eine Ware / Dienstleistung löschen
+
+```ruby
+client.income_propositions.delete_by(id: 1)
+```
+
+#### eine Ware / Dienstleistung archivieren
+
+```ruby
+client.income_propositions.archive_by(id: 1)
+```
+
+#### eine Ware / Dienstleistung unarchivieren
+
+```ruby
+client.income_propositions.unarchive_by(id: 1)
+```
+
 ### Info
 
 Der Endpunkt `lib/papierkram_api/v1/endpoints/info.rb` liefert Informationen über die API. Die Informationen werden als `Faraday::Response` zurückgegeben.
@@ -493,6 +591,50 @@ puts project.headers
 puts project.body
 ```
 
+#### erstelle ein Projekt
+
+```ruby
+project = client.projects.create(name: 'Projekt 1')
+puts project.headers
+puts project.body
+```
+
+Siehe [Projects](lib/papierkram_api/v1/endpoints/projects.rb) für mögliche Parameter.
+
+#### aktualisiere ein Projekt
+
+```ruby
+project = client.projects.update_by(id: 1, attributes: { name: 'Projekt 2' })
+puts project.headers
+puts project.body
+```
+
+Siehe [Projects](lib/papierkram_api/v1/endpoints/projects.rb) für mögliche Parameter.
+
+#### lösche ein Projekt
+
+```ruby
+project = client.projects.delete_by(id: 1)
+puts project.headers
+puts project.body
+```
+
+#### archiviere ein Projekt
+
+```ruby
+project = client.projects.archive_by(id: 1)
+puts project.headers
+puts project.body
+```
+
+#### unarchiviere ein Projekt
+
+```ruby
+project = client.projects.unarchive_by(id: 1)
+puts project.headers
+puts project.body
+```
+
 ### Tracker::Task (Aufgabe)
 
 Der Endpunkt `/papierkram_api/v1/tracker/tasks` liefert Informationen über die Aufgaben. Die Informationen werden als `Faraday::Response` zurückgegeben.

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

@@ -24,7 +24,7 @@ module PapierkramApi
             get("#{@url_api_path}/contact/companies", query)
           end
 
-          def create_supplier( # rubocop:disable Metrics/ParameterLists
+          def create_supplier( # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
             name:,
             phone: nil,
             fax: nil,
@@ -50,37 +50,36 @@ module PapierkramApi
             color: nil
           )
 
-            body = {
-              contact_type: :supplier,
-              name: name,
-              phone: phone,
-              fax: fax,
-              email: email,
-              delivery_method: delivery_method,
-              ust_idnr: ust_idnr,
-              website: website,
-              twitter: twitter,
-              postal_street: postal_street,
-              postal_city: postal_city,
-              postal_zip: postal_zip,
-              postal_country: postal_country,
-              physical_street: physical_street,
-              physical_city: physical_city,
-              physical_zip: physical_zip,
-              physical_country: physical_country,
-              bank_blz: bank_blz,
-              bank_institute: bank_institute,
-              bank_account_no: bank_account_no,
-              bank_bic: bank_bic,
-              bank_iban: bank_iban,
-              notes: notes,
-              color: color
-            }
+            body = {}
+            body[:contact_type] = 'supplier'
+            body[:name] = name
+            body[:phone] = phone if phone
+            body[:fax] = fax if fax
+            body[:email] = email if email
+            body[:delivery_method] = delivery_method if delivery_method
+            body[:ust_idnr] = ust_idnr if ust_idnr
+            body[:website] = website if website
+            body[:twitter] = twitter if twitter
+            body[:postal_street] = postal_street if postal_street
+            body[:postal_city] = postal_city if postal_city
+            body[:postal_zip] = postal_zip if postal_zip
+            body[:postal_country] = postal_country if postal_country
+            body[:physical_street] = physical_street if physical_street
+            body[:physical_city] = physical_city if physical_city
+            body[:physical_zip] = physical_zip if physical_zip
+            body[:physical_country] = physical_country if physical_country
+            body[:bank_blz] = bank_blz if bank_blz
+            body[:bank_institute] = bank_institute if bank_institute
+            body[:bank_account_no] = bank_account_no if bank_account_no
+            body[:bank_bic] = bank_bic if bank_bic
+            body[:bank_iban] = bank_iban if bank_iban
+            body[:notes] = notes if notes
+            body[:color] = color if color
 
             post("#{@url_api_path}/contact/companies", body)
           end
 
-          def create_customer( # rubocop:disable Metrics/ParameterLists
+          def create_customer( # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
             name:,
             phone: nil,
             fax: nil,
@@ -106,32 +105,31 @@ module PapierkramApi
             color: nil
           )
 
-            body = {
-              contact_type: :customer,
-              name: name,
-              phone: phone,
-              fax: fax,
-              email: email,
-              delivery_method: delivery_method,
-              ust_idnr: ust_idnr,
-              website: website,
-              twitter: twitter,
-              postal_street: postal_street,
-              postal_city: postal_city,
-              postal_zip: postal_zip,
-              postal_country: postal_country,
-              physical_street: physical_street,
-              physical_city: physical_city,
-              physical_zip: physical_zip,
-              physical_country: physical_country,
-              bank_blz: bank_blz,
-              bank_institute: bank_institute,
-              bank_account_no: bank_account_no,
-              bank_bic: bank_bic,
-              bank_iban: bank_iban,
-              notes: notes,
-              color: color
-            }
+            body = {}
+            body[:contact_type] = 'customer'
+            body[:name] = name
+            body[:phone] = phone if phone
+            body[:fax] = fax if fax
+            body[:email] = email if email
+            body[:delivery_method] = delivery_method if delivery_method
+            body[:ust_idnr] = ust_idnr if ust_idnr
+            body[:website] = website if website
+            body[:twitter] = twitter if twitter
+            body[:postal_street] = postal_street if postal_street
+            body[:postal_city] = postal_city if postal_city
+            body[:postal_zip] = postal_zip if postal_zip
+            body[:postal_country] = postal_country if postal_country
+            body[:physical_street] = physical_street if physical_street
+            body[:physical_city] = physical_city if physical_city
+            body[:physical_zip] = physical_zip if physical_zip
+            body[:physical_country] = physical_country if physical_country
+            body[:bank_blz] = bank_blz if bank_blz
+            body[:bank_institute] = bank_institute if bank_institute
+            body[:bank_account_no] = bank_account_no if bank_account_no
+            body[:bank_bic] = bank_bic if bank_bic
+            body[:bank_iban] = bank_iban if bank_iban
+            body[:notes] = notes if notes
+            body[:color] = color if color
 
             post("#{@url_api_path}/contact/companies", body)
           end

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

@@ -21,6 +21,53 @@ module PapierkramApi
 
             get("#{@url_api_path}/contact/companies/#{company_id}/persons", query)
           end
+
+          def create( # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+            company_id:,
+            first_name:,
+            last_name:,
+            title: nil,
+            salutation: nil,
+            position: nil,
+            department: nil,
+            email: nil,
+            phone: nil,
+            mobile: nil,
+            fax: nil,
+            skype: nil,
+            comment: nil
+          )
+            body = {}
+            body[:first_name] = first_name
+            body[:last_name] = last_name
+            body[:title] = title if title
+            body[:salutation] = salutation if salutation
+            body[:position] = position if position
+            body[:department] = department if department
+            body[:email] = email if email
+            body[:phone] = phone if phone
+            body[:mobile] = mobile if mobile
+            body[:fax] = fax if fax
+            body[:skype] = skype if skype
+            body[:comment] = comment if comment
+
+            post("#{@url_api_path}/contact/companies/#{company_id}/persons", body)
+          end
+
+          def update_by(company_id:, id:, attributes: {})
+            raise ArgumentError, 'attributes must be a Hash' unless attributes.is_a?(Hash)
+            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)
+          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}")
+          end
         end
       end
     end

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

@@ -13,6 +13,48 @@ module PapierkramApi
           def all
             get("#{@url_api_path}/income/propositions")
           end
+
+          def create(
+            name:,
+            article_no:,
+            description: nil,
+            time_unit: nil,
+            proposition_type: nil,
+            price: nil,
+            vat_rate: nil
+          )
+
+            body = {}
+            body[:name] = name
+            body[:article_no] = article_no
+            body[:description] = description if description
+            body[:time_unit] = time_unit if time_unit
+            body[:proposition_type] = proposition_type if proposition_type
+            body[:price] = price if price
+            body[:vat_rate] = vat_rate if vat_rate
+
+            post("#{@url_api_path}/income/propositions", body)
+          end
+
+          def update_by(id:, attributes: {})
+            if attributes[:vat_rate] && (attributes[:vat_rate].empty? || !attributes[:vat_rate].include?('%'))
+              raise ArgumentError, 'vat_rate must be a percentage and include a % sign'
+            end
+
+            put("#{@url_api_path}/income/propositions/#{id}", attributes)
+          end
+
+          def delete_by(id:)
+            delete("#{@url_api_path}/income/propositions/#{id}")
+          end
+
+          def archive_by(id:)
+            post("#{@url_api_path}/income/propositions/#{id}/archive")
+          end
+
+          def unarchive_by(id:)
+            post("#{@url_api_path}/income/propositions/#{id}/unarchive")
+          end
         end
       end
     end

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

@@ -20,6 +20,58 @@ module PapierkramApi
 
           get("#{@url_api_path}/projects", query)
         end
+
+        def create( # rubocop:disable Metrics/ParameterLists, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          name:,
+          customer_id:,
+          description: nil,
+          start_date: nil,
+          end_date: nil,
+          flagged: nil,
+          budget_type: nil,
+          budget_money: nil,
+          budget_time: nil,
+          budget_time_unit: nil,
+          color: nil,
+          default_proposition: nil,
+          team_members: nil
+        )
+
+          body = {}
+          body[:name] = name
+          body[:customer] = { id: customer_id }
+          body[:description] = description if description
+          body[:start_date] = start_date if start_date
+          body[:end_date] = end_date if end_date
+          body[:flagged] = flagged if flagged
+          body[:budget_type] = budget_type if budget_type
+          body[:budget_money] = budget_money if budget_money
+          body[:budget_time] = budget_time if budget_time
+          body[:budget_time_unit] = budget_time_unit if budget_time_unit
+          body[:color] = color if color
+          body[:default_proposition] = default_proposition if default_proposition
+          body[:team_members] = team_members if team_members
+
+          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)
+        end
+
+        def delete_by(id:)
+          delete("#{@url_api_path}/projects/#{id}")
+        end
+
+        def archive_by(id:)
+          post("#{@url_api_path}/projects/#{id}/archive")
+        end
+
+        def unarchive_by(id:)
+          post("#{@url_api_path}/projects/#{id}/unarchive")
+        end
       end
     end
   end

data/lib/papierkram_api_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papierkram_api_client
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Simon Neutert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday