zaikio-warehouse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62bf49ab4d0b2be86c5c8d9638a542a153674911d6718030354f08f7494ea47e
+  data.tar.gz: e82ad62f51dafd402cd3fedf0374ccbe7c36af0138289bd3eada8a931d3281a3
+SHA512:
+  metadata.gz: b0a6296b272dd744b53f2fe2e16facdf76ba8c895fad36f7ea9bea7248f88d160c4f925bee816ef5aeea2fce704f6832579a4b118e158775bdce6b593a2ec6d3
+  data.tar.gz: 9f4642e4a913bd9b1357d6dce4ad5555970d9405c67d77bb1518676d340a5dc76623903bef0240e59c8e39e84d32a96ef2bc5afb62ac33960302aaf14011fb42

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2022-10-10
+
+- Add `Consumption`, `ConsumptionRequest`, `ConsumptionAnnouncement` and `ConsumptionRequestCancelation`
+- Update and reuse `zaikio-client-helpers` logic to support `Zaikio::Client.with_token`
+- Initial release
+
+[Unreleased]: https://github.com/zaikio/zaikio-warehouse-ruby/compare/v0.1.0..HEAD
+[0.1.0]: https://github.com/zaikio/zaikio-hub-models/compare/c96ae1302a6ec5b90cfc445116fc83af16579e01..v0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Zaikio GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Zaikio::Warehouse
+
+This is a Ruby client gem for the [Zaikio Warehouse](https://docs.zaikio.com/api/warehouse/warehouse.html).
+
+## Installation
+
+Add to the Gemfile and install by running
+
+    $ bundle add zaikio-warehouse
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install zaikio-warehouse
+
+## Configuration and Usage
+
+After installation, add an initializer to configure the client:
+
+```ruby
+# maybe config/initializers/zaikio-warehouse.rb
+
+Zaikio::Warehouse.configure do |config|
+  config.environment = :sandbox # or :production
+end
+```
+
+You will need a valid access token for any calls, [zaikio-oauth_client](https://github.com/zaikio/zaikio-oauth_client)
+can help you with that. Once you have a token available, you can use `Zaikio::Warehouse.with_token`:
+
+```ruby
+Zaikio::Warehouse.with_token(access_token) do
+  # any API requests will now use the given access token
+  warehouse = Warehouse.find(params[:warehouse_id])
+  warehouse.name = "#{warehouse.name} with automation"
+  warehouse.save
+end
+```
+
+The gem uses [spyke](https://github.com/balvig/spyke) and mimics some of ActiveRecord's interface, as you can see in the
+example above.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the zaikio-warehouse-ruby project's codebases, issue trackers, chat rooms and mailing lists is
+expected to follow the
+[code of conduct](https://github.com/zaikio/zaikio-warehouse-ruby/blob/master/CODE_OF_CONDUCT.md).

data/lib/zaikio/warehouse/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # Base class for Zaikio Warehouse models
+    class Base < Zaikio::Client::Model
+      self.callback_methods = { create: :post, update: :patch }.freeze
+
+      class_attribute :allowed_methods
+
+      self.allowed_methods = %i[get post patch put delete]
+
+      class << self
+        def readonly!
+          self.allowed_methods = %i[get]
+        end
+
+        def disable_http_methods(*disabled_methods)
+          self.allowed_methods -= disabled_methods
+        end
+
+        def request(method, *args, **opts)
+          raise Zaikio::Error, "HTTP method #{method} is not allowed on #{self}" unless allowed_methods.include?(method)
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/zaikio/warehouse/call_off_agreement.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # See https://docs.zaikio.com/api/warehouse/warehouse.html#/SKUs/get_skus__sku_id__call_off_agreement
+    class CallOffAgreement < Base
+      uri "skus/:sku_id/call_off_agreement"
+      include_root_in_json :call_off_agreement
+
+      attributes :contract_number, :expires_on, :expired_on, :expires_after_amount_called_off,
+                 :sales_price_per_unit, :sales_price_per_unit_currency, :deletable, :created_at, :updated_at
+
+      has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+
+      def reload
+        self.attributes = self.class.where(sku_id: sku.id).find(id).attributes
+      end
+    end
+  end
+end

data/lib/zaikio/warehouse/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # Configuration for the Zaikio Warehouse client
+    class Configuration < Zaikio::Client::Helpers::Configuration
+      def self.hosts
+        {
+          development: "http://warehouse.zaikio.test/api/v1/",
+          test: "http://warehouse.zaikio.test/api/v1/",
+          staging: "https://warehouse.staging.zaikio.com/api/v1/",
+          sandbox: "https://warehouse.sandbox.zaikio.com/api/v1/",
+          production: "https://warehouse.zaikio.com/api/v1/"
+        }.freeze
+      end
+    end
+  end
+end

data/lib/zaikio/warehouse/consumption.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    class Consumption < Base
+      disable_http_methods :patch, :put, :delete
+      include_root_in_json :consumption
+
+      uri "consumptions(/:id)"
+
+      attributes :consuming_reference, :consuming_reference_link, :consuming_client, :consuming_subject, :amount,
+                 :amount_in_base_unit, :created_at, :updated_at
+
+      has_one :material, uri: nil, class_name: "Zaikio::Warehouse::Material"
+      has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+      has_one :storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+      has_one :person, uri: nil, class_name: "Zaikio::Warehouse::Person"
+      has_one :manifest_entry, uri: nil, class_name: "Zaikio::Warehouse::ManifestEntry"
+      has_one :consumption_request, uri: nil, class_name: "Zaikio::Warehouse::ConsumptionRequest"
+    end
+  end
+end

data/lib/zaikio/warehouse/consumption_announcement.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    class ConsumptionAnnouncement < Base
+      disable_http_methods :patch, :put, :delete
+      include_root_in_json :consumption_announcement
+
+      uri "consumption_announcements"
+
+      attributes :consuming_reference, :consuming_reference_link, :amount_in_base_unit,
+                 :warehouse_id, :material_id
+
+      has_many :consumption_requests, uri: nil, class_name: "Zaikio::Warehouse::ConsumptionRequest"
+    end
+  end
+end

data/lib/zaikio/warehouse/consumption_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    class ConsumptionRequest < Base
+      disable_http_methods :patch, :put, :delete
+      include_root_in_json :consumption_request
+
+      uri "consumption_requests(/:id)"
+
+      attributes :consuming_reference, :consuming_reference_link, :consuming_client, :consuming_subject, :amount,
+                 :amount_in_base_unit, :created_at, :updated_at
+
+      has_one :material, uri: nil, class_name: "Zaikio::Warehouse::Material"
+      has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+      has_one :storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+      has_one :person, uri: nil, class_name: "Zaikio::Warehouse::Person"
+      has_one :consumption_request_cancelation, uri: nil, class_name: "Zaikio::Warehouse::ConsumptionRequestCancelation"
+    end
+  end
+end

data/lib/zaikio/warehouse/consumption_request_cancelation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    class ConsumptionRequestCancelation < Base
+      disable_http_methods :patch, :put, :delete
+      include_root_in_json :consumption_request_cancelation
+
+      uri "consumption_request_cancelations(/:id)"
+
+      attributes :consumption_request_id, :cancelation_reference, :cancelation_reference_link,
+                 :cancelation_client, :cancelation_subject, :amount,
+                 :amount_in_base_unit, :created_at, :updated_at
+
+      has_one :material, uri: nil, class_name: "Zaikio::Warehouse::Material"
+      has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+      has_one :storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+      has_one :person, uri: nil, class_name: "Zaikio::Warehouse::Person"
+      has_one :consumption_request, uri: nil, class_name: "Zaikio::Warehouse::ConsumptionRequest"
+    end
+  end
+end

data/lib/zaikio/warehouse/contact.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # Contact model
+    class Contact < Base
+      readonly!
+
+      uri "contacts(/:id)"
+
+      attributes :name, :source_uri, :created_at, :updated_at
+    end
+  end
+end

data/lib/zaikio/warehouse/correction.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    class Correction < Operation
+      disable_http_methods :delete, :patch, :put
+
+      uri "corrections(/:id)"
+      include_root_in_json :correction
+
+      attributes :amount, :amount_in_base_unit, :created_at, :updated_at
+
+      has_one :material, uri: nil, class_name: "Zaikio::Warehouse::Material"
+      has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+      has_one :storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+      has_one :person, uri: nil, class_name: "Zaikio::Warehouse::Person"
+      has_one :manifest_entry, uri: nil, class_name: "Zaikio::Warehouse::ManifestEntry"
+    end
+  end
+end

data/lib/zaikio/warehouse/deposit.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    class Deposit < Operation
+      disable_http_methods :patch, :put, :delete
+
+      uri "deposits(/:id)"
+      include_root_in_json :deposit
+
+      attributes :amount, :amount_in_base_unit, :created_at, :updated_at
+
+      has_one :material, uri: nil, class_name: "Zaikio::Warehouse::Material"
+      has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+      has_one :storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+      has_one :person, uri: nil, class_name: "Zaikio::Warehouse::Person"
+      has_one :manifest_entry, uri: nil, class_name: "Zaikio::Warehouse::ManifestEntry"
+    end
+  end
+end

data/lib/zaikio/warehouse/finished_goods/call_off.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    module FinishedGoods
+      # See https://docs.zaikio.com/api/warehouse/warehouse.html#/GoodsCallOffs
+      class CallOff < ::Zaikio::Warehouse::Base
+        # Nested address model for call offs
+        class Address < ::Zaikio::Warehouse::Base
+          readonly!
+
+          uri nil
+
+          attributes :addressee, :street, :addition, :number, :zip_code, :town, :state, :country_code, :location
+        end
+
+        # Nested line item model for call offs
+        class LineItem < ::Zaikio::Warehouse::Base
+          readonly!
+
+          uri nil
+
+          attributes :quantity, :created_at, :updated_at, :picked_at
+
+          has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+          has_one :picked_by, uri: nil, class_name: "Zaikio::Warehouse::Person"
+        end
+
+        # Nested pick model for call offs
+        class Pick < ::Zaikio::Warehouse::Base
+          disable_http_methods :post, :put, :patch
+
+          uri "finished_goods/call_offs/:call_off_id/picks(/:id)"
+
+          attributes :call_off_line_item_id, :quantity, :created_at
+
+          has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+          has_one :storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+          has_one :call_off, uri: nil, class_name: "Zaikio::Warehouse::FinishedGoods::CallOff"
+          has_one :picker, uri: nil, class_name: "Zaikio::Warehouse::Person"
+        end
+
+        uri "finished_goods/call_offs(/:id)"
+
+        attributes :state, :references, :delivery_date, :deletable, :created_at, :updated_at
+
+        has_one :delivery_address, uri: nil, class_name: "Address"
+        has_one :customer, uri: nil, class_name: "Zaikio::Warehouse::Contact"
+        has_one :operator, uri: nil, class_name: "Zaikio::Warehouse::Organization"
+        has_many :line_items, uri: nil, class_name: "LineItem"
+      end
+    end
+  end
+end

data/lib/zaikio/warehouse/finished_goods/material.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    module FinishedGoods
+      # See https://docs.zaikio.com/api/warehouse/warehouse.html#/GoodsCallOff%20Materials
+      class Material < ::Zaikio::Warehouse::Base
+        readonly!
+
+        uri "finished_goods/materials(/:id)"
+
+        attributes :name, :references, :kind, :category, :base_unit, :width, :length, :height, :weight,
+                   :dimensions_unit, :created_at, :updated_at, :deletable
+
+        has_one :operator, uri: nil, class_name: "Zaikio::Warehouse::Organization"
+        has_many :skus, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+        has_many :manifest, uri: nil, class_name: "Zaikio::Warehouse::ManifestEntry"
+      end
+    end
+  end
+end

data/lib/zaikio/warehouse/manifest_entry.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # See https://docs.zaikio.com/api/warehouse/warehouse.html#/Manifests/get_manifest_entries__id_
+    class ManifestEntry < Base
+      readonly!
+
+      uri "manifest_entries(/:id)"
+
+      attributes :amount, :amount_in_base_unit, :amount_available, :amount_available_in_base_unit, :amount_delta,
+                 :amount_delta_in_base_unit, :amount_available_delta, :amount_available_delta_in_base_unit,
+                 :created_at, :updated_at
+
+      has_one :operator, uri: nil, class_name: "Zaikio::Warehouse::Organization"
+      has_one :storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+      has_one :material, uri: nil, class_name: "Zaikio::Warehouse::Material"
+      has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+      has_one :operation, uri: nil, class_name: "Zaikio::Warehouse::Operation"
+      has_one :person, uri: nil, class_name: "Zaikio::Warehouse::Person"
+    end
+  end
+end

data/lib/zaikio/warehouse/material.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # See https://docs.zaikio.com/api/warehouse/warehouse.html#/Materials
+    class Material < Base
+      uri "materials(/:id)"
+      include_root_in_json :material
+
+      attributes :name, :article_number, :references, :kind, :category, :base_unit, :width, :length, :height, :weight,
+                 :dimensions_unit, :weight_unit, :created_at, :updated_at, :deletable
+
+      has_many :skus, class_name: "Zaikio::Warehouse::SKU", uri: "materials/:material_id/skus"
+
+      has_one :operator, uri: nil
+      has_many :manifest,
+               uri: "materials/:material_id/manifest",
+               class_name: "Zaikio::Warehouse::ManifestEntry"
+      has_many :manifest_entries,
+               uri: "materials/:material_id/manifest_entries(/:id)",
+               class_name: "Zaikio::Warehouse::ManifestEntry"
+    end
+  end
+end

data/lib/zaikio/warehouse/operation.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # Base class for all operations
+    class Operation < Base
+      uri nil
+
+      attributes :type
+    end
+  end
+end

data/lib/zaikio/warehouse/organization.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # Organization model. Kept here to not have a dependency on zaikio-hub-models
+    class Organization < Base
+      readonly!
+
+      uri nil # cannot use Warehouse API to retrieve the operator
+
+      attributes :name
+    end
+  end
+end

data/lib/zaikio/warehouse/person.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # Person model. Kept here to not have a dependency on zaikio-hub-models
+    class Person < Base
+      readonly!
+
+      uri nil
+
+      attributes :display_name
+    end
+  end
+end

data/lib/zaikio/warehouse/site.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # Site model. Kept here to not have a dependency on zaikio-hub-models
+    class Site < Base
+      readonly!
+
+      uri nil
+
+      attributes :display_name
+    end
+  end
+end

data/lib/zaikio/warehouse/sku.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # See https://docs.zaikio.com/api/warehouse/warehouse.html#/SKUs
+    class SKU < Base
+      uri "skus(/:id)"
+      include_root_in_json :sku
+
+      attributes :identifier, :amount_in_base_unit, :unit, :order_number, :references, :width, :length, :height,
+                 :weight, :dimensions_unit, :weight_unit, :packed, :costs_per_unit, :costs_per_unit_currency,
+                 :minimum_stock_level, :locked, :deletable, :created_at, :updated_at
+
+      has_one :operator, uri: nil, class_name: "Zaikio::Warehouse::Organization"
+      has_one :owner, uri: nil, class_name: "Zaikio::Warehouse::Contact"
+      has_one :material, uri: nil, class_name: "Zaikio::Warehouse::Material"
+      has_many :manifest,
+               uri: "skus/:sku_id/manifest",
+               class_name: "Zaikio::Warehouse::ManifestEntry"
+      has_many :manifest_entries,
+               uri: "skus/:sku_id/manifest_entries(/:id)",
+               class_name: "Zaikio::Warehouse::ManifestEntry"
+      has_one :call_off_agreement, uri: "skus/:sku_id/call_off_agreement"
+    end
+  end
+end

data/lib/zaikio/warehouse/storage_area.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # See https://docs.zaikio.com/api/warehouse/warehouse.html#/StorageAreas
+    class StorageArea < Base
+      uri "storage_areas(/:id)"
+      include_root_in_json :storage_area
+
+      attributes :name, :usage, :level, :coordinates, :width, :length, :height, :weight_limit, :deletable,
+                 :created_at, :updated_at
+
+      has_one :warehouse, uri: nil, class_name: "Zaikio::Warehouse::Warehouse"
+      has_many :manifest,
+               uri: "storage_areas/:storage_area_id/manifest",
+               class_name: "Zaikio::Warehouse::ManifestEntry"
+      has_many :manifest_entries,
+               uri: "storage_areas/:storage_area_id/manifest_entries(/:id)",
+               class_name: "Zaikio::Warehouse::ManifestEntry"
+    end
+  end
+end

data/lib/zaikio/warehouse/transfer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    class Transfer < Operation
+      disable_http_methods :put, :patch, :delete
+
+      uri "transfers(/:id)"
+      include_root_in_json :transfer
+
+      attributes :amount, :amount_in_base_unit
+
+      has_one :material, uri: nil, class_name: "Zaikio::Warehouse::Material"
+      has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+      has_one :source_storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+      has_one :target_storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+      has_one :person, uri: nil, class_name: "Zaikio::Warehouse::Person"
+      has_one :withdrawal, uri: nil, class_name: "Zaikio::Warehouse::Withdrawal"
+      has_one :deposit, uri: nil, class_name: "Zaikio::Warehouse::Deposit"
+      has_one :manifest_entry, uri: nil, class_name: "Zaikio::Warehouse::ManifestEntry"
+    end
+  end
+end

data/lib/zaikio/warehouse/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    VERSION = "0.1.0"
+  end
+end

data/lib/zaikio/warehouse/warehouse.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # See https://docs.zaikio.com/api/warehouse/warehouse.html#/Warehouses
+    class Warehouse < Base
+      uri "warehouses(/:id)"
+      include_root_in_json :warehouse
+
+      attributes :name, :deletable, :created_at, :updated_at
+
+      has_one :operator, uri: nil, class_name: "Zaikio::Warehouse::Organization"
+      has_one :site, uri: nil, class_name: "Zaikio::Warehouse::Site"
+
+      has_many :storage_areas,
+               class_name: "Zaikio::Warehouse::StorageArea",
+               uri: "storage_areas?warehouse_id=:warehouse_id"
+    end
+  end
+end

data/lib/zaikio/warehouse/withdrawal.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    class Withdrawal < Operation
+      disable_http_methods :patch, :put, :delete
+      include_root_in_json :withdrawal
+
+      uri "withdrawals(/:id)"
+
+      attributes :amount, :amount_in_base_unit, :created_at, :updated_at
+
+      has_one :material, uri: nil, class_name: "Zaikio::Warehouse::Material"
+      has_one :sku, uri: nil, class_name: "Zaikio::Warehouse::SKU"
+      has_one :storage_area, uri: nil, class_name: "Zaikio::Warehouse::StorageArea"
+      has_one :person, uri: nil, class_name: "Zaikio::Warehouse::Person"
+      has_one :manifest_entry, uri: nil, class_name: "Zaikio::Warehouse::ManifestEntry"
+
+      has_one :goods_call_off_line_item,
+              uri: nil,
+              class_name: "Zaikio::Warehouse::FinishedGoods::CallOff::LineItem"
+      has_one :withdrawal_request, uri: nil, class_name: "Zaikio::Warehouse::WithdrawalRequest"
+    end
+  end
+end

data/lib/zaikio/warehouse/withdrawal_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Warehouse
+    # Client model for nested withdrawal request representations
+    class WithdrawalRequest < Base
+      disable_http_methods :get, :put, :post, :patch, :delete # there is no endpoint available at the moment
+
+      # no attributes, there's only an ID
+    end
+  end
+end

data/lib/zaikio/warehouse.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/class/attribute"
+require "zaikio-client-helpers"
+
+# Base und utility classes
+require "zaikio/warehouse/configuration"
+require "zaikio/warehouse/base"
+require "zaikio/warehouse/operation"
+
+# Models
+require "zaikio/warehouse/call_off_agreement"
+require "zaikio/warehouse/consumption"
+require "zaikio/warehouse/consumption_request"
+require "zaikio/warehouse/consumption_request_cancelation"
+require "zaikio/warehouse/consumption_announcement"
+require "zaikio/warehouse/contact"
+require "zaikio/warehouse/correction"
+require "zaikio/warehouse/deposit"
+require "zaikio/warehouse/finished_goods/call_off"
+require "zaikio/warehouse/finished_goods/material"
+require "zaikio/warehouse/manifest_entry"
+require "zaikio/warehouse/material"
+require "zaikio/warehouse/organization"
+require "zaikio/warehouse/person"
+require "zaikio/warehouse/site"
+require "zaikio/warehouse/sku"
+require "zaikio/warehouse/storage_area"
+require "zaikio/warehouse/transfer"
+require "zaikio/warehouse/warehouse"
+require "zaikio/warehouse/withdrawal"
+require "zaikio/warehouse/withdrawal_request"
+
+require "zaikio/warehouse/version"
+
+module Zaikio
+  # Namespace for the Zaikio Warehouse Client
+  module Warehouse
+    class << self
+      attr_reader :configuration
+
+      class_attribute :connection
+
+      def configure
+        self.connection = nil
+        @configuration ||= Configuration.new
+        yield(@configuration)
+
+        Base.connection = create_connection
+      end
+
+      def with_token(token, &block)
+        Zaikio::Client.with_token(token, &block)
+      end
+
+      def create_connection
+        self.connection = Zaikio::Client.create_connection(configuration).tap do |c|
+          c.headers = { user_agent: "zaikio-warehouse-ruby #{Zaikio::Warehouse::VERSION}" }
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,272 @@
+--- !ruby/object:Gem::Specification
+name: zaikio-warehouse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zaikio GmbH
+- Torsten Schönebaum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zaikio-client-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby API Client for Zaikio's Warehouse Platform
+email:
+- ts@zaikio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/zaikio/warehouse.rb
+- lib/zaikio/warehouse/base.rb
+- lib/zaikio/warehouse/call_off_agreement.rb
+- lib/zaikio/warehouse/configuration.rb
+- lib/zaikio/warehouse/consumption.rb
+- lib/zaikio/warehouse/consumption_announcement.rb
+- lib/zaikio/warehouse/consumption_request.rb
+- lib/zaikio/warehouse/consumption_request_cancelation.rb
+- lib/zaikio/warehouse/contact.rb
+- lib/zaikio/warehouse/correction.rb
+- lib/zaikio/warehouse/deposit.rb
+- lib/zaikio/warehouse/finished_goods/call_off.rb
+- lib/zaikio/warehouse/finished_goods/material.rb
+- lib/zaikio/warehouse/manifest_entry.rb
+- lib/zaikio/warehouse/material.rb
+- lib/zaikio/warehouse/operation.rb
+- lib/zaikio/warehouse/organization.rb
+- lib/zaikio/warehouse/person.rb
+- lib/zaikio/warehouse/site.rb
+- lib/zaikio/warehouse/sku.rb
+- lib/zaikio/warehouse/storage_area.rb
+- lib/zaikio/warehouse/transfer.rb
+- lib/zaikio/warehouse/version.rb
+- lib/zaikio/warehouse/warehouse.rb
+- lib/zaikio/warehouse/withdrawal.rb
+- lib/zaikio/warehouse/withdrawal_request.rb
+homepage: https://docs.zaikio.com/api/warehouse/warehouse.html
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://docs.zaikio.com/api/warehouse/warehouse.html
+  source_code_uri: https://github.com/zaikio/zaikio-warehouse-ruby
+  changelog_uri: https://github.com/zaikio/zaikio-warehouse-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key: 
+specification_version: 4
+summary: Ruby API Client for Zaikio's Warehouse Platform
+test_files: []