opengraphplus 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ed71a686aba73ab87adf5879a2ad3cbf6e590eec37ce7a84f0f5db2859c924e
-  data.tar.gz: 2484bbb094455d512d68ada748c07d9baeeabee0d5072104753443ceb86b27c1
+  metadata.gz: 0d5e0af7ba91d92d1f9c20380bd19c0d684eb68e65fb7f90bfdb803b051c3d4a
+  data.tar.gz: 4bc63ce1ff20de87a5101edea02ffa931875a8231bed0047cc90ee69cede2a6f
 SHA512:
-  metadata.gz: 1a8a858d5b2e4c4f5ed06b066ffe0f369dadee0ac5e5f3c1590e1f5495d876e39024d463b3dcc1f392501088ead4f11825988b3437f84544e3311f2ed047e5ec
-  data.tar.gz: ccf697e5805ca290db0cc3e7ddd0a700b18db2671591db50a5f894d08acd0681f67c629a7fd2d94a8ec39311c97fba6002f6bbe5221c785991ce6150af7ee87a
+  metadata.gz: 5f4d532d192695beb6fd9565e3cf8a12e5e478cb72fdebc7467a26122810eeedf5d75fd9bee5e78cbd74f8879de040ccae1d2c4352ca099308a311f6cbe99ee9
+  data.tar.gz: b238b9d0ac0aff9bf41164d8d9b9a8b882557c6e57f57bd1d2230b36d03a8ea6a20ab8c0d9302a828c6083141f9d6fa9b8b2d39a66b01306f2d42ab74af4c9cb

data/README.md

@@ -27,27 +27,27 @@ Sign up at [og.plus](https://og.plus) to get your API key.
 #### Using environment variables
 
 ```bash
-rails g opengraphplus:env ogp_live_████████████████████
+rails g opengraphplus:env ogplus_live_████████████████████
 ```
 
 This will:
-- Append `OPENGRAPHPLUS__API_KEY=ogp_live_████████████████████` to your `.env` file (or the first env file found)
+- Append `OGPLUS__API_KEY=ogplus_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
+rails g opengraphplus:env ogplus_live_████████████████████ -e .envrc
 ```
 
 #### Using Rails credentials
 
 ```bash
-rails g opengraphplus:credentials ogp_live_████████████████████
+rails g opengraphplus:credentials ogplus_live_████████████████████
 ```
 
 This will:
-- Add `opengraphplus.api_key` to your encrypted `credentials.yml.enc`
+- Add `ogplus.api_key` to your encrypted `credentials.yml.enc`
 - Create `config/initializers/opengraphplus.rb`
 
 #### Manual configuration
@@ -62,12 +62,27 @@ Then configure manually in `config/initializers/opengraphplus.rb`:
 
 ```ruby
 OpenGraphPlus.configure do |config|
-  config.api_key = ENV["OPENGRAPHPLUS__API_KEY"]
+  config.api_key = ENV["OGPLUS__API_KEY"]
   # or
-  config.api_key = Rails.application.credentials.opengraphplus.api_key
+  config.api_key = Rails.application.credentials.ogplus.api_key
 end
 ```
 
+## Capturing a Different URL
+
+By default, OpenGraphPlus screenshots the current request URL for the `og:image`. To screenshot a different URL (e.g., a public preview page when the main page requires authentication):
+
+```ruby
+class ArticlesController < ApplicationController
+  open_graph do |og|
+    og.title = "My Article"
+    og.image.url = open_graph_plus_image_url(url_for(format: :opengraph))
+  end
+end
+```
+
+The `open_graph_plus_image_url` helper is available in both controllers and views. It generates a signed URL that tells OpenGraphPlus to screenshot the provided URL instead of the current request.
+
 ## Verifying OpenGraph Tags
 
 You can verify that your pages have the required OpenGraph tags using the included command:

data/lib/generators/opengraphplus/base_generator.rb

@@ -5,14 +5,14 @@ require "rails/generators"
 module Opengraphplus
   module Generators
     class BaseGenerator < Rails::Generators::Base
-      API_KEY_PREFIX = "ogp_"
+      API_KEY_PREFIXES = %w[ogp_ ogplus_].freeze
 
       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
+        unless API_KEY_PREFIXES.any? { |prefix| api_key.start_with?(prefix) }
+          say_status :error, "Invalid API key: must start with '#{API_KEY_PREFIXES.join("' or '")}'", :red
           raise SystemExit
         end
       end

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

@@ -23,11 +23,11 @@ module Opengraphplus
         yaml_content = credentials.read.presence || ""
         config = parse_yaml(yaml_content)
 
-        config["opengraphplus"] ||= {}
-        config["opengraphplus"]["api_key"] = api_key
+        config["ogplus"] ||= {}
+        config["ogplus"]["api_key"] = api_key
 
         credentials.write(yaml_dump(config))
-        say_status :insert, "credentials.yml.enc (opengraphplus.api_key)", :green
+        say_status :insert, "credentials.yml.enc (ogplus.api_key)", :green
       end
 
       def create_initializer

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

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

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

@@ -13,7 +13,7 @@ module Opengraphplus
         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"
+      ENV_VAR_NAME = "OGPLUS__API_KEY"
 
       def append_to_env_file
         if options[:envfile]

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

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

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

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

data/lib/opengraphplus/image_generator.rb

@@ -2,24 +2,16 @@
 
 module OpenGraphPlus
   class ImageGenerator
-    attr_reader :request
-
-    def initialize(request)
-      @request = request
+    def initialize(api_key)
+      @api_key = api_key
     end
 
-    def url
-      return nil unless api_key
+    def url(source_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
+        .signed_path("/api/websites/v1", @api_key)
+        .build("image", url: source_url)
     end
   end
 end

data/lib/opengraphplus/rails/controller.rb

@@ -7,7 +7,7 @@ module OpenGraphPlus
       include OpenGraphPlus::Rails::Helper
 
       included do
-        helper_method :open_graph, :open_graph_tags, :open_graph_meta_tags
+        helper_method :open_graph, :open_graph_tags, :open_graph_meta_tags, :open_graph_plus_image_url
         before_action :set_default_open_graph
         append_before_action :set_default_open_graph_image
       end
@@ -18,8 +18,8 @@ module OpenGraphPlus
         end
       end
 
-      def open_graph_image_generator
-        ImageGenerator.new(request)
+      def open_graph_plus_image_url(source_url = request.original_url)
+        OpenGraphPlus.image_url(source_url)
       end
 
       private
@@ -30,10 +30,7 @@ module OpenGraphPlus
       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
+        open_graph.image.url ||= open_graph_plus_image_url
       end
     end
   end

data/lib/opengraphplus/signature/url.rb

@@ -10,7 +10,7 @@ module OpenGraphPlus
       attr_reader :base_uri
 
       def initialize(base_url: nil)
-        @base_uri = URI.parse(base_url || ENV.fetch("OPENGRAPHPLUS_URL", DEFAULT_BASE_URL))
+        @base_uri = URI.parse(base_url || ENV.fetch("OGPLUS_URL", DEFAULT_BASE_URL))
       end
 
       def signed_path(prefix, api_key)

data/lib/opengraphplus/version.rb

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

data/lib/opengraphplus.rb

@@ -4,6 +4,10 @@ require_relative "opengraphplus/version"
 
 module OpenGraphPlus
   class Error < StandardError; end
+
+  def self.image_url(source_url)
+    ImageGenerator.new(configuration.api_key).url(source_url)
+  end
 end
 
 require_relative "opengraphplus/api_key"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opengraphplus
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Brad Gessler
 bindir: exe
 cert_chain: []
-date: 2026-01-09 00:00:00.000000000 Z
+date: 2026-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport