imageomatic 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7903eeab14e261a76042cba4e2a2127dc84bf4d1bb1c88d3cec3b2e8fddafa87
-  data.tar.gz: 336a739324d3dc2216e9089bebff9e1a47f513cc3049906a3b036d4a73529ab9
+  metadata.gz: 56c3cad53d8ab41c03d1062ff85f3d0616680c1703a57592d33a92878921e485
+  data.tar.gz: 787aef08807389181b223c5f9a27b41af680954425d80afd9b767699963590f6
 SHA512:
-  metadata.gz: e47c991db4e2d284a28853ab375864dc6d8a5cf12743c629694045ad7be2c822362797ebc3bc7afa15189c5154c7d98d68dc3f9ad4b97002781248e8134d0da5
-  data.tar.gz: 91a59cce1f7a876d4fec576c6f7560e043ff0ac996308370abad4403fe392594383a869bf77506bb19d37b5818451522565efded925a9d774a457879756fa6f1
+  metadata.gz: 0addd92d5d109f408285aa777d9234a69652472a9a5cb0e12809baa9a15b5565c04640458f2acd879897b125df544586a37cfed6571c5cf711e4d3fb04f2455a
+  data.tar.gz: b3047ca8ec7f5394bd1e8a4c4b15fd281a17cb6b9ff9630dc38aaa53a06ff9629682a86de45141365d86a560b1dda41e2a8292bac8306548c6e7944a9d589060

data/app/controllers/concerns/imageomatic/opengraph.rb

@@ -2,6 +2,9 @@ module Imageomatic
   module Opengraph
     extend ActiveSupport::Concern
 
+    DEFAULT_OPENGRAPH_TYPE = "website".freeze
+
+    DEFAULT_OPENGRAPH_FALLBACK_FORMATS = [ :opengraph, :html ]
     included do
       before_action :assign_opengraph_fallback_formats, if: :opengraph_request?
       before_action :assign_opengraph_defaults
@@ -13,7 +16,7 @@ module Imageomatic
 
     protected
       def assign_opengraph_fallback_formats
-        request.formats = [ :opengraph, :html ]
+        request.formats = DEFAULT_OPENGRAPH_FALLBACK_FORMATS
       end
 
       def opengraph_request?
@@ -21,7 +24,7 @@ module Imageomatic
       end
 
       def url_for_opengraph_image
-        url_for(format: :opengraph)
+        Imageomatic.client.url_signature.url_for "opengraph", url: url_for(format: :opengraph)
       end
 
       def opengraph
@@ -30,6 +33,7 @@ module Imageomatic
 
       def assign_opengraph_defaults
         opengraph.image ||= url_for_opengraph_image
+        opengraph.type ||= DEFAULT_OPENGRAPH_TYPE
       end
   end
 end

data/app/models/imageomatic/opengraph/model.rb

@@ -1,6 +1,6 @@
 module Imageomatic
   module Opengraph
-    class Model < Struct.new(:title, :image, :description)
+    class Model < Struct.new(:title, :image, :description, :type)
       include ActionView::Helpers::OutputSafetyHelper
 
       def metatags

data/exe/imageomatic

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "imageomatic"
+
+Imageomatic::CLI.start ARGV

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

@@ -12,4 +12,8 @@ class Imageomatic::InstallGenerator < Rails::Generators::Base
   def copy_layout
     copy_file "application.opengraph.erb", "app/views/layouts/application.opengraph.erb"
   end
+
+  def copy_configuration_file
+    template "imageomatic.rb.tt", "config/initializers/imageomatic.rb"
+  end
 end

data/lib/generators/imageomatic/install/templates/imageomatic.rb.tt

@@ -0,0 +1,14 @@
+Imageomatic.configure do |config|
+  if Rails.env.production?
+    # For production deployments, set the following environment keys:
+    #
+    # ```
+    # IMAGEOMATIC_SECRET_KEY=
+    # IMAGEOMATIC_PUBLIC_KEY=
+    # ```
+    config.load_env
+  else
+    config.secret_key = "<%= Imageomatic.key_generator.secret_key %>"
+    config.public_key = "<%= Imageomatic.key_generator.public_key %>"
+  end
+end

data/lib/imageomatic/cli.rb

@@ -0,0 +1,23 @@
+require "thor"
+
+module Imageomatic
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "install", "Install Imageomatic to the Rails application"
+    def install
+      run "./bin/bundle add imageomatic"
+      run "./bin/rails generate imageomatic:install"
+    end
+
+    desc "version", "Prints the version of imageomatic"
+    def version
+      puts Imageomatic::VERSION
+    end
+
+    desc "environment [ENVIRONMENT]", "Generates environment variables for target enrivonment"
+    def environment(environment = Imageomatic::KeyGenerator::ENVIRONMENT)
+      puts Imageomatic.key_generator(environment: environment).env_vars
+    end
+  end
+end

data/lib/imageomatic/client.rb

@@ -0,0 +1,13 @@
+module Imageomatic
+  class Client
+    delegate :secret_key, :public_key, to: :configuration
+
+    def url_signature
+      @url_signature ||= UrlSignature.new(secret_key: secret_key, public_key: public_key)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/imageomatic/configuration.rb

@@ -0,0 +1,18 @@
+module Imageomatic
+  class Configuration
+    attr_accessor :secret_key, :public_key
+
+    def load_secret_key_env
+      self.secret_key = ENV.fetch("IMAGEOMATIC_SECRET_KEY")
+    end
+
+    def load_public_key_env
+      self.public_key = ENV.fetch("IMAGEOMATIC_PUBLIC_KEY")
+    end
+
+    def load_env
+      load_secret_key_env
+      load_public_key_env
+    end
+  end
+end

data/lib/imageomatic/key_generator.rb

@@ -0,0 +1,43 @@
+require "securerandom"
+
+module Imageomatic
+  # Generates random keys for environments.
+  class KeyGenerator
+    LENGTH = 14
+    DELIMITER = "_".freeze
+    ENVIRONMENT = :development
+
+    attr_reader :environment
+
+    def initialize(environment: ENVIRONMENT)
+      @environment = environment
+    end
+
+    def public_key
+      generate :public
+    end
+
+    def secret_key
+      generate :secret
+    end
+
+    def env_vars
+      <<~ENVARS
+      IMAGEOMATIC_SECRET_KEY=#{secret_key}
+      IMAGEOMATIC_PUBLIC_KEY=#{public_key}
+      ENVARS
+    end
+
+    def generate(*scopes)
+      scopes
+        .prepend(environment)
+        .append(random)
+        .join(DELIMITER)
+    end
+
+    private
+      def random
+        SecureRandom.hex(LENGTH)
+      end
+  end
+end

data/lib/imageomatic/version.rb

@@ -1,3 +1,3 @@
 module Imageomatic
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/imageomatic.rb

@@ -1,6 +1,24 @@
 require "imageomatic/version"
-require "imageomatic/engine"
+require "imageomatic/engine" if defined? Rails
 
 module Imageomatic
-  autoload :UrlSignature, "imageomatic/url_signature"
+  autoload :CLI,              "imageomatic/cli"
+  autoload :Client,           "imageomatic/client"
+  autoload :Configuration,    "imageomatic/configuration"
+  autoload :KeyGenerator,     "imageomatic/key_generator"
+  autoload :UrlSignature,     "imageomatic/url_signature"
+
+  class << self
+    def client
+      @client ||= Client.new
+    end
+
+    def key_generator(environment: Rails.env)
+      @key_generator ||= KeyGenerator.new(environment: environment)
+    end
+
+    def configure(&block)
+      block.call client.configuration
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imageomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,10 +24,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: Easiest way to generate fresh images for Rails applications.
 email:
 - brad@imageomatic.com
-executables: []
+executables:
+- imageomatic
 extensions: []
 extra_rdoc_files: []
 files:
@@ -48,11 +63,17 @@ files:
 - app/views/layouts/imageomatic/application.html.erb
 - config/initializers/mime_types.rb
 - config/routes.rb
+- exe/imageomatic
 - lib/generators/imageomatic/install/USAGE
 - lib/generators/imageomatic/install/install_generator.rb
 - lib/generators/imageomatic/install/templates/application.opengraph.erb
+- lib/generators/imageomatic/install/templates/imageomatic.rb.tt
 - lib/imageomatic.rb
+- lib/imageomatic/cli.rb
+- lib/imageomatic/client.rb
+- lib/imageomatic/configuration.rb
 - lib/imageomatic/engine.rb
+- lib/imageomatic/key_generator.rb
 - lib/imageomatic/url_signature.rb
 - lib/imageomatic/version.rb
 - lib/tasks/imageomatic_tasks.rake