Allow users to configure the api client (#5)

* Add Client and Configuration classes for API interaction

- Introduced the Client class as the main entry point for interacting
  with the PromoStandards API.
- Created the Configuration class to manage configuration options.

* Refactor: Move files to PromostandardsRubyClient namespace

- Updated file structure and module names accordingly.
- Adjusted gemspec to reflect the new naming convention.
- Updated RSpec tests to use the new module name.

Author: qbantek

lib/promostandards/ruby/client.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# PromoStandardsRubyClient is an unofficial Ruby client for interacting with
+# PromoStandards API services, providing a flexible configuration interface
+# for accessing services such as Product Data, Media Content, and Pricing.
+#
+# This gem allows users to set up a client with options for service URL and
+# logging, making it easy to integrate PromoStandards functionality into
+# Ruby applications.
+module PromoStandardsRubyClient
+  require_relative "promostandards_ruby_client/version"
+  require_relative "promostandards_ruby_client/client"
+  require_relative "promostandards_ruby_client/configuration"
+end

lib/promostandards/ruby/client/version.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module PromostandardsRubyClient
+  # The Client class is the main entry point for interacting with the
+  # PromoStandards API through the gem.
+  # This class provides flexible configuration options, allowing users
+  # to specify the API service URL, logger, and other settings either
+  # globally or per instance.
+  #
+  # == Configuration
+  #
+  # Configuration can be set globally across the application, typically
+  # in a Rails initializer:
+  #
+  #   # config/initializers/promostandards_ruby_client.rb
+  #   PromostandardsRubyClient::Client.configure do |config|
+  #     config.service_url = 'https://custom-service-url.com'
+  #     config.logger = Rails.logger
+  #   end
+  #
+  # Alternatively, options can be passed directly to an instance of the
+  # Client:
+  #
+  #   client = PromostandardsRubyClient::Client.new(
+  #     service_url: 'https://another-service-url.com',
+  #     logger: custom_logger
+  #   )
+  #
+  # == Attributes
+  #
+  # * +service_url+ - The base URL for the PromoStandards-compatible
+  #   service, set through global configuration or passed to the instance.
+  #   Defaults to nil and raises an error if not set.
+  #
+  # * +logger+ - A logger object with an API compatible with Rails.logger,
+  #   used for logging API interactions and other messages.
+  #
+  # == Example Usage
+  #
+  #   # Configure the client globally in a Rails initializer
+  #   PromostandardsRubyClient::Client.configure do |config|
+  #     config.service_url = 'https://custom-service-url.com'
+  #     config.logger = Rails.logger
+  #   end
+  #
+  #   # Instantiate the client
+  #   client = PromostandardsRubyClient::Client.new
+  #
+  #   # Or override configuration settings at instance level
+  #   options = { service_url: 'https://another-service-url.com' }
+  #   client = PromostandardsRubyClient::Client.new(options)
+  class Client
+    class << self
+      attr_accessor :configuration
+    end
+
+    # Allows global configuration of the Client class. When called with a
+    # block, it yields an instance of Configuration, enabling settings like
+    # +service_url+ and +logger+ to be set for the entire application.
+    #
+    # @example Configuring the client globally
+    #   PromostandardsRubyClient::Client.configure do |config|
+    #     config.service_url = 'https://custom-service-url.com'
+    #     config.logger = Rails.logger
+    #   end
+    #
+    # @yield [Configuration] Yields the configuration instance to the block.
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    # Initializes a new instance of Client with the specified options.
+    # If options are not provided, defaults to the global configuration
+    # or, if none exists, falls back to Configuration defaults.
+    #
+    # @param options [Hash] Optional settings to configure the client
+    # instance.
+    # @option options [String] :service_url URL where the PromoStandards
+    # API compatible service is hosted.
+    # @option options [Logger] :logger Custom logger for this client
+    # instance.
+    def initialize(options = {})
+      config = self.class.configuration || Configuration.new
+      @service_url = options[:service_url] || config.service_url
+      @logger = options[:logger] || config.logger
+
+      raise ArgumentError, "service_url must be set" if @service_url.nil?
+    end
+  end
+end

lib/promostandards_ruby_client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module PromostandardsRubyClient
+  # The Configuration class provides a way to set up and manage configuration
+  # options for the gem.
+  #
+  # == Usage
+  #
+  # Configuration can be set for the application in a Rails initializer:
+  #
+  #   # config/initializers/promostandards_ruby_client.rb
+  #   PromostandardsRubyClient::Client.configure do |config|
+  #     config.service_url = 'https://custom-service-url.com'
+  #     config.logger = Rails.logger
+  #   end
+  #
+  # Alternatively, configuration options can be passed directly when
+  # creating an instance of the client:
+  #
+  #   client = PromostandardsRubyClient::Client.new(
+  #     service_url: 'https://another-service-url.com',
+  #     logger: custom_logger
+  #   )
+  #
+  # == Attributes
+  #
+  # * +service_url+ - The base URL for the PromoStandards-compatible
+  #   service.
+  #
+  # * +logger+ - A logger with an API compatible with Rails.logger (
+  #   responding to +info+, +warn+, +error+, etc.). Defaults to a standard
+  #   Logger instance outputting to STDOUT.
+  #
+  class Configuration
+    # The base URL for the PromoStandards-compatible service.
+    # This attribute is required; it must be set in either global
+    # configuration or directly passed to the client instance. If not set,
+    # an error will be raised.
+    attr_accessor :service_url
+    # A logger with an API compatible with Rails.logger (responding to
+    # +info+, +warn+, +error+, etc.). Defaults to a standard Logger
+    # instance outputting to STDOUT.
+    attr_accessor :logger
+
+    def initialize
+      @logger = ::Logger.new($stdout)
+    end
+  end
+end

lib/promostandards_ruby_client/client.rb

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

lib/promostandards_ruby_client/configuration.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "lib/promostandards/ruby/client/version"
+require_relative "lib/promostandards_ruby_client/version"
 
 Gem::Specification.new do |spec|
   spec.name = "promostandards-ruby-client"
-  spec.version = Promostandards::Ruby::Client::VERSION
+  spec.version = PromostandardsRubyClient::VERSION
   spec.authors = ["quintsys"]
   spec.email = ["[email protected]"]
 
@@ -36,4 +36,6 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_dependency("logger")
 end

lib/promostandards_ruby_client/version.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+RSpec.describe PromostandardsRubyClient::Client do
+  let(:custom_logger) { Logger.new("/dev/null") }
+  let(:custom_service_url) { "https://custom-service-url.com" }
+
+  after do
+    described_class.configuration = nil
+  end
+
+  it "has a version number" do
+    expect(PromostandardsRubyClient::VERSION).not_to be_nil
+  end
+
+  describe ".configure" do
+    before do
+      described_class.configure do |config|
+        config.service_url = custom_service_url
+        config.logger = custom_logger
+      end
+    end
+
+    it "allows setting a global service_url" do
+      expect(described_class.configuration.service_url)
+        .to eq(custom_service_url)
+    end
+
+    it "allows setting a global logger" do
+      expect(described_class.configuration.logger).to eq(custom_logger)
+    end
+  end
+
+  describe "#initialize" do
+    context "with global configuration" do
+      before do
+        described_class.configure do |config|
+          config.service_url = custom_service_url
+          config.logger = custom_logger
+        end
+      end
+
+      it "uses global configuration for service_url" do
+        client = described_class.new
+        expect(client.instance_variable_get(:@service_url))
+          .to(eq(custom_service_url))
+      end
+
+      it "uses global configuration for logger" do
+        client = described_class.new
+        expect(client.instance_variable_get(:@logger)).to eq(custom_logger)
+      end
+
+      it "overrides global configuration with instance options" do
+        alternate_service_url = "https://another-service-url.com"
+        client = described_class.new(service_url: alternate_service_url)
+        expect(client.instance_variable_get(:@service_url))
+          .to(eq(alternate_service_url))
+      end
+    end
+
+    context "without global configuration" do
+      it "raises an error if service_url is not provided" do
+        expect do
+          described_class.new
+        end.to raise_error(ArgumentError, "service_url must be set")
+      end
+
+      it "uses provided service_url if given" do
+        client = described_class.new(service_url: custom_service_url,
+                                     logger: custom_logger)
+        expect(client.instance_variable_get(:@service_url))
+          .to(eq(custom_service_url))
+      end
+
+      it "uses provided logger if given" do
+        client = described_class.new(service_url: custom_service_url,
+                                     logger: custom_logger)
+        expect(client.instance_variable_get(:@logger)).to eq(custom_logger)
+      end
+    end
+  end
+end

promostandards-ruby-client.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "promostandards/ruby/client"
+require "promostandards_ruby_client"
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure