open_graph_reader 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47077321ba2e81ce2661a44db8908de870d1d2722a2669133bb35be087fd1004
-  data.tar.gz: db84da7bdf562ac50597da8222ed2109643db75ec47e6e3d8204f7bafb5e2872
+  metadata.gz: 0e7c1f4b9ce43af3f0ba0a120f14bdd14bf5f91aacac242e3c9d8f000d06b861
+  data.tar.gz: f8300efb032e1f687f5c99d8b53b2a553c7b6de9cd45f6c323ac86b8b9761646
 SHA512:
-  metadata.gz: 76806aa4f7106ae2767f3c457b0a095a92d36c5647b4d36a6edb341d7d908dd53d66662d364a2803b8e7e1ffd41673729edad049dde7b2988b4da90584d94146
-  data.tar.gz: 37dc4ecd1ba0ed18a48105820342c516d622a62bcb6857784f4c3fec880d43d6add6ab24eee1868137eb90e269e2c99fc4a746ca0ea8fa49570366de15d5fafe
+  metadata.gz: da884cc904c76766f0fa5e6cce33e224511be0c489c7ae99cc589a639efdfdb8c48aa90b4c51ad312f86a8133012c96efbb11f001b4a9d134c913884b697d277
+  data.tar.gz: '028e2821d6a628a266d8c365254518d3e3758f2ea94ab612addae5a875dd280eecc287e7c087aef3d957288581cdd4839bf6177ec21c2c576d17a07c798aa44c'

data/README.md

@@ -1,4 +1,4 @@
-# OpenGraphReader [![Gem Version](https://badge.fury.io/rb/open_graph_reader.svg)](http://badge.fury.io/rb/open_graph_reader) [![Build Status](https://travis-ci.org/jhass/open_graph_reader.svg?branch=master)](https://travis-ci.org/jhass/open_graph_reader)
+# OpenGraphReader [![Gem Version](https://badge.fury.io/rb/open_graph_reader.svg)](http://badge.fury.io/rb/open_graph_reader)
 
 A library to fetch and parse OpenGraph properties from an URL or a given string.
 
@@ -17,14 +17,14 @@ A library to fetch and parse OpenGraph properties from an URL or a given string.
 * Objects and their properties are defined in code, not by parsing the response at the namespace identifier.
 
 
-Ruby 2.0 and later are supported.
+Ruby 3.1 and later are supported. Compatibility with earlier versions might exist but is not verified.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'open_graph_reader'
+gem "open_graph_reader"
 ```
 
 And then execute:
@@ -38,13 +38,13 @@ Or install it yourself as:
 
 Install the following gems the same way for a higher success rate at fetching websites:
 
-* [faraday_middleware](https://github.com/lostisland/faraday_middleware)
+* [faraday-follow_redirects](https://github.com/tisba/faraday-follow-redirects)
 * [faraday-cookie_jar](https://github.com/miyagawa/faraday-cookie_jar)
 
 ## Usage
 
 ```ruby
-require 'open_graph_reader'
+require "open_graph_reader"
 
 # Returns nil if anything on the object is invalid
 object = OpenGraphReader.fetch("http://examples.opengraphprotocol.us/article.html")

data/lib/open_graph_reader/base.rb

@@ -52,18 +52,18 @@ module OpenGraphReader
     end
 
     # @private
-    def respond_to_missing?(method, _include_private=false)
+    def respond_to_missing?(method, _include_private = false)
       @bases.has_key? method.to_s
     end
 
     # Makes the found root objects available.
     # @return [Object]
-    def method_missing(method, *args, &block)
+    def method_missing(method, ...)
       name = method.to_s
       if respond_to_missing? name
         @bases[name]
       else
-        super(method, *args, &block)
+        super
       end
     end
   end

data/lib/open_graph_reader/builder.rb

@@ -7,7 +7,7 @@ module OpenGraphReader
     # Well-known types from
     #
     # @see http://ogp.me
-    KNOWN_TYPES = %w(website article book profile).freeze
+    KNOWN_TYPES = %w[website article book profile].freeze
 
     # Create a new builder.
     #
@@ -188,7 +188,7 @@ module OpenGraphReader
 
     def extra_properties object, type, verticals
       valid_properties = verticals[type]
-      set_properties   = object.class.available_properties.select {|property| object[property] }
+      set_properties = object.class.available_properties.select { |property| object[property] }
 
       set_properties - valid_properties
     end

data/lib/open_graph_reader/configuration.rb

@@ -98,15 +98,15 @@ module OpenGraphReader
 
     # Reset configuration to their defaults
     def reset_to_defaults!
-      @strict                              = false
-      @validate_required                   = true
-      @validate_references                 = true
+      @strict = false
+      @validate_required = true
+      @validate_references = true
       @discard_invalid_optional_properties = false
-      @synthesize_title                    = false
-      @synthesize_url                      = false
-      @synthesize_full_url                 = false
-      @synthesize_image_url                = false
-      @guess_datetime_format               = false
+      @synthesize_title = false
+      @synthesize_url = false
+      @synthesize_full_url = false
+      @synthesize_image_url = false
+      @guess_datetime_format = false
     end
   end
 end

data/lib/open_graph_reader/definitions.rb

@@ -9,7 +9,7 @@ module OpenGraphReader
 
     # @!macro property
     # @return [String]
-    string :type,  required: true, downcase: true, default: "website"
+    string :type, required: true, downcase: true, default: "website"
 
     # @!macro property
     # @return [String]
@@ -74,6 +74,10 @@ module OpenGraphReader
       # @return [Integer, nil]
       integer :height
 
+      # @!macro property
+      # @return [String, nil]
+      string :alt
+
       # @return [String, nil]
       def url
         secure_url || properties[:url] || content
@@ -169,7 +173,7 @@ module OpenGraphReader
 
     # @!macro property
     # @return [String, nil]
-    enum :gender, %w(male female)
+    enum :gender, %w[male female]
 
     # @!macro property
     # @return [String, nil]
@@ -224,38 +228,38 @@ module OpenGraphReader
     #  @return [Array<Profile>]
     # @!macro property
     # @return [Profile, nil]
-    url :actor,    to: Profile, verticals: %w(movie episode tv_show other), collection: true
+    url :actor, to: Profile, verticals: %w[movie episode tv_show other], collection: true
 
     # @!attribute [r] directors
     #  @return [Array<Profile>]
     # @!macro property
     # @return [Profile, nil]
-    url :director, to: Profile, verticals: %w(movie episode tv_show other), collection: true
+    url :director, to: Profile, verticals: %w[movie episode tv_show other], collection: true
 
     # @!attribute [r] writers
     #  @return [Array<Profile>]
     # @!macro property
     # @return [Profile, nil]
-    url :writer,   to: Profile, verticals: %w(movie episode tv_show other), collection: true
+    url :writer, to: Profile, verticals: %w[movie episode tv_show other], collection: true
 
     # @!macro property
     # @return [Integer, nil]
-    integer :duration,          verticals: %w(movie episode tv_show other)
+    integer :duration, verticals: %w[movie episode tv_show other]
 
     # @!macro property
     # @return [DateTime, nil]
-    datetime :release_date,     verticals: %w(movie episode tv_show other)
+    datetime :release_date, verticals: %w[movie episode tv_show other]
 
     # @!attribute [r] tags
     #   @return [Array<String>]
     # @!macro property
     # @return [String, nil]
-    string :tag,                verticals: %w(movie episode tv_show other), collection: true
+    string :tag, verticals: %w[movie episode tv_show other], collection: true
 
     # @todo validate that target vertical is video.tv_show ?
     # @!macro property
     # @return [Sring, nil]
-    url :series,   to: Video,   verticals: %w(episode)
+    url :series, to: Video, verticals: %w[episode]
   end
 
   # @see http://ogp.me/#type_book
@@ -294,39 +298,39 @@ module OpenGraphReader
 
     # @!macro property
     # @return [Integer, nil]
-    integer :duration, verticals: %w(song)
+    integer :duration, verticals: %w[song]
 
     # @todo validate that target vertical is music.album/music.song ?
     # @!attribute [r] albums
     #   @return [Array<Music>]
     # @macro property
     # @return [Music, nil]
-    url :album, to: Music,      verticals: %w(song),      collection: true
+    url :album, to: Music, verticals: %w[song], collection: true
 
     # @macro property
     # @return [Integer, nil]
-    integer :disc,              verticals: %w(song album playlist)
+    integer :disc, verticals: %w[song album playlist]
 
     # @macro property
     # @return [Integer, nil]
-    integer :track,             verticals: %w(song album playlist)
+    integer :track, verticals: %w[song album playlist]
 
     # @!attribute [r] musicians
     #  @return [Array<Profile>]
     # @!macro property
     # @return [Profile, nil]
-    url :musician, to: Profile, verticals: %w(song album), collection: true
+    url :musician, to: Profile, verticals: %w[song album], collection: true
 
     # @macro property
     # @return [Music, nil]
-    url :song, to: Music,       verticals: %w(album playlist)
+    url :song, to: Music, verticals: %w[album playlist]
 
     # @macro property
     # @return [DateTime, nil]
-    datetime :release_date,     verticals: %w(album)
+    datetime :release_date, verticals: %w[album]
 
     # @macro property
     # @return [Profile, nil]
-    url :creator, to: Profile,  verticals: %w(playlist radio_station)
+    url :creator, to: Profile, verticals: %w[playlist radio_station]
   end
 end

data/lib/open_graph_reader/fetcher.rb

@@ -1,7 +1,7 @@
 require "faraday"
 
 begin
-  require "faraday_middleware/response/follow_redirects"
+  require "faraday/follow_redirects"
 rescue LoadError; end
 
 begin
@@ -16,7 +16,7 @@ module OpenGraphReader
   # @api private
   class Fetcher
     HEADERS = {
-      "Accept"     => "text/html",
+      "Accept" => "text/html",
       "User-Agent" => "OpenGraphReader/#{OpenGraphReader::VERSION} (+https://github.com/jhass/open_graph_reader)"
     }.freeze
 
@@ -25,6 +25,7 @@ module OpenGraphReader
     # @param [URI] uri the URI to fetch.
     def initialize uri
       raise ArgumentError, "url needs to be an instance of URI" unless uri.is_a? URI
+
       @uri = uri
       @fetch_failed = false
       @connection = Faraday.default_connection.dup
@@ -33,7 +34,7 @@ module OpenGraphReader
       @get_response = nil
 
       prepend_middleware Faraday::CookieJar if defined? Faraday::CookieJar
-      prepend_middleware FaradayMiddleware::FollowRedirects if defined? FaradayMiddleware
+      prepend_middleware Faraday::FollowRedirects::Middleware if defined? Faraday::FollowRedirects
     end
 
     # The URL to fetch
@@ -71,6 +72,7 @@ module OpenGraphReader
       fetch_body unless fetched?
       raise NoOpenGraphDataError, "No response body received for #{@uri}" if fetch_failed?
       raise NoOpenGraphDataError, "Did not receive a HTML site at #{@uri}" unless html?
+
       @get_response.body
     end
 
@@ -84,6 +86,7 @@ module OpenGraphReader
       return false unless response
       return false unless response.success?
       return false unless response["content-type"]
+
       response["content-type"].include? "text/html"
     end
 

data/lib/open_graph_reader/object/dsl/types.rb

@@ -40,8 +40,8 @@ module OpenGraphReader
           rescue
             next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
             raise InvalidObjectError,
-                  "URL #{value.inspect} does not start with http:// or https:// and failed to "\
-                  "synthesize a full URL"
+              "URL #{value.inspect} does not start with http:// or https:// and failed to " \
+              "synthesize a full URL"
           end
         elsif options.has_key?(:to) && OpenGraphReader.config.validate_references
           next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
@@ -67,32 +67,28 @@ module OpenGraphReader
       end
 
       # @see http://ogp.me/#integer
-      define_type :integer do  |value, options|
-        begin
-          Integer(value)
-        rescue ArgumentError
-          next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
-          raise InvalidObjectError, "Integer expected, but was #{value.inspect}"
-        end
+      define_type :integer do |value, options|
+        Integer(value)
+      rescue ArgumentError
+        next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
+        raise InvalidObjectError, "Integer expected, but was #{value.inspect}"
       end
 
       # @see http://ogp.me/#datetime
       define_type :datetime do |value, options|
-        begin
-          if OpenGraphReader.config.guess_datetime_format
-            DateTime.parse value
-          else
-            DateTime.iso8601 value
-          end
-        rescue ArgumentError
-          next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
-          raise InvalidObjectError, "ISO8601 datetime expected, but was #{value.inspect}"
+        if OpenGraphReader.config.guess_datetime_format
+          DateTime.parse value
+        else
+          DateTime.iso8601 value
         end
+      rescue ArgumentError
+        next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
+        raise InvalidObjectError, "ISO8601 datetime expected, but was #{value.inspect}"
       end
 
       # @see http://ogp.me/#bool
       define_type :boolean do |value, options|
-        {"true" => true, "false" => false, "1" => true, "0" => false}[value].tap {|bool|
+        {"true" => true, "false" => false, "1" => true, "0" => false}[value].tap { |bool|
           if bool.nil?
             next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
             raise InvalidObjectError, "Boolean expected, but was #{value.inspect}"
@@ -102,12 +98,10 @@ module OpenGraphReader
 
       # @see http://ogp.me/#float
       define_type :float do |value, options|
-        begin
-          Float(value)
-        rescue ArgumentError
-          next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
-          raise InvalidObjectError, "Float expected, but was #{value.inspect}"
-        end
+        Float(value)
+      rescue ArgumentError
+        next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
+        raise InvalidObjectError, "Float expected, but was #{value.inspect}"
       end
     end
   end

data/lib/open_graph_reader/object/dsl.rb

@@ -72,7 +72,7 @@ module OpenGraphReader
         define_method(name) do
           value = children[name.to_s].first
           # @todo figure out a sane way to distinguish subobject properties
-          value.content if value && value.is_a?(Object)
+          value.content if value&.is_a?(Object)
           value || options[:default]
         end
       end
@@ -130,7 +130,7 @@ module OpenGraphReader
         options = args.pop if args.last.is_a? Hash
         options ||= {}
 
-        @content_processor = proc {|value|
+        @content_processor = proc { |value|
           value.downcase! if options[:downcase]
           options[:to] ||= self
           DSL.processors[type].call(value, *args, options)
@@ -164,7 +164,7 @@ module OpenGraphReader
       # @api private
       # @return [{String => Array<Strin>}]
       def verticals
-        @verticals ||= Hash.new {|h, k| h[k] = [] }
+        @verticals ||= Hash.new { |h, k| h[k] = [] }
       end
     end
   end

data/lib/open_graph_reader/object/registry.rb

@@ -1,6 +1,5 @@
 require "singleton"
 require "forwardable"
-require "set"
 
 module OpenGraphReader
   module Object
@@ -44,7 +43,7 @@ module OpenGraphReader
 
       def_delegators :@namespaces, :[]=, :has_key?
       alias_method :register, :[]=
-      alias_method :registered?,  :has_key?
+      alias_method :registered?, :has_key?
 
       # @see Registry.verticals
       attr_reader :verticals

data/lib/open_graph_reader/object.rb

@@ -39,7 +39,7 @@ module OpenGraphReader
     # Create a new object. If your class overrides this don't forget to call <tt>super</tt>.
     def initialize
       @properties = {}
-      @children = Hash.new {|h, k| h[k] = [] }
+      @children = Hash.new { |h, k| h[k] = [] }
     end
 
     # Whether this object has the given property

data/lib/open_graph_reader/parser/graph.rb

@@ -48,7 +48,7 @@ module OpenGraphReader
         #
         # @return [String]
         def namespace
-          parent.fullname if parent
+          parent&.fullname
         end
 
         # Get node's namespace as array.
@@ -69,7 +69,7 @@ module OpenGraphReader
         def inspect
           "#{super.chop} children=#{children.inspect}>"
         end
-        alias to_s inspect
+        alias_method :to_s, :inspect
       end
 
       extend Forwardable
@@ -109,8 +109,8 @@ module OpenGraphReader
       # @return [Bool] Whether the given property exists in the graph.
       def exist? property
         path = property.split(":")
-        child = path.inject(root) {|node, name|
-          node.children.find {|child| child.name == name } || break
+        child = path.inject(root) { |node, name|
+          node.children.find { |child| child.name == name } || break
         }
         !child.nil? && !child.empty?
       end
@@ -121,7 +121,7 @@ module OpenGraphReader
       # @param [String] default The default in case the a value is not found.
       # @yield Return a default in case the value is not found. Supersedes the default parameter.
       # @return [String, Bool, Integer, Float, DateTime, nil]
-      def fetch property, default=nil
+      def fetch property, default = nil
         node = find_by(property)
         return yield if node.nil? && block_given?
         return default if node.nil?
@@ -134,7 +134,7 @@ module OpenGraphReader
       # @return [Node, nil]
       def find_by property
         property = normalize_property property
-        find {|node| node.fullname == property }
+        find { |node| node.fullname == property }
       end
 
       # Fetch all nodes
@@ -143,12 +143,12 @@ module OpenGraphReader
       # @return [Array<Node>]
       def select_by property
         property = normalize_property property
-        select {|node| node.fullname == property }
+        select { |node| node.fullname == property }
       end
 
       def find_or_create_path path
-        path.inject(root) {|node, name|
-          child = node.children.reverse.find {|child| child.name == name }
+        path.inject(root) { |node, name|
+          child = node.children.reverse.find { |child| child.name == name }
 
           unless child
             child = Node.new name

data/lib/open_graph_reader/parser.rb

@@ -11,7 +11,7 @@ module OpenGraphReader
     module XPathHelpers
       # Helper to lowercase all given properties
       def self.ci_starts_with node_set, string
-        node_set.select {|node|
+        node_set.select { |node|
           node.to_s.downcase.start_with? string.downcase
         }
       end
@@ -56,7 +56,7 @@ module OpenGraphReader
     def build_graph
       graph = Graph.new
 
-      meta_tags.each do |tag|
+      sorted_meta_tags.each do |tag|
         *path, leaf = tag["property"].downcase.split(":")
         node = graph.find_or_create_path path
 
@@ -67,6 +67,11 @@ module OpenGraphReader
       graph
     end
 
+    # Ensure the tags are sorted by their hierarchy, that is sort a:b before a:b:c.
+    def sorted_meta_tags
+      meta_tags.sort_by { |tag| tag["property"] }
+    end
+
     def meta_tags
       head = @doc.xpath("/html/head").first
 
@@ -80,7 +85,7 @@ module OpenGraphReader
 
       if head["prefix"]
         @additional_namespaces = head["prefix"].scan(/(\w+):\s*([^ ]+)/)
-        @additional_namespaces.map! {|prefix, _| prefix.downcase }
+        @additional_namespaces.map! { |prefix, _| prefix.downcase }
         @additional_namespaces.each do |additional_namespace|
           next if additional_namespace == "og"
           condition << " or ci_starts_with(@property, '#{additional_namespace}')"

data/lib/open_graph_reader/version.rb

@@ -1,4 +1,4 @@
 module OpenGraphReader
-  # Tbe library version
-  VERSION = "0.7.2"
+  # The library version
+  VERSION = "0.8.0".freeze
 end

data/lib/open_graph_reader.rb

@@ -37,11 +37,11 @@ module OpenGraphReader
   # @return [Base] The base object from which you can obtain the root objects.
   # @raise [NoOpenGraphDataError] {include:NoOpenGraphDataError}
   # @raise [InvalidObjectError] {include:InvalidObjectError}
-  def self.parse! html, origin=nil
+  def self.parse! html, origin = nil
     self.current_origin = origin
     parser = Parser.new html
     raise NoOpenGraphDataError, "#{origin || html} does not contain any OpenGraph tags" unless parser.any_tags?
-    Builder.new(parser).base.tap {|base|
+    Builder.new(parser).base.tap { |base|
       base.origin = origin.to_s if origin
       self.current_origin = nil
     }
@@ -65,7 +65,7 @@ module OpenGraphReader
   # @param [#to_s] origin The source from where the given document was fetched.
   # @return [Base, nil] The base object from which you can obtain the root objects.
   # @see OpenGraphReader.parse!
-  def self.parse html, origin=nil
+  def self.parse html, origin = nil
     parse! html, origin
   rescue NoOpenGraphDataError, InvalidObjectError
   end

data/spec/fixtures/test_cases/image_alt_before_image.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta property="og:title" content="title">
+    <meta property="og:description" content="desc">
+    <meta property="og:url" content="https://example.com">
+
+    <meta property="og:image:alt" content="image:alt">
+    <meta property="og:image" content="https://example.com/example.png">
+  </head>
+  <body></body>
+</html>