opengraphplus 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8fd514b98d00901b6c41cf42ad246f71690c7fb632c2653f1e66571da1c0968
-  data.tar.gz: cb7eef25110066ade4cf4b5f05fe5f10448c7e3cf8a9f6d5bb91b785f7687d37
+  metadata.gz: 76feb6f71feac815baf6dc136ba5653801e84048adb3ca77d9dffe59d76004be
+  data.tar.gz: a7177af1e7c9f4ec5844ddc66602c75420b07c15a9f3b266e772bfdd093984f6
 SHA512:
-  metadata.gz: 2f0bb3269f68f0b57ab02e9f583042bae211f5c2f0ca7dec28a7cd35fed2e9e32ac934241380ce856f88a9919dfb2b4bdc8bbc46d2a87d70a2c6694207913a6e
-  data.tar.gz: 0b77487f2356101b48750cb729f9b88327678aafabe02fa5da16dc9ea55f2c0d5e5a3a3351ddb1294af14d791e7495fa2012ea82b4cac4afadc90f6d8e4b8770
+  metadata.gz: 7b8be6792864e32d690507fc03afb246e4a0ffa5ddf0caf75289352a9b54070d2de89845ea0236edad762c562174fa68c4b46ebc567d71fa8a223726a9a7af06
+  data.tar.gz: 678c88ffc101a8720d29c8dbbc6156f16adf8fb2a28c263b8f025fd431dc61da4167bc5719aa533a87a66412fcff37d26944f9e80c94623f1e48bb4249431efd

data/README.md

@@ -68,6 +68,112 @@ OpenGraphPlus.configure do |config|
 end
 ```
 
+## Verifying OpenGraph Tags
+
+You can verify that your pages have the required OpenGraph tags using the included command:
+
+```bash
+rails opengraph:verify http://localhost:3000
+```
+
+This will fetch the URL and check for required tags (`og:title`, `og:type`, `og:image`, `og:url`), displaying any missing required or recommended tags:
+
+```
+Verifying OpenGraph tags at http://localhost:3000...
+
+Found tags:
+  og:title       → "My Awesome Site"
+  og:type        → "website"
+  og:image       → "https://example.com/image.png"
+  og:url         → "http://localhost:3000"
+
+✓ All required OpenGraph tags present
+```
+
+The command exits with code 0 on success, or 1 if required tags are missing.
+
+## Testing
+
+OpenGraphPlus provides test helpers for both RSpec and Minitest to verify OpenGraph tags in your test suite.
+
+### RSpec
+
+Add to your `spec/spec_helper.rb` or `spec/rails_helper.rb`:
+
+```ruby
+require 'opengraphplus/rspec'
+```
+
+Then use the matchers in your specs:
+
+```ruby
+RSpec.describe "Home page", type: :request do
+  it "has all required OpenGraph tags" do
+    get "/"
+    expect(response.body).to have_open_graph_tags
+  end
+
+  it "has the correct title" do
+    get "/"
+    expect(response.body).to have_og_tag("og:title").with_content("My Site")
+  end
+
+  it "has an og:image tag" do
+    get "/"
+    expect(response.body).to have_og_tag("og:image")
+  end
+end
+```
+
+Available matchers:
+- `have_open_graph_tags` - Passes if all required OG tags are present
+- `have_og_tag("og:title")` - Passes if the specified tag exists
+- `have_og_tag("og:title").with_content("My Title")` - Passes if the tag has the expected content
+
+### Minitest
+
+Add to your test helper:
+
+```ruby
+require 'opengraphplus/minitest'
+
+class ActiveSupport::TestCase
+  include OpenGraphPlus::Minitest
+end
+```
+
+Then use the assertions in your tests:
+
+```ruby
+class HomePageTest < ActionDispatch::IntegrationTest
+  test "has all required OpenGraph tags" do
+    get "/"
+    assert_open_graph_tags(response.body)
+  end
+
+  test "has the correct title" do
+    get "/"
+    assert_og_tag(response.body, "og:title", "My Site")
+  end
+
+  test "has an og:image tag" do
+    get "/"
+    assert_og_tag(response.body, "og:image")
+  end
+
+  test "does not have private tags" do
+    get "/"
+    refute_og_tag(response.body, "og:private")
+  end
+end
+```
+
+Available assertions:
+- `assert_open_graph_tags(html)` - Passes if all required OG tags are present
+- `assert_og_tag(html, "og:title")` - Passes if the specified tag exists
+- `assert_og_tag(html, "og:title", "My Title")` - Passes if the tag has the expected content
+- `refute_og_tag(html, "og:private")` - Passes if the specified tag does not exist
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/opengraphplus/minitest.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "opengraphplus"
+
+module OpenGraphPlus
+  module Minitest
+    # Assert that all required OpenGraph tags are present
+    #
+    # @param html [String] The HTML to check
+    # @param message [String, nil] Custom failure message
+    #
+    # @example
+    #   assert_open_graph_tags(response.body)
+    #
+    def assert_open_graph_tags(html, message = nil)
+      parser = OpenGraphPlus::Parser.new(html)
+      message ||= "Expected HTML to have all required OpenGraph tags, but missing: #{parser.errors.join(', ')}"
+      assert parser.valid?, message
+    end
+
+    # Assert that a specific OpenGraph/Twitter tag is present
+    #
+    # @param html [String] The HTML to check
+    # @param property [String] The tag property (e.g., "og:title")
+    # @param content [String, nil] Expected content (optional)
+    # @param message [String, nil] Custom failure message
+    #
+    # @example
+    #   assert_og_tag(response.body, "og:title")
+    #   assert_og_tag(response.body, "og:title", "My Title")
+    #
+    def assert_og_tag(html, property, content = nil, message = nil)
+      parser = OpenGraphPlus::Parser.new(html)
+      actual_content = parser[property]
+
+      if content.nil?
+        message ||= "Expected HTML to have #{property} tag, but it was not found"
+        assert !actual_content.nil?, message
+      else
+        message ||= "Expected #{property} to have content #{content.inspect}, but got #{actual_content.inspect}"
+        assert_equal content, actual_content, message
+      end
+    end
+
+    # Assert that a specific OpenGraph/Twitter tag is NOT present
+    #
+    # @param html [String] The HTML to check
+    # @param property [String] The tag property (e.g., "og:title")
+    # @param message [String, nil] Custom failure message
+    #
+    # @example
+    #   refute_og_tag(response.body, "og:private")
+    #
+    def refute_og_tag(html, property, message = nil)
+      parser = OpenGraphPlus::Parser.new(html)
+      actual_content = parser[property]
+      message ||= "Expected HTML not to have #{property} tag, but it was found with content #{actual_content.inspect}"
+      assert actual_content.nil?, message
+    end
+  end
+end

data/lib/opengraphplus/parser.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+module OpenGraphPlus
+  class Parser
+    REQUIRED_TAGS = %w[og:title og:type og:image og:url].freeze
+    RECOMMENDED_TAGS = %w[og:description og:site_name twitter:card twitter:title twitter:image].freeze
+
+    attr_reader :html
+
+    def initialize(html)
+      @html = html.to_s
+      @tags = parse_meta_tags
+    end
+
+    def og_tags
+      @tags.select { |key, _| key.start_with?("og:") }
+    end
+
+    def twitter_tags
+      @tags.select { |key, _| key.start_with?("twitter:") }
+    end
+
+    def all_tags
+      @tags.dup
+    end
+
+    def [](property)
+      @tags[property]
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def errors
+      REQUIRED_TAGS.reject { |tag| @tags.key?(tag) }
+    end
+
+    def warnings
+      RECOMMENDED_TAGS.reject { |tag| @tags.key?(tag) }
+    end
+
+    private
+
+    def parse_meta_tags
+      doc = Nokogiri::HTML(@html)
+      tags = {}
+
+      doc.css("meta[property^='og:'], meta[name^='og:']").each do |meta|
+        property = meta["property"] || meta["name"]
+        content = meta["content"]
+        tags[property] = content if property && content
+      end
+
+      doc.css("meta[property^='twitter:'], meta[name^='twitter:']").each do |meta|
+        property = meta["property"] || meta["name"]
+        content = meta["content"]
+        tags[property] = content if property && content
+      end
+
+      tags
+    end
+  end
+end

data/lib/opengraphplus/rspec.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "opengraphplus"
+require "rspec/expectations"
+
+module OpenGraphPlus
+  module RSpec
+    extend ::RSpec::Matchers::DSL
+
+    # Matches if all required OpenGraph tags are present
+    #
+    # @example
+    #   expect(response.body).to have_open_graph_tags
+    #
+    matcher :have_open_graph_tags do
+      match do |html|
+        @parser = OpenGraphPlus::Parser.new(html)
+        @parser.valid?
+      end
+
+      failure_message do
+        "expected HTML to have all required OpenGraph tags, but missing: #{@parser.errors.join(', ')}"
+      end
+
+      failure_message_when_negated do
+        "expected HTML not to have all required OpenGraph tags, but all were present"
+      end
+    end
+
+    # Matches if a specific OpenGraph/Twitter tag is present
+    #
+    # @example
+    #   expect(response.body).to have_og_tag("og:title")
+    #   expect(response.body).to have_og_tag("og:title").with_content("My Title")
+    #
+    matcher :have_og_tag do |property|
+      chain :with_content do |expected_content|
+        @expected_content = expected_content
+      end
+
+      match do |html|
+        @parser = OpenGraphPlus::Parser.new(html)
+        @actual_content = @parser[property]
+
+        if @actual_content.nil?
+          false
+        elsif @expected_content
+          @actual_content == @expected_content
+        else
+          true
+        end
+      end
+
+      failure_message do
+        if @actual_content.nil?
+          "expected HTML to have #{property} tag, but it was not found"
+        else
+          "expected #{property} to have content #{@expected_content.inspect}, but got #{@actual_content.inspect}"
+        end
+      end
+
+      failure_message_when_negated do
+        if @expected_content
+          "expected #{property} not to have content #{@expected_content.inspect}, but it did"
+        else
+          "expected HTML not to have #{property} tag, but it was found with content #{@actual_content.inspect}"
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include OpenGraphPlus::RSpec
+end

data/lib/opengraphplus/verifier.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module OpenGraphPlus
+  class Verifier
+    class FetchError < Error; end
+
+    MAX_REDIRECTS = 5
+
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def verify
+      html = fetch_html
+      Parser.new(html)
+    end
+
+    private
+
+    def fetch_html(redirect_count = 0)
+      raise FetchError, "Too many redirects" if redirect_count > MAX_REDIRECTS
+
+      uri = URI.parse(@url)
+      response = Net::HTTP.get_response(uri)
+
+      case response
+      when Net::HTTPSuccess
+        response.body
+      when Net::HTTPRedirection
+        @url = response["location"]
+        fetch_html(redirect_count + 1)
+      else
+        raise FetchError, "HTTP #{response.code}: #{response.message}"
+      end
+    rescue URI::InvalidURIError => e
+      raise FetchError, "Invalid URL: #{e.message}"
+    rescue SocketError, Errno::ECONNREFUSED, Errno::ETIMEDOUT => e
+      raise FetchError, "Connection failed: #{e.message}"
+    end
+  end
+end

data/lib/opengraphplus/version.rb

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

data/lib/opengraphplus.rb

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
 require_relative "opengraphplus/version"
+
+module OpenGraphPlus
+  class Error < StandardError; end
+end
+
 require_relative "opengraphplus/api_key"
 require_relative "opengraphplus/configuration"
 require_relative "opengraphplus/signature"
 require_relative "opengraphplus/tag"
 require_relative "opengraphplus/namespace"
 require_relative "opengraphplus/image_generator"
-
-module OpenGraphPlus
-  class Error < StandardError; end
-end
+require_relative "opengraphplus/parser"
+require_relative "opengraphplus/verifier"
 
 require_relative "opengraphplus/rails" if defined?(::Rails::Railtie)

data/lib/rails/commands/opengraph/opengraph_command.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "rails/command"
+
+module Rails
+  module Command
+    class OpengraphCommand < Base
+      namespace "opengraph"
+
+      desc "verify URL", "Verify OpenGraph tags at a URL"
+      def verify(url)
+        require "opengraphplus"
+
+        say "Verifying OpenGraph tags at #{url}..."
+        say ""
+
+        begin
+          parser = OpenGraphPlus::Verifier.new(url).verify
+        rescue OpenGraphPlus::Verifier::FetchError => e
+          say_error e.message
+          exit 1
+        end
+
+        tags = parser.all_tags
+
+        if tags.any?
+          say "Found tags:"
+          max_key_length = tags.keys.map(&:length).max
+          tags.each do |property, content|
+            say "  #{property.ljust(max_key_length)} → #{content.inspect}"
+          end
+          say ""
+        else
+          say "No OpenGraph or Twitter tags found."
+          say ""
+        end
+
+        if parser.errors.any?
+          say "Missing required tags:"
+          parser.errors.each do |tag|
+            say "  ✗ #{tag}"
+          end
+          say ""
+        end
+
+        if parser.warnings.any?
+          say "Missing recommended tags:"
+          parser.warnings.each do |tag|
+            say "  - #{tag}"
+          end
+          say ""
+        end
+
+        if parser.valid?
+          say "✓ All required OpenGraph tags present"
+        else
+          say "Verification failed: #{parser.errors.length} required tag(s) missing"
+          exit 1
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opengraphplus
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Brad Gessler
@@ -47,7 +47,9 @@ files:
 - lib/opengraphplus/api_key.rb
 - lib/opengraphplus/configuration.rb
 - lib/opengraphplus/image_generator.rb
+- lib/opengraphplus/minitest.rb
 - lib/opengraphplus/namespace.rb
+- lib/opengraphplus/parser.rb
 - lib/opengraphplus/rails.rb
 - lib/opengraphplus/rails/controller.rb
 - lib/opengraphplus/rails/helper.rb
@@ -55,13 +57,16 @@ files:
 - lib/opengraphplus/rails/signature.rb
 - lib/opengraphplus/rails/signature/routes.rb
 - lib/opengraphplus/rails/signature/scope.rb
+- lib/opengraphplus/rspec.rb
 - lib/opengraphplus/signature.rb
 - lib/opengraphplus/signature/generator.rb
 - lib/opengraphplus/signature/url.rb
 - lib/opengraphplus/signature/verifier.rb
 - lib/opengraphplus/tag.rb
 - lib/opengraphplus/tags.rb
+- lib/opengraphplus/verifier.rb
 - lib/opengraphplus/version.rb
+- lib/rails/commands/opengraph/opengraph_command.rb
 - sig/open_graph_plus.rbs
 homepage: https://opengraphplus.com/ruby
 licenses: