jekyll-shopsavvy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 105a94a928827ffde68ed93ff535c84638f1fb95c7976ecb94c1a4cdec6ccb6f
+  data.tar.gz: 49deeab2b516ba83a90f49035de488d82631a54d6674be06d997aeceaac620e6
+SHA512:
+  metadata.gz: 0e43d86bc0764ac5731a52f36ffe28de5d2b5616814245203e5f997adcb490afaf373956334b345851407bb93fbc5cc0ec0cfca63f3d652d3b11117057533a62
+  data.tar.gz: 9a1cc160af8db9dc163dfb6022de1936b26698771074bf945f0a46dec7214dc39c492422bb63b7bd658ce87989c54756119f2f038a3ca45d989f60a363908dc2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ShopSavvy by Monolith Technologies, Inc.
+
+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,88 @@
+# jekyll-shopsavvy
+
+Jekyll plugin that adds Liquid tags and filters for embedding **live product cards, deal feeds, and price lookups** powered by the [ShopSavvy Data API](https://shopsavvy.com/data). Everything runs at build time, so the generated site stays static.
+
+[Documentation](https://shopsavvy.com/integrations/jekyll) · [Get an API key](https://shopsavvy.com/data) · [Other integrations](https://shopsavvy.com/integrations)
+
+## Install
+
+Add to your Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-shopsavvy"
+end
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+Register the plugin in `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll-shopsavvy
+
+shopsavvy:
+  api_key: ENV["SHOPSAVVY_API_KEY"]
+```
+
+> **Heads up:** GitHub Pages safe mode whitelists only specific plugins, and `jekyll-shopsavvy` is not on that list. To deploy a Jekyll site that uses this gem to GitHub Pages, build with GitHub Actions and publish the resulting `_site/` directory — that path supports any plugin.
+
+## Tags
+
+### `{% shopsavvy_product %}`
+
+Renders a product with offers from across retailers.
+
+```liquid
+{% shopsavvy_product "012345678905" %}
+{% shopsavvy_product "B0DGHYDZSB" layout="inline" %}
+{% shopsavvy_product "012345678905" layout="table" retailer="amazon" limit=10 %}
+```
+
+Layouts: `card` (default), `inline`, `table`.
+
+### `{% shopsavvy_deals %}`
+
+Renders a grid of trending deals.
+
+```liquid
+{% shopsavvy_deals category="electronics" limit=8 %}
+{% shopsavvy_deals sort="discount" grade="A" %}
+```
+
+### `{% shopsavvy_price %}`
+
+Inline price text — useful for headlines or sentences.
+
+```liquid
+The current best price is {% shopsavvy_price "012345678905" %}.
+```
+
+## Filter
+
+```liquid
+{% assign product = "012345678905" | shopsavvy_lookup %}
+<h2>{{ product.data[0].name }}</h2>
+```
+
+## Configuration
+
+Read in this order:
+
+1. `ENV["SHOPSAVVY_API_KEY"]`
+2. `_config.yml` → `shopsavvy.api_key`
+
+## Test
+
+```bash
+./test.sh
+```
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

data/lib/jekyll/shopsavvy/client.rb

@@ -0,0 +1,60 @@
+require "net/http"
+require "uri"
+require "json"
+
+module Jekyll
+  module Shopsavvy
+    # Thin HTTP wrapper that calls the ShopSavvy Data API at build time.
+    # Caches responses per Jekyll site build to keep rebuilds fast.
+    class Client
+      DEFAULT_BASE_URL = "https://api.shopsavvy.com/v1".freeze
+
+      def initialize(api_key:, base_url: DEFAULT_BASE_URL, cache: nil)
+        raise ArgumentError, "ShopSavvy API key is required" if api_key.nil? || api_key.empty?
+        @api_key = api_key
+        @base_url = base_url
+        @cache = cache || {}
+      end
+
+      def product_details(identifier)
+        get("/products/details", id: identifier)
+      end
+
+      def current_offers(identifier, retailer: nil)
+        params = { id: identifier }
+        params[:retailer] = retailer if retailer
+        get("/products/offers", **params)
+      end
+
+      def price_history(identifier, days: 90)
+        get("/products/history", id: identifier, days: days)
+      end
+
+      def deals(category: nil, limit: 10, sort: "trending", grade: nil)
+        params = { limit: limit, sort: sort }
+        params[:category] = category if category
+        params[:min_grade] = grade if grade
+        get("/deals", **params)
+      end
+
+      private
+
+      def get(path, **params)
+        cache_key = [path, params].to_s
+        return @cache[cache_key] if @cache.key?(cache_key)
+
+        uri = URI.parse("#{@base_url}#{path}")
+        uri.query = URI.encode_www_form(params) unless params.empty?
+
+        request = Net::HTTP::Get.new(uri)
+        request["Authorization"] = "Bearer #{@api_key}"
+        request["User-Agent"] = "jekyll-shopsavvy/#{VERSION}"
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
+        body = JSON.parse(response.body)
+        @cache[cache_key] = body
+        body
+      end
+    end
+  end
+end

data/lib/jekyll/shopsavvy/tags.rb

@@ -0,0 +1,177 @@
+require "shellwords"
+
+module Jekyll
+  module Shopsavvy
+    # Parses key=value style arguments out of a Liquid tag's markup string.
+    module ArgsParser
+      module_function
+
+      def parse(markup)
+        tokens = Shellwords.split(markup.to_s)
+        positional = []
+        named = {}
+        tokens.each do |t|
+          if t.include?("=")
+            k, v = t.split("=", 2)
+            named[k.to_sym] = v
+          else
+            positional << t
+          end
+        end
+        [positional, named]
+      end
+    end
+
+    # Site-level helpers: shared client and cache.
+    module SiteHelpers
+      module_function
+
+      def client_for(context)
+        site = context.registers[:site]
+        site.config["__shopsavvy_client"] ||= begin
+          api_key = ENV["SHOPSAVVY_API_KEY"] || site.config.dig("shopsavvy", "api_key")
+          Client.new(api_key: api_key, cache: (site.config["__shopsavvy_cache"] ||= {}))
+        rescue ArgumentError => e
+          Jekyll.logger.warn("ShopSavvy:", e.message)
+          nil
+        end
+      end
+    end
+
+    # {% shopsavvy_product <identifier> [layout="card"] [retailer="..."] [limit=5] %}
+    class ProductTag < Liquid::Tag
+      LAYOUTS = %w[card inline table].freeze
+
+      def initialize(tag_name, markup, tokens)
+        super
+        positional, @named = ArgsParser.parse(markup)
+        @identifier = positional.first || @named[:upc] || @named[:asin] || @named[:id] || @named[:url]
+        @layout = (@named[:layout] || "card").to_s
+        @layout = "card" unless LAYOUTS.include?(@layout)
+        @retailer = @named[:retailer]
+        @limit = (@named[:limit] || 5).to_i
+      end
+
+      def render(context)
+        client = SiteHelpers.client_for(context)
+        return "" unless client && @identifier
+
+        identifier = Liquid::Template.parse(@identifier).render(context)
+        product = client.product_details(identifier)
+        offers = client.current_offers(identifier, retailer: @retailer)
+        offer_list = (offers["data"] || []).first(@limit)
+
+        case @layout
+        when "inline" then render_inline(product, offer_list)
+        when "table"  then render_table(product, offer_list)
+        else               render_card(product, offer_list)
+        end
+      end
+
+      private
+
+      def render_card(product, offers)
+        item = (product["data"] || []).first || {}
+        cheapest = offers.min_by { |o| o["price"].to_f } || {}
+        offers_html = offers.map { |o| %(<li><span>#{o["retailer"]}</span><span>$#{o["price"]}</span></li>) }.join
+        <<~HTML
+          <div class="shopsavvy-card">
+            #{item["image"] ? %(<img class="shopsavvy-card__image" src="#{item["image"]}" alt="#{item["name"]}" loading="lazy" />) : ""}
+            <div class="shopsavvy-card__body">
+              <h3 class="shopsavvy-card__name">#{item["name"]}</h3>
+              <p class="shopsavvy-card__price">$#{cheapest["price"]} <span class="shopsavvy-card__retailer">at #{cheapest["retailer"]}</span></p>
+              <ul class="shopsavvy-card__offers">#{offers_html}</ul>
+              <a class="shopsavvy-card__cta" href="https://shopsavvy.com" rel="noopener">Compare on ShopSavvy</a>
+            </div>
+          </div>
+        HTML
+      end
+
+      def render_inline(product, offers)
+        item = (product["data"] || []).first || {}
+        cheapest = offers.min_by { |o| o["price"].to_f } || {}
+        %(<span class="shopsavvy-inline"><strong>#{item["name"]}</strong> — <span class="shopsavvy-inline__price">$#{cheapest["price"]} at #{cheapest["retailer"]}</span></span>)
+      end
+
+      def render_table(product, offers)
+        item = (product["data"] || []).first || {}
+        rows = offers.map do |o|
+          %(<tr><td>#{o["retailer"]}</td><td>$#{o["price"]}</td><td>#{o["condition"] || "new"}</td><td>#{o["availability"] ? "Yes" : "—"}</td></tr>)
+        end.join
+        <<~HTML
+          <div class="shopsavvy-table-wrap">
+            <p class="shopsavvy-table__title">#{item["name"]}</p>
+            <table class="shopsavvy-table">
+              <thead><tr><th>Retailer</th><th>Price</th><th>Condition</th><th>In stock</th></tr></thead>
+              <tbody>#{rows}</tbody>
+            </table>
+          </div>
+        HTML
+      end
+    end
+
+    # {% shopsavvy_deals [category="..."] [limit=10] [sort="trending"] [grade="A"] %}
+    class DealsTag < Liquid::Tag
+      def initialize(tag_name, markup, tokens)
+        super
+        _positional, named = ArgsParser.parse(markup)
+        @category = named[:category]
+        @limit = (named[:limit] || 10).to_i
+        @sort = named[:sort] || "trending"
+        @grade = named[:grade]
+      end
+
+      def render(context)
+        client = SiteHelpers.client_for(context)
+        return "" unless client
+        deals = client.deals(category: @category, limit: @limit, sort: @sort, grade: @grade)
+        items = deals["data"] || []
+        body = items.map do |d|
+          %(<a class="shopsavvy-deal" href="#{d["url"] || "https://shopsavvy.com"}" rel="noopener">) +
+            (d["image"] ? %(<img src="#{d["image"]}" alt="#{d["name"]}" loading="lazy" />) : "") +
+            %(<div class="shopsavvy-deal__body"><p class="shopsavvy-deal__name">#{d["name"]}</p>) +
+            %(<p class="shopsavvy-deal__price"><span class="shopsavvy-deal__sale">$#{d["price"]}</span>) +
+            (d["strikethrough"] ? %(<span class="shopsavvy-deal__msrp">$#{d["strikethrough"]}</span>) : "") +
+            %(</p><p class="shopsavvy-deal__retailer">#{d["retailer"]}</p></div></a>)
+        end.join
+        %(<div class="shopsavvy-deals-grid">#{body}</div>)
+      end
+    end
+
+    # {% shopsavvy_price <identifier> %} — emits a plain price string.
+    class PriceTag < Liquid::Tag
+      def initialize(tag_name, markup, tokens)
+        super
+        positional, _named = ArgsParser.parse(markup)
+        @identifier = positional.first
+      end
+
+      def render(context)
+        client = SiteHelpers.client_for(context)
+        return "" unless client && @identifier
+        identifier = Liquid::Template.parse(@identifier).render(context)
+        offers = client.current_offers(identifier)
+        cheapest = (offers["data"] || []).min_by { |o| o["price"].to_f }
+        cheapest ? "$#{cheapest["price"]}" : ""
+      end
+    end
+  end
+end
+
+# {{ "012345678905" | shopsavvy_lookup }}
+module Jekyll
+  module Shopsavvy
+    module Filters
+      def shopsavvy_lookup(identifier)
+        site = @context.registers[:site]
+        api_key = ENV["SHOPSAVVY_API_KEY"] || site.config.dig("shopsavvy", "api_key")
+        return {} if api_key.nil?
+        client = Jekyll::Shopsavvy::Client.new(api_key: api_key, cache: (site.config["__shopsavvy_cache"] ||= {}))
+        client.product_details(identifier.to_s)
+      rescue StandardError => e
+        Jekyll.logger.warn("ShopSavvy:", "lookup failed: #{e.message}")
+        {}
+      end
+    end
+  end
+end

data/lib/jekyll/shopsavvy/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Shopsavvy
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll-shopsavvy.rb

@@ -0,0 +1,9 @@
+require "jekyll"
+require_relative "jekyll/shopsavvy/version"
+require_relative "jekyll/shopsavvy/client"
+require_relative "jekyll/shopsavvy/tags"
+
+Liquid::Template.register_tag("shopsavvy_product", Jekyll::Shopsavvy::ProductTag)
+Liquid::Template.register_tag("shopsavvy_deals",   Jekyll::Shopsavvy::DealsTag)
+Liquid::Template.register_tag("shopsavvy_price",   Jekyll::Shopsavvy::PriceTag)
+Liquid::Template.register_filter(Jekyll::Shopsavvy::Filters)

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-shopsavvy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ShopSavvy by Monolith Technologies, Inc.
+bindir: bin
+cert_chain: []
+date: 2026-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Adds {% shopsavvy_product %}, {% shopsavvy_deals %}, {% shopsavvy_price
+  %} Liquid tags and a shopsavvy_lookup filter for embedding live product cards, deal
+  feeds, and price lookups in Jekyll sites at build time.
+email:
+- business@shopsavvy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-shopsavvy.rb
+- lib/jekyll/shopsavvy/client.rb
+- lib/jekyll/shopsavvy/tags.rb
+- lib/jekyll/shopsavvy/version.rb
+homepage: https://shopsavvy.com/integrations/jekyll
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://shopsavvy.com/integrations/jekyll
+  source_code_uri: https://github.com/shopsavvy/jekyll-shopsavvy
+  documentation_uri: https://shopsavvy.com/integrations/jekyll
+  changelog_uri: https://github.com/shopsavvy/jekyll-shopsavvy/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Jekyll Liquid tags and filters powered by the ShopSavvy Data API
+test_files: []