opengraphplus 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84dcc38250134ee587a8c981aab111e6cc13114455f69f6aff9eb3c90a2333bf
-  data.tar.gz: 14ff03291f508e0a7d91d1e104b9f8f647e6430885eb3e644b8cc96942aa1f8e
+  metadata.gz: 7d947ee47bc0e434395f69cceb99321f78ab4f8ac437f5b537b97ffa9a199d51
+  data.tar.gz: 308d3466e160b11f935afd3b9f0c891ba3b268f95f3de12400af9e815020a82f
 SHA512:
-  metadata.gz: b3d569b9fc677192c068379c45cb3b7206f3f39c88d024404beb0d91fab470e4c2862b099936ceb2b5c3d8edc857694f85305121a9d438422a39bb8f3a77b106
-  data.tar.gz: 1627854d4aa87fe61df5c98b803b4788adbe2118732334753b5d117b76bd1abe493ef9848974a48941a716431dcd6c5a2f1a9f1909b45a8a4f95a297307ddcd0
+  metadata.gz: ac3f345867d3cc9e5ad6fa1745f5f6ea45cf505fdd057191c0af0d48ca62d8af6e64aa7dfa26b2097f8d97af95fab8dec9888a37b00a573bc94c5ad68660c6c3
+  data.tar.gz: 9a20a378f2e36d594667c2abdba8e194bdcae2bc55a2daf33bf1195162b9c9498ca257e426e645ae85a3087cc0f80b83ff9f7065f730cc240564daf7617e58e7

data/lib/opengraphplus/configuration.rb

@@ -2,12 +2,14 @@
 
 module OpenGraphPlus
   class Configuration
-    attr_reader :api_key
-
     def initialize
       @api_key = nil
     end
 
+    def api_key
+      @api_key or warn "[OpenGraphPlus] API key not configured. Set OpenGraphPlus.configuration.api_key to enable automatic Open Graph image generation."
+    end
+
     def api_key=(value)
       @api_key = value.is_a?(APIKey) ? value : APIKey.parse(value)
     end

data/lib/opengraphplus/image_generator.rb

@@ -6,11 +6,20 @@ module OpenGraphPlus
 
     def initialize(request)
       @request = request
-      @signature_url = Signature::URL.new
     end
 
     def url
-      @signature_url.build("/opengraph", url: request.original_url)
+      return nil unless api_key
+
+      Signature::URL.new
+        .signed_path("/api/websites/v1", api_key)
+        .build("image", url: request.original_url)
+    end
+
+    private
+
+    def api_key
+      @api_key ||= OpenGraphPlus.configuration.api_key
     end
   end
 end

data/lib/opengraphplus/namespace.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module OpenGraphPlus
+  module Namespace
+    class Base
+      include Enumerable
+
+      def each(&block) = tags.each(&block)
+
+      def tag(property, value)
+        Tag.new(property, value) if value
+      end
+
+      def render_in(_view_context = nil)
+        map { |tag| tag.render_in }.join("\n").html_safe
+      end
+
+      def update(**kwargs)
+        kwargs.each { |key, value| public_send(:"#{key}=", value) }
+        self
+      end
+    end
+
+    class Image < Base
+      attr_accessor :url, :secure_url, :type, :width, :height, :alt
+
+      def tags
+        [
+          tag("og:image", url),
+          tag("og:image:secure_url", secure_url),
+          tag("og:image:type", type),
+          tag("og:image:width", width),
+          tag("og:image:height", height),
+          tag("og:image:alt", alt)
+        ].compact
+      end
+    end
+
+    class Viewport < Base
+      attr_accessor :width
+
+      def tags
+        [
+          tag("og:plus:viewport:width", width)
+        ].compact
+      end
+    end
+
+    class Plus < Base
+      attr_accessor :selector, :style
+
+      def style=(value)
+        @style = case value
+        when Hash
+          hash_to_css(value)
+        else
+          value
+        end
+      end
+
+      def viewport
+        @viewport ||= Viewport.new
+      end
+
+      def tags
+        [
+          tag("og:plus:selector", selector),
+          tag("og:plus:style", style),
+          *viewport.tags
+        ].compact
+      end
+
+      private
+
+      def hash_to_css(hash)
+        hash.map { |k, v| "#{k.to_s.tr("_", "-")}: #{v}" }.join("; ")
+      end
+    end
+
+    class OG < Base
+      attr_accessor :title, :description, :url, :type, :site_name, :locale, :determiner, :audio, :video
+
+      def initialize
+        @type = "website"
+      end
+
+      def image
+        @image ||= Image.new
+      end
+
+      def plus
+        @plus ||= Plus.new
+      end
+
+      def image_url=(url)
+        image.url = url
+        image.secure_url = url
+      end
+
+      def tags
+        [
+          tag("og:title", title),
+          tag("og:description", description),
+          tag("og:url", url),
+          tag("og:type", type),
+          tag("og:site_name", site_name),
+          tag("og:locale", locale),
+          tag("og:determiner", determiner),
+          tag("og:audio", audio),
+          tag("og:video", video),
+          *image.tags,
+          *plus.tags
+        ].compact
+      end
+    end
+
+    class Twitter < Base
+      class Image < Base
+        attr_accessor :url, :alt
+
+        def tags
+          [
+            tag("twitter:image", url),
+            tag("twitter:image:alt", alt)
+          ].compact
+        end
+      end
+
+      attr_accessor :card, :site, :creator, :title, :description
+
+      def initialize
+        @card = "summary_large_image"
+      end
+
+      def image
+        @image ||= Image.new
+      end
+
+      def image_url=(url)
+        image.url = url
+      end
+
+      def tags
+        [
+          tag("twitter:card", card),
+          tag("twitter:site", site),
+          tag("twitter:creator", creator),
+          tag("twitter:title", title),
+          tag("twitter:description", description),
+          *image.tags
+        ].compact
+      end
+    end
+
+    class Root < Base
+      extend Forwardable
+
+      def og
+        @og ||= OG.new
+      end
+
+      def twitter
+        @twitter ||= Twitter.new
+      end
+
+      def tags
+        [*og.tags, *twitter.tags]
+      end
+
+      def_delegators :og,
+        :title, :title=,
+        :description, :description=,
+        :url, :url=,
+        :type, :type=,
+        :site_name, :site_name=,
+        :locale, :locale=,
+        :determiner, :determiner=,
+        :audio, :audio=,
+        :video, :video=,
+        :image, :image_url=,
+        :plus
+    end
+  end
+
+  # Backwards compatibility
+  Tags = Namespace
+end

data/lib/opengraphplus/rails/controller.rb

@@ -4,9 +4,11 @@ module OpenGraphPlus
   module Rails
     module Controller
       extend ActiveSupport::Concern
+      include OpenGraphPlus::Rails::Helper
 
       included do
         helper_method :open_graph, :open_graph_tags, :open_graph_meta_tags
+        before_action :set_default_open_graph
         append_before_action :set_default_open_graph_image
       end
 
@@ -22,14 +24,17 @@ module OpenGraphPlus
 
       private
 
+      def set_default_open_graph
+        open_graph.type = "website"
+        open_graph.url = request.original_url
+      end
+
       def set_default_open_graph_image
         return if open_graph.image.url
 
         generated_url = open_graph_image_generator.url
         open_graph.image.url = generated_url if generated_url
       end
-
-      include Helper
     end
   end
 end

data/lib/opengraphplus/rails/helper.rb

@@ -3,21 +3,19 @@
 module OpenGraphPlus
   module Rails
     module Helper
-      def open_graph(**kwargs)
-        @open_graph_root ||= Tags::Root.new
-        @open_graph_root.update(**kwargs) if kwargs.any?
-        yield(@open_graph_root) if block_given?
+      def open_graph(**)
+        @open_graph_root ||= Namespace::Root.new
+        @open_graph_root.update(**)
+        yield @open_graph_root if block_given?
         @open_graph_root
       end
 
       def open_graph_tags
-        root = @open_graph_root || Tags::Root.new
-        Tags::Renderer.new(root).tags
+        open_graph.to_a
       end
 
       def open_graph_meta_tags
-        result = open_graph_tags.map(&:to_s).join("\n")
-        result.respond_to?(:html_safe) ? result.html_safe : result
+        open_graph.render_in(self)
       end
     end
   end

data/lib/opengraphplus/signature/generator.rb

@@ -6,10 +6,21 @@ require "base64"
 module OpenGraphPlus
   module Signature
     class Generator
+      class InvalidAPIKeyError < StandardError; end
+
       attr_reader :api_key
 
       def initialize(api_key)
-        @api_key = api_key
+        @api_key = case api_key
+        when APIKey
+          api_key
+        when String
+          APIKey.parse(api_key)
+        end
+
+        raise InvalidAPIKeyError, "API key is missing or invalid" unless @api_key
+        raise InvalidAPIKeyError, "API key is missing public_key" unless @api_key.public_key
+        raise InvalidAPIKeyError, "API key is missing secret_key" unless @api_key.secret_key
       end
 
       def generate(path_and_query)

data/lib/opengraphplus/signature/url.rb

@@ -6,57 +6,40 @@ module OpenGraphPlus
   module Signature
     class URL
       DEFAULT_BASE_URL = "https://opengraphplus.com"
-      DEFAULT_PATH_PREFIX = "/v2/:signature"
 
-      attr_reader :base_uri, :path_prefix
+      attr_reader :base_uri
 
-      def initialize(api_key: nil, generator: nil, base_url: nil, path_prefix: DEFAULT_PATH_PREFIX)
-        @api_key = api_key
-        @generator = generator
+      def initialize(base_url: nil)
         @base_uri = URI.parse(base_url || ENV.fetch("OPENGRAPHPLUS_URL", DEFAULT_BASE_URL))
-        @path_prefix = path_prefix
       end
 
-      def build(path, **params)
-        return nil unless generator
-
-        path_and_query = build_path_and_query(path, params)
-        signature = generator.generate(path_and_query)
-
-        base_uri.dup.tap do |uri|
-          uri.path = signed_path(signature, path)
-          uri.query = URI.encode_www_form(params) unless params.empty?
-        end.to_s
-      end
-
-      def generator
-        @generator ||= begin
-          api_key = @api_key || OpenGraphPlus.configuration.api_key
-          if api_key
-            Generator.new(api_key)
-          else
-            warn_missing_api_key
-            nil
-          end
-        end
+      def signed_path(prefix, api_key)
+        SignedPath.new(prefix:, api_key:, base_uri:)
       end
+    end
 
-      private
+    class SignedPath
+      attr_reader :prefix, :api_key, :base_uri
 
-      def build_path_and_query(path, params)
-        normalized_path = File.join("/", path)
-        params.empty? ? normalized_path : "#{normalized_path}?#{URI.encode_www_form(params)}"
+      def initialize(prefix:, api_key:, base_uri:)
+        @prefix = prefix
+        @api_key = api_key
+        @base_uri = base_uri
       end
 
-      def signed_path(signature, path)
-        File.join(path_prefix.gsub(":signature", signature), path)
+      def generator
+        @generator ||= Generator.new(api_key)
       end
 
-      def warn_missing_api_key
-        return if @warned
+      def build(*segments, **params)
+        signed_path = File.join("/", *segments.map(&:to_s))
+        path_and_query = params.empty? ? signed_path : "#{signed_path}?#{URI.encode_www_form(params)}"
+        signature = generator.generate(path_and_query)
 
-        warn "[OpenGraphPlus] API key not configured. Set OpenGraphPlus.configuration.api_key to enable automatic Open Graph image generation."
-        @warned = true
+        base_uri.dup.tap do |uri|
+          uri.path = File.join(prefix, signature, *segments.map(&:to_s))
+          uri.query = URI.encode_www_form(params) unless params.empty?
+        end.to_s
       end
     end
   end

data/lib/opengraphplus/tag.rb

@@ -15,15 +15,8 @@ module OpenGraphPlus
       %(<meta property="#{escape property}" content="#{escape content}">)
     end
 
-    def render_in(view_context = nil)
-      result = meta
-      if view_context.respond_to?(:raw)
-        view_context.raw(result)
-      elsif result.respond_to?(:html_safe)
-        result.html_safe
-      else
-        result
-      end
+    def render_in(_view_context = nil)
+      meta.html_safe
     end
 
     def to_s

data/lib/opengraphplus/tags.rb

@@ -5,6 +5,25 @@ require "forwardable"
 module OpenGraphPlus
   module Tags
     class Base
+      include Enumerable
+
+      def each(&block)
+        tags.each do |t|
+          case t
+          when Base
+            t.each(&block)
+          when Tag
+            yield t if t.content
+          end
+        end
+      end
+
+      def tags = []
+
+      def render_in(view_context)
+        map { |tag| tag.render_in(view_context) }.join("\n")
+      end
+
       def update(**kwargs)
         kwargs.each { |key, value| public_send(:"#{key}=", value) }
         self
@@ -13,29 +32,16 @@ module OpenGraphPlus
 
     class Image < Base
       attr_accessor :url, :width, :height, :type, :alt, :secure_url
-    end
 
-    class Twitter < Base
-      attr_accessor :card, :site, :creator, :title, :description, :image, :image_alt
-
-      def initialize
-        @card = "summary_large_image"
-      end
-    end
-
-    class OpenGraph < Base
-      attr_accessor :title, :description, :url, :type, :site_name, :locale, :determiner, :audio, :video
-      attr_reader :image, :plus
-
-      def initialize
-        @type = "website"
-        @image = Image.new
-        @plus = Plus.new
-      end
-
-      def image_url=(url)
-        @image.url = url
-        @image.secure_url = url
+      def tags
+        [
+          Tag.new("og:image", url),
+          Tag.new("og:image:secure_url", secure_url),
+          Tag.new("og:image:type", type),
+          Tag.new("og:image:width", width),
+          Tag.new("og:image:height", height),
+          Tag.new("og:image:alt", alt),
+        ]
       end
     end
 
@@ -52,6 +58,13 @@ module OpenGraphPlus
         end
       end
 
+      def tags
+        [
+          Tag.new("og:plus:selector", selector),
+          Tag.new("og:plus:style", style),
+        ]
+      end
+
       private
 
       def hash_to_css(hash)
@@ -59,12 +72,65 @@ module OpenGraphPlus
       end
     end
 
+    class OpenGraph < Base
+      attr_accessor :title, :description, :url, :type, :site_name, :locale, :determiner, :audio, :video
+
+      def image = @image ||= Image.new
+      def plus = @plus ||= Plus.new
+
+      def initialize
+        @type = "website"
+      end
+
+      def image_url=(url)
+        image.url = url
+        image.secure_url = url
+      end
+
+      def tags
+        [
+          Tag.new("og:title", title),
+          Tag.new("og:description", description),
+          Tag.new("og:url", url),
+          Tag.new("og:type", type),
+          Tag.new("og:site_name", site_name),
+          Tag.new("og:locale", locale),
+          Tag.new("og:determiner", determiner),
+          Tag.new("og:audio", audio),
+          Tag.new("og:video", video),
+          image,
+          plus,
+        ]
+      end
+    end
+
+    class Twitter < Base
+      attr_accessor :card, :site, :creator, :title, :description, :image, :image_alt
+
+      def initialize
+        @card = "summary_large_image"
+      end
+
+      def tags
+        [
+          Tag.new("twitter:card", card),
+          Tag.new("twitter:site", site),
+          Tag.new("twitter:creator", creator),
+          Tag.new("twitter:title", title),
+          Tag.new("twitter:description", description),
+          Tag.new("twitter:image", image),
+          Tag.new("twitter:image:alt", image_alt),
+        ]
+      end
+    end
+
     class Root < Base
       extend Forwardable
 
-      attr_reader :og, :twitter
+      def og = @og ||= OpenGraph.new
+      def twitter = @twitter ||= Twitter.new
 
-      def_delegators :@og,
+      def_delegators :og,
         :title, :title=,
         :description, :description=,
         :url, :url=,
@@ -77,9 +143,8 @@ module OpenGraphPlus
         :image, :image_url=,
         :plus
 
-      def initialize
-        @og = OpenGraph.new
-        @twitter = Twitter.new
+      def tags
+        [og, twitter]
       end
     end
   end

data/lib/opengraphplus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenGraphPlus
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/lib/opengraphplus.rb

@@ -5,8 +5,7 @@ require_relative "opengraphplus/api_key"
 require_relative "opengraphplus/configuration"
 require_relative "opengraphplus/signature"
 require_relative "opengraphplus/tag"
-require_relative "opengraphplus/tags"
-require_relative "opengraphplus/tags/renderer"
+require_relative "opengraphplus/namespace"
 require_relative "opengraphplus/image_generator"
 
 module OpenGraphPlus

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opengraphplus
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Brad Gessler
 bindir: exe
 cert_chain: []
-date: 2025-12-18 00:00:00.000000000 Z
+date: 2026-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,6 +42,7 @@ files:
 - lib/opengraphplus/api_key.rb
 - lib/opengraphplus/configuration.rb
 - lib/opengraphplus/image_generator.rb
+- lib/opengraphplus/namespace.rb
 - lib/opengraphplus/rails.rb
 - lib/opengraphplus/rails/controller.rb
 - lib/opengraphplus/rails/helper.rb
@@ -55,7 +56,6 @@ files:
 - lib/opengraphplus/signature/verifier.rb
 - lib/opengraphplus/tag.rb
 - lib/opengraphplus/tags.rb
-- lib/opengraphplus/tags/renderer.rb
 - lib/opengraphplus/version.rb
 - sig/open_graph_plus.rbs
 homepage: https://opengraphplus.com/ruby

data/lib/opengraphplus/tags/renderer.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-module OpenGraphPlus
-  module Tags
-    class Renderer
-      attr_reader :root
-
-      def initialize(root)
-        @root = root
-      end
-
-      def tags
-        [*og_tags, *twitter_tags].compact
-      end
-
-      private
-
-      def og
-        root.og
-      end
-
-      def twitter
-        root.twitter
-      end
-
-      def tag(property, content)
-        return nil if content.nil?
-
-        Tag.new(property, content)
-      end
-
-      def og_tags
-        [
-          tag("og:title", og.title),
-          tag("og:description", og.description),
-          tag("og:url", og.url),
-          tag("og:type", og.type),
-          tag("og:site_name", og.site_name),
-          tag("og:locale", og.locale),
-          tag("og:determiner", og.determiner),
-          tag("og:audio", og.audio),
-          tag("og:video", og.video),
-          *og_image_tags
-        ]
-      end
-
-      def og_image_tags
-        return [] unless og.image
-
-        image = og.image
-        [
-          tag("og:image", image.url),
-          tag("og:image:secure_url", image.secure_url),
-          tag("og:image:type", image.type),
-          tag("og:image:width", image.width),
-          tag("og:image:height", image.height),
-          tag("og:image:alt", image.alt)
-        ]
-      end
-
-      def twitter_tags
-        [
-          tag("twitter:card", twitter.card),
-          tag("twitter:site", twitter.site),
-          tag("twitter:creator", twitter.creator),
-          tag("twitter:title", twitter.title || og.title),
-          tag("twitter:description", twitter.description || og.description),
-          tag("twitter:image", twitter_image_url),
-          tag("twitter:image:alt", twitter.image_alt || og.image&.alt)
-        ]
-      end
-
-      def twitter_image_url
-        twitter.image || og.image&.url
-      end
-    end
-  end
-end