as_colour 0.1.0

data/lib/as_colour/as_colour_error.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module AsColour
+  class AsColourError < StandardError
+  #   attr_reader :error
+  #   attr_reader :raw
+  #   attr_reader :response_code
+
+  #   def initialize(http_response)
+  #     @raw = http_response
+  #     @response_code = @raw.response_code
+
+  #     data = process_response_body
+  #     if data.nil?
+  #       set_default_error_message
+  #     else
+  #       @error = data
+  #     end
+  #   end
+
+  #   def error?
+  #     true
+  #   end
+
+  #   def to_s
+  #     return remove_extra_quotes(@error) if @error.is_a?(String)
+
+  #     retval = @error.each_with_object([]) do |(key, value), str|
+  #       str_value = value.is_a?(Array) ? value.join(', ') : value
+  #       str_value = remove_extra_quotes(str_value)
+  #       str << "#{key}: #{str_value}"
+  #     end
+  #     retval.join(', ')
+  #   end
+  #   alias message to_s
+
+  #   private
+
+  #   def remove_extra_quotes(str)
+  #     str.tr('"', '')
+  #   end
+
+  #   def process_response_body
+  #     JSON.parse(@raw.body, symbolize_names: true).to_snake_keys unless @raw.body.empty?
+  #   rescue StandardError
+  #     @raw.body.strip
+  #   end
+
+  #   def set_default_error_message
+  #     require 'uri'
+  #     api_path = URI.parse(@raw.effective_url).path
+  #     @error = "ASColour API returned an error for #{api_path}."
+
+  #     if @response_code == 401
+  #       @error += ' Please check your credentials.'
+  #     elsif @response_code == 404
+  #       @error += ' Please check your API path.'
+  #     end
+  #   end
+  end
+end

data/lib/as_colour/client/colours.rb

@@ -0,0 +1,13 @@
+module AsColour
+  class Client
+    module Colours
+      def colours(args = {})
+        results = process_request(:get, 'catalog/colours', params: args)
+        return results if results.is_a?(AsColourError)
+
+        results[:data].map { |row| AsColour::Colour.new(row) }
+      end
+      alias list_colours colours
+    end
+  end
+end

data/lib/as_colour/client/inventory_items.rb

@@ -0,0 +1,20 @@
+module AsColour
+  class Client
+    module InventoryItems
+      def items(args = {})
+        results = process_request(:get, 'inventory/items', params: args)
+        return results if results.is_a?(AsColourError)
+
+        results[:data].map { |row| AsColour::InventoryItem.new(row) }
+      end
+      alias list_items items
+
+      def item(sku)
+        results = process_request(:get, "inventory/items/#{sku}")
+        return results if results.is_a?(AsColourError)
+
+        results[:data].map { |row| AsColour::InventoryItem.new(row) }
+      end
+    end
+  end
+end

data/lib/as_colour/client/price_list.rb

@@ -0,0 +1,13 @@
+module AsColour
+  class Client
+    module PriceList
+      def price_list(args = {})
+        args.merge!(auth_token_required: true)
+        results = process_request(:get, 'catalog/pricelist', params: args)
+        return results if results.is_a?(AsColourError)
+
+        results[:data].map { |row| AsColour::PriceListItem.new(row) }
+      end
+    end
+  end
+end

data/lib/as_colour/client/product_variants.rb

@@ -0,0 +1,33 @@
+module AsColour
+  class Client
+    module ProductVariants
+      def product_variants(style_code, args = {})
+        results = process_request(:get, "catalog/products/#{style_code}/variants", params: args)
+        return results if results.is_a?(AsColourError)
+
+        results[:data].map { |row| AsColour::Product.new(row) }
+      end
+
+      def product_variant(style_code, variant_id)
+        result = process_request(:get, "catalog/products/#{style_code}/variants/#{variant_id}")
+        return result if result.is_a?(AsColourError)
+
+        AsColour::Product.new(result)
+      end
+
+      def product_variant_inventory(style_code, variant_id)
+        results = process_request(:get, "catalog/products/#{style_code}/variants/#{variant_id}/inventory")
+        return results if results.is_a?(AsColourError)
+
+        results[:data].map { |row| AsColour::ProductInventory.new(row) }
+      end
+
+      def product_variant_inventory_inbound(style_code, variant_id)
+        result = process_request(:get, "catalog/products/#{style_code}/variants/#{variant_id}/inbound")
+        return result if result.is_a?(AsColourError)
+
+        AsColour::Product.new(result)
+      end
+    end
+  end
+end

data/lib/as_colour/client/products.rb

@@ -0,0 +1,27 @@
+module AsColour
+  class Client
+    module Products
+      def products(args = {})
+        results = process_request(:get, 'catalog/products', params: args)
+        return results if results.is_a?(AsColourError)
+
+        results[:data].map { |row| AsColour::Product.new(row) }
+      end
+      alias list_products products
+
+      def product(style_code)
+        result = process_request(:get, "catalog/products/#{style_code}")
+        return result if result.is_a?(AsColourError)
+
+        AsColour::Product.new(result)
+      end
+
+      def product_images(style_code)
+        results = process_request(:get, "catalog/products/#{style_code}/images")
+        return results if results.is_a?(AsColourError)
+
+        results[:data].map { |row| AsColour::ProductImage.new(row) }
+      end
+    end
+  end
+end

data/lib/as_colour/client.rb

@@ -0,0 +1,105 @@
+require_relative 'client/colours'
+require_relative 'client/products'
+require_relative 'client/product_variants'
+require_relative 'client/inventory_items'
+require_relative 'client/price_list'
+
+require_relative 'model/as_colour_model'
+require_relative 'model/colour'
+require_relative 'model/inventory_item'
+require_relative 'model/price_list_item'
+require_relative 'model/product'
+require_relative 'model/product_image'
+require_relative 'model/product_inventory'
+require_relative 'model/product_variant'
+
+module AsColour
+  class Client
+    include AsColour::Client::Colours
+    include AsColour::Client::Products
+    include AsColour::Client::ProductVariants
+    include AsColour::Client::InventoryItems
+    include AsColour::Client::PriceList
+
+    def initialize(auth = nil)
+      @auth = auth || load_from_environment
+
+      if @auth.nil?
+        raise AsColourError, 'API authentication incomplete! You need the subscription key.'
+      end
+    end
+
+    private
+
+    def as_colour_auth_headers(auth_token_required)
+      retval = {
+        'Content-Type' => 'application/json',
+        'charset' => 'utf-8',
+        'Subscription-Key' => @auth[:subscription_key]
+      }
+      retval['Authorization'] = "Bearer #{process_auth_token_request}" if auth_token_required
+      retval
+    end
+
+    def load_from_environment
+      return if ENV['ASCOLOUR_SUBSCRIPTION_KEY'].nil?
+
+      {
+        subscription_key: ENV['ASCOLOUR_SUBSCRIPTION_KEY'],
+        email: ENV['ASCOLOUR_EMAIL'],
+        password: ENV['ASCOLOUR_PASSWORD']
+      }
+    end
+
+    def process_as_colour_response(response_body)
+      JSON.parse(response_body, symbolize_names: true).to_snake_keys
+    rescue
+      response_body
+    end
+
+    def process_auth_token_request
+      request_params = {
+        method: :post,
+        headers: as_colour_auth_headers(nil),
+        body: {
+          email: @auth[:email],
+          password: @auth[:password]
+        }.to_json
+      }
+
+      proxy = @auth[:proxy] || ENV['PROXY']
+      request_params[:proxy] = proxy unless proxy.nil?
+
+      response = Typhoeus::Request.new(
+        "https://api.ascolour.com/v1/api/authentication",
+        request_params
+      ).run
+      return AsColourError.new(response) unless response.success?
+
+      retval = process_as_colour_response(response.body)
+      retval[:token]
+    end
+
+    def process_request(request_type, url_path, options = {})
+      options_params = options[:params] || {}
+      auth_token_required = options_params.delete(:auth_token_required) || false
+      request_params = {
+        method: request_type,
+        params: options_params.to_camelback_keys,
+        headers: as_colour_auth_headers(auth_token_required),
+        body: options[:body]&.to_json
+      }
+
+      proxy = @auth[:proxy] || ENV['PROXY']
+      request_params[:proxy] = proxy unless proxy.nil?
+
+      response = Typhoeus::Request.new(
+        "https://api.ascolour.com/v1/#{url_path}",
+        request_params
+      ).run
+      return AsColourError.new(response) unless response.success?
+
+      process_as_colour_response(response.body)
+    end
+  end
+end

data/lib/as_colour/model/as_colour_model.rb

@@ -0,0 +1,7 @@
+module AsColour
+  class AsColourModel < OpenStruct
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/as_colour/model/colour.rb

@@ -0,0 +1,7 @@
+module AsColour
+  class Colour < AsColourModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/as_colour/model/inventory_item.rb

@@ -0,0 +1,7 @@
+module AsColour
+  class InventoryItem < AsColourModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/as_colour/model/price_list_item.rb

@@ -0,0 +1,7 @@
+module AsColour
+  class PriceListItem < AsColourModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/as_colour/model/product.rb

@@ -0,0 +1,7 @@
+module AsColour
+  class Product < AsColourModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/as_colour/model/product_image.rb

@@ -0,0 +1,7 @@
+module AsColour
+  class ProductImage < AsColourModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/as_colour/model/product_inventory.rb

@@ -0,0 +1,7 @@
+module AsColour
+  class ProductInventory < AsColourModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/as_colour/model/product_variant.rb

@@ -0,0 +1,7 @@
+module AsColour
+  class ProductVariant < AsColourModel
+    def initialize(data = {})
+      super(data)
+    end
+  end
+end

data/lib/as_colour/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AsColour
+  VERSION = '0.1.0'
+end

data/lib/as_colour.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'json'
+require 'typhoeus'
+require 'awrence'
+require 'plissken'
+require 'base64'
+require 'ostruct'
+
+require_relative 'as_colour/version'
+require_relative 'as_colour/client'
+require_relative 'as_colour/as_colour_error'

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: as_colour
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wes Hays
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: plissken
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awrence
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+description: Ruby API wrapper for the ASColour.com API
+email:
+- weshays@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- as_colour.gemspec
+- as_colour_api.pdf
+- bin/console
+- bin/setup
+- docker-compose.yml
+- examples/catalog_colours.rb
+- examples/catalog_products.rb
+- examples/inventory.rb
+- examples/price_list.rb
+- lib/as_colour.rb
+- lib/as_colour/as_colour_error.rb
+- lib/as_colour/client.rb
+- lib/as_colour/client/colours.rb
+- lib/as_colour/client/inventory_items.rb
+- lib/as_colour/client/price_list.rb
+- lib/as_colour/client/product_variants.rb
+- lib/as_colour/client/products.rb
+- lib/as_colour/model/as_colour_model.rb
+- lib/as_colour/model/colour.rb
+- lib/as_colour/model/inventory_item.rb
+- lib/as_colour/model/price_list_item.rb
+- lib/as_colour/model/product.rb
+- lib/as_colour/model/product_image.rb
+- lib/as_colour/model/product_inventory.rb
+- lib/as_colour/model/product_variant.rb
+- lib/as_colour/version.rb
+homepage: https://github.com/BenefitMany/as_colour
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/BenefitMany/as_colour
+  bug_tracker_uri: https://github.com/BenefitMany/as_colour/issues
+  changelog_uri: https://github.com/BenefitMany/as_colour/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/BenefitMany/as_colour/blob/main/as_colour_api.pdf
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.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: Ruby API wrapper for the ASColour.com API
+test_files: []