shedcloud-partner_api 0.1.0

data/lib/shedcloud/partner_api/resources/work_orders.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class WorkOrders < Base
+        def list(params = {})
+          @http.request('GET', '/partner/v1/work-orders', query: params) || {}
+        end
+
+        def get(id)
+          @http.request('GET', "/partner/v1/work-orders/#{path_segment(id)}") || {}
+        end
+
+        def create(body, options: nil)
+          @http.request('POST', '/partner/v1/work-orders', body: body, headers: option_headers(options)) || {}
+        end
+
+        def update(id, body, options: nil)
+          @http.request('PATCH', "/partner/v1/work-orders/#{path_segment(id)}", body: body, headers: option_headers(options)) || {}
+        end
+
+        def update_status(id, body)
+          @http.request('POST', "/partner/v1/work-orders/#{path_segment(id)}/status", body: body) || {}
+        end
+
+        def status_history(id, params = {})
+          @http.request('GET', "/partner/v1/work-orders/#{path_segment(id)}/status-history", query: params) || {}
+        end
+      end
+    end
+  end
+end

data/lib/shedcloud/partner_api/scopes.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Scopes
+      LOT_STOCK_READ = 'partner-api.lot-stock.read'
+      LEADS_READ = 'partner-api.leads.read'
+      LEADS_WRITE = 'partner-api.leads.write'
+      QUOTES_READ = 'partner-api.quotes.read'
+      QUOTES_WRITE = 'partner-api.quotes.write'
+      ORDERS_READ = 'partner-api.orders.read'
+      ORDERS_WRITE = 'partner-api.orders.write'
+      WORK_ORDERS_READ = 'partner-api.work-orders.read'
+      WORK_ORDERS_WRITE = 'partner-api.work-orders.write'
+      LOCATIONS_READ = 'partner-api.locations.read'
+      LOCATIONS_WRITE = 'partner-api.locations.write'
+      CUSTOMERS_READ = 'partner-api.customers.read'
+      CUSTOMERS_WRITE = 'partner-api.customers.write'
+      PRODUCTS_READ = 'partner-api.products.read'
+      USERS_READ = 'partner-api.users.read'
+      USERS_WRITE = 'partner-api.users.write'
+      CONTRACTS_READ = 'partner-api.contracts.read'
+      PAYMENTS_READ = 'partner-api.payments.read'
+      PAYMENTS_WRITE = 'partner-api.payments.write'
+      DOCUMENTS_READ = 'partner-api.documents.read'
+      EVENTS_READ = 'partner-api.events.read'
+      CONFIGURATOR_SESSIONS_WRITE = 'partner-api.configurator-sessions.write'
+      DOMAINS_READ = 'partner-api.domains.read'
+      AGREEMENTS_READ = 'partner-api.agreements.read'
+      PRODUCTS_WRITE = 'partner-api.products.write'
+
+      ALL = [
+        LOT_STOCK_READ,
+        LEADS_READ,
+        LEADS_WRITE,
+        QUOTES_READ,
+        QUOTES_WRITE,
+        ORDERS_READ,
+        ORDERS_WRITE,
+        WORK_ORDERS_READ,
+        WORK_ORDERS_WRITE,
+        LOCATIONS_READ,
+        LOCATIONS_WRITE,
+        CUSTOMERS_READ,
+        CUSTOMERS_WRITE,
+        PRODUCTS_READ,
+        USERS_READ,
+        USERS_WRITE,
+        CONTRACTS_READ,
+        PAYMENTS_READ,
+        PAYMENTS_WRITE,
+        DOCUMENTS_READ,
+        EVENTS_READ,
+        CONFIGURATOR_SESSIONS_WRITE,
+        DOMAINS_READ,
+        AGREEMENTS_READ,
+        PRODUCTS_WRITE
+      ].freeze
+    end
+  end
+end

data/lib/shedcloud/partner_api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    VERSION = '0.1.0'
+  end
+end

data/lib/shedcloud/partner_api/webhooks.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module ShedCloud
+  module PartnerApi
+    module Webhooks
+      SIGNATURE_HEADER = 'X-ShedCloud-Signature'
+      EVENT_ID_HEADER = 'X-ShedCloud-Event-Id'
+      EVENT_TYPE_HEADER = 'X-ShedCloud-Event-Type'
+      DEFAULT_TOLERANCE_SECONDS = 300
+
+      module_function
+
+      def compute_signature(secret, timestamp, body)
+        OpenSSL::HMAC.hexdigest('SHA256', secret, "#{timestamp}.#{body}")
+      end
+
+      def verify_signature(secret, header, body, tolerance_seconds: 0)
+        verify_signature_at(secret, header, body, Time.now.to_i, tolerance_seconds)
+      end
+
+      def verify_signature_at(secret, header, body, now, tolerance_seconds = 0)
+        raise ArgumentError, 'webhook signature verification failed: secret is required' if secret.to_s.empty?
+        raise ArgumentError, 'webhook signature verification failed: signature header is missing' if header.to_s.strip.empty?
+
+        tolerance_seconds = DEFAULT_TOLERANCE_SECONDS if tolerance_seconds <= 0
+
+        timestamp = 0
+        signatures = []
+
+        header.to_s.split(',').each do |part|
+          part = part.strip
+          next unless part.include?('=')
+
+          key, value = part.split('=', 2)
+          case key
+          when 't'
+            unless value.match?(/\A\d+\z/)
+              raise ArgumentError, 'webhook signature verification failed: invalid timestamp in signature header'
+            end
+
+            timestamp = value.to_i
+          when 'v1'
+            signatures << value
+          end
+        end
+
+        if timestamp.zero? || signatures.empty?
+          raise ArgumentError, 'webhook signature verification failed: signature header missing t= or v1='
+        end
+
+        delta = (now - timestamp).abs
+        if delta > tolerance_seconds
+          raise ArgumentError, 'webhook signature verification failed: signature timestamp outside tolerance'
+        end
+
+        expected = compute_signature(secret, timestamp, body)
+        return nil if signatures.any? { |signature| secure_compare(signature.downcase, expected) }
+
+        raise ArgumentError, 'webhook signature verification failed: signature mismatch'
+      end
+
+      def secure_compare(left, right)
+        return false unless left.bytesize == right.bytesize
+
+        left.unpack('C*').zip(right.unpack('C*')).reduce(0) { |acc, (a, b)| acc | (a ^ b) }.zero?
+      end
+      private_class_method :secure_compare
+    end
+  end
+end

data/lib/shedcloud/partner_api.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'partner_api/version'
+require_relative 'partner_api/hosts'
+require_relative 'partner_api/auth'
+require_relative 'partner_api/errors'
+require_relative 'partner_api/scopes'
+require_relative 'partner_api/request_options'
+require_relative 'partner_api/http_transport'
+require_relative 'partner_api/http_client'
+require_relative 'partner_api/auth_provider'
+require_relative 'partner_api/webhooks'
+require_relative 'partner_api/resources/base'
+require_relative 'partner_api/resources/lot_stock'
+require_relative 'partner_api/resources/stock_templates'
+require_relative 'partner_api/resources/leads'
+require_relative 'partner_api/resources/quotes'
+require_relative 'partner_api/resources/orders'
+require_relative 'partner_api/resources/work_orders'
+require_relative 'partner_api/resources/locations'
+require_relative 'partner_api/resources/customers'
+require_relative 'partner_api/resources/domains'
+require_relative 'partner_api/resources/agreements'
+require_relative 'partner_api/resources/products'
+require_relative 'partner_api/resources/users'
+require_relative 'partner_api/resources/payments'
+require_relative 'partner_api/resources/documents'
+require_relative 'partner_api/resources/events'
+require_relative 'partner_api/resources/configurator_sessions'
+require_relative 'partner_api/client'
+
+module ShedCloud
+  module PartnerApi
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: shedcloud-partner_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Corland Partners LLC
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Call ShedCloud Partner API endpoints (/partner/v1/*) with API keys or
+  OAuth2 client credentials.
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/release.yml"
+- ".gitignore"
+- AGENTS.md
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/list_lot_stock.rb
+- lib/shedcloud/partner_api.rb
+- lib/shedcloud/partner_api/auth.rb
+- lib/shedcloud/partner_api/auth_provider.rb
+- lib/shedcloud/partner_api/client.rb
+- lib/shedcloud/partner_api/errors.rb
+- lib/shedcloud/partner_api/hosts.rb
+- lib/shedcloud/partner_api/http_client.rb
+- lib/shedcloud/partner_api/http_transport.rb
+- lib/shedcloud/partner_api/request_options.rb
+- lib/shedcloud/partner_api/resources/agreements.rb
+- lib/shedcloud/partner_api/resources/base.rb
+- lib/shedcloud/partner_api/resources/configurator_sessions.rb
+- lib/shedcloud/partner_api/resources/customers.rb
+- lib/shedcloud/partner_api/resources/documents.rb
+- lib/shedcloud/partner_api/resources/domains.rb
+- lib/shedcloud/partner_api/resources/events.rb
+- lib/shedcloud/partner_api/resources/leads.rb
+- lib/shedcloud/partner_api/resources/locations.rb
+- lib/shedcloud/partner_api/resources/lot_stock.rb
+- lib/shedcloud/partner_api/resources/orders.rb
+- lib/shedcloud/partner_api/resources/payments.rb
+- lib/shedcloud/partner_api/resources/products.rb
+- lib/shedcloud/partner_api/resources/quotes.rb
+- lib/shedcloud/partner_api/resources/stock_templates.rb
+- lib/shedcloud/partner_api/resources/users.rb
+- lib/shedcloud/partner_api/resources/work_orders.rb
+- lib/shedcloud/partner_api/scopes.rb
+- lib/shedcloud/partner_api/version.rb
+- lib/shedcloud/partner_api/webhooks.rb
+homepage: https://github.com/Corland-Partners-LLC/shedcloud-gem
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Corland-Partners-LLC/shedcloud-gem
+  source_code_uri: https://github.com/Corland-Partners-LLC/shedcloud-gem
+  changelog_uri: https://github.com/Corland-Partners-LLC/shedcloud-gem/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: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Official Ruby client for the ShedCloud Partner API
+test_files: []