fakturoid 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cae22776ba1f641b53df7971a9fff3638dd72d12cd8b5cdaf9119fe50fe6bbd
-  data.tar.gz: 8f419fd25dfca96f55350b7191b558901066686b13abaec8dbdd24b40edeca6b
+  metadata.gz: 3ef863bf7aae45cfbf91d5c50c8f8b28d6b50aba851fcb2a0478f04364127d60
+  data.tar.gz: bf9e9c5cad8973615dc48e9c76c7e3c6061ad9bef6558725740348c751a201c6
 SHA512:
-  metadata.gz: 0d811acd5330902725beee5c17be2def9ac46a5818669e0a95003603aceca34239f93bbb07bc9d90f57f55aed027f5de2fa0bc5bd04eab3ef232d9f2024e69d5
-  data.tar.gz: 2554b7dd7c746b2eb08ddc3374f70ee5854d0f9e211a8974c96ff663c78032b1314843a8386ef0314bc9c315fdbef0608921b4f2ac2dcf78c59a03cda15f83e9
+  metadata.gz: aec705fea7250afb8fef4cd70ed1b20c472a9510d21122d9cfffaf83b3cd1e32158d55612d34492ce5cef662e07d1738dc0c577c666cb0818a108c1d2c7ef70c
+  data.tar.gz: 9242d93bba87c3c15f479d6c042b26cfae52831ec327105b1f1ecebd6fecadfcb4aeaea98f99c242555b944ddb1797e54ad6cc6ffcf504d7d52c76761dbd076b

data/.github/workflows/rubocop.yml

@@ -0,0 +1,20 @@
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-ruby
+# https://github.com/actions/starter-workflows/blob/main/ci/ruby.yml
+
+name: Rubocop
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+
+      - name: Rubocop
+        run: bundle exec rubocop

data/.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-ruby
+# https://github.com/actions/starter-workflows/blob/main/ci/ruby.yml
+
+name: Tests
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+      # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,35 +1,77 @@
-Metrics/LineLength:
+AllCops:
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+  NewCops: disable
+  Exclude:
+    - 'Rakefile'
+    - 'fakturoid.gemspec'
+    - 'vendor/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
   Enabled: false
 
 Metrics/ClassLength:
   Exclude:
     - 'test/**/*'
 
-Style/AccessModifierIndentation:
+Metrics/BlockLength:
+  Exclude:
+      - 'test/**/*'
+
+Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-Style/CaseIndentation:
+Layout/CaseIndentation:
   IndentOneStep: true
 
 Style/SignalException:
   EnforcedStyle: only_raise
 
-Style/TrailingWhitespace:
+Layout/TrailingWhitespace:
   Enabled: false
 
 Style/ClassAndModuleChildren:
   Exclude:
     - 'test/**/*'
 
-Style/SpaceAroundOperators:
-  MultiSpaceAllowedForOperators:
-    - '<'
-    - '='
+Metrics/PerceivedComplexity:
+  Enabled: false
 
-Documentation:
+Metrics/MethodLength:
   Enabled: false
 
-AllCops:
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/NegatedIf:
   Exclude:
-    - 'Rakefile'
-    - 'fakturoid.gemspec'
+    - 'lib/fakturoid/response.rb'
+
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/fakturoid/api.rb'
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/RescueStandardError:
+  Exclude:
+    - 'test/response_test.rb'
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+3.0.3

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+## 0.4.0
+
+- Fix Faraday v1.x deprecations.
+- Add support for Faraday v2.x.
+- Add support form number formats endpoint
+
+  ```ruby
+  number_formats = Fakturoid::Client::NumberFormat.invoices
+  ```
+
+- Add support for `until`, `updated_until` and `custom_id`
+params to invoice index action methods
+
+  ```ruby
+  invoices = Fakturoid::Client::Invoice.all(since: "2022-03-01T00:00:00+01:00", until: "2022-03-31T23:59:59+01:00")
+  invoices = Fakturoid::Client::Invoice.regular(updated_since: "2022-03-01T00:00:00+01:00", updated_until: "2022-03-31T23:59:59+01:00")
+  proformas = Fakturoid::Client::Invoice.proforma(custom_id: "custom-123")
+  ```
+
+- Add support for `custom_id` param to expense index action method
+
+  ```ruby
+  Fakturoid::Client::Expense.all(custom_id: "custom-123")
+  ```
+
+- Add support for pagination to search endpoints
+
+  ```ruby
+  Fakturoid::Client::Invoice.search("apples", page: 3)
+  Fakturoid::Client::Expense.search("computers", page: 2)
+  Fakturoid::Client::Subject.search("apple", page: 2)
+  ```
+
 ## 0.3.0
 
 - Add support for `variable_symbol` and `bank_account_id` param in invoice `fire` method.

data/Gemfile

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

data/README.md

@@ -1,17 +1,18 @@
 # Fakturoid
 
 The Fakturoid gem is ruby library for API communication with web based invoicing service [www.fakturoid.cz](https://fakturoid.cz).
-Fakturoid [API documentation](http://docs.fakturoid.apiary.io).
+Fakturoid [API documentation](https://fakturoid.docs.apiary.io/).
 
 [![Gem Version](https://badge.fury.io/rb/fakturoid.svg)](http://badge.fury.io/rb/fakturoid)
-[![Circle CI](https://circleci.com/gh/fakturoid/fakturoid-ruby.svg?style=svg)](https://circleci.com/gh/fakturoid/fakturoid-ruby)
+[![Tests](https://github.com/fakturoid/fakturoid-ruby/actions/workflows/tests.yml/badge.svg)](https://github.com/fakturoid/fakturoid-ruby/actions/workflows/tests.yml)
+[![Rubocop](https://github.com/fakturoid/fakturoid-ruby/actions/workflows/rubocop.yml/badge.svg)](https://github.com/fakturoid/fakturoid-ruby/actions/workflows/rubocop.yml)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'fakturoid'
+gem "fakturoid"
 ```
 
 And then run:
@@ -24,10 +25,10 @@ Fakturoid gem is configured within config block placed in `config/initializers/f
 
 ```ruby
 Fakturoid.configure do |config|
-  config.email = 'yourfakturoid@email.com'
-  config.api_key = 'fasdff823fdasWRFKW843ladfjklasdf834'
-  config.account = 'applecorp' # former subdomain (first part of URL)
-  config.user_agent = 'Name of your app (your@email.com)'
+  config.email = "yourfakturoid@email.com"
+  config.api_key = "fasdff823fdasWRFKW843ladfjklasdf834"
+  config.account = "applecorp" # former subdomain (first part of URL)
+  config.user_agent = "Name of your app (your@email.com)"
 end
 ```
 
@@ -35,7 +36,7 @@ end
 
 ### Account resource
 
-To get informations about your account in Fakturoid run following code:
+To get information about your account in Fakturoid run following code:
 
 ```ruby
 response = Fakturoid::Client::Account.current
@@ -46,11 +47,11 @@ response.body # contains hash with returned body
 Accessing content of returned body:
 
 ```ruby
-response.body['name'] # return name of your company
+response.body["name"] # return name of your company
 response.name # alternative way of getting the name of your company
 ```
 
-For the list of all returned account fields see the [Account API documentation](http://docs.fakturoid.apiary.io/#account)
+For the list of all returned account fields see the [Account API documentation](https://fakturoid.docs.apiary.io/#reference/account)
 
 ### User resource
 
@@ -72,7 +73,17 @@ If you want to get information about one user which belongs to account use:
 response = Fakturoid::Client::User.find(user_id)
 ```
 
-For the list of all returned user fields see the [Users API documentation](http://docs.fakturoid.apiary.io/#users)
+For the list of all returned user fields see the [Users API documentation](https://fakturoid.docs.apiary.io/#reference/users)
+
+### Number Format resource
+
+For the list of invoice number formats which belong to the current account:
+
+```ruby
+response = Fakturoid::Client::NumberFormat.invoices
+```
+
+For the list of all returned user fields see the [Number formats API documentation](https://fakturoid.docs.apiary.io/#reference/number-formats)
 
 ### Subject resource
 
@@ -85,7 +96,7 @@ response = Fakturoid::Client::Subject.all(page: 2)
 Fulltext search subjects:
 
 ```ruby
-response = Fakturoid::Client::Subject.search('Client name')
+response = Fakturoid::Client::Subject.search("Client name")
 ```
 
 To find one subject use:
@@ -97,13 +108,13 @@ response = Fakturoid::Client::Subject.find(subject_id)
 You can create new subject with:
 
 ```ruby
-response = Fakturoid::Client::Subject.create(name: 'New client')
+response = Fakturoid::Client::Subject.create(name: "New client")
 ```
 
 To update subject use following code:
 
 ```ruby
-response = Fakturoid::Client::Subject.update(subject_id, name: 'Updated client')
+response = Fakturoid::Client::Subject.update(subject_id, name: "Updated client")
 ```
 
 Delete subject:
@@ -112,7 +123,7 @@ Delete subject:
 Fakturoid::Client::Subject.delete subject_id
 ```
 
-For the list of all subject fields and options see the [Subjects API documentation](http://docs.fakturoid.apiary.io/#subjects)
+For the list of all subject fields and options see the [Subjects API documentation](https://fakturoid.docs.apiary.io/#reference/subjects)
 
 ### Invoice resource
 
@@ -125,7 +136,7 @@ response = Fakturoid::Client::Invoice.all(page: 2)
 Fulltext search invoices:
 
 ```ruby
-response = Fakturoid::Client::Invoice.search('Client name')
+response = Fakturoid::Client::Invoice.search("Client name")
 ```
 
 To find one invoice use:
@@ -139,8 +150,8 @@ To download invoice in PDF format you can use following code:
 ```ruby
 response = Fakturoid::Client::Invoice.download_pdf(invoice_id)
 
-File.open '/path/to/file.pdf', 'w' do |f|
-  f.write response.body
+File.open("/path/to/file.pdf", "wb") do |f|
+  f.write(response.body)
 end
 ```
 
@@ -152,9 +163,9 @@ invoice = {
   lines: [
     {
       quantity: 5,
-      unit_name: 'kg',
-      name: 'Sand',
-      unit_price: '100',
+      unit_name: "kg",
+      name: "Sand",
+      unit_price: "100",
       vat_rate: 21
     }
   ]
@@ -165,16 +176,16 @@ response = Fakturoid::Client::Invoice.create(invoice)
 Invoice actions (eg. pay invoice):
 
 ```ruby
-response = Fakturoid::Client::Invoice.fire(invoice_id, 'pay')
+response = Fakturoid::Client::Invoice.fire(invoice_id, "pay")
 ```
 
-Send invoice with customized message (for more information see [the API Documentation](http://docs.fakturoid.apiary.io/#messages)):
+Send invoice with customized message (for more information see [the API Documentation](https://fakturoid.docs.apiary.io/#reference/messages)):
 
 ```ruby
 message = {
-  email: 'testemail@testemail.cz',
-  email_copy: 'some@emailcopy.cz',
-  subject: 'I have an invoice for you',
+  email: "testemail@testemail.cz",
+  email_copy: "some@emailcopy.cz",
+  subject: "I have an invoice for you",
   message: "Hi,\n\nyou can find invoice no. #no# on the following page #link#\n\nHave a nice day"
 }
 
@@ -185,7 +196,7 @@ response.status_code # => 201
 To update invoice use following code:
 
 ```ruby
-response = Fakturoid::Client::Invoice.update(invoice_id, number: '2015-0015')
+response = Fakturoid::Client::Invoice.update(invoice_id, number: "2015-0015")
 ```
 
 Delete invoice:
@@ -194,7 +205,7 @@ Delete invoice:
 response = Fakturoid::Client::Invoice.delete(invoice_id)
 ```
 
-For the list of all invoice fields and options see the [Invoices API documentation](http://docs.fakturoid.apiary.io/#invoices)
+For the list of all invoice fields and options see the [Invoices API documentation](https://fakturoid.docs.apiary.io/#reference/invoices)
 
 ## Handling error responses
 
@@ -258,6 +269,3 @@ The Fakturoid gem raises exceptions if error response is returned from the serve
     </tr>
   </tbody>
 </table>
-
-## Thanks
-Development was supported by [eBallance Creative s.r.o.](http://www.eballance.cz)

data/lib/fakturoid/api/arguments.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fakturoid
   class Api
     module Arguments
@@ -11,7 +13,7 @@ module Fakturoid
       end
 
       def validate_search_query(query)
-        raise ArgumentError, 'Query parameter is required' if query.nil? || query.empty?
+        raise ArgumentError, "Query parameter is required" if query.nil? || query.empty?
         true
       end
     end

data/lib/fakturoid/api/http_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fakturoid
   class Api
     module HttpMethods

data/lib/fakturoid/api.rb

@@ -1,5 +1,7 @@
-require 'fakturoid/api/arguments'
-require 'fakturoid/api/http_methods'
+# frozen_string_literal: true
+
+require "fakturoid/api/arguments"
+require "fakturoid/api/http_methods"
 
 module Fakturoid
   class Api

data/lib/fakturoid/client/account.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class Account < Fakturoid::Api
       def self.current
-        get_request('account.json')
+        get_request("account.json")
       end
     end
   end

data/lib/fakturoid/client/bank_account.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class BankAccount < Fakturoid::Api
       def self.all
-        get_request('bank_accounts.json')
+        get_request("bank_accounts.json")
       end
     end
   end

data/lib/fakturoid/client/event.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class Event < Fakturoid::Api
       def self.all(params = {})
         request_params = permit_params(params, :page, :since, :subject_id) || {}
 
-        get_request('events.json', request_params: request_params)
+        get_request("events.json", request_params: request_params)
       end
 
       def self.paid(params = {})
         request_params = permit_params(params, :page, :since, :subject_id) || {}
 
-        get_request('events/paid.json', request_params: request_params)
+        get_request("events/paid.json", request_params: request_params)
       end
     end
   end

data/lib/fakturoid/client/expense.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class Expense < Fakturoid::Api
       def self.all(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :number, :variable_symbol, :status, :subject_id) || {}
+        request_params = permit_params(params, :page, :since, :updated_since, :number, :variable_symbol, :status, :subject_id, :custom_id) || {}
 
-        get_request('expenses.json', request_params: request_params)
+        get_request("expenses.json", request_params: request_params)
       end
 
       def self.find(id)
@@ -12,9 +14,13 @@ module Fakturoid
         get_request("expenses/#{id}.json")
       end
 
-      def self.search(query)
+      def self.search(query, params = {})
         validate_search_query(query)
-        get_request('expenses/search.json', request_params: { query: query })
+
+        request_params = permit_params(params, :page)
+        request_params[:query] = query
+
+        get_request("expenses/search.json", request_params: request_params)
       end
 
       def self.fire(id, event, params = {})
@@ -26,7 +32,7 @@ module Fakturoid
       end
 
       def self.create(payload = {})
-        post_request('expenses.json', payload: payload)
+        post_request("expenses.json", payload: payload)
       end
 
       def self.update(id, payload = {})

data/lib/fakturoid/client/generator.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class Generator < Fakturoid::Api
       def self.all(params = {})
         request_params = permit_params(params, :page, :since, :updated_since, :subject_id) || {}
 
-        get_request('generators.json', request_params: request_params)
+        get_request("generators.json", request_params: request_params)
       end
 
       def self.recurring(params = {})
         request_params = permit_params(params, :page, :since, :updated_since, :subject_id) || {}
 
-        get_request('generators/recurring.json', request_params: request_params)
+        get_request("generators/recurring.json", request_params: request_params)
       end
 
       def self.template(params = {})
         request_params = permit_params(params, :page, :since, :updated_since, :subject_id) || {}
 
-        get_request('generators/template.json', request_params: request_params)
+        get_request("generators/template.json", request_params: request_params)
       end
 
       def self.find(id)
@@ -25,7 +27,7 @@ module Fakturoid
       end
 
       def self.create(payload = {})
-        post_request('generators.json', payload: payload)
+        post_request("generators.json", payload: payload)
       end
 
       def self.update(id, payload = {})

data/lib/fakturoid/client/invoice.rb

@@ -1,22 +1,26 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class Invoice < Fakturoid::Api
+      INDEX_PARAMS = [:page, :since, :until, :updated_since, :updated_until, :number, :status, :subject_id, :custom_id].freeze
+
       def self.all(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :number, :status, :subject_id) || {}
+        request_params = permit_params(params, *INDEX_PARAMS) || {}
 
-        get_request('invoices.json', request_params: request_params)
+        get_request("invoices.json", request_params: request_params)
       end
 
       def self.regular(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :number, :status, :subject_id) || {}
+        request_params = permit_params(params, *INDEX_PARAMS) || {}
 
-        get_request('invoices/regular.json', request_params: request_params)
+        get_request("invoices/regular.json", request_params: request_params)
       end
 
       def self.proforma(params = {})
-        request_params = permit_params(params, :page, :since, :updated_since, :number, :status, :subject_id) || {}
+        request_params = permit_params(params, *INDEX_PARAMS) || {}
 
-        get_request('invoices/proforma.json', request_params: request_params)
+        get_request("invoices/proforma.json", request_params: request_params)
       end
 
       def self.find(id)
@@ -24,14 +28,18 @@ module Fakturoid
         get_request("invoices/#{id}.json")
       end
 
-      def self.search(query)
+      def self.search(query, params = {})
         validate_search_query(query)
-        get_request('invoices/search.json', request_params: { query: query })
+
+        request_params = permit_params(params, :page)
+        request_params[:query] = query
+
+        get_request("invoices/search.json", request_params: request_params)
       end
 
       def self.download_pdf(id)
         validate_numerical_id(id)
-        get_request("invoices/#{id}/download.pdf", headers: { content_type: 'application/pdf' })
+        get_request("invoices/#{id}/download.pdf", headers: { content_type: "application/pdf" })
       end
 
       def self.fire(id, event, params = {})
@@ -48,7 +56,7 @@ module Fakturoid
       end
 
       def self.create(payload = {})
-        post_request('invoices.json', payload: payload)
+        post_request("invoices.json", payload: payload)
       end
 
       def self.update(id, payload = {})

data/lib/fakturoid/client/number_format.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Client
+    class NumberFormat < Fakturoid::Api
+      def self.invoices
+        get_request("number_formats/invoices.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/client/subject.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Fakturoid
   module Client
     class Subject < Fakturoid::Api
       def self.all(params = {})
         request_params = permit_params(params, :page, :since, :updated_since, :custom_id) || {}
 
-        get_request('subjects.json', request_params: request_params)
+        get_request("subjects.json", request_params: request_params)
       end
 
       def self.find(id)
@@ -12,13 +14,17 @@ module Fakturoid
         get_request("subjects/#{id}.json")
       end
 
-      def self.search(query)
+      def self.search(query, params = {})
         validate_search_query(query)
-        get_request('subjects/search.json', request_params: { query: query })
+
+        request_params = permit_params(params, :page)
+        request_params[:query] = query
+
+        get_request("subjects/search.json", request_params: request_params)
       end
 
       def self.create(payload = {})
-        post_request('subjects.json', payload: payload)
+        post_request("subjects.json", payload: payload)
       end
 
       def self.update(id, payload = {})