imageomatic 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06c6119133165811c725fd96bafc43649fb538b7bc2968a9532b031c106e7298
-  data.tar.gz: faf5699c37dc7666d504ab8a0bd245ef0242867ff45ba4e84d4a15b2ad96871d
+  metadata.gz: 533fb806d3a3ce5ac58f2f79fedb695504ce8e5a2ec2a81772004a27f12c733f
+  data.tar.gz: c5bda15752799f09a89b87ae1dd48a4b2ceb0cb87f8a3c315451a0328d80dacb
 SHA512:
-  metadata.gz: a5766340cae879938c1faa44a7850ff7a3b173ca94dca76497336b45b1a9012472bb40142044ba1ddc27f561fa85be4b225c68dcf0e2cf27a150f5f884730f5f
-  data.tar.gz: 2f3f7cc2b4fb13e67417f4aa3d10a28e49fdda77e0dc3e8ae5895e55c20b3302afbdc46c70fb0c645845c7251a402d42434e61d15d0ad6ebbc7bafaf15d3afe7
+  metadata.gz: 63106766ef8c74a8705f62204a246f0d47e446ee4fedcd35d4314ef04b5bb6cce1a6bb564ef2ed919f1d955aba22e58e6d291e61328f7c26adc42913ab1f8abd
+  data.tar.gz: 29591c03426214e136d0f58eb9d9e0e869714cdf2452e55b2cbf115e6cf0cbeef348dd1d1637750ce74287285091d52b6c3937f42cbb93a09998c2293ea21c73

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

@@ -24,7 +24,11 @@ module Imageomatic
       end
 
       def url_for_opengraph_image
-        Imageomatic.client.url_signature.url_for "opengraph", url: url_for(format: :opengraph)
+        imageomatic_opengraph_url url: url_for(format: :opengraph)
+      end
+
+      def imageomatic_opengraph_url(*args, **kwargs)
+        Imageomatic.client.url_signature.url_for "opengraph", *args, **kwargs
       end
 
       def opengraph

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

@@ -0,0 +1,51 @@
+module Imageomatic
+  module Opengraph
+    # Provides a way to specify OpenGraph keys for an OpengraphModel, which can later
+    # be iterated upon to generate OpenGraph meta tags.
+    class Base
+      # Encapsulates OpenGraph properties and provides helpers that are
+      # useful for documentation purposes or for reflecting on Ruby objects.
+      class Property
+        attr_accessor :key, :name, :description, :default
+
+        def initialize(key, description = nil, default: nil)
+          @key = key
+          @description = description
+          # If we get a string like `og:image:url`, this would give us `url`
+          *_, @name = key.rpartition(":")
+          @default = default
+        end
+      end
+
+      # Allows for the object to be initialized with args like `Image.new(url: "https://example.com/logo.png", alt: "Logo image")`.
+      def initialize(**kwargs)
+        kwargs.each do |kwarg, value|
+          self.send("#{kwarg}=", value)
+        rescue NoMethodError
+          raise NoMethodError, "#{kwarg.inspect} is not a property of #{self.inspect}"
+        end
+      end
+
+      # DSL for creating properties when defining a model.
+      def self.property(*args, **kwargs)
+        property = Property.new *args, **kwargs
+        attr_accessor property.name
+        self.properties.append property
+      end
+
+      # Array where properties are registered.
+      def self.properties
+        @properties ||= []
+      end
+
+      # Iterates through the properties and also gets their value.
+      def properties
+        Enumerator.new do |y|
+          self.class.properties.each do |property|
+            y << [ property, (self.send(property.name) || property.default) ]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Imageomatic
+  module Opengraph
+    class Image < Base
+      property "og:image:url",        "Identical to og:image."
+      property "og:image:secure_url", "An alternate url to use if the webpage requires HTTPS."
+      property "og:image:type",       "A MIME type for this image."
+      property "og:image:width",      "The number of pixels wide."
+      property "og:image:height",     "The number of pixels high."
+      property "og:image:alt",        "A description of what is in the image (not a caption). If the page specifies an og:image it should specify og:image:alt."
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module Imageomatic
       include ActionView::Helpers::TagHelper
 
       def to_html
-        tag :meta, property: "og:#{property}", content: content
+        tag :meta, property: property, content: content
       end
     end
   end

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

@@ -0,0 +1,35 @@
+module Imageomatic
+  module Opengraph
+    # Iterates recursively through an OpenGraph object and gets a bunch of
+    # metatags and keys.
+    class MetatagMapper
+      include ActionView::Helpers::OutputSafetyHelper
+
+      attr_reader :model
+      delegate :context,
+        to: :model
+
+      def initialize(model)
+        @model = model
+      end
+
+      def metatags
+        Enumerator.new do |y|
+          model.properties.each do |property, content|
+            if content.respond_to? :properties
+              MetatagMapper.new(content).metatags.each do |tag|
+                y << tag
+              end
+            else
+              y << Metatag.new(property.key, content) if content.present?
+            end
+          end
+        end
+      end
+
+      def to_html
+        safe_join metatags.map(&:to_html), "\n"
+      end
+    end
+  end
+end

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

@@ -1,19 +1,35 @@
 module Imageomatic
   module Opengraph
-    class Model < Struct.new(:title, :image, :description, :type)
-      include ActionView::Helpers::OutputSafetyHelper
+    class Model < Base
+      property "og:title",        %[The title of your object as it should appear within the graph, e.g., "The Rock".]
+      property "og:type",         %[The type of your object, e.g., "video.movie". Depending on the type you specify, other properties may also be required.]
+      property "og:image",        %[An image URL which should represent your object within the graph.]
+      property "og:url",          %[The canonical URL of your object that will be used as its permanent ID in the graph, e.g., "https://www.imdb.com/title/tt0117500/".]
+      property "og:description",  %[A one to two sentence description of your object.]
+      property "twitter",  %[A one to two sentence description of your object.]
 
-      def metatags
-        Enumerator.new do |y|
-          each_pair do |property, content|
-            y << Metatag.new(property, content) if content.present?
-          end
-        end
+      delegate :to_html, to: :metatag_mapper
+
+      def image
+        @image ||= Image.new
       end
 
-      def to_html
-        safe_join metatags.map(&:to_html), "\n"
+      def image=(url)
+        image.url = url
       end
+
+      def twitter
+        @twitter ||= Twitter.new.tap do |twitter|
+          twitter.title = title
+          twitter.description = description
+          twitter.image = image.url
+        end
+      end
+
+      private
+        def metatag_mapper
+          MetatagMapper.new(self)
+        end
     end
   end
 end

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

@@ -0,0 +1,11 @@
+module Imageomatic
+  module Opengraph
+    class Twitter < Base
+      property "twitter:card",        "Type of card, which is 'summary_large_image'", default: "summary_large_image"
+      property "twitter:site",        "Twitter @handle of the account"
+      property "twitter:title",       "Title of the card, similar to og:title"
+      property "twitter:description", "Description of the card, similar to og:description"
+      property "twitter:image",       "Image URL of the card, similar to og:image"
+    end
+  end
+end

data/lib/imageomatic/version.rb

@@ -1,3 +1,3 @@
 module Imageomatic
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imageomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-24 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,8 +58,12 @@ files:
 - app/jobs/imageomatic/application_job.rb
 - app/mailers/imageomatic/application_mailer.rb
 - app/models/imageomatic/application_record.rb
+- app/models/imageomatic/opengraph/base.rb
+- app/models/imageomatic/opengraph/image.rb
 - app/models/imageomatic/opengraph/metatag.rb
+- app/models/imageomatic/opengraph/metatag_mapper.rb
 - app/models/imageomatic/opengraph/model.rb
+- app/models/imageomatic/opengraph/twitter.rb
 - app/views/layouts/imageomatic/application.html.erb
 - config/initializers/mime_types.rb
 - config/routes.rb
@@ -100,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.3.20
 signing_key:
 specification_version: 4
 summary: Easiest way to generate fresh images for Rails applications.