fakturoid 0.5.0 → 1.0.0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -5,6 +7,6 @@ task default: :test
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end

data/fakturoid.gemspec

@@ -1,30 +1,41 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fakturoid/version'
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name          = "fakturoid"
-  s.version       = Fakturoid::VERSION
-  s.authors       = ["Eda Riedl", "Lukáš Konarovský", "Oldřich Vetešník", "Kamil Hanus"]
-  s.email         = ["podpora@fakturoid.cz"]
-  s.summary       = %q{Ruby client for web based invoicing service www.fakturoid.cz}
-  s.description   = %q{Ruby client for web based invoicing service www.fakturoid.cz}
-  s.homepage      = "https://github.com/fakturoid/fakturoid-ruby"
-  s.license       = "MIT"
+require_relative "lib/fakturoid/version"
 
-  s.files         = `git ls-files -z`.split("\x0")
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ["lib"]
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  spec.name          = "fakturoid"
+  spec.version       = Fakturoid::VERSION
+  spec.authors       = ["Eda Riedl", "Lukáš Konarovský", "Oldřich Vetešník", "Kamil Hanus"]
+  spec.email         = ["podpora@fakturoid.cz"]
 
-  s.add_dependency 'multi_json'
-  s.add_dependency 'faraday'
+  spec.summary       = "Ruby client for web based invoicing service www.fakturoid.cz"
+  spec.description   = "Ruby client for web based invoicing service www.fakturoid.cz"
+  spec.homepage      = "https://github.com/fakturoid/fakturoid-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0" # rubocop:disable Gemspec/RequiredRubyVersion
 
-  s.add_development_dependency "bundler", "> 1"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "minitest"
-  s.add_development_dependency "shoulda-context"
-  s.add_development_dependency "mocha"
-  s.add_development_dependency "rubocop"
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fakturoid/fakturoid-ruby"
+  spec.metadata["changelog_uri"]   = "https://github.com/fakturoid/fakturoid-ruby/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "multi_json"
+
+  spec.add_development_dependency "bundler", "> 1"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+  # spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "shoulda-context"
 end

data/lib/fakturoid/api/account.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class Account
+      include Base
+
+      def current
+        perform_request(HTTP_GET, "account.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/bank_account.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class BankAccount
+      include Base
+
+      def all
+        perform_request(HTTP_GET, "bank_accounts.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    module Base
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def perform_request(method, path, params = {})
+        raw_response = client.perform_request(method, path, params)
+        Response.new(raw_response, self.class, method)
+      end
+    end
+  end
+end

data/lib/fakturoid/api/event.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class Event
+      include Base
+
+      INDEX_PARAMS = [:page, :since, :subject_id].freeze
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, *INDEX_PARAMS) || {}
+
+        perform_request(HTTP_GET, "events.json", request_params: request_params)
+      end
+
+      def paid(params = {})
+        request_params = Utils.permit_params(params, *INDEX_PARAMS) || {}
+
+        perform_request(HTTP_GET, "events/paid.json", request_params: request_params)
+      end
+    end
+  end
+end

data/lib/fakturoid/api/expense.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class Expense
+      include Base
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, :since, :updated_since, :page, :subject_id, :custom_id, :number, :variable_symbol, :status) || {}
+
+        perform_request(HTTP_GET, "expenses.json", request_params: request_params)
+      end
+
+      def search(params = {})
+        Utils.validate_search_query(query: params[:query], tags: params[:tags], allow_tags: true)
+
+        request_params = Utils.permit_params(params, :query, :tags, :page)
+
+        perform_request(HTTP_GET, "expenses/search.json", request_params: request_params)
+      end
+
+      def find(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "expenses/#{id}.json")
+      end
+
+      def download_attachment(expense_id, id)
+        Utils.validate_numerical_id(expense_id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "expenses/#{expense_id}/attachments/#{id}/download")
+      end
+
+      def fire(id, event)
+        request_params = { event: event }
+
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_POST, "expenses/#{id}/fire.json", request_params: request_params)
+      end
+
+      def create(payload = {})
+        perform_request(HTTP_POST, "expenses.json", payload: payload)
+      end
+
+      def update(id, payload = {})
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_PATCH, "expenses/#{id}.json", payload: payload)
+      end
+
+      def delete(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "expenses/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/expense_payment.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class ExpensePayment
+      include Base
+
+      def create(expense_id, payload = {})
+        Utils.validate_numerical_id(expense_id)
+        perform_request(HTTP_POST, "expenses/#{expense_id}/payments.json", payload: payload)
+      end
+
+      def delete(expense_id, id)
+        Utils.validate_numerical_id(expense_id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "expenses/#{expense_id}/payments/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class Generator
+      include Base
+
+      INDEX_PARAMS = [:since, :updated_since, :page, :subject_id].freeze
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, *INDEX_PARAMS) || {}
+
+        perform_request(HTTP_GET, "generators.json", request_params: request_params)
+      end
+
+      def find(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "generators/#{id}.json")
+      end
+
+      def create(payload = {})
+        perform_request(HTTP_POST, "generators.json", payload: payload)
+      end
+
+      def update(id, payload = {})
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_PATCH, "generators/#{id}.json", payload: payload)
+      end
+
+      def delete(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "generators/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/inbox_file.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class InboxFile
+      include Base
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, :page)
+
+        perform_request(HTTP_GET, "inbox_files.json", request_params: request_params)
+      end
+
+      def create(payload = {})
+        perform_request(HTTP_POST, "inbox_files.json", payload: payload)
+      end
+
+      def send_to_ocr(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_POST, "inbox_files/#{id}/send_to_ocr.json")
+      end
+
+      def download(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "inbox_files/#{id}/download")
+      end
+
+      def delete(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "inbox_files/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/inventory_item.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class InventoryItem
+      include Base
+
+      INDEX_PARAMS = [:since, :until, :updated_since, :updated_until, :page, :article_number, :sku].freeze
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, *INDEX_PARAMS) || {}
+
+        perform_request(HTTP_GET, "inventory_items.json", request_params: request_params)
+      end
+
+      def archived(params = {})
+        request_params = Utils.permit_params(params, *INDEX_PARAMS) || {}
+
+        perform_request(HTTP_GET, "inventory_items/archived.json", request_params: request_params)
+      end
+
+      def low_quantity(params = {})
+        request_params = Utils.permit_params(params, *INDEX_PARAMS) || {}
+
+        perform_request(HTTP_GET, "inventory_items/low_quantity.json", request_params: request_params)
+      end
+
+      def search(params = {})
+        Utils.validate_search_query(query: params[:query])
+
+        request_params = Utils.permit_params(params, :query, :page)
+
+        perform_request(HTTP_GET, "inventory_items/search.json", request_params: request_params)
+      end
+
+      def find(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "inventory_items/#{id}.json")
+      end
+
+      def create(payload = {})
+        perform_request(HTTP_POST, "inventory_items.json", payload: payload)
+      end
+
+      def update(id, payload = {})
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_PATCH, "inventory_items/#{id}.json", payload: payload)
+      end
+
+      def delete(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "inventory_items/#{id}.json")
+      end
+
+      def archive(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_POST, "inventory_items/#{id}/archive.json")
+      end
+
+      def unarchive(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_POST, "inventory_items/#{id}/unarchive.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/inventory_move.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class InventoryMove
+      include Base
+
+      INDEX_PARAMS = [:since, :until, :updated_since, :updated_until, :page, :inventory_item_id].freeze
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, *INDEX_PARAMS) || {}
+
+        perform_request(HTTP_GET, "inventory_moves.json", request_params: request_params)
+      end
+
+      def find(inventory_item_id, id)
+        Utils.validate_numerical_id(inventory_item_id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "inventory_items/#{inventory_item_id}/inventory_moves/#{id}.json")
+      end
+
+      def create(inventory_item_id, payload = {})
+        Utils.validate_numerical_id(inventory_item_id)
+        perform_request(HTTP_POST, "inventory_items/#{inventory_item_id}/inventory_moves.json", payload: payload)
+      end
+
+      def update(inventory_item_id, id, payload = {})
+        Utils.validate_numerical_id(inventory_item_id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_PATCH, "inventory_items/#{inventory_item_id}/inventory_moves/#{id}.json", payload: payload)
+      end
+
+      def delete(inventory_item_id, id)
+        Utils.validate_numerical_id(inventory_item_id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "inventory_items/#{inventory_item_id}/inventory_moves/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/invoice.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class Invoice
+      include Base
+
+      INDEX_PARAMS = [:since, :until, :updated_since, :updated_until, :page, :subject_id, :custom_id, :number, :status, :document_type].freeze
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, *INDEX_PARAMS) || {}
+
+        perform_request(HTTP_GET, "invoices.json", request_params: request_params)
+      end
+
+      def search(params = {})
+        Utils.validate_search_query(query: params[:query], tags: params[:tags], allow_tags: true)
+
+        request_params = Utils.permit_params(params, :query, :tags, :page)
+
+        perform_request(HTTP_GET, "invoices/search.json", request_params: request_params)
+      end
+
+      def find(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "invoices/#{id}.json")
+      end
+
+      def download_pdf(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "invoices/#{id}/download.pdf", headers: { content_type: "application/pdf" })
+      end
+
+      def download_attachment(invoice_id, id)
+        Utils.validate_numerical_id(invoice_id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "invoices/#{invoice_id}/attachments/#{id}/download")
+      end
+
+      def fire(id, event)
+        request_params = { event: event }
+
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_POST, "invoices/#{id}/fire.json", request_params: request_params)
+      end
+
+      def create(payload = {})
+        perform_request(HTTP_POST, "invoices.json", payload: payload)
+      end
+
+      def update(id, payload = {})
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_PATCH, "invoices/#{id}.json", payload: payload)
+      end
+
+      def delete(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "invoices/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/invoice_message.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class InvoiceMessage
+      include Base
+
+      def create(invoice_id, payload = {})
+        Utils.validate_numerical_id(invoice_id)
+        perform_request(HTTP_POST, "invoices/#{invoice_id}/message.json", payload: payload)
+      end
+    end
+  end
+end

data/lib/fakturoid/api/invoice_payment.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class InvoicePayment
+      include Base
+
+      def create(invoice_id, payload = {})
+        Utils.validate_numerical_id(invoice_id)
+        perform_request(HTTP_POST, "invoices/#{invoice_id}/payments.json", payload: payload)
+      end
+
+      def create_tax_document(invoice_id, id)
+        Utils.validate_numerical_id(invoice_id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_POST, "invoices/#{invoice_id}/payments/#{id}/create_tax_document.json")
+      end
+
+      def delete(invoice_id, id)
+        Utils.validate_numerical_id(invoice_id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "invoices/#{invoice_id}/payments/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/number_format.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class NumberFormat
+      include Base
+
+      def invoices
+        perform_request(HTTP_GET, "number_formats/invoices.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/recurring_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class RecurringGenerator
+      include Base
+
+      INDEX_PARAMS = [:since, :updated_since, :page, :subject_id].freeze
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, *INDEX_PARAMS) || {}
+
+        perform_request(HTTP_GET, "recurring_generators.json", request_params: request_params)
+      end
+
+      def find(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "recurring_generators/#{id}.json")
+      end
+
+      def create(payload = {})
+        perform_request(HTTP_POST, "recurring_generators.json", payload: payload)
+      end
+
+      def update(id, payload = {})
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_PATCH, "recurring_generators/#{id}.json", payload: payload)
+      end
+
+      def delete(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "recurring_generators/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/subject.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class Subject
+      include Base
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, :since, :updated_since, :page, :custom_id) || {}
+
+        perform_request(HTTP_GET, "subjects.json", request_params: request_params)
+      end
+
+      def search(params = {})
+        Utils.validate_search_query(query: params[:query])
+
+        request_params = Utils.permit_params(params, :query, :page)
+
+        perform_request(HTTP_GET, "subjects/search.json", request_params: request_params)
+      end
+
+      def find(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_GET, "subjects/#{id}.json")
+      end
+
+      def create(payload = {})
+        perform_request(HTTP_POST, "subjects.json", payload: payload)
+      end
+
+      def update(id, payload = {})
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_PATCH, "subjects/#{id}.json", payload: payload)
+      end
+
+      def delete(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_DELETE, "subjects/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/todo.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class Todo
+      include Base
+
+      def all(params = {})
+        request_params = Utils.permit_params(params, :page, :since) || {}
+
+        perform_request(HTTP_GET, "todos.json", request_params: request_params)
+      end
+
+      def toggle_completion(id)
+        Utils.validate_numerical_id(id)
+        perform_request(HTTP_POST, "todos/#{id}/toggle_completion.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/api/user.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Api
+    class User
+      include Base
+
+      def current
+        perform_request(HTTP_GET, "user.json", url: client.config.api_endpoint_without_account)
+      end
+
+      def all
+        perform_request(HTTP_GET, "users.json")
+      end
+    end
+  end
+end