spreadshop_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61d1e29aeef3a14d5174d64c269f579db384d55a904ed06f9f2db2eb29313dc0
-  data.tar.gz: 03cf50bba404559089f63d3ab2fe12462921f2d80d366b8399d6412433b07cd4
+  metadata.gz: e36079277ca7c86a4202b90b10e3155fa570b47c8922b1b6e97af6f84d6623bc
+  data.tar.gz: 7a21faffddce4b89f0cb2a8b6426a9e6f20c32ab1ef3c39d93640b5464231230
 SHA512:
-  metadata.gz: 2eb595decdecb9bc0651f0db35fc15c8d27c45699ecb2cadac39839047b52931ed68dc5fffaf8d40fc192e60055ffc0906a7ec1fb3c9f3c2e008caf45f7004c0
-  data.tar.gz: 07b908a8785890ec264189b8e68c224ea13e3e46799f08804f13311b424db8c8c67b4df74d48268238118d1134c7e287dbafbf883b29f4c4f6dc76896bb90d5c
+  metadata.gz: b0fb8b2e877eb2fc4bc34cf75b8f55569b14daa6f46c21d275a99da9dcb0173dd13cec2cd1a556b7e0052bd934d401eba39ea9423646f81d757cd43c329f6fc0
+  data.tar.gz: 4fd129760e341d9bd8bb1569bff1801fb521093a5d7207c710785beb13db5a6ddca9002ce3ceb8988d61332cacb5055fb038802cc213cf38080dde13ccbaa93d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
-## [Unreleased]
+## [Released]
 
 ## [0.0.1] - 2025-01-25
 
 - Initial release
     - It is possible to get the Shop id and name
+
+## [0.0.2] - 2025-01-27
+
+- Add Products query
+    - It is possible to get the products and products by id

data/README.md

@@ -1,6 +1,6 @@
 # SpreadshopClient
 
-
+[![Gem Version](https://badge.fury.io/rb/spreadshop_client.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/spreadshop_client)
 [![Build Status](https://github.com/paderich/spreadshop_client/actions/workflows/main.yml/badge.svg)](https://github.com/paderich/spreadshop_client/actions)
 
 `SpreadshopClient` is a Ruby gem that provides a convenient interface for interacting with the Spreadshop GraphQL API. It simplifies fetching shop data by encapsulating the necessary queries and handling the API communication, making it easy to integrate into your Ruby projects or Rails applications.
@@ -22,6 +22,8 @@ Or install it yourself as:
 gem install spreadshop_client
 ```
 ## Usage
+
+### Fetch Shop
 Here's an example of how to use the SpreadshopClient gem to fetch shop details:
 ```ruby
 require 'spreadshop_client'
@@ -42,6 +44,43 @@ else
 end
 ```
 
+### Fetching Products
+To fetch all products from a shop, you can use the SpreadshopClient as follows:
+```ruby
+require 'spreadshop_client'
+
+shop_id = "1394271"       # Replace with the actual shop ID
+platform = "EU"           # Replace with the platform
+locale = "de_DE"          # Replace with the locale
+
+products = SpreadshopClient::Product.get_all(shop_id: shop_id, platform: platform, locale: locale)
+
+if products.is_a?(Array)
+  puts "Number of Products: #{products.size}"
+  
+  first_product = products.first
+  puts "First Product ID: #{first_product.id}"
+  puts "First Product Name: #{first_product.name}"
+else
+  puts "Error fetching products: #{products[:error]}"
+end
+```
+
+To fetch a specific product by ID:
+```ruby
+product_id = "12345"  # Replace with the actual product ID
+
+product = SpreadshopClient::Product.get_by_id(product_id: product_id, shop_id: shop_id, platform: platform, locale: locale)
+
+if product.is_a?(SpreadshopClient::Product)
+  puts "Product ID: #{product.id}"
+  puts "Product Name: #{product.name}"
+else
+  puts "Error fetching product by ID: #{product[:error]}"
+end
+```
+
+
 ## Development and Testing
 ### Run Tests:
 ```ruby

data/lib/spreadshop_client/models/product.rb

@@ -0,0 +1,39 @@
+require_relative "../client"
+
+module SpreadshopClient
+  module Models
+    class ProductModel
+      include ProductsQueries
+
+      attr_reader :id, :name, :image, :price
+
+      def initialize(attributes)
+        @id = attributes["id"]
+        @name = attributes["name"]
+        @image = attributes["image"] || {}
+        @price = attributes["price"] || {}
+      end
+
+      def self.get_all(shop_id:, platform:, locale:)
+        response = SpreadshopClient::Client.query(GET_PRODUCTS, {shopId: shop_id, platform: platform, locale: locale})
+
+        if response["data"] && response["data"]["products"]
+          response["data"]["products"]["items"].map { |item| new(item) }
+        else
+          {error: response["errors"] || "Unknown error"}
+        end
+      end
+
+      def self.get_by_id(product_id:, shop_id:, platform:, locale:)
+        response = SpreadshopClient::Client.query(GET_PRODUCTS, {shopId: shop_id, platform: platform, locale: locale})
+
+        # Safely navigate through the response using dig
+        items = response.dig("data", "products", "items") || []
+        item = items.find { |item| item["id"] == product_id }
+
+        # Return a new instance if found, otherwise return nil
+        item ? new(item) : nil
+      end
+    end
+  end
+end

data/lib/spreadshop_client/models/product_queries.rb

@@ -0,0 +1,27 @@
+module SpreadshopClient
+  module Models
+    module ProductsQueries
+      GET_PRODUCTS = <<~GQL.strip
+        query($shopId: ID!, $platform: Platform!, $locale: Locale!) {
+          products(shopId: $shopId, platform: $platform, locale: $locale) {
+            items {
+              id
+              name
+              image {
+                src
+                srcset
+                altText
+                format
+              }
+              price {
+                vatExcluded
+                vatIncluded
+                vatAmount
+              }
+            }
+          }
+        }
+      GQL
+    end
+  end
+end

data/lib/spreadshop_client/models/shop.rb

@@ -1,23 +1,24 @@
-require_relative "../queries/shop_queries"
 require_relative "../client"
 
 module SpreadshopClient
-  class Shop
-    include SpreadshopClient::Queries::ShopQueries
+  module Models
+    class ShopModel
+      include SpreadshopClient::Models::ShopQueries
 
-    attr_reader :id, :name
+      attr_reader :id, :name
 
-    def initialize(attributes)
-      @id = attributes["id"]
-      @name = attributes["name"]
-    end
+      def initialize(attributes)
+        @id = attributes["id"]
+        @name = attributes["name"]
+      end
 
-    def self.get_shop(name:, platform:, locale:)
-      response = SpreadshopClient::Client.query(GET_SHOP, {name: name, platform: platform, locale: locale})
-      if response["data"] && response["data"]["shop"]
-        new(response["data"]["shop"])
-      else
-        {error: response["errors"] || "Unknown error"}
+      def self.get_shop(name:, platform:, locale:)
+        response = SpreadshopClient::Client.query(GET_SHOP, {name: name, platform: platform, locale: locale})
+        if response["data"] && response["data"]["shop"]
+          new(response["data"]["shop"])
+        else
+          {error: response["errors"] || "Unknown error"}
+        end
       end
     end
   end

data/lib/spreadshop_client/{queries → models}/shop_queries.rb

@@ -1,5 +1,5 @@
 module SpreadshopClient
-  module Queries
+  module Models
     module ShopQueries
       GET_SHOP = <<~GQL.strip
         query($name: String!, $platform: Platform!, $locale: Locale!) {

data/lib/spreadshop_client/version.rb

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

data/lib/spreadshop_client.rb

@@ -3,12 +3,27 @@
 $LOAD_PATH.unshift(File.expand_path("..", __dir__))
 
 require "spreadshop_client/version"
+require "spreadshop_client/models/shop_queries"
+require "spreadshop_client/models/product_queries"
 require "spreadshop_client/models/shop"
+require "spreadshop_client/models/product"
 
 module SpreadshopClient
   class Error < StandardError; end
 
-  def self.get_shop(name:, platform:, locale:)
-    Shop.get_shop(name: name, platform: platform, locale: locale)
+  module Shop
+    def self.get_shop(name:, platform:, locale:)
+      SpreadshopClient::Models::ShopModel.get_shop(name: name, platform: platform, locale: locale)
+    end
+  end
+
+  module Product
+    def self.get_all(shop_id:, platform:, locale:)
+      SpreadshopClient::Models::ProductModel.get_all(shop_id: shop_id, platform: platform, locale: locale)
+    end
+
+    def self.get_by_id(product_id:, shop_id:, platform:, locale:)
+      SpreadshopClient::Models::ProductModel.get_by_id(product_id: product_id, shop_id: shop_id, platform: platform, locale: locale)
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: spreadshop_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Paderich
 bindir: exe
 cert_chain: []
-date: 2025-01-25 00:00:00.000000000 Z
+date: 2025-01-27 00:00:00.000000000 Z
 dependencies: []
 description: This gems provides a client for the Spreadshop GraphQL API.
 email:
@@ -24,8 +24,10 @@ files:
 - Rakefile
 - lib/spreadshop_client.rb
 - lib/spreadshop_client/client.rb
+- lib/spreadshop_client/models/product.rb
+- lib/spreadshop_client/models/product_queries.rb
 - lib/spreadshop_client/models/shop.rb
-- lib/spreadshop_client/queries/shop_queries.rb
+- lib/spreadshop_client/models/shop_queries.rb
 - lib/spreadshop_client/version.rb
 - sig/spreadshop_client.rbs
 homepage: https://github.com/paderich/spreadshop_client