big_commerce-management_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 633a92516ac21a7df777b1bdae97d4b0ec623f00f0946b77822bf04432cde707
+  data.tar.gz: 3409875235a0efe188b7a9f16fe22040600546dd68a5fe7ed739547934a4fb9c
+SHA512:
+  metadata.gz: fa94744067607cd0e15129a0815c2a45465ddbdd3b3dece4adb637494758b250d77febac896b23d5431db258843edb613b389743471f15bb6c2ed4939a27f5a9
+  data.tar.gz: fec8d7979001e9193e76d10c0231be65ec84312828969fd76a649beb453bf7fc49633c9332b4e9f454ae32d49c82ac58bb65a1c75336e2bd703ef35b25a69793

data/.env.test.example

@@ -0,0 +1,3 @@
+# Used by VCR-based tests
+BC_ACCESS_TOKEN=
+BC_STORE_HASH=

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      BC_ACCESS_TOKEN: "Foo"
+      BC_STORE_HASH: "Bar"
+    strategy:
+      matrix:
+        ruby: ['3.2', '3.1', '3.0', '2.7', '2.6', '2.5']
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,62 @@
+# Created by https://www.toptal.com/developers/gitignore/api/ruby
+# Edit at https://www.toptal.com/developers/gitignore?templates=ruby
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env*
+!.env*.example
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# End of https://www.toptal.com/developers/gitignore/api/ruby

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in big_commerce_rest.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Skye Shaw
+
+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,89 @@
+# BigCommerce::ManagementAPI
+
+![CI Status](https://github.com/ScreenStaring/big_commerce-management_api/actions/workflows/ci.yml/badge.svg)
+
+v3 API client for [BigCommerce's REST Management API](https://developer.bigcommerce.com/docs/rest-management)
+
+**Incomplete! v3 has many endpoints and this only provides what we need at ScreenStaring** which currently
+is mostly customers and subscribers stuff but adding new endpoints should be trivial. See [Adding New Endpoints](#adding-new-endpoints).
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "big_commerce-management_api"
+```
+
+And then execute:
+
+    bundle install
+
+Or install it yourself as:
+
+    gem install big_commerce-management_api
+
+## Usage
+
+```rb
+require "big_commerce/management_api"
+
+bc = BigCommerce::ManagementAPI.new(store_hash, auth_token)
+customers = bc.customers.get
+customers = bc.customers.get(:id => [1,2,3], :include => %w[addresses formfields], :page => 10, :limit => 25)
+
+p customers.meta.pagination.total
+p customers.headers.request_id
+p customers.headers["some-header"]
+
+# customers is Enumerable
+customers.each do |customer|
+  p customer.first_name
+  p customer.addresses[0].address_type
+  # ...
+end
+
+begin
+  customers = bc.customers.get(:page => 1, :size => 99)
+rescue BigCommerce::ManagementAPI::ResponseError => e
+  p e.message
+  p e.headers.rate_limit_requests_left
+end
+
+attribute = bc.customers.attributes.create(
+  :name => "Daily screen-staring count",
+  :type => "number"
+)
+p attribute.id
+p attribute.meta.total # 1
+```
+
+## Adding New Endpoints
+
+1. Add JSON response body to `lib/big_commerce/management/classes.json`
+1. Create or update `lib/big_commerce/management/THE_RESOURCE.rb`. See `customers.rb` for an example
+1. For new classes
+   - If the response JSON's top-level property is not `"data"` define `RESULT_KEY` with the name of the top-level property
+   - Define `RESULT_INSTANCE` and set it to the class to use on response data pointed to by `RESULT_KEY`
+   - Call the appropriate HTTP verb method passing the endpoint's path (the portion **after** the API's `v3` URL) and parameters
+1. If the method's return value should not be an `Array` call `unwrap(result)` before returning
+
+## Testing
+
+Tests use [VCR](https://github.com/vcr/vcr). If you need to re-record cassettes or create new ones a BigCommerce
+account is with API access is required. See `.env.test.example`.
+
+To re-record certain tests you must import fixture data into your store. See `etc/customers.csv`. These records can be deleted once
+the VCR cassettes are recorded and you are done with development. The IDs they create are assumed by the tests which may present
+a problem. Open an issue if so.
+
+Any records that are created by the tests are deleted. Well, a delete is attempted in an `after` block, if something goes wrong with the test
+the record(s) may remain in your store.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+Made by [ScreenStaring](http://screenstaring.com)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/big_commerce-management_api.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/big_commerce/management_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "big_commerce-management_api"
+  spec.version       = BigCommerce::ManagementAPI::VERSION
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{v3 API client for BigCommerce's REST Management API}
+  spec.description = %q{v3 API client for BigCommerce's REST Management API. Implementation is far from complete but adding support for new endpoints is trivial.}
+  spec.homepage      = "https://github.com/ScreenStaring/big_commerce-management_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ScreenStaring/big_commerce-management_api"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/ScreenStaring/big_commerce-management_api/issues"
+  # spec.metadata["changelog_uri"] = "https://github.com/ScreenStaring/big_commerce-management_api/blob/master/Changes"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "class2", ">= 0.6.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "dotenv"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "big_commerce/management_api"
+
+# 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/etc/customers.csv

@@ -0,0 +1,6 @@
+Email Address,First Name,Last Name,Company,Phone,Notes,Store Credit,Customer Group,Address ID - 1,Address First Name - 1,Address Last Name - 1,Address Company - 1,Address Line 1 - 1,Address Line 2 - 1,Address City - 1,Address State - 1,Address Zip - 1,Address Country - 1,Receive Review/Abandoned Cart Emails?
+user1@example.com,John,Doe,Acme Inc. ,555-555-1212,Note 1,59.99,,,,,Fofiha,59 West 46th Street,,New York,New York,10005,United States,N
+user2@example.com,Bob,John,Acme Inc. ,212-555-1212,,,,,,,,123 55th St. ,#1,New York,New York,10038,United States,N
+user3@example.com,Richard,Smith,FooBar LLC,310-555-1212,,101,,,Abe,Simpson,,21 W. 21st St. ,,New York,New York,10015,United States,Y
+user4@example.com,Paulo,Costa,,,,,,,,,,666 6th Ave. ,,New York,New York,10005,United States,N
+user5@example.com,Caio,Oliver ,,510-555-1212,,,,,,,Fofiha,125 55th St. ,Apt 3Q,New York,New York,10001,United States,Y

data/lib/big_commerce/management_api/classes.json

@@ -0,0 +1,130 @@
+{
+  "attribute": {
+    "id": 1,
+    "name": "Age",
+    "type": "string",
+    "date_modified": {"json_class":"Time","s":0,"n":0},
+    "date_created": {"json_class":"Time","s":0,"n":0}
+  },
+  "attribute_value": {
+    "attribute_id": 0,
+    "attribute_value": "string",
+    "id": 0,
+    "customer_id": 0,
+    "date_modified": {"json_class":"Time","s":0,"n":0},
+    "date_created": {"json_class":"Time","s":0,"n":0}
+  },
+  "customer": {
+    "id": 1,
+    "email": "string@example.com",
+    "first_name": "string",
+    "last_name": "string",
+    "company": "string",
+    "phone": "string",
+    "notes": "string",
+    "tax_exempt_category": "string",
+    "customer_group_id": 0,
+    "addresses": [
+      {
+        "first_name": "string",
+        "last_name": "string",
+        "company": "string",
+        "address1": "Addr1",
+        "address2": "",
+        "city": "string",
+        "state_or_province": "string",
+        "postal_code": "string",
+        "country_code": "st",
+        "phone": "string",
+        "address_type": "residential",
+        "customer_id": 0,
+        "id": 0,
+        "country": "string"
+      }
+    ],
+    "store_credit_amounts": [
+      {
+        "amount": 43.15
+      }
+    ],
+    "form_fields": [
+      { "name": "string", "value": "string" }
+    ],
+    "accepts_product_review_abandoned_cart_emails": true,
+    "channel_ids": [],
+    "shopper_profile_id": "82511e54-4040-40fe-b742-2b25655f205b",
+    "segment_ids": [],
+    "date_modified": {"json_class":"Time","s":0,"n":0},
+    "date_created": {"json_class":"Time","s":0,"n":0}
+  },
+  "metafield": {
+    "id": 0,
+    "owner_client_id": "X123",
+    "key": "Staff Name",
+    "value": "Ronaldo",
+    "namespace": "Sales Department",
+    "permission_set": "app_only",
+    "resource_type": "cart",
+    "resource_id": 1,
+    "description": "order",
+    "date_modified": {"json_class":"Time","s":0,"n":0},
+    "date_created": {"json_class":"Time","s":0,"n":0}
+  },
+  "inventory": {
+    "identity": {
+      "sku": "RE-130",
+      "variant_id": 79,
+      "product_id": 120,
+      "sku_id": 0
+    },
+    "locations": [
+      {
+        "location_id": 1,
+        "location_code": "BC-LOCATION-1",
+        "location_name": "Default location",
+        "available_to_sell": 10,
+        "total_inventory_onhand": 11,
+        "location_enabled": true,
+        "settings": {
+          "safety_stock": 1,
+          "is_in_stock": true,
+          "warning_level": 1,
+          "bin_picking_number": "1"
+        }
+      }
+    ]
+  },
+  "segment": {
+    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
+    "name": "My Segment",
+    "description": "Description",
+    "updated_at": {"json_class":"Time","s":0,"n":0},
+    "created_at": {"json_class":"Time","s":0,"n":0}
+  },
+  "subscriber": {
+    "email": "string",
+    "first_name": "string",
+    "last_name": "string",
+    "source": "string",
+    "order_id": 1,
+    "channel_id": 1,
+    "id": 0,
+    "date_modified": {"json_class":"Time","s":0,"n":0},
+    "date_created": {"json_class":"Time","s":0,"n":0},
+    "consents": []
+  },
+  "meta": {
+    "pagination": {
+      "total": 246,
+      "count": 5,
+      "per_page": 5,
+      "current_page": 1,
+      "total_pages": 50,
+      "links": {
+        "previous": "?limit=5&page=2",
+        "current": "?limit=5&page=3",
+        "next": "?limit=5&page=4"
+      }
+    }
+  }
+}

data/lib/big_commerce/management_api/classes.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "class2"
+require "json"
+
+# This results in certain properties in the JSON samples/definitions to be parsed as
+# Time which class2 will see and convert the attribute values to Time
+require "json/add/time"
+
+classes = File.read(File.join(__dir__, "classes.json"))
+class2 "BigCommerce::ManagementAPI", JSON.parse(classes, :create_additions => true) do
+  def meta
+    @meta
+  end
+
+  def meta=(meta)
+    @meta = meta
+  end
+
+  def headers
+    @headers
+  end
+
+  def headers=(headers)
+    @headers = headers
+  end
+end
+
+require "big_commerce/management_api/customers"
+require "big_commerce/management_api/inventories"
+require "big_commerce/management_api/segments"
+require "big_commerce/management_api/subscribers"

data/lib/big_commerce/management_api/customers.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require "big_commerce/management_api/endpoint"
+
+module BigCommerce
+  module ManagementAPI
+    class Customers < Endpoint
+      class Addresses < Endpoint
+        PATH = "customers/addresses"
+        RESULT_INSTANCE = Address
+
+        def create(*attributes)
+          attributes.flatten!
+
+          POST(PATH, attributes.map(&:to_h))
+        end
+
+        def delete(*ids)
+          ids.flatten!
+
+          DELETE(
+            PATH,
+            with_in_param({:id => ids}, :id)
+          )
+        end
+
+        def get(options = {})
+          GET(
+            PATH,
+            with_in_param(
+              options,
+              :company,
+              :customer_id,
+              :id,
+              :name
+            )
+          )
+        end
+      end
+
+      class Attributes < Endpoint
+        PATH = "customers/attributes"
+        RESULT_INSTANCE = Attribute
+
+        def get(options = {})
+          GET(PATH, options)
+        end
+
+        def create(*attributes)
+          attributes.flatten!
+
+          POST(PATH, attributes.map(&:to_h))
+        end
+
+        def delete(*ids)
+          ids.flatten!
+
+          DELETE(
+            PATH,
+            with_in_param({:id => ids}, :id)
+          )
+        end
+      end
+
+      class AttributeValues < Endpoint
+        PATH = "customers/attribute-values"
+        RESULT_INSTANCE = AttributeValue
+
+        def get(options = {})
+          GET(
+            PATH,
+            with_in_param(
+              options,
+              :attribute_id,
+              :customer_id
+            )
+          )
+        end
+
+        def upsert(*attributes)
+          attributes.flatten!
+
+          PUT(PATH, attributes)
+        end
+      end
+
+      class Metafields < Endpoint
+        PATH = "customers/%d/metafields"
+        RESULT_INSTANCE = Metafield
+
+        def get(customer_id, options = {})
+          GET(path(customer_id), options)
+        end
+
+        def create(metafield)
+          metafield = metafield.to_h
+          id = metafield.delete(:resource_id)
+
+          if id.nil?
+            raise ArgumentError, "Cannot create customer metafield: given metafield record has no resource_id"
+          end
+
+          POST(path(id), metafield)
+        end
+
+        def update(metafield)
+          metafield = metafield.to_h
+
+          resource = metafield.delete(:resource_id)
+          if resource.nil?
+            raise ArgumentError, "Cannot update customer metafield: given metafield has no resource_id"
+          end
+
+          id = metafield.delete(:id)
+          if id.nil?
+            raise ArgumentError, "Cannot update customer metafield: given metafield has no id"
+          end
+
+          result = PUT(path(resource_id, id), metafield)
+          unwrap(result)
+        end
+
+        private
+
+        def path(customer_id, *rest)
+          path = sprintf(PATH, customer_id)
+          return path if rest.empty?
+
+          path << "/" << rest.join("/")
+        end
+      end
+
+      PATH = "customers"
+      RESULT_INSTANCE = Customer
+
+      attr_reader :addresses,
+                  :attributes,
+                  :attribute_values,
+                  :metafields
+
+      def initialize(*argz)
+        super(*argz)
+
+        @addresses = Addresses.new(*argz)
+        @attributes = Attributes.new(*argz)
+        @attribute_values = AttributeValues.new(*argz)
+        @metafields = Metafields.new(*argz)
+      end
+
+      def create(*customers)
+        customers.flatten!
+
+        POST(PATH, customers.map(&:to_h))
+      end
+
+      def delete(*ids)
+        ids.flatten!
+
+        DELETE(
+          PATH,
+          with_in_param({:id => ids}, :id)
+        )
+      end
+
+      def get(options = {})
+        GET(
+          PATH,
+          with_in_param(
+            options,
+            :company,
+            :customer_group_id,
+            :email,
+            :id,
+            :name,
+            :registration_ip_address
+          )
+        )
+      end
+
+      def update(*customers)
+        customers.flatten!
+
+        PUT(PATH, customers.map(&:to_h))
+      end
+    end
+  end
+end

data/lib/big_commerce/management_api/endpoint.rb

@@ -0,0 +1,294 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "big_commerce/management_api/version"
+
+module BigCommerce
+  module ManagementAPI
+    Error = Class.new(StandardError)
+
+    class ResponseHeaders
+      def initialize(headers)
+        @headers = headers || {}
+      end
+
+      def [](name)
+        @headers[name]
+      end
+
+      def request_id
+        value = @headers["x-request-id"]
+        value.is_a?(Array) ? value[0] : value
+      end
+
+      %w[x-rate-limit-requests-left
+         x-rate-limit-time-reset-ms
+         x-rate-limit-requests-quota
+         x-rate-limit-time-window-ms].each do |header|
+
+        method = header.delete_prefix("x-")
+        method.tr!("-", "_")
+
+        define_method(method) do
+          value = @headers[header]
+          # Net::HTTP returns as an array
+          (value.is_a?(Array) ? value[0] : value).to_i
+        end
+      end
+    end
+
+    class ResponseError < Error
+      attr_reader :headers
+
+      def initialize(data, headers)
+        @headers = ResponseHeaders.new(headers)
+        @data = data
+
+        super error_message(data)
+      end
+
+      private
+
+      def error_message(data)
+        #
+        # Looks for a structure like one of these  and picks best message:
+        #
+        # A:
+        #
+        # {"errors"=>
+        #   [{"status"=>409,
+        #     "title"=>"Cannot have multiple segments with the same name",
+        #     "type"=>
+        #      "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes",
+        #     "errors"=>{}}]
+        #
+        #
+        # B:
+        #
+        # {"status"=>422,
+        #  "title"=>"Set customer attribute values failed.",
+        #  "type"=>
+        #   "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes",
+        #  "errors"=>{"0.data"=>"missing attribute value"}}
+        #
+        return data unless data.is_a?(Hash)
+
+        data = data["errors"][0] if data["errors"].is_a?(Array)
+
+        if data["errors"].any?
+          errors = data["errors"].map { |property, message| "#{property}: #{message.chomp(".")}" }
+          errors.join(", ")
+        else
+          title = data["title"].chomp(".")
+          sprintf("%s (%s)", title, data["status"])
+        end
+      end
+    end
+
+    class Endpoint
+      HOST = "api.bigcommerce.com"
+      PORT = 443
+
+      USER_AGENT = "BigCommerce Management API Client v#{BigCommerce::ManagementAPI::VERSION} (Ruby v#{RUBY_VERSION})"
+
+      CONTENT_TYPE = "Content-Type"
+      CONTENT_TYPE_JSON = "application/json"
+
+      JSON_CONTENT_TYPES = [CONTENT_TYPE_JSON, "application/problem+json"].freeze
+
+      RESULT_KEY = "data"
+
+      # May go in its own file
+      class Response
+        include Enumerable
+
+        # class Pagination
+        class2 self,
+               :pagination => {
+                 :total => 0,
+                 :count => 0,
+                 :per_page => 0,
+                 :current_page => 0,
+                 :total_pages => 0,
+                 :links => {
+                   :previous => "string",
+                   :current => "string",
+                   :next => "string"
+                 }
+               }
+
+        class Meta
+          attr_reader :pagination, :total, :success, :failed
+
+          def initialize(meta)
+            @total = meta["total"]
+            @success = meta["success"]
+            @failed = meta["failed"]
+
+            @pagination = Pagination.new(meta["pagination"]) if meta["pagination"]
+          end
+        end
+
+        attr_reader :meta, :headers
+
+        def initialize(headers, result = nil, meta = nil)
+          @result = result || []
+          @headers = ResponseHeaders.new(headers)
+          @meta = Meta.new(meta) if meta
+        end
+
+        def each(&block)
+          @result.each(&block)
+        end
+      end
+
+      def initialize(store_hash, auth_token, options = nil)
+        raise ArgumentError, "store hash required" if store_hash.to_s.empty?
+        raise ArgumentError, "auth token required" if auth_token.to_s.empty?
+
+        @store_hash = store_hash
+        @auth_token = auth_token
+        @options = options || {}
+      end
+
+      protected
+
+      def DELETE(path, data = {})
+        path = endpoint(path)
+        path << query_string(data) if data && data.any?
+
+        request(Net::HTTP::Delete.new(path), data)
+      end
+
+      def GET(path, data = {})
+        path = endpoint(path)
+        path << query_string(data) if data && data.any?
+
+        request(Net::HTTP::Get.new(path), data)
+      end
+
+      def POST(path, data = {})
+        request(Net::HTTP::Post.new(endpoint(path)), data)
+      end
+
+      def PUT(path, data = {})
+        request(Net::HTTP::Put.new(endpoint(path)), data)
+      end
+
+      # For better or worse all Response instances contain an Array
+      # In some cases we don't want this since response only contains a single result
+      def unwrap(result)
+        record = result.first
+        return unless record
+
+        record.meta = result.meta
+        record.headers = result.headers
+        record
+      end
+
+      def with_in_param(options, *param_names)
+        return unless options
+
+        options = options.dup
+        options.keys.each do |name|
+          # Remove optional ":in" portion from "id:in" which may or may not be a Symbol
+          name = name.to_s.split(":")[0].to_sym
+          next unless param_names.include?(name)
+
+          values = Array(options.delete(name))
+
+          in_name = "#{name}:in"
+          values.concat(Array(options.delete(in_name)))
+
+          next unless values.any?
+
+          options[in_name] = values
+        end
+
+        options
+      end
+
+      private
+
+      def query_string(params)
+        query = []
+
+        # We do this manually to join arrays and because time cannot be escaped as it will not be properly applied server-side
+        params.each do |name, value|
+          name = URI.encode_www_form_component(name)
+
+          if value.is_a?(Array)
+            value = value.join(",")
+          elsif value.respond_to?(:strftime)
+            value = value.strftime("%Y-%m-%dT%H:%M:%S%z")
+          else
+            value = URI.encode_www_form_component(value)
+          end
+
+          query << "#{name}=#{value}"
+        end
+
+        sprintf("?%s", query.join("&"))
+      end
+
+      def endpoint(path)
+        sprintf("/stores/%s/v3/%s", @store_hash, path)
+      end
+
+      # TODO: move this to request() so we can create ResponseError
+      def parse_json(s)
+        JSON.parse(s)
+      rescue JSON::ParserError => e
+        raise Error, "failed to parse response JSON: #{e}"
+      end
+
+      def request(req, data = {})
+        req["X-Auth-Token"] = @auth_token
+        req["User-Agent"] = USER_AGENT
+
+        if req.request_body_permitted? && data && data.any?
+          req.body = data.to_json
+          req[CONTENT_TYPE] = CONTENT_TYPE_JSON
+        end
+
+        request = Net::HTTP.new(HOST, PORT)
+        request.use_ssl = true
+
+        if !@options[:debug]
+         request.set_debug_output(nil)
+        else
+          request.set_debug_output(
+            @options[:debug].is_a?(IO) ? @options[:debug] : $stderr
+          )
+        end
+
+        request.start { |http| handle_response(http.request(req)) }
+      end
+
+      def handle_response(res)
+        # TODO: data can be HTML string! Don't want this in the error! Do we?
+        data = res.body && JSON_CONTENT_TYPES.include?(res[CONTENT_TYPE]) ? parse_json(res.body) : res.body
+        # pp data
+        # Otherwise only available by name via #[]
+        headers = res.to_hash
+
+        raise ResponseError.new(data, headers) if res.code[0] != "2"
+
+        # 204, likely
+        return Response.new(headers) unless data
+
+        result = data[self.class::RESULT_KEY]
+        if result.is_a?(Array)
+          result.map! { |data| self.class::RESULT_INSTANCE.new(data) }
+        else
+          result = [self.class::RESULT_INSTANCE.new(result)]
+        end
+
+        # If response code is 2XX and data is a String we will have an error here
+        # but it's TBD if this is ever the case
+        Response.new(headers, result, data["meta"])
+      end
+    end
+  end
+end

data/lib/big_commerce/management_api/inventories.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "big_commerce/management_api/endpoint"
+
+module BigCommerce
+  module ManagementAPI
+    class Inventories
+      class Items < Endpoint
+        PATH = "inventory/items"
+        RESULT_INSTANCE = Inventory
+
+        def get(options = {})
+          GET(
+            PATH,
+            with_in_param(
+              options,
+              :location_code,
+              :location_id,
+              :product_id,
+              :sku,
+              :variant_id
+            )
+          )
+        end
+      end
+
+      attr_reader :items
+
+      def initialize(*argz)
+        @items = Items.new(*argz)
+      end
+    end
+  end
+end

data/lib/big_commerce/management_api/segments.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "big_commerce/management_api/endpoint"
+
+module BigCommerce
+  module ManagementAPI
+    class Segments < Endpoint
+      PATH = "segments"
+      RESULT_INSTANCE = Segment
+
+      def create(*segments)
+        segments.flatten!
+
+        POST(PATH, segments.map(&:to_h))
+      end
+
+      def delete(*ids)
+        ids.flatten!
+
+        DELETE(
+          PATH,
+          with_in_param({:id => ids}, :id)
+        )
+      end
+
+      def get(options = {})
+        GET(
+          PATH,
+          with_in_param(
+            options,
+            :id
+          )
+        )
+      end
+
+      def update(*segments)
+        segments.flatten!
+
+        PUT(PATH, segments.map(&:to_h))
+      end
+    end
+  end
+end

data/lib/big_commerce/management_api/subscribers.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "big_commerce/management_api/endpoint"
+
+module BigCommerce
+  module ManagementAPI
+    class Subscribers < Endpoint
+      PATH = "customers/subscribers"
+      RESULT_INSTANCE = Subscriber
+
+      def create(attributes)
+        result = POST(PATH, attributes)
+        unwrap(result)
+      end
+
+      def delete(options)
+        DELETE(
+          PATH,
+          with_in_param(
+            options,
+            :date_created,
+            :date_modified,
+            :email,
+            :first_name,
+            :id,
+            :last_name,
+            :order_id,
+            :source
+          )
+        )
+      end
+
+      ##
+      #
+      # Given an ID find a single Subscriber. Given a Hash find Subscribers by the provided criteria.
+      #
+      def get(options_or_id)
+        query = options_or_id
+
+        if query.is_a?(Hash)
+          query = with_in_param(
+            query,
+            :date_created,
+            :date_modified,
+            :email,
+            :first_name,
+            :id,
+            :last_name,
+            :order_id,
+            :source
+          )
+        end
+
+        GET(PATH, query)
+      end
+
+      def update(attributes)
+        attributes = attributes.to_h
+
+        id = attributes.delete(:id)
+        if id.nil?
+          raise ArgumentError, "Cannot update subscriber: given subscriber has no id"
+        end
+
+        result = UPDATE("#{PATH}/#{id}", attributes)
+        unwrap(result)
+      end
+    end
+  end
+end

data/lib/big_commerce/management_api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BigCommerce
+  module ManagementAPI
+    VERSION = "0.0.1"
+  end
+end

data/lib/big_commerce/management_api.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "big_commerce/management_api/classes"
+
+module BigCommerce
+  module ManagementAPI
+    def self.new(*argz)
+      Client.new(*argz)
+    end
+
+    class Client
+      attr_reader :customers,
+                  :inventories,
+                  :segments,
+                  :subscribers
+
+      def initialize(*argz)
+        @customers = ManagementAPI::Customers.new(*argz)
+        @inventories = ManagementAPI::Inventories.new(*argz)
+        @segments = ManagementAPI::Segments.new(*argz)
+        @subscribers = ManagementAPI::Subscribers.new(*argz)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: big_commerce-management_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: class2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: v3 API client for BigCommerce's REST Management API. Implementation is
+  far from complete but adding support for new endpoints is trivial.
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.test.example"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- big_commerce-management_api.gemspec
+- bin/console
+- bin/setup
+- etc/customers.csv
+- lib/big_commerce/management_api.rb
+- lib/big_commerce/management_api/classes.json
+- lib/big_commerce/management_api/classes.rb
+- lib/big_commerce/management_api/customers.rb
+- lib/big_commerce/management_api/endpoint.rb
+- lib/big_commerce/management_api/inventories.rb
+- lib/big_commerce/management_api/segments.rb
+- lib/big_commerce/management_api/subscribers.rb
+- lib/big_commerce/management_api/version.rb
+homepage: https://github.com/ScreenStaring/big_commerce-management_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ScreenStaring/big_commerce-management_api
+  source_code_uri: https://github.com/ScreenStaring/big_commerce-management_api
+  bug_tracker_uri: https://github.com/ScreenStaring/big_commerce-management_api/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: v3 API client for BigCommerce's REST Management API
+test_files: []