opengraphplus 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48292c717ae45fcea5cd4273eba0baf9b1d9ebeb646ddc2d9c2cf666894c1f74
-  data.tar.gz: 293b987be6c9eee0193d12e601df3e542713e53f631720ddab150b1374a4055b
+  metadata.gz: e8fd514b98d00901b6c41cf42ad246f71690c7fb632c2653f1e66571da1c0968
+  data.tar.gz: cb7eef25110066ade4cf4b5f05fe5f10448c7e3cf8a9f6d5bb91b785f7687d37
 SHA512:
-  metadata.gz: 8e4a720f1974d2177dc7221cbe073dd3d68d57393c6b85d387d602d40bb2cf479c4118f4383ef40973d29c1eeb3fc60323500d29846d296acf64e15c35ff5c58
-  data.tar.gz: 8655b837fa39a53ba16b9fd2ca1112f99c04fa4b5472b54f8bc35f74915e23b4dd5b4e4fba0b26dba08b2a8d9fbed7f573ad63927d3e5a12c1c3ff475f19dcd2
+  metadata.gz: 2f0bb3269f68f0b57ab02e9f583042bae211f5c2f0ca7dec28a7cd35fed2e9e32ac934241380ce856f88a9919dfb2b4bdc8bbc46d2a87d70a2c6694207913a6e
+  data.tar.gz: 0b77487f2356101b48750cb729f9b88327678aafabe02fa5da16dc9ea55f2c0d5e5a3a3351ddb1294af14d791e7495fa2012ea82b4cac4afadc90f6d8e4b8770

data/README.md

@@ -18,7 +18,55 @@ gem install opengraphplus
 
 ## Usage
 
-When this gem is complete, an API key will be required to connect to the gem, the it's installed, added to a layout, and it should just work.
+### Get your API key
+
+Sign up at [og.plus](https://og.plus) to get your API key.
+
+### Configuration
+
+#### Using environment variables
+
+```bash
+rails g opengraphplus:env ogp_live_████████████████████
+```
+
+This will:
+- Append `OPENGRAPHPLUS__API_KEY=ogp_live_████████████████████` to your `.env` file (or the first env file found)
+- Create `config/initializers/opengraphplus.rb`
+
+To specify a different env file:
+
+```bash
+rails g opengraphplus:env ogp_live_████████████████████ -e .envrc
+```
+
+#### Using Rails credentials
+
+```bash
+rails g opengraphplus:credentials ogp_live_████████████████████
+```
+
+This will:
+- Add `opengraphplus.api_key` to your encrypted `credentials.yml.enc`
+- Create `config/initializers/opengraphplus.rb`
+
+#### Manual configuration
+
+Run the basic install generator for a commented template:
+
+```bash
+rails g opengraphplus:install
+```
+
+Then configure manually in `config/initializers/opengraphplus.rb`:
+
+```ruby
+OpenGraphPlus.configure do |config|
+  config.api_key = ENV["OPENGRAPHPLUS__API_KEY"]
+  # or
+  config.api_key = Rails.application.credentials.opengraphplus.api_key
+end
+```
 
 ## Development
 

data/lib/generators/opengraphplus/base_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Opengraphplus
+  module Generators
+    class BaseGenerator < Rails::Generators::Base
+      API_KEY_PREFIX = "ogp_"
+
+      argument :api_key, type: :string, required: true,
+        desc: "Your OpenGraphPlus API key"
+
+      def validate_api_key
+        unless api_key.start_with?(API_KEY_PREFIX)
+          say_status :error, "Invalid API key: must start with '#{API_KEY_PREFIX}'", :red
+          raise SystemExit
+        end
+      end
+    end
+  end
+end

data/lib/generators/opengraphplus/credentials/credentials_generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "active_support/core_ext/hash/keys"
+require_relative "../base_generator"
+
+module Opengraphplus
+  module Generators
+    class CredentialsGenerator < BaseGenerator
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Configures OpenGraphPlus using Rails encrypted credentials"
+
+      def add_to_credentials
+        credentials = Rails.application.credentials
+
+        unless credentials.key?
+          say_status :error, "No credentials key found. Run `rails credentials:edit` first.", :red
+          return
+        end
+
+        # Read existing content, merge, write back
+        yaml_content = credentials.read.presence || ""
+        config = parse_yaml(yaml_content)
+
+        config["opengraphplus"] ||= {}
+        config["opengraphplus"]["api_key"] = api_key
+
+        credentials.write(yaml_dump(config))
+        say_status :insert, "credentials.yml.enc (opengraphplus.api_key)", :green
+      end
+
+      def create_initializer
+        template "initializer.rb.tt", "config/initializers/opengraphplus.rb"
+      end
+
+      private
+
+      def parse_yaml(content)
+        return {} if content.blank?
+        YAML.safe_load(content, permitted_classes: [Symbol], aliases: true) || {}
+      end
+
+      def yaml_dump(config)
+        # Preserve nice formatting
+        YAML.dump(config.deep_stringify_keys)
+      end
+    end
+  end
+end

data/lib/generators/opengraphplus/credentials/templates/initializer.rb.tt

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+OpenGraphPlus.configure do |config|
+  config.api_key = Rails.application.credentials.opengraphplus.api_key
+end

data/lib/generators/opengraphplus/env/env_generator.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative "../base_generator"
+
+module Opengraphplus
+  module Generators
+    class EnvGenerator < BaseGenerator
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Configures OpenGraphPlus using environment variables"
+
+      class_option :envfile, type: :string, aliases: "-e",
+        desc: "Specific env file to write to (e.g., .env, .envrc)"
+
+      ENV_FILES = %w[.env .env.local .env.development .env.development.local .envrc].freeze
+      ENV_VAR_NAME = "OPENGRAPHPLUS__API_KEY"
+
+      def append_to_env_file
+        if options[:envfile]
+          write_to_env_file(options[:envfile], create: true)
+        else
+          env_file = detect_env_file
+          if env_file
+            write_to_env_file(env_file)
+          else
+            say_status :skip, "No env file found (create one or use -e)", :yellow
+          end
+        end
+      end
+
+      def create_initializer
+        template "initializer.rb.tt", "config/initializers/opengraphplus.rb"
+      end
+
+      private
+
+      def detect_env_file
+        ENV_FILES.find { |f| File.exist?(f) }
+      end
+
+      def write_to_env_file(env_file, create: false)
+        env_line = "#{ENV_VAR_NAME}=#{api_key}"
+
+        unless File.exist?(env_file)
+          if create
+            create_file env_file, "#{env_line}\n"
+          end
+          return
+        end
+
+        if File.read(env_file).include?(ENV_VAR_NAME)
+          say_status :skip, "#{env_file} (#{ENV_VAR_NAME} already defined)", :yellow
+        else
+          content = File.read(env_file)
+          prefix = content.end_with?("\n") || content.empty? ? "" : "\n"
+          append_to_file env_file, "#{prefix}#{env_line}\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/opengraphplus/env/templates/initializer.rb.tt

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+OpenGraphPlus.configure do |config|
+  config.api_key = ENV["OPENGRAPHPLUS__API_KEY"]
+end

data/lib/generators/opengraphplus/install/templates/README

@@ -1,46 +1,6 @@
 
 OpenGraphPlus has been installed!
 
-Next steps:
-
-1. Add your API key to config/initializers/opengraphplus.rb
-   Get your API key at: https://opengraphplus.com/dashboard
-
-2. Add the helper to your layout file (e.g., app/views/layouts/application.html.erb):
-
-   <head>
-     <%%= open_graph_meta_tags %>
-   </head>
-
-3. Customize the default Open Graph tags in ApplicationController:
-
-   class ApplicationController < ActionController::Base
-     open_graph do |og|
-       og.type = "website"
-       og.url = request.original_url
-       og.site_name = "Your Site Name"
-     end
-   end
-
-4. Override tags in specific controllers (inherits from parent):
-
-   class ArticlesController < ApplicationController
-     before_action { @article = Article.find(params[:id]) }
-
-     open_graph do |og|
-       og.title = @article.title
-       og.description = @article.excerpt
-       og.type = "article"
-     end
-   end
-
-5. Set tags in views:
-
-   <%% open_graph do |og|
-     og.title = "My Page Title"
-     og.description = "My Page Description"
-   end %>
-
-6. Verify it works by checking your page source for og:image meta tags,
-   or use the preview tool at: https://opengraphplus.com/previews/new
+For setup instructions, visit https://opengraphplus.com/guides/rails
 
+For a website API key, visit https://opengraphplus.com/dashboard

data/lib/generators/opengraphplus/install/templates/initializer.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+# Get your API key at https://opengraphplus.com/dashboard
 OpenGraphPlus.configure do |config|
-  # Get your API key at https://opengraphplus.com/dashboard
+  # Use Rails credentials.
   config.api_key = Rails.application.credentials.opengraphplus_api_key
+
   # Or use ENV:
   # config.api_key = ENV["OPENGRAPHPLUS_API_KEY"]
 end

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

@@ -7,21 +7,14 @@ module OpenGraphPlus
     class Base
       include Enumerable
 
-      def each(&)
-        tags.each do |t|
-          case t
-          when Base
-            t.each(&)
-          when Tag
-            yield t if t.content
-          end
-        end
-      end
+      def each(&block) = tags.each(&block)
 
-      def tags = []
+      def tag(property, value)
+        Tag.new(property, value) if value
+      end
 
-      def render_in(rails_view_context)
-        rails_view_context.safe_join(map { |tag| tag.render_in(rails_view_context) }, "\n")
+      def render_in(_view_context = nil)
+        map { |tag| tag.render_in }.join("\n").html_safe
       end
 
       def update(**kwargs)
@@ -31,23 +24,32 @@ module OpenGraphPlus
     end
 
     class Image < Base
-      attr_accessor :url, :width, :height, :type, :alt, :secure_url
+      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.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),
-        ]
+          tag("og:plus:viewport:width", width)
+        ].compact
       end
     end
 
     class Plus < Base
-      attr_accessor :selector
-      attr_reader :style
+      attr_accessor :selector, :style
 
       def style=(value)
         @style = case value
@@ -58,11 +60,16 @@ module OpenGraphPlus
         end
       end
 
+      def viewport
+        @viewport ||= Viewport.new
+      end
+
       def tags
         [
-          Tag.new("og:plus:selector", selector),
-          Tag.new("og:plus:style", style),
-        ]
+          tag("og:plus:selector", selector),
+          tag("og:plus:style", style),
+          *viewport.tags
+        ].compact
       end
 
       private
@@ -75,13 +82,18 @@ module OpenGraphPlus
     class OG < 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
+        @image ||= Image.new
+      end
+
+      def plus
+        @plus ||= Plus.new
+      end
+
       def image_url=(url)
         image.url = url
         image.secure_url = url
@@ -89,46 +101,73 @@ module OpenGraphPlus
 
       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,
-        ]
+          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
-      attr_accessor :card, :site, :creator, :title, :description, :image, :image_alt
+      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.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),
-        ]
+          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
-      def twitter = @twitter ||= Twitter.new
+      def og
+        @og ||= OG.new
+      end
+
+      def twitter
+        @twitter ||= Twitter.new
+      end
+
+      def tags
+        [*og.tags, *twitter.tags]
+      end
 
       def_delegators :og,
         :title, :title=,
@@ -142,10 +181,6 @@ module OpenGraphPlus
         :video, :video=,
         :image, :image_url=,
         :plus
-
-      def tags
-        [og, twitter]
-      end
     end
   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/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,8 +15,8 @@ module OpenGraphPlus
       %(<meta property="#{escape property}" content="#{escape content}">)
     end
 
-    def render_in(rails_view_context)
-      rails_view_context.raw(meta)
+    def render_in(_view_context = nil)
+      meta.html_safe
     end
 
     def to_s

data/lib/opengraphplus/tags.rb

@@ -7,11 +7,11 @@ module OpenGraphPlus
     class Base
       include Enumerable
 
-      def each(&)
+      def each(&block)
         tags.each do |t|
           case t
           when Base
-            t.each(&)
+            t.each(&block)
           when Tag
             yield t if t.content
           end

data/lib/opengraphplus/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opengraphplus
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Brad Gessler
 bindir: exe
 cert_chain: []
-date: 2025-12-18 00:00:00.000000000 Z
+date: 2026-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -34,6 +34,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/opengraphplus/base_generator.rb
+- lib/generators/opengraphplus/credentials/credentials_generator.rb
+- lib/generators/opengraphplus/credentials/templates/initializer.rb.tt
+- lib/generators/opengraphplus/env/env_generator.rb
+- lib/generators/opengraphplus/env/templates/initializer.rb.tt
 - lib/generators/opengraphplus/install/install_generator.rb
 - lib/generators/opengraphplus/install/templates/README
 - lib/generators/opengraphplus/install/templates/initializer.rb