opengraphplus 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d947ee47bc0e434395f69cceb99321f78ab4f8ac437f5b537b97ffa9a199d51
-  data.tar.gz: 308d3466e160b11f935afd3b9f0c891ba3b268f95f3de12400af9e815020a82f
+  metadata.gz: e8fd514b98d00901b6c41cf42ad246f71690c7fb632c2653f1e66571da1c0968
+  data.tar.gz: cb7eef25110066ade4cf4b5f05fe5f10448c7e3cf8a9f6d5bb91b785f7687d37
 SHA512:
-  metadata.gz: ac3f345867d3cc9e5ad6fa1745f5f6ea45cf505fdd057191c0af0d48ca62d8af6e64aa7dfa26b2097f8d97af95fab8dec9888a37b00a573bc94c5ad68660c6c3
-  data.tar.gz: 9a20a378f2e36d594667c2abdba8e194bdcae2bc55a2daf33bf1195162b9c9498ca257e426e645ae85a3087cc0f80b83ff9f7065f730cc240564daf7617e58e7
+  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/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opengraphplus
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Brad Gessler
 bindir: exe
 cert_chain: []
-date: 2026-01-07 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