fulfil_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 124631d877876585ac53ed309947e4f11f20fc74a53736f8d2d642d2c169d0fc
+  data.tar.gz: fe5ee384f9fd99b5c7870128bda748236470bee352b352b789fb2d6a871d8b67
+SHA512:
+  metadata.gz: 53ebe91f5b165c7e0d67bb16afbbaa0622ed2e2dd52bd3837952f903be9543f8170c2eb7190d219d26991955bbfde5196232ec78e46d22e7578c11b2c0f9e582
+  data.tar.gz: 52223100fa5671720036c9ee9b8cf9d5b7fc1ed62604528a08e8c94391aad7749796740db80700297cef935380bb6011382165f43d4303a76672b286ab0c60b7

data/.rubocop.yml

@@ -0,0 +1,35 @@
+require:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  Exclude:
+    - bin/*
+    - vendor/**/*
+  NewCops: enable
+  TargetRubyVersion: 3.0
+
+Layout/LineLength:
+  Exclude:
+    - fulfil_api.gemspec
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*_test.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - test/**/*_test.rb
+
+Minitest/MultipleAssertions:
+  Max: 5
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.3.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-10
+
+- 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 stefan@codeture.nl. 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stefan Vermaas
+
+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,148 @@
+# The `fulfil_api` Ruby gem
+
+The `fulfil_api` is a simple, powerful HTTP client written in Ruby to interact with Fulfil's API. It takes learnings from many years of working with Fulfil's APIs and turns it into an easy to use HTTP client.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```shell
+  $ bundle add fulfil_api
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+  $ gem install fulfil_api
+```
+
+## Usage
+
+### Configuration
+
+There are two ways of configuring the HTTP client:
+
+1. Staticly through an initializer file (typically used in a Rails application)
+2. Dynamically through calling the `FulfilApi.with_config` method.
+
+The configuration of the FulfilApi client is thread-safe and therefore you can even combine both the static and dynamic configuration of Fulfil in case you need to.
+
+#### Using a Static Configuration
+
+```ruby
+# config/initializers/fulfil_api.rb
+
+FulfilApi.configure do |config|
+  config.access_token = FulfilApi::AccessToken.new(ENV["FULFIL_API_KEY"])
+  config.merchant_id = "the-id-of-the-merchant"
+end
+```
+
+
+#### Using a Dynamic Configuration
+
+```ruby
+FulfilApi.with_config(
+  access_token: FulfilApi::AccessToken.new(ENV["FULFIL_API_KEY"]),
+  merchant_id: "the-id-of-the-merchant"
+) do
+  # Query the Fulfil API
+end
+```
+
+#### Available Configuration Options
+
+The following configuration options are (currently) available throught both configuration methods:
+
+- `access_token` (`FulfilApi::AccessToken`): The `access_token` is required to authenticate with Fulfil's API endpoints. Fulfil supports two types of access tokens: "OAuth" and "Personal" access tokens. The gem supports both tokens and defaults to the personal access token.
+
+> **NOTE:** To use an OAuth access token, use `FulfilApi::AccessToken.new(oauth_token, type: :oauth)`. Typically, you would use the OAuth access token only when using the [dynamic configuration](#using-a-dynamic-configuration) mode of the gem.
+
+- `merchant_id` (`String`): The `merchant_id` is the subdomain that the Fulfil instance is hosted on. This configuration option is required to be able to query Fulfil's API endpoints.
+
+### Querying the Fulfil API
+
+> **NOTE:** Currently, the gem is under heavy development. The querying interface of the gem is really basic at the moment. In the future, we will closer match the querying interface of `ActiveRecord`.
+
+The gem uses an `ActiveRecord` like query interface to query the Fulfil API.
+
+```ruby
+# Find one specific resource
+sales_order = FulfilApi::Resource.set(name: "sale.sale").find_by(["id", "=", 100])
+p sales_order["id"] # => 100
+
+# Find a list of resources
+sales_orders = FulfilApi::Resource.set(name: "sale.sale").where(["channel", "=", 4])
+p sales_orders.size # => 500 (standard number of resources returned by Fulfil)
+p sales_orders.first["id"] # => 10 (an example of an ID returned by Fulfil)
+
+# Find a limited list of resources
+sales_orders = FulfilApi::Resource.set(name: "sale.sale").where(["channel", "=", 4]).limit(50)
+p sales_orders.size # => 50
+
+# Include more resource details than the ID only
+sales_orders = FulfilApi::Resource.set(name: "sale.sale").select("reference").where(["channel", "=", 4])
+p sales_orders.first["reference"] # => SO1234
+
+# Fetch nested data from a relation
+line_items = FulfilApi::Resource.set(name: "sale.line").select("sale.reference")
+p line_items.first["sale"]["reference"] # => SO1234
+
+# Query nested data from a relation
+line_items = FulfilApi::Resource.set(name: "sale.line").where(["sale.reference", "=", "SO1234"])
+p line_items.first["id"] # => 10
+```
+
+> **NOTE:** It's important to note that the results from the Fulfil API are cached. This prevents you from accidentally overasking the Fulfil API. To reload the resources from the Fulfil API after you've already fetchted them, use the `.reload` on the returned relation (e.g. `line_items.reload`).
+
+### Interacting with the `FulfilApi::Resource`
+
+Any data returned through the `FulfilApi` gem returns a list or a single `FulfilApi::Resource`. The data of the API resource is accessible through a `Hash`-like method.
+
+```ruby
+sales_order = FulfilApi::Resource.set(name: "sale.sale").find_by(["id", "=", 100])
+p sales_order["id"] # => 100
+```
+
+When you're requesting relational data for an API resource, you can access it in a similar manner.
+
+```ruby
+sales_order = FulfilApi::Resource.set(name: "sale.sale").select("channel.name").find_by(["id", "=", 100])
+p sales_order["channel"]["name"] # => Shopify
+```
+
+> **NOTE:** Fulfil is not able to return nested data from `Array`-like API resources. If you want to find all line items of a sales order, it's typically better to query the line item resource directly.
+
+```ruby
+# You can't do this
+FulfilApi::Resource.set(name: "sale.sale").select("lines.reference").find_by(["id", "=", 100])
+
+# You can do this (BUT it's not recommended)
+sales_order = FulfilApi::Resource.set(name: "sale.sale").select("lines").find_by(["id", "=", 100])
+line_items = FulfilApi::Resource.set(name: "sale.line").where(["id", "in", sales_order["lines"]])
+
+# You can do this (recommended)
+line_items = FulfilApi::Resource.set(name: "sale.line").find_by(["sale.id", "=", 100])
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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 `bin/rake install`.
+
+## Releasing
+
+To release a new version, run the `bin/release` script. This will update the version number in `version.rb`, 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/codeturebv/fulfil_api. 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/codeturebv/fulfil_api/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 Fulfil project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/codeturebv/fulfil_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+end
+
+task default: %i[test]

data/lib/fulfil_api/access_token.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  # The {Fulfil::AccessToken} provides information about the type of access token
+  #   that is provided to access the Fulfil API.
+  class AccessToken
+    attr_reader :value, :type
+
+    class TypeInvalid < Error; end
+
+    # @param value [String] The raw access token contents
+    # @param type [Symbol, String] The access token type (personal or oauth)
+    def initialize(value, type: :personal)
+      @type = type.to_sym
+      @value = value
+    end
+
+    # Builds the HTTP headers for the access token based on the {#type}.
+    #
+    # @return [Hash]
+    def to_http_header
+      case type
+      when :personal
+        { "X-API-KEY" => value }
+      when :oauth
+        { "Authorization" => "Bearer #{value}" }
+      else
+        raise TypeInvalid, "#{type} is not a valid access token type. Use :personal or :oauth instead."
+      end
+    end
+  end
+end

data/lib/fulfil_api/client.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/net_http_persistent"
+
+module FulfilApi
+  class Client
+    # @param configuration [FulfilApi::Configuration]
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    # Performs an HTTP DELETE request to a Fulfil API endpoint.
+    #
+    # @param relative_path [String] The relative path to the API resource.
+    # @return [Array, Hash, String] The parsed response body.
+    def delete(relative_path)
+      request(:delete, relative_path)
+    end
+
+    # Performs an HTTP GET request to a Fulfil API endpoint.
+    #
+    # @param relative_path [String] The relative path to the API resource.
+    # @param url_parameters [Hash, nil] The optional URL parameters for the API endpoint.
+    # @return [Array, Hash, String] The parsed response body.
+    def get(relative_path, url_parameters: nil)
+      request(:get, relative_path, url_parameters)
+    end
+
+    # Performs an HTTP POST request to a Fulfil API endpoint.
+    #
+    # @param relative_path [String] The relative path to the API resource.
+    # @param body [Array, Hash, nil] The request body for the POST HTTP request.
+    # @return [Array, Hash, String] The parsed response body.
+    def post(relative_path, body: {})
+      request(:post, relative_path, body)
+    end
+
+    # Performs an HTTP PUT request to a Fulfil API endpoint.
+    #
+    # @param relative_path [String] The relative path to the API resource.
+    # @param body [Array, Hash, nil] The optional request body for the PUT HTTP request.
+    # @return [Array, Hash, String] The parsed response body.
+    def put(relative_path, body: nil)
+      return request(:put, relative_path) if body.nil?
+
+      request(:put, relative_path, body)
+    end
+
+    private
+
+    attr_reader :configuration
+
+    # @return [String] The absolute URL to the API base URL.
+    def api_endpoint
+      @api_endpoint ||= "https://#{configuration.merchant_id}.fulfil.io"
+    end
+
+    # @return [Faraday::Connection]
+    def connection
+      # TODO: Allow passing configuration options for the request
+      @connection ||= Faraday.new(headers: request_headers, url: api_endpoint) do |connection|
+        connection.adapter :net_http_persistent # TODO: Allow passing configuration options
+
+        # Configuration of the request middleware
+        connection.request :json
+
+        # Configuration of the response middleware
+        connection.response :json
+        connection.response :raise_error
+      end
+    end
+
+    # @param relative_path [String] The relative path to the API endpoint.
+    # @return [String] The absolute path for the request to the API endpoint.
+    def expand_relative_path(relative_path)
+      path = relative_path.start_with?("/") ? relative_path[1..] : relative_path
+      "/api/#{configuration.api_version}/#{path}"
+    end
+
+    # @param exception [Faraday::Error] Any error raised by Faraday during the execution
+    #   of the HTTP request to the API endpoint.
+    def handle_request_error(exception)
+      raise FulfilApi::Error.new(
+        exception.message,
+        details: {
+          response_body: exception.response_body,
+          response_headers: exception.response_headers,
+          response_status: exception.response_status
+        }
+      )
+    end
+
+    # @param method [Symbol, String] The HTTP verb for the HTTP request.
+    # @param relative_path [String] The relative path to the API endpoint.
+    # @return [Array, Hash, String] The parsed response body.
+    def request(method, relative_path, *args, **kwargs)
+      connection.send(method.to_sym, expand_relative_path(relative_path), *args, **kwargs).body
+    rescue Faraday::Error => e
+      handle_request_error(e)
+    end
+
+    # @return [Hash] The HTTP headers for any HTTP request to Fulfil.
+    def request_headers
+      default_headers = { "Content-Type" => "application/json" }
+      return default_headers if configuration.access_token.nil?
+
+      default_headers.merge(**configuration.access_token.to_http_header)
+    end
+  end
+
+  # Builds an HTTP client to interact with an API endpoint of Fulfil.
+  #
+  # @example with a custom configuration
+  #
+  # To use a different configuration, wrap the call to the {.client} method into
+  #   an {.with_config} block.
+  #
+  #   FulfilApi.with_config(...) do
+  #     FulfilApi.client.get(...)
+  #   end
+  #
+  # @return [FulfilApi::Client]
+  def self.client
+    Client.new(FulfilApi.configuration)
+  end
+end

data/lib/fulfil_api/configuration.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  # Configuration model for the Fulfil gem.
+  #
+  # This model holds configuration settings and provides thread-safe access
+  #   to these settings.
+  class Configuration
+    attr_accessor :access_token, :api_version, :merchant_id
+
+    # Initializes the configuration with optional settings.
+    #
+    # @param options [Hash, nil] An optional list of configuration options.
+    #   Each key in the hash should correspond to a configuration attribute.
+    def initialize(options = {})
+      @mutex = Mutex.new
+
+      # Assigns the optional configuration options
+      options.each_pair do |key, value|
+        send(:"#{key}=", value) if respond_to?(:"#{key}=")
+      end
+
+      # Sets the default options if not provided
+      set_default_options
+    end
+
+    # Provides thread-safe access to missing methods, allowing dynamic handling of configuration options.
+    #
+    # @param method [Symbol] The method name.
+    # @param args [Array] The arguments passed to the method.
+    # @param block [Proc] An optional block passed to the method.
+    # @return [void]
+    def method_missing(method, *args, &block)
+      @mutex.synchronize { super }
+    end
+
+    # Ensures that the object responds correctly to methods handled by method_missing.
+    #
+    # @param method [Symbol] The method name.
+    # @param include_private [Boolean] Whether to include private methods.
+    # @return [Boolean] Whether the object responds to the method.
+    def respond_to_missing?(method, include_private = false)
+      @mutex.synchronize { super }
+    end
+
+    private
+
+    # Sets the default options for the gem configuration.
+    #
+    # This method is called during initialization to ensure all configuration
+    #   options have sensible defaults if not explicitly set.
+    #
+    # @return [void]
+    def set_default_options
+      self.api_version = "v2" if api_version.nil?
+    end
+  end
+
+  @configuration = Configuration.new
+  @configuration_mutex = Mutex.new
+
+  # Provides thread-safe access to the gem's configuration.
+  #
+  # @return [Fulfil::Configuration] The current configuration object.
+  def self.configuration
+    @configuration_mutex.synchronize { @configuration }
+  end
+
+  # Allows the configuration of the gem in a thread-safe manner.
+  #
+  # @yieldparam [Fulfil::Configuration] config The current configuration object.
+  # @return [void]
+  def self.configure
+    @configuration_mutex.synchronize { yield(@configuration) }
+  end
+
+  # Overwrites the configuration with the newly provided configuration options.
+  #
+  # @param options [Hash, Fulfil::Configuration] A list of configuration options for the gem.
+  # @return [Fulfil::Configuration] The updated configuration object.
+  def self.configuration=(options_or_configuration)
+    @configuration_mutex.synchronize do
+      if options_or_configuration.is_a?(Hash)
+        options_or_configuration.each_pair do |key, value|
+          @configuration.send(:"#{key}=", value) if @configuration.respond_to?(:"#{key}=")
+        end
+      elsif options_or_configuration.is_a?(Configuration)
+        @configuration = options_or_configuration
+      end
+    end
+  end
+
+  # Temporarily applies the provided configuration options within a block,
+  #   and then reverts to the original configuration after the block executes.
+  #
+  # @param temporary_options [Hash] A hash of temporary configuration options.
+  # @yield Executes the block with the temporary configuration.
+  # @return [void]
+  def self.with_config(temporary_options)
+    original_configuration = configuration.dup
+    self.configuration = temporary_options
+
+    yield
+  ensure
+    # Revert to the original configuration
+    self.configuration = original_configuration
+  end
+end

data/lib/fulfil_api/error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  # The {FulfilApi::Error} is the base class for all FulfilApi errors, also used
+  #   for generic or unexpected errors.
+  class Error < StandardError
+    attr_reader :details
+
+    # @param message [String] The displayable error message for the receiver.
+    # @param details [Hash] Any additional details exposed by the issuer of the exception.
+    def initialize(message, details: nil)
+      @details = details
+      super(message)
+    end
+
+    # @return [String]
+    def message
+      "[FulfilApi::Error] #{super}"
+    end
+  end
+end

data/lib/fulfil_api/resource/attribute_assignable.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  class Resource
+    # The {FulfilApi::Resource::AttributeAssignable} module provides a set of helper
+    #   methods to assign and cast attributes (including their values) to a {FulfilApi::Resource}.
+    module AttributeAssignable
+      # Assigns and casts a set of attributes for the {FulfilApi::Resource}
+      #
+      # @param attributes [Hash] The assignable attributes
+      # @return [Hash] The resource attributes
+      def assign_attributes(attributes)
+        attributes.each_pair do |key, value|
+          assign_attribute(key, value)
+        end
+
+        @attributes
+      end
+
+      # Assigns and casts a single attribute for the {FulfilApi::Resource}.
+      #
+      # @param name [String, Symbol] The attribute name
+      # @param value [Any] The attribute value
+      # @return [Hash] The resource attributes
+      def assign_attribute(name, value)
+        attribute = build_attribute(name, value)
+        attribute.deep_stringify_keys!
+
+        @attributes = @attributes.deep_merge(attribute)
+      end
+
+      private
+
+      # Builds the attribute value and clears the path to the attribute when the
+      #   attribute name doesn't exist yet on the {FulfilApi::Resource}.
+      #
+      # @example attribute with a single attribute name
+      #   $ build_attribute("warehouse", "Main Warehouse")
+      #   => { "warehouse" => "Main Warehouse" }
+      #
+      # @example attribute with multiple/nested attribute names
+      #   $ build_attribute("warehouse.id", 10)
+      #   => { "warehouse" => { "id" => 10 } }
+      #
+      # @param attribute_names [String, Symbol] The expanded list of attribute names
+      # @param value [Any] The attribute value
+      # @return [Hash] The newly build attribute
+      def build_attribute(name, value) # rubocop:disable Metrics/MethodLength
+        attribute_names = name.to_s.split(".")
+        attribute = {}
+        attribute_level = attribute
+
+        attribute_names.each do |attribute_name|
+          if attribute_name == attribute_names.last
+            attribute_level[attribute_name] = type_cast_attribute_value(value)
+          else
+            attribute_level[attribute_name] ||= {}
+            attribute_level = attribute_level[attribute_name]
+          end
+        end
+
+        attribute
+      end
+
+      # @param value [Any] The raw attribute value before type casting
+      # @return [Any] The type casted attribute value
+      def type_cast_attribute_value(value)
+        case value
+        when Array
+          value.map { type_cast_attribute_value(_1) }
+        when Hash
+          AttributeType.cast(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/fulfil_api/resource/attribute_type.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "base64"
+require "bigdecimal"
+
+module FulfilApi
+  class Resource
+    # The {FulfilApi::Resource::AttributeType} enables parsing any attribute value
+    #   returned by the Fulfil API. To preserve type information Fulfil extends the JSON format.
+    #   When the response value is extended, it is considered castable.
+    #
+    # @example an extended attribute value (date)
+    #   $ AttributeType.cast({ "__class__" => "date", "iso_string" => "2024-12-12" })
+    #   => #<Date: 2024-08-30 />
+    #
+    # For all possible special
+    class AttributeType
+      # Casts any attribute value to its final form.
+      #
+      # @param value [Any] The attribute value to cast
+      # @return [Any] The casted attribute value
+      def self.cast(value)
+        new(value).cast_value
+      end
+
+      # @param value [Any]
+      def initialize(value)
+        @type = extended?(value) ? value.fetch("__class__") : nil
+        @value = value
+      end
+
+      # Casts the attribute value to an useable format for a Ruby application.
+      #
+      # @return [Any]
+      def cast_value
+        case @type
+        when "bytes" then Base64.decode64(value_before_cast)
+        when "date" then Date.parse(value_before_cast)
+        when "datetime" then DateTime.parse(value_before_cast)
+        when "decimal" then BigDecimal(value_before_cast)
+        when "time" then Time.parse(value_before_cast)
+        when "timedelta" then value_before_cast
+        else
+          @value
+        end
+      end
+
+      # Retrieves the raw attribute value.
+      #
+      # @return [Any]
+      def value_before_cast
+        case @type
+        when "bytes" then @value["base64"]
+        when "date", "datetime", "time", "timedelta" then @value["iso_string"]
+        when "decimal" then @value["decimal"]
+        else
+          @value
+        end
+      end
+
+      private
+
+      # The {#extended?} checks if the provided value is considered an extended
+      #   attribute value.
+      #
+      # @param value [Any] The attribute value returned by Fulfil's API endpoint.
+      # @return [true, false]
+      def extended?(value)
+        value.is_a?(Hash) && value.key?("__class__")
+      end
+    end
+  end
+end

data/lib/fulfil_api/resource/relation/loadable.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  class Resource
+    class Relation
+      # The {FulfilApi::Resource::Relation::Loadable} extends the relation by
+      #   adding methods to load, reload and identify loaded resources from Fulfil's
+      #   API endpoints.
+      #
+      # By default, all HTTP requests to Fulfil are delayed until they're directly
+      #   or indirectly requested by the user of the gem. This way, we ensure that
+      #   we only request data when we need to.
+      module Loadable
+        # Loads resources from Fulfil's API based on the current filters, fields, and limits
+        #   if they haven't been loaded yet.
+        #
+        # Requires that {#name} is set; raises an exception if it's not.
+        #
+        # @return [true, false] True if the resources were loaded successfully.
+        def load
+          return true if loaded?
+
+          if name.nil?
+            raise FulfilApi::Resource::Relation::ModelNameMissing, "The model name is missing. Use #set to define it."
+          end
+
+          response = FulfilApi.client.put(
+            "/model/#{name}/search_read",
+            body: { filters: conditions, fields: fields, limit: request_limit }.compact_blank
+          )
+
+          @resources = response.map { |resource| @resource_klass.new(resource) }
+          @loaded = true
+        end
+
+        # Checks whether the resources have been loaded to avoid repeated API calls when
+        #   using enumerable methods.
+        #
+        # @return [true, false] True if the resources are already loaded.
+        def loaded?
+          @loaded
+        end
+
+        # Reloads the resources from Fulfil's API by resetting the {@loaded} flag.
+        #
+        # @return [true, false] True if the resources were successfully reloaded.
+        def reload
+          @loaded = false
+          load
+        end
+      end
+    end
+  end
+end

data/lib/fulfil_api/resource/relation/naming.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  class Resource
+    class Relation
+      # The {FulfilApi::Resource::Relation::Naming} extends the relation by
+      #   adding methods to it that allow us to identify the type of resource that
+      #   is being requested.
+      module Naming
+        extend ActiveSupport::Concern
+
+        included do
+          # Custom error class for missing model name. The model name is required to be
+          #   able to build the API endpoint to perform the search/read HTTP request.
+          class ModelNameMissing < Error; end # rubocop:disable Lint/ConstantDefinitionInBlock
+        end
+
+        # Sets the name of the resource model to be queried.
+        #
+        # @todo In the future, derive the {#name} from the @resource_klass automatically.
+        #
+        # @param name [String] The name of the resource model in Fulfil.
+        # @return [FulfilApi::Resource::Relation] A new {Relation} instance with the model name set.
+        def set(name:)
+          clone.tap do |relation|
+            relation.name = name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fulfil_api/resource/relation/query_methods.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  class Resource
+    class Relation
+      # The {FulfilApi::Resource::Relation::QueryMethods} extends the relation by
+      #   adding query methods to it.
+      module QueryMethods
+        # Finds the first resource that matches the given conditions.
+        #
+        # It constructs a query using the `where` method, limits the result to one record,
+        #   and then returns the first result.
+        #
+        # @note Unlike the other methods in this module, `#find_by` will immediately trigger an
+        #   HTTP request to retrieve the resource, rather than allowing for lazy evaluation.
+        #
+        # @param conditions [Array<String, String, String>] The filter conditions as required by Fulfil.
+        # @return [FulfilApi::Resource, nil] The first resource that matches the conditions,
+        #   or nil if no match is found.
+        def find_by(conditions)
+          where(conditions).limit(1).first
+        end
+
+        # Limits the number of resources returned by Fulfil's API. This is useful when only
+        #   a specific number of resources are needed.
+        #
+        # @note If not specified, Fulfil's API defaults to returning up to 500 resources per call.
+        #
+        # @param value [Integer] The maximum number of resources to return.
+        # @return [FulfilApi::Resource::Relation] A new {Relation} instance with the limit applied.
+        def limit(value)
+          clone.tap do |relation|
+            relation.request_limit = value
+          end
+        end
+
+        # Specifies the fields to include in the response from Fulfil's API. By default, only
+        #   the ID is returned.
+        #
+        # Supports dot notation for nested data fields, though not all nested data may be available
+        #   depending on the API's limitations.
+        #
+        # @example Requesting nested data fields
+        #   FulfilApi::Resource.set(name: "sale.line").select("sale.reference").find_by(["id", "=", 10])
+        #
+        # @example Requesting additional fields
+        #   FulfilApi::Resource.set(name: "sale.sale").select(:reference).find_by(["id", "=", 10])
+        #
+        # @param fields [Array<Symbol, String>] The fields to include in the response.
+        # @return [FulfilApi::Resource::Relation] A new {Relation} instance with the selected fields.
+        def select(*fields)
+          clone.tap do |relation|
+            relation.fields.concat(fields.map(&:to_s))
+            relation.fields.uniq!
+          end
+        end
+
+        # Adds filter conditions for querying Fulfil's API. Conditions should be formatted
+        #   as arrays according to the Fulfil API documentation.
+        #
+        # @example Simple querying with conditions
+        #   FulfilApi::Resource.set(name: "sale.line").where(["sale.reference", "=", "ORDER-123"])
+        #
+        # @todo Enhance the {#where} method to allow more natural and flexible queries.
+        #
+        # @param conditions [Array<String, String, String>] The filter conditions as required by Fulfil.
+        # @return [FulfilApi::Resource::Relation] A new {Relation} instance with the conditions applied.
+        def where(conditions)
+          clone.tap do |relation|
+            relation.conditions << conditions.flatten
+            relation.conditions.uniq!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fulfil_api/resource/relation.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  class Resource
+    # The {FulfilApi::Resource::Relation} class provides an abstraction for chaining multiple API operations.
+    #
+    # It allows handling a set of API resources in a uniform way, similar to
+    #   ActiveRecord's query interface, enabling the user to build complex queries
+    #   in a clean and reusable manner.
+    class Relation
+      include Enumerable
+      include Loadable
+      include Naming
+      include QueryMethods
+
+      attr_accessor :conditions, :fields, :name, :request_limit
+
+      delegate_missing_to :all
+
+      # @param resource_klass [FulfilApi::Resource] The resource data model class.
+      def initialize(resource_klass)
+        @resource_klass = resource_klass
+
+        @loaded = false
+        @resources = []
+
+        reset
+      end
+
+      # Loads and returns all resources from Fulfil's API. This method functions as a proxy,
+      #   deferring the loading of resources until they are required, thus avoiding unnecessary
+      #   HTTP requests.
+      #
+      # @return [Array<FulfilApi::Resource>] An array of loaded resource objects.
+      def all
+        load
+        @resources
+      end
+
+      # The {#each} method allows iteration over the resources. If no block is given,
+      #   it returns an Enumerator, enabling lazy evaluation and allowing for chaining
+      #   without immediately triggering an API request.
+      #
+      # @yield [resource] Yields each resource object to the given block.
+      # @return [Enumerator, self] Returns an Enumerator if no block is given; otherwise, returns self.
+      def each(&block)
+        all.each(&block)
+      end
+
+      # Resets any of the previously provided query conditions.
+      #
+      # @return [FulfilApi::Resource::Relation] The relation with cleared query conditions.
+      def reset
+        @conditions = []
+        @fields = %w[id]
+        @limit = nil
+
+        self
+      end
+    end
+  end
+end

data/lib/fulfil_api/resource.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  # The {FulfilApi::Resource} represents a single resource returned by the API
+  #   endpoints of Fulfil.
+  class Resource
+    include AttributeAssignable
+
+    def initialize(attributes = {})
+      @attributes = {}.with_indifferent_access
+      assign_attributes(attributes)
+    end
+
+    class << self
+      delegate_missing_to :relation
+
+      # Builds a new {Fulfil::Resource::Relation} based on the current class to
+      #   enable us to chain requests to Fulfil without querying their API endpoints
+      #   multiple times in a row.
+      #
+      # @note it makes use of the {.delegate_missing_to} method from {ActiveSupport}
+      #   to ensure that all unknown class methods for the {FulfilApi::Resource} are
+      #   forwarded to the {FulfilApi::Resource.relation}.
+      #
+      # @example forwarding of the .where class method
+      #   FulfilApi::Resource.set(name: "sale.sale").find_by(["id", "=", 100])
+      #
+      # @return [FulfilApi::Resource::Relation]
+      def relation
+        Relation.new(self)
+      end
+    end
+
+    # Looks up the value for the given attribute name.
+    #
+    # @param attribute_name [String, Symbol] The name of the attribute
+    # @return [Any, nil]
+    def [](attribute_name)
+      @attributes[attribute_name]
+    end
+
+    # Returns all currently assigned attributes for a {FulfilApi::Resource}.
+    #
+    # @return [Hash]
+    def to_h
+      @attributes
+    end
+  end
+end

data/lib/fulfil_api/test_helper.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "webmock"
+
+module FulfilApi
+  # The TestHelper module provides utility methods for stubbing HTTP requests
+  # to the Fulfil API in test environments. It uses WebMock to intercept and
+  # simulate API requests, allowing developers to test how their code interacts
+  # with the Fulfil API without making real HTTP requests.
+  #
+  # This module is designed to be included in test cases where you need to
+  # simulate API interactions. It offers a flexible interface to stub requests
+  # for various models and resources, making it easier to write comprehensive
+  # and isolated tests.
+  #
+  # @example Including the TestHelper in your test case
+  #   class MyTest < Minitest::Test
+  #     include FulfilApi::TestHelper
+  #
+  #     def test_api_call
+  #       stub_fulfil_request(:get, response: { name: "Product A" }, model: "product.product", id: "123")
+  #       # Your test code here
+  #     end
+  #   end
+  module TestHelper
+    # Stubs an HTTP request to the Fulfil API based on the provided parameters.
+    #
+    # @param [String, Symbol] method The HTTP method to be stubbed (e.g., :get, :post).
+    # @param [Hash] response The response body to return as a JSON object (default is {}).
+    # @param [Integer] status The HTTP status code to return (default is 200).
+    # @param [Hash] options Additional options, such as the model and ID for the request URL.
+    # @option options [String] :model The API model (e.g., 'product.product', 'sale.sale').
+    # @option options [String] :id The ID of the resource within the model (optional).
+    #
+    # @return [WebMock::RequestStub] The WebMock request stub object.
+    #
+    # @example Stub a GET request for a product model
+    #   stub_fulfil_request(:get, response: { name: "Product A" }, model: "product.product", id: "123")
+    def stub_fulfil_request(method, response: {}, status: 200, **options)
+      stubbed_request_for(method, **options)
+        .and_return(status: status, body: response.to_json, headers: { "Content-Type": "application/json" })
+    end
+
+    private
+
+    # Builds the WebMock request stub for the Fulfil API based on the provided method and options.
+    #
+    # @param [String, Symbol] method The HTTP method to be stubbed (e.g., :get, :post).
+    # @param [Hash] options Additional options, such as the model and ID for the request URL.
+    # @option options [String] :model The API model (e.g., 'product.product', 'sale.sale').
+    # @option options [String] :id The ID of the resource within the model (optional).
+    #
+    # @return [WebMock::RequestStub] The WebMock request stub object.
+    #
+    # @example Stub a POST request for creating a new order
+    #   stubbed_request_for(:post, model: "sale.sale")
+    #
+    # @example Stub a GET request for a specific product
+    #   stubbed_request_for(:get, model: "product.product", id: "123")
+    def stubbed_request_for(method, **options)
+      case options.transform_keys(&:to_sym)
+      in { model:, id: }
+        stub_request(method.to_sym, %r{fulfil.io/api/v\d+/(?:model/)?#{model}/#{id}(.*)}i)
+      in { model: }
+        stub_request(method.to_sym, %r{fulfil.io/api/v\d+/(?:model/)?#{model}(.*)}i)
+      else
+        stub_request(method.to_sym, %r{fulfil.io/api/v\d+}i)
+      end
+    end
+  end
+end

data/lib/fulfil_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  VERSION = "0.0.1"
+end

data/lib/fulfil_api.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+require "active_support"
+require "active_support/core_ext/enumerable"
+require "active_support/core_ext/hash/deep_merge"
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/object/blank"
+
+module FulfilApi
+end
+
+loader.eager_load

data/sig/fulfil_api.rbs

@@ -0,0 +1,4 @@
+module FulfilApi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: fulfil_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Vermaas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: A Ruby HTTP client to interact with the API endpoints of Fulfil.io
+email:
+- stefan@codeture.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/fulfil_api.rb
+- lib/fulfil_api/access_token.rb
+- lib/fulfil_api/client.rb
+- lib/fulfil_api/configuration.rb
+- lib/fulfil_api/error.rb
+- lib/fulfil_api/resource.rb
+- lib/fulfil_api/resource/attribute_assignable.rb
+- lib/fulfil_api/resource/attribute_type.rb
+- lib/fulfil_api/resource/relation.rb
+- lib/fulfil_api/resource/relation/loadable.rb
+- lib/fulfil_api/resource/relation/naming.rb
+- lib/fulfil_api/resource/relation/query_methods.rb
+- lib/fulfil_api/test_helper.rb
+- lib/fulfil_api/version.rb
+- sig/fulfil_api.rbs
+homepage: https://www.github.com/codeturebv/fulfil_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/codeturebv/fulfil_api
+  source_code_uri: https://www.github.com/codeturebv/fulfil_api
+  changelog_uri: https://www.github.com/codeturebv/fulfil_api/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: A HTTP client to interact the Fulfil.io API
+test_files: []