shedcloud-partner_api 0.1.0

data/lib/shedcloud/partner_api/http_client.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'uri'
+
+module ShedCloud
+  module PartnerApi
+    class HttpClient
+      def initialize(base_url:, get_access_token:, transport: HttpTransport.new, user_agent: 'shedcloud-ruby/partner-api')
+        @base_url = Hosts.trim_trailing_slashes(base_url)
+        @get_access_token = get_access_token
+        @transport = transport
+        @user_agent = user_agent
+      end
+
+      def request(method, path, query: nil, body: nil, headers: {}, skip_auth: false, content_type: 'application/json')
+        url = @base_url + path
+        if query && !query.empty?
+          encoded = self.class.encode_query(query)
+          url += "?#{encoded}" unless encoded.empty?
+        end
+
+        request_headers = {
+          'Accept' => 'application/json',
+          'User-Agent' => @user_agent
+        }.merge(headers)
+
+        payload = nil
+        unless body.nil?
+          payload = if content_type == 'application/x-www-form-urlencoded'
+                      URI.encode_www_form(body)
+                    elsif body.empty?
+                      '{}'
+                    else
+                      JSON.generate(body)
+                    end
+          request_headers['Content-Type'] = content_type if content_type
+        end
+
+        unless skip_auth
+          token = @get_access_token.call
+          raise PartnerApiError.new('no access token available', status: 401) if token.to_s.empty?
+
+          request_headers['Authorization'] = "Bearer #{token}"
+        end
+
+        response = @transport.send(method, url, request_headers, payload)
+        parsed = parse_body(response[:body])
+
+        if response[:status] < 200 || response[:status] >= 300
+          message, code = extract_error(parsed, response[:status].to_s)
+          raise PartnerApiError.new(message, status: response[:status], body: parsed, code: code)
+        end
+
+        return nil if parsed.nil?
+        raise PartnerApiError.new('partner-api: decode response: expected JSON object', status: 500) unless parsed.is_a?(Hash)
+
+        parsed
+      end
+
+      def self.encode_query(params)
+        out = {}
+
+        params.each do |key, value|
+          key = key.to_s
+
+          if value.is_a?(QueryValue)
+            out[key] = format_query_value(value.value)
+            next
+          end
+
+          next if value.nil? || value == '' || value == false || value == 0 || value == 0.0 || value == []
+
+          if value.is_a?(Array)
+            out[key] = value.map { |item| format_query_value(item) }.join(',')
+            next
+          end
+
+          out[key] = format_query_value(value)
+        end
+
+        URI.encode_www_form(out)
+      end
+
+      def self.format_query_value(value)
+        case value
+        when TrueClass, FalseClass then value ? 'true' : 'false'
+        else value.to_s
+        end
+      end
+
+      private
+
+      def parse_body(raw)
+        return nil if raw.nil? || raw.empty?
+
+        JSON.parse(raw)
+      rescue JSON::ParserError
+        raw
+      end
+
+      def extract_error(body, fallback)
+        message = fallback
+        code = nil
+
+        return [message, code] unless body.is_a?(Hash)
+
+        message = body['error_description'] if body['error_description'].is_a?(String) && !body['error_description'].empty?
+        message = body['error'] if message == fallback && body['error'].is_a?(String) && !body['error'].empty?
+        message = body['message'] if message == fallback && body['message'].is_a?(String) && !body['message'].empty?
+        code = body['error'] if body['error'].is_a?(String)
+
+        [message, code]
+      end
+    end
+  end
+end

data/lib/shedcloud/partner_api/http_transport.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+module ShedCloud
+  module PartnerApi
+    class HttpTransport
+      REQUEST_CLASS = {
+        'GET' => Net::HTTP::Get,
+        'POST' => Net::HTTP::Post,
+        'PUT' => Net::HTTP::Put,
+        'PATCH' => Net::HTTP::Patch,
+        'DELETE' => Net::HTTP::Delete
+      }.freeze
+
+      def send(method, url, headers, body)
+        uri = URI(url)
+        request = build_request(method, uri, headers, body)
+
+        response = Net::HTTP.start(
+          uri.host,
+          uri.port,
+          use_ssl: uri.scheme == 'https',
+          open_timeout: 30,
+          read_timeout: 30
+        ) do |http|
+          http.request(request)
+        end
+
+        {
+          status: response.code.to_i,
+          body: response.body.to_s,
+          headers: response.each_header.to_h.transform_values { |v| [v] }
+        }
+      end
+
+      private
+
+      def build_request(method, uri, headers, body)
+        klass = REQUEST_CLASS[method.to_s.upcase]
+        if klass
+          request = klass.new(uri)
+          headers.each { |name, value| request[name] = value }
+          request.body = body unless body.nil?
+          return request
+        end
+
+        request = Net::HTTP::GenericRequest.new(method.to_s.upcase, !body.nil?, !body.nil?, uri)
+        headers.each { |name, value| request[name] = value }
+        request.body = body unless body.nil?
+        request
+      end
+    end
+  end
+end

data/lib/shedcloud/partner_api/request_options.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    # Wraps a query parameter value that must be sent even when falsy (e.g. converted=false).
+    QueryValue = Data.define(:value)
+
+    class RequestOptions
+      attr_reader :idempotency_key, :if_match
+
+      def initialize(idempotency_key: nil, if_match: nil)
+        @idempotency_key = idempotency_key
+        @if_match = if_match
+      end
+
+      def self.with_idempotency_key(key)
+        new(idempotency_key: key)
+      end
+
+      def self.with_if_match(version)
+        new(if_match: version)
+      end
+
+      def headers
+        out = {}
+        out['Idempotency-Key'] = idempotency_key if idempotency_key && !idempotency_key.empty?
+        out['If-Match'] = if_match.to_s unless if_match.nil?
+        out
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class Agreements < Base
+        def list(params = {})
+          @http.request('GET', '/partner/v1/agreements', query: params) || {}
+        end
+
+        def get(id)
+          @http.request('GET', "/partner/v1/agreements/#{path_segment(id)}") || {}
+        end
+
+        def active
+          @http.request('GET', '/partner/v1/agreements/active') || {}
+        end
+
+        def list_state_legal(agreement_id)
+          @http.request('GET', "/partner/v1/agreements/#{path_segment(agreement_id)}/state-legal") || {}
+        end
+
+        def get_state_legal(agreement_id, state)
+          @http.request('GET', "/partner/v1/agreements/#{path_segment(agreement_id)}/state-legal/#{path_segment(state)}") || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class Base
+        def initialize(http)
+          @http = http
+        end
+
+        private
+
+        def path_segment(id)
+          URI.encode_www_form_component(id.to_s)
+        end
+
+        def option_headers(options)
+          options&.headers || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class ConfiguratorSessions < Base
+        def create(body, options: nil)
+          @http.request('POST', '/partner/v1/configurator-sessions', body: body, headers: option_headers(options)) || {}
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class Documents < Base
+        def list(params)
+          @http.request('GET', '/partner/v1/documents', query: params) || {}
+        end
+
+        def download(id)
+          @http.request('GET', "/partner/v1/documents/#{path_segment(id)}/download") || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class Domains < Base
+        def list(params = {})
+          @http.request('GET', '/partner/v1/domains', query: params) || {}
+        end
+
+        def for_location(location_id, params = {})
+          @http.request('GET', "/partner/v1/locations/#{path_segment(location_id)}/domains", query: params) || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class Events < Base
+        def list(params = {})
+          query = params.dup
+          query[:types] = query[:types].join(',') if query[:types].is_a?(Array)
+          @http.request('GET', '/partner/v1/events', query: query) || {}
+        end
+
+        def each(params = {})
+          cursor = params[:cursor].to_s
+          last_seen = cursor
+
+          loop do
+            page_params = params.dup
+            if cursor.empty?
+              page_params.delete(:cursor)
+            else
+              page_params[:cursor] = cursor
+            end
+
+            response = list(page_params)
+            data = response['data'].is_a?(Array) ? response['data'] : []
+
+            data.each do |event|
+              result = yield(event)
+              return last_seen if result == false
+
+              last_seen = event['id'] if event['id'].is_a?(String) && !event['id'].empty?
+            end
+
+            break unless response['hasMore'] && response['nextCursor'].is_a?(String) && !response['nextCursor'].empty?
+
+            cursor = response['nextCursor']
+          end
+
+          last_seen
+        end
+
+        def redeliver(id)
+          @http.request('POST', "/partner/v1/events/#{path_segment(id)}/redeliver") || {}
+        end
+
+        def deliveries(params = {})
+          @http.request('GET', '/partner/v1/webhook-deliveries', query: params) || {}
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class LotStock < Base
+        def list(params = {})
+          @http.request('GET', '/partner/v1/lot-stock', query: params) || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class Orders < Base
+        def list(params = {})
+          @http.request('GET', '/partner/v1/orders', query: params) || {}
+        end
+
+        def get(id)
+          @http.request('GET', "/partner/v1/orders/#{path_segment(id)}") || {}
+        end
+
+        def create(body, options: nil)
+          @http.request('POST', '/partner/v1/orders', body: body, headers: option_headers(options)) || {}
+        end
+
+        def add_line_item(id, body)
+          @http.request('POST', "/partner/v1/orders/#{path_segment(id)}/line-items", body: body) || {}
+        end
+
+        def delete_line_item(id, line_id)
+          @http.request('DELETE', "/partner/v1/orders/#{path_segment(id)}/line-items/#{path_segment(line_id)}")
+        end
+
+        def update(id, body, options: nil)
+          @http.request('PATCH', "/partner/v1/orders/#{path_segment(id)}", body: body, headers: option_headers(options)) || {}
+        end
+
+        def update_status(id, body)
+          @http.request('POST', "/partner/v1/orders/#{path_segment(id)}/status", body: body) || {}
+        end
+
+        def status_history(id, params = {})
+          @http.request('GET', "/partner/v1/orders/#{path_segment(id)}/status-history", query: params) || {}
+        end
+
+        def line_items(id)
+          @http.request('GET', "/partner/v1/orders/#{path_segment(id)}/line-items") || {}
+        end
+
+        def contract(id)
+          @http.request('GET', "/partner/v1/orders/#{path_segment(id)}/contract") || {}
+        end
+
+        def payments(id, params = {})
+          @http.request('GET', "/partner/v1/orders/#{path_segment(id)}/payments", query: params) || {}
+        end
+
+        def create_payment(id, body, options: nil)
+          @http.request('POST', "/partner/v1/orders/#{path_segment(id)}/payments", body: body, headers: option_headers(options)) || {}
+        end
+
+        def create_payment_link(id, body)
+          @http.request('POST', "/partner/v1/orders/#{path_segment(id)}/payment-links", body: body) || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class Payments < Base
+        def list(params = {})
+          @http.request('GET', '/partner/v1/payments', query: params) || {}
+        end
+
+        def get(id)
+          @http.request('GET', "/partner/v1/payments/#{path_segment(id)}") || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class Products < Base
+        def list(params = {})
+          @http.request('GET', '/partner/v1/products', query: params) || {}
+        end
+
+        def get(id)
+          @http.request('GET', "/partner/v1/products/#{path_segment(id)}") || {}
+        end
+
+        def create(body, options: nil)
+          @http.request('POST', '/partner/v1/products', body: body, headers: option_headers(options)) || {}
+        end
+
+        def update(id, body)
+          @http.request('PATCH', "/partner/v1/products/#{path_segment(id)}", body: body) || {}
+        end
+
+        def create_size(id, body, options: nil)
+          @http.request('POST', "/partner/v1/products/#{path_segment(id)}/sizes", body: body, headers: option_headers(options)) || {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class Quotes < Base
+        def list(params = {})
+          @http.request('GET', '/partner/v1/quotes', query: params) || {}
+        end
+
+        def create(body, options: nil)
+          @http.request('POST', '/partner/v1/quotes', body: body, headers: option_headers(options)) || {}
+        end
+
+        def convert(id, body = {}, options: nil)
+          @http.request('POST', "/partner/v1/quotes/#{path_segment(id)}/convert", body: body, headers: option_headers(options)) || {}
+        end
+
+        def get(id)
+          @http.request('GET', "/partner/v1/quotes/#{path_segment(id)}") || {}
+        end
+
+        def update(id, body, options: nil)
+          @http.request('PATCH', "/partner/v1/quotes/#{path_segment(id)}", body: body, headers: option_headers(options)) || {}
+        end
+
+        def update_status(id, body)
+          @http.request('POST', "/partner/v1/quotes/#{path_segment(id)}/status", body: body) || {}
+        end
+
+        def status_history(id, params = {})
+          @http.request('GET', "/partner/v1/quotes/#{path_segment(id)}/status-history", query: params) || {}
+        end
+
+        def line_items(id)
+          @http.request('GET', "/partner/v1/quotes/#{path_segment(id)}/line-items") || {}
+        end
+
+        def add_line_item(id, body)
+          @http.request('POST', "/partner/v1/quotes/#{path_segment(id)}/line-items", body: body) || {}
+        end
+
+        def delete_line_item(id, line_id)
+          @http.request('DELETE', "/partner/v1/quotes/#{path_segment(id)}/line-items/#{path_segment(line_id)}")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ShedCloud
+  module PartnerApi
+    module Resources
+      class StockTemplates < Base
+        def list(params = {})
+          query = params.dup
+          query[:tags] = query[:tags].join(',') if query[:tags].is_a?(Array)
+          @http.request('GET', '/partner/v1/stock-templates', query: query) || {}
+        end
+
+        def get(id)
+          @http.request('GET', "/partner/v1/stock-templates/#{path_segment(id)}") || {}
+        end
+      end
+    end
+  end
+end

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

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