commerce_tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6387743307e316b919e263c931016c71e50c16555a99c5a0328018a14ae6ebf
+  data.tar.gz: 99717e4bbb24977bf3b344ba86473670f18c9d499c617431907c51d60d5de7d6
+SHA512:
+  metadata.gz: d473c5497fbcec35b51b6bd1cd367b374fa6d36f558795527b044af97edf74675d35fc794b55cc1386d7f1619be742df7d7a87ac2b4bd5854354270ef3880f3b
+  data.tar.gz: 8a02ab332968b7ece9a4c20f3144900ec0d2bae8f19f8bbea7efae762f332960817d4b1439681dfcf001bf2f32b28eed031af7f1ec9915ca4b60ef121852c3ac

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-01
+
+- Initial release

data/README.md

@@ -0,0 +1,35 @@
+# CommerceTools
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/commerce_tools`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/commerce_tools.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/commerce_tools/inventory_manager.rb

@@ -0,0 +1,247 @@
+# Copyright (c) 2025 Thnk: Labs
+# Author: J
+#
+# All rights reserved. This software and associated documentation files (the "Software")
+# may not be used, copied, modified, merged, published, distributed, sublicensed, and/or
+# sold, except with the express written permission of Thnk: Labs. Unauthorized copying of this
+# file, via any medium is strictly prohibited.
+#
+# 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.
+
+require 'shopify_api'
+
+module CommerceTools
+  class InventoryManager
+    VALID_REASONS = %w[
+      correction cycle_count_available damaged movement_created
+      movement_updated movement_received movement_canceled other
+      promotion quality_control received reservation_created
+      reservation_deleted reservation_updated restock safety_stock shrinkage
+    ].freeze
+
+    VALID_STATES = %w[
+      available on_hand incoming committed reserved
+      damaged safety_stock quality_control
+    ].freeze
+
+    def initialize(shop_url:, access_token:)
+      @session = ShopifyAPI::Auth::Session.new(
+        shop: shop_url,
+        access_token: access_token
+      )
+      @client = ShopifyAPI::Clients::Graphql::Admin.new(session: @session)
+    end
+
+    def adjust_inventory_level(inventory_item_id:, location_id:, delta:, state: 'available', reason: 'correction', reference_uri: nil)
+      validate_inputs!(state: state, reason: reason)
+
+      variables = build_adjustment_variables(
+        inventory_item_id: inventory_item_id,
+        location_id: location_id,
+        delta: delta,
+        state: state,
+        reason: reason,
+        reference_uri: reference_uri
+      )
+
+      response = execute_mutation(adjustment_mutation, variables)
+      handle_response(response)
+    end
+
+    def move_inventory(
+      inventory_item_id:,
+      location_id:,
+      quantity:,
+      from_state:,
+      to_state:,
+      reason: 'correction',
+      reference_uri: nil,
+      ledger_uri: nil
+    )
+      validate_inputs!(state: from_state, reason: reason)
+      validate_inputs!(state: to_state)
+
+      variables = build_move_variables(
+        inventory_item_id: inventory_item_id,
+        location_id: location_id,
+        quantity: quantity,
+        from_state: from_state,
+        to_state: to_state,
+        reason: reason,
+        reference_uri: reference_uri,
+        ledger_uri: ledger_uri
+      )
+
+      response = execute_mutation(move_mutation, variables)
+      handle_response(response)
+    end
+
+    def get_inventory_level(inventory_item_id:, location_id:, states: ['available'])
+      validate_states!(states)
+
+      variables = {
+        "id": "gid://shopify/InventoryLevel/#{location_id}?inventory_item_id=#{inventory_item_id}"
+      }
+
+      response = execute_query(inventory_level_query, variables)
+      handle_response(response)
+    end
+
+    private
+
+      def validate_inputs!(state:, reason: nil)
+        unless VALID_STATES.include?(state)
+          raise ArgumentError, "Invalid state: #{state}. Must be one of: #{VALID_STATES.join(', ')}"
+        end
+
+        if reason && !VALID_REASONS.include?(reason)
+          raise ArgumentError, "Invalid reason: #{reason}. Must be one of: #{VALID_REASONS.join(', ')}"
+        end
+      end
+
+      def validate_states!(states)
+        invalid_states = states - VALID_STATES
+        unless invalid_states.empty?
+          raise ArgumentError, "Invalid states: #{invalid_states.join(', ')}"
+        end
+      end
+
+      def build_adjustment_variables(inventory_item_id:, location_id:, delta:, state:, reason:, reference_uri:)
+        {
+          "input": {
+            "name": state,
+            "reason": reason,
+            "referenceDocumentUri": reference_uri,
+            "changes": [
+                      {
+                        "delta": delta,
+                        "inventoryItemId": inventory_item_id,
+                        "locationId": location_id
+                      }
+                    ]
+          }
+        }
+      end
+
+      def build_move_variables(inventory_item_id:, location_id:, quantity:, from_state:, to_state:, reason:, reference_uri:, ledger_uri:)
+        {
+          "input": {
+            "reason": reason,
+            "referenceDocumentUri": reference_uri,
+            "changes": [
+                        {
+                          "inventoryItemId": inventory_item_id,
+                          "quantity": quantity,
+                          "from": {
+                            "name": from_state,
+                            "locationId": location_id
+                          },
+                          "to": {
+                            "name": to_state,
+                            "locationId": location_id,
+                            "ledgerDocumentUri": ledger_uri
+                          }
+                        }
+                      ]
+          }
+        }
+      end
+
+      def adjustment_mutation
+        <<~GRAPHQL
+        mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
+          inventoryAdjustQuantities(input: $input) {
+            userErrors {
+              field
+              message
+            }
+            inventoryAdjustmentGroup {
+              createdAt
+              reason
+              changes {
+                name
+                delta
+                quantityAfterChange
+              }
+            }
+          }
+        }
+      GRAPHQL
+      end
+
+      def move_mutation
+        <<~GRAPHQL
+        mutation inventoryMoveQuantities($input: InventoryMoveQuantitiesInput!) {
+          inventoryMoveQuantities(input: $input) {
+            userErrors {
+              field
+              message
+            }
+            inventoryAdjustmentGroup {
+              createdAt
+              reason
+              changes {
+                name
+                delta
+                quantityAfterChange
+              }
+            }
+          }
+        }
+      GRAPHQL
+      end
+
+      def inventory_level_query
+        <<~GRAPHQL
+        query($id: ID!) {
+          inventoryLevel(id: $id) {
+            quantities(names: $states) {
+              name
+              quantity
+            }
+            item {
+              id
+            }
+            location {
+              id
+            }
+          }
+        }
+      GRAPHQL
+      end
+
+      def execute_mutation(mutation, variables)
+        @client.query(query: mutation, variables: variables)
+      rescue StandardError => e
+        raise InventoryError, "Failed to execute mutation: #{e.message}"
+      end
+
+      def execute_query(query, variables)
+        @client.query(query: query, variables: variables)
+      rescue StandardError => e
+        raise InventoryError, "Failed to execute query: #{e.message}"
+      end
+
+      def handle_response(response)
+        if response.errors.any?
+          raise InventoryError, "GraphQL errors: #{response.errors.messages.join(', ')}"
+        end
+
+        data = response.body['data']
+        user_errors = data.values.first['userErrors']
+
+        if user_errors.any?
+          raise InventoryError, "User errors: #{user_errors.map { |e| e['message'] }.join(', ')}"
+        end
+
+        data
+      end
+  end
+
+  class InventoryError < StandardError; end
+end

data/lib/commerce_tools/version.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2025 Thnk: Labs
+# Author: J
+#
+# All rights reserved. This software and associated documentation files (the "Software")
+# may not be used, copied, modified, merged, published, distributed, sublicensed, and/or
+# sold, except with the express written permission of Thnk: Labs. Unauthorized copying of this
+# file, via any medium is strictly prohibited.
+#
+# 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.
+
+
+# frozen_string_literal: true
+
+module CommerceTools
+  VERSION = "0.1.0"
+end

data/lib/commerce_tools.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2025 Thnk: Labs
+# Author: J
+#
+# All rights reserved. This software and associated documentation files (the "Software")
+# may not be used, copied, modified, merged, published, distributed, sublicensed, and/or
+# sold, except with the express written permission of Thnk: Labs. Unauthorized copying of this
+# file, via any medium is strictly prohibited.
+#
+# 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.
+
+
+# frozen_string_literal: true
+
+require_relative "commerce_tools/version"
+require_relative 'commerce_tools/inventory_manager'
+
+module CommerceTools
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/commerce_tools.rbs

@@ -0,0 +1,4 @@
+module CommerceTools
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: commerce_tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- thnkr-one
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-03 00:00:00.000000000 Z
+dependencies: []
+description: Write a longer description or delete this line.
+email:
+- jacob@thnk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/commerce_tools.rb
+- lib/commerce_tools/inventory_manager.rb
+- lib/commerce_tools/version.rb
+- sig/commerce_tools.rbs
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []