og_pilot_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54a99ba0e0f98aac023dc3e51ab7bb61602a4fb67e25867c1dd8401d7ddda8ed
+  data.tar.gz: ff0a2d846acd2ab806df0722e69faadaef51199aa299213c07776eeb444b4db7
+SHA512:
+  metadata.gz: edb9ac50dd687e1420b2adf4cb9e6ab4207ebd2772e57adfae8727d4e1e945f838f7ba2c7f848b4450e368d86c0bdd31134e8d9da2f0977b24b37a904d571626
+  data.tar.gz: '09bad37e9324e6ef35c618feb139c2f88c8f9b877631257db008b6a8c60adf0c22de29e19f9afe20701622743905143ef56ff3f38b028f57b8390ceb84b0ad70'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sunergos IT LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# OG Pilot Ruby
+
+A small Ruby client for generating OG Pilot Open Graph images via signed JWTs.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "og_pilot_ruby"
+```
+
+Then install:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+The default initializer reads from `OG_PILOT_API_KEY` and `OG_PILOT_DOMAIN` automatically.
+Override as needed:
+
+```ruby
+OgPilotRuby.configure do |config|
+  config.api_key = ENV.fetch("OG_PILOT_API_KEY")
+  config.domain = ENV.fetch("OG_PILOT_DOMAIN")
+end
+```
+
+For Rails, drop the snippet above into `config/initializers/og_pilot_ruby.rb`.
+You can also generate it with:
+
+```bash
+bin/rails og_pilot_ruby:install
+```
+
+## Usage
+
+Generate an image URL (follows the redirect returned by OG Pilot). In Rails, you can skip the `require`:
+
+```ruby
+require "og_pilot_ruby"
+
+image_url = OgPilotRuby.create_image(
+  template: "blog_post",
+  title: "How to Build Amazing OG Images",
+  description: "A complete guide to social media previews",
+  bg_color: "#1a1a1a",
+  text_color: "#ffffff",
+  author_name: "Jane Smith",
+  publish_date: "2024-01-15",
+  iat: Time.now.to_i
+)
+```
+
+If you omit `iat`, OG Pilot will cache the image indefinitely. Provide an `iat` to
+refresh the cache daily.
+
+Fetch JSON metadata instead:
+
+```ruby
+payload = {
+  template: "page",
+  title: "Hello OG Pilot"
+}
+
+data = OgPilotRuby.create_image(**payload, json: true)
+```
+
+## Development
+
+Run tests with:
+
+```bash
+bundle exec rake test
+```
+
+### Releases
+
+This repo uses `gem-release` to bump versions and tag releases:
+
+```bash
+bundle exec gem bump --version patch
+bundle exec gem bump --version minor
+bundle exec gem bump --version major
+bundle exec gem bump --version 1.2.3
+```
+
+Then publish:
+
+```bash
+bundle exec rake release
+```

data/lib/generators/og_pilot_ruby/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Install og_pilot
+
+Example:
+    bin/rails generate og_pilot:install
+
+    This will perform the following:
+        Add an initializer file where you can overwrite the library's configuration

data/lib/generators/og_pilot_ruby/install/install_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module OgPilotRuby
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates an OG Pilot initializer\n" \
+        "Usage: rails g og_pilot_ruby:install"
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/og_pilot_ruby.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+OgPilotRuby.configure do |config|
+  # Defaults read from ENV:
+  # config.api_key = ENV.fetch("OG_PILOT_API_KEY", nil)
+  # config.domain = ENV.fetch("OG_PILOT_DOMAIN", nil)
+
+  # Optional overrides:
+  # config.open_timeout = 5
+  # config.read_timeout = 10
+end

data/lib/og_pilot_ruby/client.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+
+require_relative "errors"
+require_relative "jwt_encoder"
+
+module OgPilotRuby
+  class Client
+    ENDPOINT_PATH = "/api/v1/images"
+
+    def initialize(config)
+      @config = config
+    end
+
+    def create_image(params = {}, json: false, iat: nil, headers: {})
+      uri = build_uri(params, iat:)
+      response = request(uri, json:, headers:)
+
+      if json
+        JSON.parse(response.body)
+      else
+        response["Location"] || uri.to_s
+      end
+    end
+
+    private
+
+      attr_reader :config
+
+      def request(uri, json:, headers:)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        http.open_timeout = config.open_timeout if config.open_timeout
+        http.read_timeout = config.read_timeout if config.read_timeout
+
+        request = Net::HTTP::Get.new(uri)
+        request["Accept"] = "application/json" if json
+        headers.each { |key, value| request[key] = value }
+
+        response = http.request(request)
+        return response unless response.is_a?(Net::HTTPClientError) || response.is_a?(Net::HTTPServerError)
+
+        raise OgPilotRuby::RequestError, "OG Pilot request failed with status #{response.code}: #{response.body}"
+      rescue OpenSSL::SSL::SSLError => e
+        raise OgPilotRuby::RequestError, "OG Pilot request failed with SSL error: #{e.message}"
+      rescue Net::OpenTimeout => e
+        raise OgPilotRuby::RequestError, "OG Pilot request timed out: #{e.message}"
+      rescue Net::ReadTimeout => e
+        raise OgPilotRuby::RequestError, "OG Pilot request timed out: #{e.message}"
+      rescue Net::HTTPBadRequest => e
+        raise OgPilotRuby::RequestError, "OG Pilot request failed with bad request: #{e.message}"
+      rescue Net::HTTPUnauthorized => e
+        raise OgPilotRuby::RequestError, "OG Pilot request failed with unauthorized: #{e.message}"
+      end
+
+      def build_uri(params, iat:)
+        payload = build_payload(params, iat:)
+        token = OgPilotRuby::JwtEncoder.encode(payload, api_key!)
+        uri = URI.join(config.base_url, ENDPOINT_PATH)
+        uri.query = URI.encode_www_form(token: token)
+        uri
+      end
+
+      def build_payload(params, iat:)
+        symbolized = params.transform_keys(&:to_sym)
+
+        symbolized[:iat] = iat.to_i if iat
+        symbolized[:iss] ||= domain!
+        symbolized[:sub] ||= api_key_prefix
+
+        validate_payload!(symbolized)
+        symbolized
+      end
+
+      def validate_payload!(payload)
+        raise OgPilotRuby::ConfigurationError, "OG Pilot domain is missing" if payload[:iss].nil? || payload[:iss].empty?
+        raise OgPilotRuby::ConfigurationError, "OG Pilot API key prefix is missing" if payload[:sub].nil? || payload[:sub].empty?
+        raise ArgumentError, "OG Pilot title is required" if payload[:title].nil? || payload[:title].empty?
+      end
+
+      def api_key!
+        return config.api_key if config.api_key
+
+        raise OgPilotRuby::ConfigurationError, "OG Pilot API key is missing"
+      end
+
+      def domain!
+        return config.domain if config.domain
+
+        raise OgPilotRuby::ConfigurationError, "OG Pilot domain is missing"
+      end
+
+      def api_key_prefix
+        api_key!.slice(0, 8)
+      end
+  end
+end

data/lib/og_pilot_ruby/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module OgPilotRuby
+  class Configuration
+    DEFAULT_BASE_URL = "https://ogpilot.com"
+    private_constant :DEFAULT_BASE_URL
+
+    attr_accessor :api_key, :domain, :base_url, :open_timeout, :read_timeout
+
+    def initialize
+      @api_key = ENV.fetch("OG_PILOT_API_KEY", nil)
+      @domain = ENV.fetch("OG_PILOT_DOMAIN", nil)
+      @base_url = DEFAULT_BASE_URL
+      @open_timeout = 5
+      @read_timeout = 10
+    end
+  end
+end

data/lib/og_pilot_ruby/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OgPilotRuby
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class RequestError < Error; end
+end

data/lib/og_pilot_ruby/jwt_encoder.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "jwt"
+
+module OgPilotRuby
+  class JwtEncoder
+    ALGORITHM = "HS256"
+
+    def self.encode(payload, api_key)
+      JWT.encode(payload, api_key, ALGORITHM)
+    end
+  end
+end

data/lib/og_pilot_ruby/rails_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module OgPilotRuby
+  module RailsHelper
+    def create_image(params = {}, json: false, iat: nil, headers: {}, **keyword_params)
+      OgPilotRuby.create_image(params, json:, iat:, headers:, **keyword_params)
+    end
+  end
+end

data/lib/og_pilot_ruby/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+if defined?(Rails::Railtie)
+  module OgPilotRuby
+    # Rails integration for OG Pilot Ruby
+    class Railtie < Rails::Railtie
+      initializer 'og_pilot_ruby.inflections' do
+        ActiveSupport::Inflector.inflections(:en) do |inflect|
+          inflect.acronym 'OgPilotRuby'
+        end
+      end
+    end
+  end
+end

data/lib/og_pilot_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OgPilotRuby
+  VERSION = "0.1.0"
+end

data/lib/og_pilot_ruby.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.ignore("#{__dir__}/og_pilot_ruby/railtie.rb")
+loader.setup
+
+module OgPilotRuby
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def reset_config!
+      @config = Configuration.new
+    end
+
+    def client
+      Client.new(config)
+    end
+
+    def create_image(params = {}, json: false, iat: nil, headers: {}, **keyword_params)
+      params ||= {}
+      client.create_image(params.merge(keyword_params), json:, iat:, headers:)
+    end
+  end
+end
+
+if defined?(Rails::Railtie)
+  require "og_pilot_ruby/railtie"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: og_pilot_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sunergos IT LLC
+- Raul Popadineti
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Generate OG Pilot image URLs or JSON metadata using signed JWTs.
+email:
+- office@sunergos.ro
+- raul@sunergos.ro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/generators/og_pilot_ruby/install/USAGE
+- lib/generators/og_pilot_ruby/install/install_generator.rb
+- lib/generators/og_pilot_ruby/install/templates/initializer.rb
+- lib/og_pilot_ruby.rb
+- lib/og_pilot_ruby/client.rb
+- lib/og_pilot_ruby/configuration.rb
+- lib/og_pilot_ruby/errors.rb
+- lib/og_pilot_ruby/jwt_encoder.rb
+- lib/og_pilot_ruby/rails_helper.rb
+- lib/og_pilot_ruby/railtie.rb
+- lib/og_pilot_ruby/version.rb
+homepage: https://ogpilot.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://ogpilot.com
+  source_code_uri: https://github.com/sunergos-ro/og_pilot_ruby
+  changelog_uri: https://github.com/sunergos-ro/og_pilot_ruby/commits/main
+  documentation_uri: https://ogpilot.com/docs
+  bug_tracker_uri: https://github.com/sunergos-ro/og_pilot_ruby/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Ruby client for the OG Pilot Open Graph image generator.
+test_files: []