showroom 0.1.0

data/lib/showroom/models/search/result.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Showroom
+  module Search
+    # Wraps the +resources.results+ hash from a Shopify search suggest response,
+    # exposing typed arrays for each resource kind.
+    #
+    # @example
+    #   result = Showroom::Search::Result.new(raw['resources']['results'])
+    #   result.products     # => [Array<ProductSuggestion>]
+    #   result.collections  # => [Array<CollectionSuggestion>]
+    #   result.queries      # => [Array<QuerySuggestion>]
+    class Result
+      # @param results_hash [Hash] the +resources.results+ hash from the API response
+      def initialize(results_hash)
+        @data = results_hash
+      end
+
+      # Returns product suggestions from the search result.
+      #
+      # @return [Array<ProductSuggestion>]
+      def products
+        @data.fetch('products', []).map { |h| ProductSuggestion.new(h) }
+      end
+
+      # Returns collection suggestions from the search result.
+      #
+      # @return [Array<CollectionSuggestion>]
+      def collections
+        @data.fetch('collections', []).map { |h| CollectionSuggestion.new(h) }
+      end
+
+      # Returns page suggestions from the search result.
+      #
+      # @return [Array<PageSuggestion>]
+      def pages
+        @data.fetch('pages', []).map { |h| PageSuggestion.new(h) }
+      end
+
+      # Returns article suggestions from the search result.
+      #
+      # @return [Array<ArticleSuggestion>]
+      def articles
+        @data.fetch('articles', []).map { |h| ArticleSuggestion.new(h) }
+      end
+
+      # Returns query suggestions from the search result.
+      #
+      # @return [Array<QuerySuggestion>]
+      def queries
+        @data.fetch('queries', []).map { |h| QuerySuggestion.new(h) }
+      end
+    end
+  end
+end

data/lib/showroom/models/search/suggestion.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Showroom
+  module Search
+    # Base class for all search suggestion types.
+    #
+    # Subclasses that correspond to a fully-loadable model override {.complete_model_class}
+    # to declare which model to fetch. Calling {#load} on a suggestion that has no
+    # model raises +NoMethodError+.
+    #
+    # @example Loadable suggestion
+    #   suggestion = result.products.first
+    #   suggestion.load  # => Showroom::Product
+    #
+    # @example Non-loadable suggestion
+    #   suggestion = result.queries.first
+    #   suggestion.load  # => NoMethodError
+    class Suggestion < Resource
+      class << self
+        # Override in subclasses to declare the corresponding full model class.
+        #
+        # @return [Class]
+        # @raise [NoMethodError] when the suggestion type has no associated model
+        def complete_model_class
+          raise NoMethodError, "#{name} has no associated model — #load is not available"
+        end
+      end
+
+      # Returns the identifier used to fetch the full record (defaults to the
+      # +handle+ attribute). Override in subclasses when the identifier differs.
+      #
+      # @return [String]
+      def loadable_identifier
+        @attrs['handle']
+      end
+
+      # Fetches the full model record for this suggestion.
+      #
+      # Delegates to the model class declared by {.complete_model_class}, finding
+      # by {#loadable_identifier}.
+      #
+      # @return [Resource]
+      # @raise [NoMethodError] when the suggestion type has no associated model
+      # @raise [Showroom::NotFound] when the record is not found
+      def load
+        self.class.complete_model_class.find(loadable_identifier)
+      end
+    end
+  end
+end

data/lib/showroom/models/search.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Showroom
+  # Provides search/suggest functionality against the Shopify search API.
+  #
+  # @example
+  #   result = Showroom::Search.suggest('lorem', types: [:product, :collection], limit: 5)
+  #   result.products.first.title  # => "Lorem Road Bike"
+  module Search
+    # Calls GET /search/suggest.json and returns a {Result} wrapping the response.
+    #
+    # Builds query parameters of the form:
+    #   ?q=...&resources[type]=product,collection&resources[limit]=10
+    #
+    # @param query_str [String] the search query
+    # @param types [Array<Symbol>] resource types to search (e.g. +:product+, +:collection+, +:query+)
+    # @param limit [Integer] maximum number of results per type
+    # @param params [Hash] additional query parameters forwarded to the API
+    # @return [Result]
+    def self.suggest(query_str, types: %i[product collection], limit: Showroom.per_page, **params)
+      query = { q: query_str, 'resources[limit]' => limit }
+      query['resources[type]'] = types.join(',') unless types.empty?
+      query.merge!(params)
+      raw = Showroom.client.get('/search/suggest.json', query)
+      Result.new(raw.dig('resources', 'results') || {})
+    end
+  end
+end

data/lib/showroom/models.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'core/countable'
+require_relative 'models/resource'
+
+require_relative 'models/product_image'
+require_relative 'models/product_option'
+require_relative 'models/product_variant'
+require_relative 'models/product'
+
+require_relative 'models/collection'
+
+require_relative 'models/search/suggestion'
+require_relative 'models/search/product_suggestion'
+require_relative 'models/search/collection_suggestion'
+require_relative 'models/search/page_suggestion'
+require_relative 'models/search/article_suggestion'
+require_relative 'models/search/query_suggestion'
+require_relative 'models/search/result'
+require_relative 'models/search'

data/lib/showroom.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative 'showroom/core/version'
+require_relative 'showroom/core/error'
+require_relative 'showroom/core/default'
+require_relative 'showroom/core/configurable'
+require_relative 'showroom/core/store_url'
+require_relative 'showroom/http/middleware/raise_error'
+require_relative 'showroom/core/connection'
+require_relative 'showroom/client'
+require_relative 'showroom/models'
+
+# Top-level namespace for the Showroom gem.
+#
+# Acts as a module-level client with {Core::Configurable} mixed in, so you can
+# configure and use Showroom directly without instantiating a {Client}.
+#
+# @example Global configuration
+#   Showroom.configure do |c|
+#     c.store = 'example.myshopify.com'
+#   end
+#
+# @example Module-level request
+#   Showroom.client.get('/products.json')
+module Showroom
+  extend Core::Configurable
+
+  reset!
+
+  # Returns the memoized module-level {Client}.
+  #
+  # @return [Client]
+  def self.client
+    @client ||= Client.new(**options)
+  end
+
+  # Configures the module and resets the memoized client so the next call to
+  # {.client} picks up the new settings.
+  #
+  # @yield [self]
+  # @return [self]
+  def self.configure
+    super.tap { @client = nil }
+  end
+
+  # Resets all configuration to defaults and clears the memoized client.
+  #
+  # @return [void]
+  def self.reset!
+    super
+    @client = nil
+  end
+
+  # Alias for {.configure} — yields self for block-style setup.
+  #
+  # @yield [self]
+  # @return [self]
+  def self.setup(&)
+    configure(&)
+  end
+
+  # Fetches products from the configured store.
+  #
+  # @param params [Hash] Shopify query parameters
+  # @return [Array<Product>]
+  def self.products(**params)
+    Product.where(**params)
+  end
+
+  # Fetches a single product by handle from the configured store.
+  #
+  # @param handle [String] the product handle
+  # @return [Product]
+  # @raise [Showroom::NotFound] when the product is not found
+  def self.product(handle)
+    Product.find(handle)
+  end
+
+  # Fetches collections from the configured store.
+  #
+  # @param params [Hash] Shopify query parameters
+  # @return [Array<Collection>]
+  def self.collections(**params)
+    Collection.where(**params)
+  end
+
+  # Fetches a single collection by handle from the configured store.
+  #
+  # @param handle [String] the collection handle
+  # @return [Collection]
+  # @raise [Showroom::NotFound] when the collection is not found
+  def self.collection(handle)
+    Collection.find(handle)
+  end
+
+  # Calls the Shopify search suggest endpoint and returns a {Search::Result}.
+  #
+  # All keyword arguments are forwarded verbatim to {Search.suggest}
+  # (accepted keys: +types:+, +limit:+; see {Search.suggest} for details).
+  #
+  # @param query_str [String] the search query
+  # @return [Search::Result]
+  def self.search(query_str, **)
+    Search.suggest(query_str, **)
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: showroom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 01max
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: |-
+  A standalone Ruby gem providing a Faraday-based client
+      to interact with the Shopify public API.
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/showroom.rb
+- lib/showroom/client.rb
+- lib/showroom/core/configurable.rb
+- lib/showroom/core/connection.rb
+- lib/showroom/core/countable.rb
+- lib/showroom/core/default.rb
+- lib/showroom/core/error.rb
+- lib/showroom/core/store_url.rb
+- lib/showroom/core/version.rb
+- lib/showroom/http/middleware/raise_error.rb
+- lib/showroom/models.rb
+- lib/showroom/models/collection.rb
+- lib/showroom/models/product.rb
+- lib/showroom/models/product_image.rb
+- lib/showroom/models/product_option.rb
+- lib/showroom/models/product_variant.rb
+- lib/showroom/models/resource.rb
+- lib/showroom/models/search.rb
+- lib/showroom/models/search/article_suggestion.rb
+- lib/showroom/models/search/collection_suggestion.rb
+- lib/showroom/models/search/page_suggestion.rb
+- lib/showroom/models/search/product_suggestion.rb
+- lib/showroom/models/search/query_suggestion.rb
+- lib/showroom/models/search/result.rb
+- lib/showroom/models/search/suggestion.rb
+homepage: https://github.com/01max/showroom
+licenses:
+- GPL-3.0-or-later
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/01max/showroom
+  source_code_uri: https://github.com/01max/showroom
+  changelog_uri: https://github.com/01max/showroom/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: An unauthenticated Ruby client for Shopify's public API.
+test_files: []