fakturoid 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ef863bf7aae45cfbf91d5c50c8f8b28d6b50aba851fcb2a0478f04364127d60
-  data.tar.gz: bf9e9c5cad8973615dc48e9c76c7e3c6061ad9bef6558725740348c751a201c6
+  metadata.gz: e0bd9fc1b14ec03436ce4475e0a3c07a3c1bf5a4c6bb2f0feb0f9f311b2552b6
+  data.tar.gz: c66ecd117726d0e857949499d1a2562f7637645ae477b154715ed33580f3a4b6
 SHA512:
-  metadata.gz: aec705fea7250afb8fef4cd70ed1b20c472a9510d21122d9cfffaf83b3cd1e32158d55612d34492ce5cef662e07d1738dc0c577c666cb0818a108c1d2c7ef70c
-  data.tar.gz: 9242d93bba87c3c15f479d6c042b26cfae52831ec327105b1f1ecebd6fecadfcb4aeaea98f99c242555b944ddb1797e54ad6cc6ffcf504d7d52c76761dbd076b
+  metadata.gz: affec1b4c502b6689af925a8944868a444e3d47e00e575c9ec63f45ca98f56a6c72c68771432527153ba3f0b799add0c32fabed54bf6f5fd0fb1f48ceeac152f
+  data.tar.gz: fbbcea0fd540d7ece9b88237749d3c2b50218bd5320daaf21dc543c0bc2adabe389229e190f8ca09a712db98d09f5ef02816298ee7c87c914b5f74174c551f5f

data/.github/workflows/rubocop.yml

@@ -8,12 +8,12 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.0
           bundler-cache: true
 
       - name: Rubocop

data/.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
         ruby-version: ['2.6', '2.7', '3.0']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Set up Ruby
       # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
   SuggestExtensions: false
   NewCops: disable
   Exclude:
@@ -63,6 +63,9 @@ Layout/EmptyLineAfterGuardClause:
 Layout/EmptyLineBetweenDefs:
   Enabled: false
 
+Style/HashSyntax:
+  Enabled: false
+
 Style/RescueStandardError:
   Exclude:
     - 'test/response_test.rb'

data/.ruby-version

@@ -1 +1 @@
-3.0.3
+3.2.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.0
+
+- Add support for inventory items and moves.
+
 ## 0.4.0
 
 - Fix Faraday v1.x deprecations.

data/README.md

@@ -207,6 +207,140 @@ response = Fakturoid::Client::Invoice.delete(invoice_id)
 
 For the list of all invoice fields and options see the [Invoices API documentation](https://fakturoid.docs.apiary.io/#reference/invoices)
 
+### InventoryItem resource
+
+To get all inventory items:
+
+```ruby
+response = Fakturoid::Client::InventoryItems.all
+```
+
+To filter inventory items by certain SKU code:
+
+```ruby
+response = Fakturoid::Client::InventoryItems.all(sku: 'SKU1234')
+```
+
+To search inventory items (searches in `name`, `article_number` and `sku`):
+
+```ruby
+response = Fakturoid::Client::InventoryItems.search('Item name')
+```
+
+To get all archived inventory items:
+
+```ruby
+response = Fakturoid::Client::InventoryItems.archived
+```
+
+To get a single inventory item:
+
+```ruby
+response = Fakturoid::Client::InventoryItems.find(inventory_item_id)
+```
+
+To create an inventory item:
+
+```ruby
+inventory_item = {
+  name: "Item name",
+  sku: "SKU1234",
+  track_quantity: true,
+  quantity: 100,
+  native_purchase_price: 500,
+  native_retail_price: 1000
+}
+response = Fakturoid::Client::InventoryItems.create(inventory_item)
+```
+
+To update an inventory item:
+
+```ruby
+response = Fakturoid::Client::InventoryItems.update(inventory_item_id, name: "Another name")
+```
+
+To archive an inventory item:
+
+```ruby
+response = Fakturoid::Client::InventoryItems.archive(inventory_item_id)
+```
+
+To unarchive an inventory item:
+
+```ruby
+response = Fakturoid::Client::InventoryItems.unarchive(inventory_item_id)
+```
+
+To delete an inventory item:
+
+```ruby
+response = Fakturoid::Client::InventoryItems.delete(inventory_item_id)
+```
+
+### InventoryMove resource
+
+To get get all inventory moves across all inventory items:
+
+```ruby
+response = Fakturoid::Client::InventoryMoves.all
+```
+
+To get inventory moves for a single inventory item:
+
+```ruby
+response = Fakturoid::Client::InventoryMoves.all(inventory_item_id: inventory_item_id)
+```
+
+To get a single inventory move:
+
+```ruby
+response = Fakturoid::Client::InventoryMoves.find(inventory_item_id, inventory_move_id)
+```
+
+To create a stock-in inventory move:
+
+```ruby
+response = Fakturoid::Client::InventoryMoves.create(
+  inventory_item_id,
+  direction: "in",
+  moved_on: Date.today,
+  quantity_change: 5,
+  purchase_price: "249.99",
+  purchase_currency: "CZK",
+  private_note: "Bought with discount"
+)
+```
+
+To create a stock-out inventory move:
+
+```ruby
+response = Fakturoid::Client::InventoryMoves.create(
+  inventory_item_id,
+  direction: "out",
+  moved_on: Date.today,
+  quantity_change: "1.5",
+  retail_price: 50,
+  retail_currency: "EUR",
+  native_retail_price: "1250"
+)
+```
+
+To update an inventory move:
+
+```ruby
+inventory_move = {
+  private_note: "Text"
+  # Plus other fields if necessary
+}
+response = Fakturoid::Client::InventoryMoves.update(inventory_item_id, inventory_move_id, inventory_move)
+```
+
+To delete an inventory move:
+
+```ruby
+response = Fakturoid::Client::InventoryMoves.delete(inventory_item_id, inventory_move_id)
+```
+
 ## Handling error responses
 
 The Fakturoid gem raises exceptions if error response is returned from the servers. All exceptions contains following attributes:

data/fakturoid.gemspec

@@ -6,7 +6,7 @@ require 'fakturoid/version'
 Gem::Specification.new do |s|
   s.name          = "fakturoid"
   s.version       = Fakturoid::VERSION
-  s.authors       = ["Eda Riedl", "Lukáš Konarovský", "Oldřich Vetešník"]
+  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}

data/lib/fakturoid/client/inventory_items.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Client
+    class InventoryItems < Fakturoid::Api
+      INDEX_PARAMS = [:page, :since, :updated_since, :article_number, :sku].freeze
+
+      def self.all(params = {})
+        request_params = permit_params(params, *INDEX_PARAMS) || {}
+
+        get_request("inventory_items.json", request_params: request_params)
+      end
+
+      def self.archived(params = {})
+        request_params = permit_params(params, *INDEX_PARAMS) || {}
+
+        get_request("inventory_items/archived.json", request_params: request_params)
+      end
+
+      def self.find(id)
+        validate_numerical_id(id)
+        get_request("inventory_items/#{id}.json")
+      end
+
+      def self.search(query, params = {})
+        validate_search_query(query)
+
+        request_params = permit_params(params, :page)
+        request_params[:query] = query
+
+        get_request("inventory_items/search.json", request_params: request_params)
+      end
+
+      def self.archive(id)
+        validate_numerical_id(id)
+        post_request("inventory_items/#{id}/archive.json")
+      end
+
+      def self.unarchive(id)
+        validate_numerical_id(id)
+        post_request("inventory_items/#{id}/unarchive.json")
+      end
+
+      def self.create(payload = {})
+        post_request("inventory_items.json", payload: payload)
+      end
+
+      def self.update(id, payload = {})
+        validate_numerical_id(id)
+        patch_request("inventory_items/#{id}.json", payload: payload)
+      end
+
+      def self.delete(id)
+        validate_numerical_id(id)
+        delete_request("inventory_items/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/client/inventory_moves.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Fakturoid
+  module Client
+    class InventoryMoves < Fakturoid::Api
+      def self.all(params = {})
+        request_params = permit_params(params, :page, :since, :updated_since, :inventory_item_id) || {}
+
+        get_request("inventory_moves.json", request_params: request_params)
+      end
+
+      def self.find(inventory_item_id, id)
+        validate_numerical_id(inventory_item_id)
+        validate_numerical_id(id)
+        get_request("inventory_items/#{inventory_item_id}/inventory_moves/#{id}.json")
+      end
+
+      def self.create(inventory_item_id, payload = {})
+        validate_numerical_id(inventory_item_id)
+        post_request("inventory_items/#{inventory_item_id}/inventory_moves.json", payload: payload)
+      end
+
+      def self.update(inventory_item_id, id, payload = {})
+        validate_numerical_id(inventory_item_id)
+        validate_numerical_id(id)
+        patch_request("inventory_items/#{inventory_item_id}/inventory_moves/#{id}.json", payload: payload)
+      end
+
+      def self.delete(inventory_item_id, id)
+        validate_numerical_id(inventory_item_id)
+        validate_numerical_id(id)
+        delete_request("inventory_items/#{inventory_item_id}/inventory_moves/#{id}.json")
+      end
+    end
+  end
+end

data/lib/fakturoid/client.rb

@@ -6,6 +6,8 @@ require "fakturoid/client/number_format"
 require "fakturoid/client/user"
 require "fakturoid/client/subject"
 require "fakturoid/client/invoice"
+require "fakturoid/client/inventory_items"
+require "fakturoid/client/inventory_moves"
 require "fakturoid/client/expense"
 require "fakturoid/client/generator"
 require "fakturoid/client/event"

data/lib/fakturoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Fakturoid
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fakturoid
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Eda Riedl
 - Lukáš Konarovský
 - Oldřich Vetešník
+- Kamil Hanus
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -152,6 +153,8 @@ files:
 - lib/fakturoid/client/event.rb
 - lib/fakturoid/client/expense.rb
 - lib/fakturoid/client/generator.rb
+- lib/fakturoid/client/inventory_items.rb
+- lib/fakturoid/client/inventory_moves.rb
 - lib/fakturoid/client/invoice.rb
 - lib/fakturoid/client/number_format.rb
 - lib/fakturoid/client/subject.rb
@@ -192,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.2
 signing_key:
 specification_version: 4
 summary: Ruby client for web based invoicing service www.fakturoid.cz