as_colour 0.1.0

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at weshays@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Dockerfile

@@ -0,0 +1,24 @@
+FROM ruby:3.3.5
+
+RUN apt update -yqq
+# RUN apt-get install libvips-dev -yqq
+# RUN apt-get install build-essential libpq-dev postgresql-contrib vim -yqq
+# RUN apt-get install imagemagick libmagickcore-dev libmagickwand-dev -yqq
+RUN apt-get -q clean
+RUN rm -rf /var/lib/apt/lists/* /usr/share/doc /usr/share/man
+
+RUN mkdir -p /app
+WORKDIR /app
+
+RUN gem update --system
+RUN gem install bundler --version 2.4.6
+RUN bundle config set specific_platform x86_64-linux
+COPY . .
+RUN bundle install
+
+
+# RUN bundle binstubs --all
+
+# RUN chmod +x docker-entrypoint.sh
+# ENTRYPOINT ["/app/docker-entrypoint.sh"]
+# CMD ["sleep", "100000"]

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ascolour.gemspec
+gemspec
+
+group :development do
+  gem 'pry-byebug', '~> 3.10'
+  gem 'dotenv', '~> 3.1'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.13'
+  gem 'rubocop', '~> 1.69'
+  gem 'simplecov', '~> 0.22'
+  gem 'vcr', '~> 6.3'
+  gem 'webmock', '~> 3.24'
+end

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    ascolour (0.1.0)
+      awrence (~> 3.0)
+      json (~> 2.12)
+      ostruct (~> 0.6.1)
+      plissken (~> 3.0)
+      typhoeus (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    awrence (3.0.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.6.0)
+    docile (1.4.1)
+    dotenv (3.1.7)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.17.1)
+    ffi (1.17.1-aarch64-linux-gnu)
+    ffi (1.17.1-aarch64-linux-musl)
+    ffi (1.17.1-arm-linux-gnu)
+    ffi (1.17.1-arm-linux-musl)
+    ffi (1.17.1-arm64-darwin)
+    ffi (1.17.1-x86-linux-gnu)
+    ffi (1.17.1-x86-linux-musl)
+    ffi (1.17.1-x86_64-darwin)
+    ffi (1.17.1-x86_64-linux-gnu)
+    ffi (1.17.1-x86_64-linux-musl)
+    hashdiff (1.1.2)
+    json (2.12.0)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    method_source (1.1.0)
+    ostruct (0.6.1)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    plissken (3.0.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.73.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.1)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    vcr (6.3.1)
+      base64
+    webmock (3.25.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  ruby
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  ascolour!
+  dotenv (~> 3.1)
+  pry-byebug (~> 3.10)
+  rake (~> 13.0)
+  rspec (~> 3.13)
+  rubocop (~> 1.69)
+  simplecov (~> 0.22)
+  vcr (~> 6.3)
+  webmock (~> 3.24)
+
+BUNDLED WITH
+   2.6.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 BenefitMany
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

data/README.md

@@ -0,0 +1,124 @@
+# ASColour
+
+This gem is a wrapper for the ASColour API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'as_colour'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ascolour
+
+## Usage
+
+```ruby
+require 'as_colour'
+
+auth = {
+  subscription_key: ENV['ASCOLOUR_SUBSCRIPTION_KEY']
+}
+
+client = AsColour::Client.new(auth)
+
+client.colours.each do |colour|
+  puts colour
+end
+```
+
+## Development
+
+### Local Development using RVM
+
+You will need to add a .env file to the root of the project with the following variables:
+
+```
+ASCOLOUR_SUBSCRIPTION_KEY=your_access_key
+```
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+### Local Development using Docker
+
+You can also use Docker to develop the gem. To do this, you will need to have Docker installed on your machine.
+
+To get started, you will need to build the Docker image:
+
+```
+docker compose build
+```
+
+After the image is built, you can run the following command to start the container. Note that
+you will want to do this in its own terminal window so you can attach to the container.
+
+```
+docker compose up
+```
+
+You will see "Attaching to ascolour" in the output. This means the container is running and you can now run the following command to attach to the container:
+
+```
+docker exec -it ascolour bash
+```
+
+To stop the container, you can run the following command:
+
+```
+docker compose down
+```
+
+# Rebuild Gemfile.lock
+
+```
+docker compose run ascolour bundle install
+```
+
+## Implemented Endpoints
+
+- Catalog
+  - Colours
+    - List: `GET /catalog/colours`
+  - Products
+    - List: `GET /catalog/products`
+    - Item: `GET /catalog/products/{style_code}`
+    - Images: `GET /catalog/products/{style_code}/images`
+  - Product Variants
+    - List: `GET /catalog/products/{style_code}/variants`
+    - Item: `GET /catalog/products/{style_code}/variants/{variant_id}`
+    - Inventory: `GET /catalog/products/{style_code}/variants/{variant_id}/inventory`
+    - Inventory Inbound: `GET /catalog/products/{style_code}/variants/{variant_id}/inbound`
+  - Price List
+    - List: `GET /price-list`
+- Inventory
+  - Items: `GET /inventory/items`
+  - Item: `GET /inventory/items/{sku}`
+
+## TODO Endpoints
+
+All known endpoints have been implemented. If you know of any endpoints that are not listed above, please open an issue or a pull request.
+
+## Limitations
+
+In order to use the ASColour API you must first have a ASColour account. At this time, ASColour does not offer a sandbox environment for testing, so you will need to reach out to them about getting access your account data.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BenefitMany/ascolour. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/BenefitMany/ascolour/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ascolour project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/BenefitMany/ascolour/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/as_colour.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), 'lib'))
+
+require_relative 'lib/as_colour/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'as_colour'
+  spec.version       = AsColour::VERSION
+  spec.authors       = ['Wes Hays']
+  spec.email         = ['weshays@gmail.com']
+
+  spec.summary       = 'Ruby API wrapper for the ASColour.com API'
+  spec.description   = 'Ruby API wrapper for the ASColour.com API'
+  spec.homepage      = 'https://github.com/BenefitMany/as_colour'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['source_code_uri'] = 'https://github.com/BenefitMany/as_colour'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/BenefitMany/as_colour/issues'
+  spec.metadata['changelog_uri'] = 'https://github.com/BenefitMany/as_colour/blob/main/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://github.com/BenefitMany/as_colour/blob/main/as_colour_api.pdf'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'typhoeus', '~> 1.4'
+  spec.add_dependency 'json', '~> 2.12'
+  spec.add_dependency 'plissken', '~> 3.0'
+  spec.add_dependency 'awrence', '~> 3.0'
+  spec.add_dependency 'ostruct', '~> 0.6.1'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'as_colour'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,20 @@
+services:
+  ascolour:
+    container_name: "ascolour"
+    platform: linux/x86_64
+    build: .
+    # command: bundle exec rails s -p 3000 -b '0.0.0.0'
+    environment:
+      LOG_LEVEL: DEBUG
+    volumes:
+      - .:/app
+      - ascolour_bundle:/usr/local/bundle
+    working_dir: /app
+    # Keeps the stdin open, so we can attach to our app container's process and
+    # do stuff such as `byebug` or `binding.pry`:
+    stdin_open: true
+    # Allows us to send signals (CTRL+C, CTRL+P + CTRL+Q) into the container
+    tty: true
+
+volumes:
+  ascolour_bundle:

data/examples/catalog_colours.rb

@@ -0,0 +1,23 @@
+require 'pry-byebug'
+require 'dotenv'
+require_relative '../lib/as_colour'
+
+Dotenv.load('../.env')
+
+auth = {
+  subscription_key: ENV['ASCOLOUR_SUBSCRIPTION_KEY']
+}
+ascolor_client = AsColour::Client.new(auth)
+
+# =========================================
+# Colours List
+# =========================================
+ascolor_client.colours.each do |colour|
+  puts colour
+end
+
+# Filter by color name
+# =========================================
+ascolor_client.colours(colour_filter: 'red').each do |colour|
+  puts colour
+end

data/examples/catalog_products.rb

@@ -0,0 +1,54 @@
+require 'pry-byebug'
+require 'dotenv'
+require_relative '../lib/as_colour'
+
+Dotenv.load('../.env')
+
+auth = {
+  subscription_key: ENV['ASCOLOUR_SUBSCRIPTION_KEY']
+}
+ascolor_client = AsColour::Client.new(auth)
+
+# =========================================
+# Products List
+# =========================================
+
+ascolor_client.products.each do |colour|
+  puts colour
+end
+
+# Filter by color name
+# =========================================
+ascolor_client.colours(colour_filter: 'red').each do |colour|
+  puts colour
+end
+
+# Variant List
+# =========================================
+ascolor_client.product_variants('1001').each do |variant|
+  puts variant
+end
+
+# Variant Item
+# =========================================
+ascolor_client.product_variant('1001', '1001-BLACK-P-OS').each do |inventory|
+  puts inventory
+end
+
+# Variant Inventory
+# =========================================
+ascolor_client.product_variant_inventory('1001', '1001-BLACK-P-OS').each do |inventory|
+  puts inventory
+end
+
+# Variant Inventory Inbound (NOT WORKING)
+# =========================================
+# ascolor_client.product_variant_inventory_inbound('1001', '1001-BLACK-P-OS').each do |inventory|
+#   puts inventory
+# end
+
+# Product Images
+# =========================================
+ascolor_client.product_images('1001').each do |variant|
+  puts variant
+end

data/examples/inventory.rb

@@ -0,0 +1,23 @@
+require 'pry-byebug'
+require 'dotenv'
+require_relative '../lib/as_colour'
+
+Dotenv.load('../.env')
+
+auth = {
+  subscription_key: ENV['ASCOLOUR_SUBSCRIPTION_KEY']
+}
+ascolor_client = AsColour::Client.new(auth)
+
+# =========================================
+# Items List
+# =========================================
+ascolor_client.items.each do |item|
+  puts item
+end
+
+# Item by SKU
+# =========================================
+ascolor_client.item('1001-BLACK-P-OS').each do |item|
+  puts item
+end

data/examples/price_list.rb

@@ -0,0 +1,25 @@
+require 'pry-byebug'
+require 'dotenv'
+require_relative '../lib/as_colour'
+
+Dotenv.load('../.env')
+
+auth = {
+  subscription_key: ENV['ASCOLOUR_SUBSCRIPTION_KEY'],
+  email: ENV['ASCOLOUR_EMAIL'],
+  password: ENV['ASCOLOUR_PASSWORD']
+}
+ascolor_client = AsColour::Client.new(auth)
+
+# =========================================
+# Price List
+# =========================================
+ascolor_client.price_list.each do |price|
+  puts price
+end
+
+# Set Page Number and Page Size
+# =========================================
+ascolor_client.price_list(page_number: 2, page_size: 3).each do |price|
+  puts price
+end