zaikio-procurement 0.4.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '00691a481c639aeef92efb3b1f8070564b0763ec232613fa4a1e7b47bd0b1770'
-  data.tar.gz: 36ec16902de34b2c48ea043340b3714ff76e4feefa1b491e7cf62cf518640cd5
+  metadata.gz: '016449cd994a32db26e9bc0045b4ede62213fe4e3fa4cd5621181d51a4d6a36a'
+  data.tar.gz: fd65209c17d5ecb34120b74d6592dfbd685771aec031139ed14ca5901f764c3f
 SHA512:
-  metadata.gz: d42302e4b51f4ee9505e9c34a20c07f257f96012f36a3e5471735b5cc1bd9a1e0be805e890b08171dc1d61855734834c4194b5b210b8e3908574c0c4a41a5171
-  data.tar.gz: 943068ff4356498e78f5aaae3f047b472d63e507466cd61eb49fdafef6c22f0d69175de5e8f263dc27e92b7d98c4583746d46586636e1b0d9d1ca314a22b414f
+  metadata.gz: 1b32bae8614933368afd866da4b29463fbccf7ac8d0ae802b5247de2c2f58e8778680a0260c3608069175e29d97bb0c5a2952d2235ced7e320d35cc1511f19e1
+  data.tar.gz: 34f11708110b5db2ebfbdd89ebbb72749182e0dd0a79aaee6dceea45e6b93a407489eecea7ffe6ce8b8265b344ed8bc1a97577bd1af301d17a0dfda48d6eac77

data/README.md

@@ -1,6 +1,6 @@
 # Zaikio::Procurement
 
-Ruby API Client for Zaikio's Procurement Platform.
+Ruby API Client for Zaikio's Procurement Consumer Platform.
 
 ## Installation
 
@@ -30,14 +30,13 @@ Zaikio::Procurement.configure do |config|
 end
 ```
 
-
 ## Usage
 
 The Procurement Client has an ORM like design.
 
 For the requests to work, a valid JSON Web token with the correct OAuth Scopes must always be provided. Please refer to [zakio-oauth_client](https://github.com/zaikio/zaikio-oauth_client).
 
-If you want to know which actions are available and which scopes are required, please refer to the [Procurement Consumer API Reference](https://docs.zaikio.com/api/procurement_consumers/procurement.html).
+If you want to know which actions are available and which scopes are required, please refer to the [Procurement Consumer API V2 Reference](https://docs.zaikio.com/api/procurement_consumers/consumers_v2.html).
 
 ### As an organization
 
@@ -46,88 +45,83 @@ token = "..." # Your valid JWT for an organization
 Zaikio::Procurement.with_token(token) do
 
   # Fetch Data
-  Zaikio::Procurement::Article.all
-  Zaikio::Procurement::Article.find("7cbf51bd-35a8-47a1-84a2-57aa63140234")
-  Zaikio::Procurement::Article.list_by_article_type_or_supplier_slug("great_paper_company")
+  Zaikio::Procurement::MaterialRequirement.all
+  Zaikio::Procurement::MaterialRequirement.find("7cbf51bd-35a8-47a1-84a2-57aa63140234")
 
   # Associations
-  article = Zaikio::Procurement::Article.find("7cbf51bd-35a8-47a1-84a2-57aa63140234")
-  article.supplier
-  article.variants
-
-  # Search for all variants of a substrate
-  search = Zaikio::Procurement::SubstrateSearch.new("Magno", grain: "long", paper_weight: 80)
+  material_requirement = Zaikio::Procurement::MaterialRequirement.find("7cbf51bd-35a8-47a1-84a2-57aa63140234")
+  material_requirement.availability
+  material_requirement.pricing
+  material_requirement.order
 
-  # or by providing a supplier_id to search for all variants of a substrate of from a specific supplier
-  search = Zaikio::Procurement::SubstrateSearch.new("Magno", grain: "long", paper_weight: 80, supplier_id: "b5b14aa0-ae84-452b-9719-a38545365902")
+  # Search for a variant
+  search = Zaikio::Procurement::VariantSearch.new(type: "sheet_substrate", query: "Soap", grain: "short", paper_weight: 80)
+  # You can either pass a single value or a comma separated list of types, e.g. type: "sheet_substrate,plate"
+  # Use all to include all available Variant types in the response
 
   search.results # Returns a list of matching variants
-  search.facets # Returns a list of search facets that can be used to further narrow down the results
-
-  # https://docs.zaikio.com/api/procurement_consumers/procurement.html#/LineItemSuggestions/post_variants__variant_id__line_item_suggestions
-  variant = Zaikio::Procurement::Variant.find("845a4d7e-db5a-46a6-9d30-bf2e884cb393")
-  variant.line_item_suggestion(amount: 10, unit: "sheet") # Returns a line item suggestion for a specifc variant
-
-  # in Supplier API one must provide a valid scope when using `Variant` or `Article`:
-  # https://docs.zaikio.com/api/procurement_suppliers/procurement.html#/Variants/get__article_type__variants__variant_id_
-  variant = Zaikio::Procurement::Variant.substrate.find("845a4d7e-db5a-46a6-9d30-bf2e884cb393")
-  variant.skus
-  
-  # https://docs.zaikio.com/api/procurement_consumers/procurement.html#/LineItemSuggestions/post_suppliers__supplier_id__line_item_suggestions
-  supplier = Zaikio::Procurement::Supplier.find("b5b14aa0-ae84-452b-9719-a38545365902")
-  supplier.line_item_suggestions(
-    variants: [
-      {
-        id: "0001b94e-4e87-4ee9-8b14-6ff9910b4f26",
-        amount: 2000,
-        exact_amount: false,
-        environmental_certification: "FSC Mix Credit",
-        unit: "sheet"
-      },
-      {
-        id: "10236394-ecd4-465b-ab72-0fbd79296e6a",
-        amount: 10,
-        exact_amount: false,
-        environmental_certification: "PEFC 100%",
-        unit: "sheet"
-      }
-    ]
-  ) # Returns line item suggestions for multiple variants of a supplier
-
-
-  # Create new resources
+  search.available_filters # Returns a list of available filters that can be used to further narrow down the results
+
+  # Filter and search material requirements
+  # Available filters can be found here:  https://docs.zaikio.com/api/procurement_consumers/consumers_v2.html#/MaterialRequirements/get_material_requirements
+  Zaikio::Procurement::MaterialRequirement.where(query: "Sappi", filters: { article_category: "sheet_substrate", status: "ordered" })
+
+  ### Create new resources
+
+  # Create a ContractRequest
+  Zaikio::Procurement::ContractRequest.create(
+    supplier_id: "061c2b43-ae94-459d-8739-35b20684e47a",
+    customer_number: "1968353479",
+    contact_first_name: "Frank",
+    contact_last_name: "Gallikanokus",
+    contact_email: "fgalli@example.com",
+    contact_phone: "+3333333333333",
+    references: ["my reference"])
+
+  # Create a MaterialRequirement
+  Zaikio::Procurement::MaterialRequirement.create(
+    amount: 200,
+    job_client: "Awesome Client",
+    job_description: "Awesome print product",
+    job_link: "https://www.example.com",
+    job_reference: "my job reference",
+    material_required_at: "2022-08-03",
+    supplier_id: "b2a0f1ab-7610-451e-acc7-633284300521",
+    variant_id: "31924842-b38b-47b2-90b0-68f8f42f37d6",
+    references: ["my requirement reference"],
+    visible_in_web: true)
+
+  # Create an Order
   Zaikio::Procurement::Order.create(
-    contract_id: "fd677fc7-abd9-460c-b086-34de1a8349e8",
-    delivery_mode: "complete",
-    exclusive_sales_group_id: "42dcbaf6-e557-4423-96bc-707ebbc223c0",
-    references: ["CO/XXXXXX"],
-    state_event: "place",
-    deliveries_attributes: [
-      {
-        address_addressee: "Joey’s Print Ltd",
-        address_text: "Emmerich-Josef-Straße 1A, 55116 Mainz",
-        desired_delivery_date: "2021-01-29",
-        references: ["D/XXXXXX"]
-      }
-    ],
-    order_line_items_attributes: [
-      {
-        sku_id: "26b3aadc-928f-4d1a-ba2d-13ac3c8f523d",
-        amount: 108000
-      }
-    ]
-  )
-
-  order = Zaikio::Procurement::Order.find("86b4a0c5-6d54-4702-a059-da258643f260")
-  order.order_line_items.create(sku_id: "6535eeb0-45c2-4c63-8cb9-4814562bb875", amount: 68000)
-
-  # Update resources
-  line_item = Zaikio::Procurement::OrderLineItem.find("058a5513-925e-4d0c-923d-fa1ed4bfb3ce")
-  line_item.update(amount: 69000)
-
-  # Deleting resources
-  line_item = Zaikio::Procurement::OrderLineItem.find("2f5a99c2-9734-4aac-9cee-911b061d3a5a")
-  line_item.destroy
+    material_requirement_ids: ["9f98e841-1502-4d7b-9b8a-0cf9b8072875"],
+    references: ["my order reference"],
+    copy_material_requirement_references_to_line_items: true)
+
+  ### Update resources
+  material_requirement = Zaikio::Procurement::MaterialRequirement.find("058a5513-925e-4d0c-923d-fa1ed4bfb3ce")
+  material_requirement.update(amount: 1000)
+
+  ### Deleting resources
+  material_requirement = Zaikio::Procurement::MaterialRequirement.find("2f5a99c2-9734-4aac-9cee-911b061d3a5a")
+  material_requirement.destroy
+
+  ### Custom methods
+
+  # Placing an order and submitting it to the supplier
+  order = Zaikio::Procurement::Order.find("8eaeb37a-d7aa-424a-aac1-1ade4b4030e2")
+  order.place
+
+  # Cancel a placed order
+  order = Zaikio::Procurement::Order.find("3d36c6c5-b979-4073-8fcc-78a6cf1bc8bd")
+  order.cancel
+
+  # Archive a canceled or completed material requirement
+  material_requirement = Zaikio::Procurement::MaterialRequirement.find("2f5a99c2-9734-4aac-9cee-911b061d3a5a")
+  material_requirement.archive
+
+  # Refreshing the order conditions (price, stock and delivery date) of the material requirement
+  material_requirement = Zaikio::Procurement::MaterialRequirement.find("2f5a99c2-9734-4aac-9cee-911b061d3a5a")
+  material_requirement.refresh
 end
 ```
 
@@ -139,7 +133,7 @@ This can be easily caught using the `with_fallback` method. We recommend to alwa
 
 ```rb
 Zaikio::Directory.with_token(token) do
-  Zaikio::Procurement::Article.with_fallback.find("7cbf51bd-35a8-47a1-84a2-57aa63140234") # => nil
-  Zaikio::Procurement::Article.with_fallback.all # Automatically uses empty array as fallback
+  Zaikio::Procurement::MaterialRequirement.with_fallback.find("7cbf51bd-35a8-47a1-84a2-57aa63140234") # => nil
+  Zaikio::Procurement::MaterialRequirement.with_fallback.all # Automatically uses empty array as fallback
 end
 ```

data/lib/zaikio/procurement/article.rb

@@ -1,38 +1,11 @@
-require_relative "concern/article_type_scoped"
-
 module Zaikio
   module Procurement
     class Article < Base
-      include ArticleTypeScoped
-      include_root_in_json :article
-
-      # Class methods
-      class << self
-        # Spyke URI override
-        def uri
-          Zaikio::Procurement.configuration.flavor == :supplier ? ":type/articles(/:id)" : "articles(/:id)"
-        end
-
-        def list_by_article_type_or_supplier_slug(type_or_slug)
-          with("#{type_or_slug}/articles").get
-        end
-
-        def list_by_article_type_and_supplier_slug(type, slug)
-          with("#{type}/#{slug}/articles").get
-        end
-      end
-
-      # Attributes
-      attributes :name, :base_unit, :coated, :description, :finish,
-                 :kind, :supplier_id, :created_at, :updated_at
-
       # Associations
       has_one :supplier, class_name: "Zaikio::Procurement::Supplier",
                          uri: nil
-      # Manually build variants association to work for consumers and suppliers
-      def variants
-        self.class.request(:get, "#{uri}/variants").data.collect { |v| Zaikio::Procurement::Variant.new(v) }
-      end
+      has_many :skus,    class_name: "Zaikio::Procurement::Sku",
+                         uri: nil
     end
   end
 end

data/lib/zaikio/procurement/availability.rb

@@ -0,0 +1,8 @@
+module Zaikio
+  module Procurement
+    class Availability < Base
+      # Attributes
+      attributes :delivery_date, :in_stock, :accuracy, :verified_at
+    end
+  end
+end

data/lib/zaikio/procurement/configuration.rb

@@ -4,22 +4,19 @@ module Zaikio
   module Procurement
     class Configuration
       HOSTS = {
-        development: "https://procurement.zaikio.test",
-        test: "https://procurement.zaikio.test",
-        staging: "https://procurement.staging.zaikio.com",
-        sandbox: "https://procurement.sandbox.zaikio.com",
-        production: "https://procurement.zaikio.com"
+        development: "https://procurement.zaikio.test/api/v2/",
+        test: "https://procurement.zaikio.test/api/v2/",
+        staging: "https://procurement.staging.zaikio.com/api/v2/",
+        sandbox: "https://procurement.sandbox.zaikio.com/api/v2/",
+        production: "https://procurement.zaikio.com/api/v2/"
       }.freeze
 
-      FLAVORS = %i[consumer supplier].freeze
-
       attr_accessor :host
-      attr_reader :environment, :flavor
+      attr_reader :environment
       attr_writer :logger
 
       def initialize
         @environment = :sandbox
-        @flavor      = :consumer
       end
 
       def logger
@@ -31,12 +28,6 @@ module Zaikio
         @host = host_for(environment)
       end
 
-      def flavor=(flavor)
-        raise StandardError.new, "Invalid Zaikio::Procurement flavor '#{flavor}'" unless FLAVORS.include?(flavor)
-
-        @flavor = flavor
-      end
-
       private
 
       def host_for(environment)

data/lib/zaikio/procurement/contract_request.rb

@@ -4,16 +4,19 @@ module Zaikio
       uri "contract_requests(/:id)"
       include_root_in_json :contract_request
 
+      def self.create(supplier_id:, **attributes)
+        new(request(:post, "suppliers/#{supplier_id}/contract_requests",
+                    contract_request: attributes)&.body&.dig("data"))
+      end
+
       # Attributes
-      attributes :accepted_at, :connectivity_checked_at, :contact_email, :contact_first_name,
-                 :contact_last_name, :contact_phone, :currency, :customer_number, :declined_at,
-                 :mapped_at, :references, :state, :vetted_at, :consumer_id, :consumer, :supplier_id,
-                 :created_at, :updated_at
+      attributes :contact_email, :contact_first_name, :contact_last_name,
+                 :contact_phone, :customer_number, :declined_at, :declined_reason,
+                 :references, :state, :created_at, :updated_at
 
       # Associations
       belongs_to :supplier, class_name: "Zaikio::Procurement::Supplier",
                             uri: nil
-      has_one :contract, uri: nil
     end
   end
 end

data/lib/zaikio/procurement/delivery.rb

@@ -1,19 +1,11 @@
 module Zaikio
   module Procurement
     class Delivery < Base
-      uri "deliveries(/:id)"
-      include_root_in_json :delivery
-
-      # Attributes
-      attributes :confirmed_delivery_date, :desired_delivery_date, :references,
-                 :order_id, :created_at, :updated_at
-
       # Associations
-      belongs_to :address,           class_name: "Zaikio::Procurement::Address", uri: nil
-      belongs_to :order,             class_name: "Zaikio::Procurement::Order", uri: nil
-
-      has_many :delivery_line_items, class_name: "Zaikio::Procurement::DeliveryLineItem",
-                                     uri: "deliveries/:delivery_id/delivery_line_items(/:id)"
+      has_one :site,     class_name: "Zaikio::Procurement::Site",
+                         uri: nil
+      has_one :address,  class_name: "Zaikio::Procurement::Address",
+                         uri: nil
     end
   end
 end

data/lib/zaikio/procurement/job.rb

@@ -0,0 +1,8 @@
+module Zaikio
+  module Procurement
+    class Job < Base
+      # Attributes
+      attributes :anticipated_costs, :client, :description, :link, :reference
+    end
+  end
+end

data/lib/zaikio/procurement/material.rb

@@ -0,0 +1,15 @@
+module Zaikio
+  module Procurement
+    class Material < Base
+      attributes :amount,
+                 :description,
+                 :environmental_certification,
+                 :unit,
+                 :sku_preference_ids
+
+      # Associations
+      has_one :supplier, class_name: "Zaikio::Procurement::Supplier", uri: nil
+      has_one :variant, class_name: "Zaikio::Procurement::Variant", uri: nil
+    end
+  end
+end

data/lib/zaikio/procurement/material_requirement.rb

@@ -5,22 +5,35 @@ module Zaikio
       include_root_in_json :material_requirement
 
       # Attributes
-      attributes :amount, :anticipated_costs, :archived_at, :archived_by, :article_category, :canceled_at, :currency,
-                 :description, :environmental_certification, :expected_at, :fulfilled_at, :material_required_at,
-                 :job_client, :job_description, :job_link, :job_reference, :ordered_at, :order_number, :person,
-                 :price, :purchaser, :price_based_on_quantity, :references, :site, :state, :unit,
-                 :created_at, :updated_at
+      attributes :state, :references, :visible_in_web, :ordered_at, :fulfilled_at, :canceled_at, :created_at,
+                 :updated_at
 
       # Associations
-      has_one :supplier, class_name: "Zaikio::Procurement::Supplier", uri: nil
-      has_one :variant, class_name: "Zaikio::Procurement::Variant", uri: nil
-      has_many :order_line_items, class_name: "Zaikio::Procurement::OrderLineItem", uri: nil
+      has_one :required_material, class_name: "Zaikio::Procurement::Material", uri: nil
+      has_one :delivery, class_name: "Zaikio::Procurement::Delivery", uri: nil
+      has_one :order, class_name: "Zaikio::Procurement::Order", uri: nil
+      has_one :pricing, class_name: "Zaikio::Procurement::Pricing", uri: nil
+      has_one :availability, class_name: "Zaikio::Procurement::Availability", uri: nil
+      has_one :quantity, class_name: "Zaikio::Procurement::Quantity", uri: nil
+      has_one :job, class_name: "Zaikio::Procurement::Job", uri: nil
+      has_one :creator, class_name: "Zaikio::Procurement::Person", uri: nil
 
-      def order(purchaser_id:)
-        result = self.class.request(:post, "material_requirements/#{id}/order",
-                                    order: { purchaser_id: purchaser_id })
+      def archive
+        Zaikio::Procurement::MaterialRequirement.new(
+          self.class.request(:patch, "#{collection_name}/#{id}/archive").data
+        )
+      end
+
+      def refresh
+        Zaikio::Procurement::MaterialRequirement.new(
+          self.class.request(:patch, "#{collection_name}/#{id}/refresh").data
+        )
+      end
+
+      private
 
-        Zaikio::Procurement::MaterialRequirement.new(result.data)
+      def collection_name
+        self.class.name.demodulize.underscore.pluralize
       end
     end
   end

data/lib/zaikio/procurement/order.rb

@@ -5,21 +5,31 @@ module Zaikio
       include_root_in_json :order
 
       # Attributes
-      attributes :canceled_by_consumer_at, :canceled_by_supplier_at, :cancelation_requested_at, :confirmed_at,
-                 :currency, :delivery_mode, :gross_total, :net_handling_fee, :net_shipping_fee, :net_total,
-                 :partially_shipped_at, :partially_shipped_remainder_canceled_at, :placed_at, :producing_at,
-                 :references, :shipped_at, :state, :state_reason, :taxes, :taxes_on_fees, :transfer_failed_at,
-                 :transferred_at, :contract_id, :exclusive_sales_group_id, :person_id, :created_at, :updated_at
+      attributes :copy_material_requirement_references_to_line_items, :currency, :references,
+                 :state, :canceled_by_consumer_at, :canceled_by_supplier_at, :confirmed_at,
+                 :placed_at, :transferred_at, :created_at, :updated_at
 
       # Associations
-      has_one :contract,              class_name: "Zaikio::Procurement::Contract",
-                                      uri: "contracts(/:id)"
-      has_one :exclusive_sales_group, class_name: "Zaikio::Procurement::SalesGroup",
-                                      uri: "sales_groups(/:id)"
-      has_many :order_line_items,     class_name: "Zaikio::Procurement::OrderLineItem",
-                                      uri: "orders/:order_id/order_line_items(/:id)"
-      has_many :deliveries,           class_name: "Zaikio::Procurement::Delivery",
-                                      uri: "orders/:order_id/deliveries(/:id)"
+      has_one :delivery,          class_name: "Zaikio::Procurement::Delivery",
+                                  uri: nil
+      has_many :order_line_items, class_name: "Zaikio::Procurement::OrderLineItem",
+                                  uri: nil
+      has_one :pricing,           class_name: "Zaikio::Procurement::Pricing",
+                                  uri: nil
+      has_one :person,            class_name: "Zaikio::Procurement::Person",
+                                  uri: nil
+
+      def place
+        Zaikio::Procurement::MaterialRequirement.new(
+          self.class.request(:patch, "orders/#{id}/place").data
+        )
+      end
+
+      def cancel
+        Zaikio::Procurement::MaterialRequirement.new(
+          self.class.request(:patch, "orders/#{id}/cancel").data
+        )
+      end
     end
   end
 end

data/lib/zaikio/procurement/order_line_item.rb

@@ -1,16 +1,12 @@
 module Zaikio
   module Procurement
     class OrderLineItem < Base
-      uri "order_line_items(/:id)"
-      include_root_in_json :order_line_item
-
       # Attributes
-      attributes :amount, :amount_in_base_unit, :base_unit, :catalog_price, :confirmed_price, :description,
-                 :order_number, :tax_rate, :taxes, :total_gross_price, :total_net_price, :unit, :order_id,
-                 :sku_id, :created_at, :updated_at
+      attributes :references, :amount, :amount_in_base_unit, :base_unit, :confirmed_delivery_at, :description,
+                 :order_number, :created_at, :updated_at
 
       # Associations
-      belongs_to :order, class_name: "Zaikio::Procurement::Order",
+      has_one :pricing,  class_name: "Zaikio::Procurement::Pricing",
                          uri: nil
       has_one :sku,      class_name: "Zaikio::Procurement::Sku",
                          uri: nil

data/lib/zaikio/procurement/person.rb

@@ -0,0 +1,8 @@
+module Zaikio
+  module Procurement
+    class Person < Base
+      # Attributes
+      attributes :full_name
+    end
+  end
+end

data/lib/zaikio/procurement/pricing.rb

@@ -0,0 +1,6 @@
+module Zaikio
+  module Procurement
+    class Pricing < Base
+    end
+  end
+end

data/lib/zaikio/procurement/quantity.rb

@@ -0,0 +1,8 @@
+module Zaikio
+  module Procurement
+    class Quantity < Base
+      # Attributes
+      attributes :order_quantity_in_requested_unit, :order_quantity_in_base_unit
+    end
+  end
+end

data/lib/zaikio/procurement/site.rb

@@ -0,0 +1,11 @@
+module Zaikio
+  module Procurement
+    class Site < Base
+      uri "sites(/:id)"
+
+      # Associations
+      has_one :address, class_name: "Zaikio::Procurement::Address",
+                        uri: nil
+    end
+  end
+end

data/lib/zaikio/procurement/sku.rb

@@ -1,24 +1,9 @@
 module Zaikio
   module Procurement
     class Sku < Base
-      uri "skus(/:id)"
-      include_root_in_json :sku
-
-      # Attributes
-      attributes :amount, :amount_in_base_unit, :availability_in_days, :dimension_unit,
-                 :environmental_certification, :gross_weight, :height, :length, :net_weight,
-                 :order_number, :unit, :weight_unit, :width, :variant_id, :created_at, :updated_at
-
       # Associations
-      has_many :prices, class_name: "Zaikio::Procurement::Price",
-                        uri: "skus/:sku_id/prices"
-
-      # Manually build variant association to work for consumers and suppliers
-      def variant
-        Zaikio::Procurement::Variant.new(
-          self.class.request(:get, attributes.dig("variant", "links", 0, "href")).data
-        )
-      end
+      has_many :suppliers, class_name: "Zaikio::Procurement::Supplier",
+                           uri: nil
     end
   end
 end

data/lib/zaikio/procurement/supplier.rb

@@ -3,54 +3,18 @@ module Zaikio
     class Supplier < Base
       uri "suppliers(/:id)"
 
-      # Attributes
-      attributes :automatically_accept_contract_requests, :brand_color, :cancelation_policy, :display_name,
-                 :slug, :supports_split_delivery, :created_at, :updated_at
-
-      # Associations
-      has_many :contract_requests, class_name: "Zaikio::Procurement::ContractRequest",
-                                   uri: "suppliers/:supplier_id/contract_requests(/:id)"
-
-      has_many :distributors, class_name: "Zaikio::Procurement::Supplier", uri: nil
-
-      def line_item_suggestions(**attributes)
-        variants = attributes.delete(:variants)
-
-        unless variants.is_a?(Array) && variants.all?(Hash)
-          raise ArgumentError, "For variants, you must pass an Array of Hashes"
-        end
-
-        self.class.request(
-          :post, line_item_suggestions_path, payload(attributes, variants)
-        ).data.deep_symbolize_keys
-      end
-
-      private
-
-      def payload(attributes, variants)
-        MultiJson.dump(
-          line_item_suggestions: {
-            exclusive_sales_group_id: attributes[:exclusive_sales_group_id],
-            variants: variant_payload(variants)
-          }.reject { |_k, v| v.blank? }
-        )
-      end
+      def self.upcoming
+        result = Zaikio::Procurement::Supplier
+                 .request(:get, "upcoming_suppliers")&.body&.dig("data")
 
-      def variant_payload(variants)
-        variants.collect do |variant|
-          {
-            id: variant[:id],
-            amount: variant[:amount],
-            exact_amount: variant[:exact_amount] || false,
-            environmental_certification: variant[:environmental_certification],
-            unit: variant[:unit] || "sheet"
-          }
-        end
+        result.collect { |s| Zaikio::Procurement::Supplier.new(s) }
       end
 
-      def line_item_suggestions_path
-        "suppliers/#{id}/line_item_suggestions"
-      end
+      # Attributes
+      attributes :slug, :name, :connected, :currency, :customer_number, :prices_updated_at,
+                 :additional_pricing_agreements, :article_types, :automatically_accept_contract_requests,
+                 :brand_color, :cancelation_policy, :logo_url, :maximum_days_until_delivery,
+                 :minimum_days_before_delivery, :supports_split_delivery, :maximum_order_size, :created_at, :updated_at
     end
   end
 end

data/lib/zaikio/procurement/variant.rb

@@ -1,50 +1,20 @@
-require_relative "concern/article_type_scoped"
-
 module Zaikio
   module Procurement
     class Variant < Base
-      include ArticleTypeScoped
       include_root_in_json :variant
 
-      # Spyke URI override
-      def self.uri
-        Zaikio::Procurement.configuration.flavor == :supplier ? ":type/variants(/:id)" : "variants(/:id)"
+      # Constants
+      def self.types
+        %w[carbonless_copy_paper coating coating_plate envelope ink laminating_foil
+           offset_printing_blanket plate ring_binding self_adhesive sheet_substrate
+           sleeking_foil specialized_printing_blanket web_substrate].freeze
       end
 
-      # Attributes
-      attributes :brightness, :category, :color, :dimensions_unit, :form, :grain, :height, :paper_weight,
-                 :paper_weight_unit, :roughness, :thickness, :transparency, :unit_system, :whiteness,
-                 :width, :article_id, :created_at, :updated_at
-
       # Associations
       has_one :article, class_name: "Zaikio::Procurement::Article",
                         uri: nil
-      has_many :skus, class_name: "Zaikio::Procurement::Sku",
-                      uri: "variants/:variant_id/skus"
-
-      def line_item_suggestion(**attributes)
-        self.class.request(
-          :post, line_item_suggestions_path, payload(attributes)
-        ).data.map(&:deep_symbolize_keys)
-      end
-
-      private
-
-      def line_item_suggestions_path
-        "variants/#{id}/line_item_suggestions"
-      end
-
-      def payload(attributes)
-        MultiJson.dump(
-          line_item_suggestion: {
-            amount: attributes[:amount] || 1,
-            unit: attributes[:unit],
-            exact_amount: attributes[:exact_amount],
-            environmental_certification: attributes[:environmental_certification],
-            exclusive_sales_group_id: attributes[:exclusive_sales_group_id]
-          }
-        )
-      end
+      has_many :skus,   class_name: "Zaikio::Procurement::Sku",
+                        uri: nil
     end
   end
 end

data/lib/zaikio/procurement/variant_search.rb

@@ -0,0 +1,43 @@
+module Zaikio
+  module Procurement
+    class VariantSearch
+      def initialize(type: "all", query: nil, **filters)
+        @type         = type.split.join
+        @query        = query
+        @filters      = filters
+        @valid_types  = Zaikio::Procurement::Variant.types + ["all"]
+
+        unless @filters.respond_to?(:stringify_keys)
+          raise ArgumentError, "When using additional search parameters, you must pass a hash as an argument."
+        end
+
+        unless @type.split(",").all? { |t| @valid_types.include?(t) }
+          raise ArgumentError,
+                "When using the type parameter, you must pass one or more of \
+                 the following types: #{@valid_types.join(', ')}."
+        end
+
+        @response = Zaikio::Procurement::Base.with(path).get
+      end
+
+      def results
+        @response.results.collect { |variant| Zaikio::Procurement::Variant.new(variant) }
+      end
+
+      def available_filters
+        @response.available_filters
+      end
+
+      private
+
+      def path
+        "variants".tap do |qp|
+          qp << "?type=#{@type}"
+          qp << "&query=#{@query}" if @query
+          qp << "&" if @query && @filters.any?
+          qp << @filters.to_query("filters") if @filters
+        end
+      end
+    end
+  end
+end

data/lib/zaikio/procurement/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Procurement
-    VERSION = "0.4.1".freeze
+    VERSION = "2.0.0".freeze
   end
 end

data/lib/zaikio/procurement.rb

@@ -9,21 +9,21 @@ require "zaikio/procurement/base"
 require "zaikio/procurement/address"
 require "zaikio/procurement/article"
 require "zaikio/procurement/variant"
-require "zaikio/procurement/substrate_search"
+require "zaikio/procurement/variant_search"
 require "zaikio/procurement/sku"
-require "zaikio/procurement/price"
 require "zaikio/procurement/supplier"
-require "zaikio/procurement/contract"
 require "zaikio/procurement/contract_request"
-require "zaikio/procurement/sales_group"
-require "zaikio/procurement/sales_group_membership"
 require "zaikio/procurement/order"
 require "zaikio/procurement/order_line_item"
 require "zaikio/procurement/delivery"
-require "zaikio/procurement/delivery_line_item"
-require "zaikio/procurement/current_supplier"
 require "zaikio/procurement/material_requirement"
-require "zaikio/procurement/order_conditions_inquiry"
+require "zaikio/procurement/material"
+require "zaikio/procurement/pricing"
+require "zaikio/procurement/site"
+require "zaikio/procurement/availability"
+require "zaikio/procurement/quantity"
+require "zaikio/procurement/job"
+require "zaikio/procurement/person"
 
 module Zaikio
   module Procurement
@@ -48,12 +48,8 @@ module Zaikio
         AuthorizationMiddleware.token = original_token
       end
 
-      def connection_path
-        "#{configuration.host}/#{configuration.flavor.to_s.pluralize}/api/v1/"
-      end
-
       def create_connection
-        self.connection = Faraday.new(url: connection_path,
+        self.connection = Faraday.new(url: configuration.host,
                                       ssl: { verify: configuration.environment != :test }) do |c|
           c.request     :json
           c.response    :logger, configuration&.logger, headers: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-procurement
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Zaikio GmbH
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -109,26 +109,24 @@ files:
 - lib/zaikio/procurement/address.rb
 - lib/zaikio/procurement/article.rb
 - lib/zaikio/procurement/authorization_middleware.rb
+- lib/zaikio/procurement/availability.rb
 - lib/zaikio/procurement/base.rb
-- lib/zaikio/procurement/concern/article_type_scoped.rb
 - lib/zaikio/procurement/configuration.rb
-- lib/zaikio/procurement/contract.rb
 - lib/zaikio/procurement/contract_request.rb
-- lib/zaikio/procurement/current_supplier.rb
 - lib/zaikio/procurement/delivery.rb
-- lib/zaikio/procurement/delivery_line_item.rb
-- lib/zaikio/procurement/invoice.rb
+- lib/zaikio/procurement/job.rb
+- lib/zaikio/procurement/material.rb
 - lib/zaikio/procurement/material_requirement.rb
 - lib/zaikio/procurement/order.rb
-- lib/zaikio/procurement/order_conditions_inquiry.rb
 - lib/zaikio/procurement/order_line_item.rb
-- lib/zaikio/procurement/price.rb
-- lib/zaikio/procurement/sales_group.rb
-- lib/zaikio/procurement/sales_group_membership.rb
+- lib/zaikio/procurement/person.rb
+- lib/zaikio/procurement/pricing.rb
+- lib/zaikio/procurement/quantity.rb
+- lib/zaikio/procurement/site.rb
 - lib/zaikio/procurement/sku.rb
-- lib/zaikio/procurement/substrate_search.rb
 - lib/zaikio/procurement/supplier.rb
 - lib/zaikio/procurement/variant.rb
+- lib/zaikio/procurement/variant_search.rb
 - lib/zaikio/procurement/version.rb
 homepage: https://www.zaikio.com/
 licenses:

data/lib/zaikio/procurement/concern/article_type_scoped.rb

@@ -1,21 +0,0 @@
-module Zaikio
-  module Procurement
-    module ArticleTypeScoped
-      extend ActiveSupport::Concern
-      included do
-        scope :substrate, -> { where(type: :substrate) }
-        scope :plate, -> { where(type: :plate) }
-      end
-      module ClassMethods
-        def find(id)
-          if Zaikio::Procurement.configuration.flavor == :supplier &&
-             (current_scope.nil? || current_scope.params[:type].blank?)
-            raise ArgumentError, "id and type are required for #{name.demodulize} in Supplier API"
-          end
-
-          super
-        end
-      end
-    end
-  end
-end

data/lib/zaikio/procurement/contract.rb

@@ -1,17 +0,0 @@
-module Zaikio
-  module Procurement
-    class Contract < Base
-      uri "contracts(/:id)"
-      include_root_in_json :contract
-
-      # Attributes
-      attributes :currency, :customer_number, :references, :consumer_id,
-                 :consumer, :supplier_id, :created_at, :updated_at
-
-      # Associations
-      has_one :supplier,  class_name: "Zaikio::Procurement::Supplier",
-                          uri: nil
-      has_one :contract_request, uri: nil
-    end
-  end
-end

data/lib/zaikio/procurement/current_supplier.rb

@@ -1,17 +0,0 @@
-module Zaikio
-  module Procurement
-    class CurrentSupplier < Base
-      self.primary_key = nil
-      uri "supplier"
-      include_root_in_json :supplier
-
-      def self.find
-        all.find_one
-      end
-
-      def self.find_with_fallback(fallback)
-        all.with_fallback(fallback).find_one
-      end
-    end
-  end
-end

data/lib/zaikio/procurement/delivery_line_item.rb

@@ -1,17 +0,0 @@
-module Zaikio
-  module Procurement
-    class DeliveryLineItem < Base
-      uri "delivery_line_items(/:id)"
-      include_root_in_json :delivery_line_item
-
-      # Attributes
-      attributes :amount, :created_at, :updated_at
-
-      # Associations
-      belongs_to :delivery,     class_name: "Zaikio::Procurement::Delivery",
-                                uri: nil
-      has_one :order_line_item, class_name: "Zaikio::Procurement::OrderLineItem",
-                                uri: nil
-    end
-  end
-end

data/lib/zaikio/procurement/invoice.rb

@@ -1,8 +0,0 @@
-module Zaikio
-  module Procurement
-    class Invoice < Base
-      uri "invoices(/:id)"
-      include_root_in_json :invoice
-    end
-  end
-end

data/lib/zaikio/procurement/order_conditions_inquiry.rb

@@ -1,15 +0,0 @@
-module Zaikio
-  module Procurement
-    class OrderConditionsInquiry < Base
-      uri "order_conditions_inquiries(/:id)"
-      include_root_in_json :order_conditions_inquiry
-
-      # Attributes
-      attributes :contract_id, :currency, :created_at, :updated_at,
-                 :desired_delivery_date, :verified_at, :expires_at,
-                 :verified_net_handling_fee, :verified_net_shipping_fee,
-                 :verified_net_total, :verified_delivery_date, :order_line_items,
-                 :verified_order_line_items
-    end
-  end
-end

data/lib/zaikio/procurement/price.rb

@@ -1,18 +0,0 @@
-module Zaikio
-  module Procurement
-    class Price < Base
-      uri "prices(/:id)"
-      include_root_in_json :price
-
-      # Attributes
-      attributes :kind, :minimum_order_quantity, :order_number, :price, :valid_from,
-                 :valid_until, :sales_group_id, :sku_id, :created_at, :updated_at
-
-      # Associations
-      has_one :sku,         class_name: "Zaikio::Procurement::Sku",
-                            uri: nil
-      has_one :sales_group, class_name: "Zaikio::Procurement::SalesGroup",
-                            uri: nil
-    end
-  end
-end

data/lib/zaikio/procurement/sales_group.rb

@@ -1,11 +0,0 @@
-module Zaikio
-  module Procurement
-    class SalesGroup < Base
-      uri "sales_groups(/:id)"
-      include_root_in_json :sales_group
-
-      # Attributes
-      attributes :currency, :exclusive, :name, :created_at, :updated_at
-    end
-  end
-end

data/lib/zaikio/procurement/sales_group_membership.rb

@@ -1,11 +0,0 @@
-module Zaikio
-  module Procurement
-    class SalesGroupMembership < Base
-      uri "sales_group_memberships(/:id)"
-      include_root_in_json :sales_group_membership
-
-      # Attributes
-      attributes :contract, :sales_group, :created_at, :updated_at
-    end
-  end
-end

data/lib/zaikio/procurement/substrate_search.rb

@@ -1,38 +0,0 @@
-module Zaikio
-  module Procurement
-    class SubstrateSearch
-      def initialize(query = nil, options = {})
-        @query        = query
-        @supplier     = options.delete(:supplier_id)
-        @options      = options
-        @article_type = "substrate"
-
-        unless @options.respond_to?(:stringify_keys)
-          raise ArgumentError, "When using additional search parameters, you must pass a hash as an argument."
-        end
-
-        @response = Zaikio::Procurement::Base.with(path).get
-      end
-
-      def results
-        @response.results.collect { |variant| Zaikio::Procurement::Variant.new(variant) }
-      end
-
-      def facets
-        @response.facets
-      end
-
-      private
-
-      def path
-        String.new(@article_type).tap do |qp|
-          qp << "/#{@supplier}" if @supplier
-          qp << "/variants/search?"
-          qp << "query=#{@query}" if @query
-          qp << "&" if @query && @options.any?
-          qp << @options.to_query if @options
-        end
-      end
-    end
-  end
-end