open_graph_reader 0.4.0 → 0.5.0

data/lib/open_graph_reader/fetcher.rb

@@ -1,14 +1,14 @@
-require 'faraday'
+require "faraday"
 
 begin
-  require 'faraday_middleware/response/follow_redirects'
+  require "faraday_middleware/response/follow_redirects"
 rescue LoadError; end
 
 begin
-  require 'faraday/cookie_jar'
+  require "faraday/cookie_jar"
 rescue LoadError; end
 
-require 'open_graph_reader/version'
+require "open_graph_reader/version"
 
 module OpenGraphReader
   # Fetch an URI to retrieve its HTML body, if available.
@@ -16,8 +16,8 @@ module OpenGraphReader
   # @api private
   class Fetcher
     HEADERS = {
-      'Accept'     => 'text/html',
-      'User-Agent' => "OpenGraphReader/#{OpenGraphReader::VERSION} (+https://github.com/jhass/open_graph_reader)"
+      "Accept"     => "text/html",
+      "User-Agent" => "OpenGraphReader/#{OpenGraphReader::VERSION} (+https://github.com/jhass/open_graph_reader)"
     }.freeze
 
     # Create a new fetcher.
@@ -29,13 +29,8 @@ module OpenGraphReader
       @connection = Faraday.default_connection.dup
       @connection.headers.replace(HEADERS)
 
-      if defined? Faraday::CookieJar
-        prepend_middleware Faraday::CookieJar
-      end
-
-      if defined? FaradayMiddleware
-        prepend_middleware FaradayMiddleware::FollowRedirects
-      end
+      prepend_middleware Faraday::CookieJar if defined? Faraday::CookieJar
+      prepend_middleware FaradayMiddleware::FollowRedirects if defined? FaradayMiddleware
     end
 
     # The URL to fetch
@@ -81,8 +76,8 @@ module OpenGraphReader
       response = @get_response || @head_response
       return false unless response
       return false unless response.success?
-      return false unless response['content-type']
-      response['content-type'].include? 'text/html'
+      return false unless response["content-type"]
+      response["content-type"].include? "text/html"
     end
 
     # Whether the target URI was fetched.
@@ -103,9 +98,9 @@ module OpenGraphReader
     private
 
     def prepend_middleware middleware
-      unless @connection.builder.handlers.include? middleware
-        @connection.builder.insert(0, middleware)
-      end
+      return if @connection.builder.handlers.include? middleware
+
+      @connection.builder.insert(0, middleware)
     end
   end
 end

data/lib/open_graph_reader/object.rb

@@ -1,9 +1,8 @@
-require 'open_graph_reader/object/registry'
-require 'open_graph_reader/object/dsl'
-require 'open_graph_reader/object/dsl/types'
+require "open_graph_reader/object/registry"
+require "open_graph_reader/object/dsl"
+require "open_graph_reader/object/dsl/types"
 
 module OpenGraphReader
-
   # This module provides the base functionality for all OpenGraph objects
   # and makes the {DSL} methods for describing them available when included.
   #
@@ -37,7 +36,6 @@ module OpenGraphReader
     # @return [{String => Array<String, Object>}]
     attr_reader :children
 
-
     # Create a new object. If your class overrides this don't forget to call <tt>super</tt>.
     def initialize
       @properties = {}
@@ -48,7 +46,7 @@ module OpenGraphReader
     #
     # @param [#to_s] name
     # @return [Bool]
-    def has_property? name
+    def property? name
       self.class.available_properties.include? name.to_s
     end
 
@@ -70,8 +68,8 @@ module OpenGraphReader
     # @raise [UndefinedPropertyError] If the requested property is undefined.
     # @return [String, Object]
     def [] name
-      raise UndefinedPropertyError, "Undefined property #{name} on #{inspect}" unless has_property? name
-      public_send name.to_s #properties[name.to_s]
+      raise UndefinedPropertyError, "Undefined property #{name} on #{inspect}" unless property? name
+      public_send name.to_s
     end
 
     # Set the property to the given value.
@@ -81,7 +79,7 @@ module OpenGraphReader
     # @param [String, Object] value
     # @raise [UndefinedPropertyError] If the requested property is undefined.
     def []= name, value
-      if has_property?(name)
+      if property?(name)
         public_send "#{name}=", value
       elsif OpenGraphReader.config.strict
         raise UndefinedPropertyError, "Undefined property #{name} on #{inspect}"

data/lib/open_graph_reader/object/dsl.rb

@@ -1,4 +1,4 @@
-require 'open_graph_reader/object/registry'
+require "open_graph_reader/object/registry"
 
 module OpenGraphReader
   module Object
@@ -36,49 +36,72 @@ module OpenGraphReader
           options = args.pop if args.last.is_a? Hash
           options ||= {}
 
-          available_properties << name.to_s
-          required_properties << name.to_s if options[:required]
-          Registry.register [@namespace, name].join(':'), options[:to] if options[:to]
-
-          if options[:verticals]
-            options[:verticals].each do |vertical|
-              vertical = [@namespace, vertical].join('.')
-              verticals[vertical] << name.to_s
-              Registry.verticals <<  vertical
-            end
-          end
+          register_property name, options
+          register_verticals name, options[:verticals]
 
           if options[:collection]
-            define_method("#{name}s") do
-              children[name.to_s]
-            end
-
-            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 || options[:default]
-            end
+            define_collection name, options
           else
-            define_method(name) do
-              properties[name.to_s] || options[:default]
-            end
-
-            define_method("#{name}=") do |value|
-              # @todo figure out a sane way to distinguish subobject properties
-              unless value.is_a? Object
-                value.downcase! if options[:downcase]
-                value = processor.call(value, *args, options)
-              end
-              properties[name.to_s] = value
-            end
+            define_single name, options, args, processor
           end
         end
       end
 
+      # @api private
+      def register_property name, options
+        available_properties << name.to_s
+        required_properties << name.to_s if options[:required]
+        Registry.register [namespace, name].join(":"), options[:to] if options[:to]
+      end
+
+      # @api private
+      def register_verticals name, assigned_verticals
+        [*assigned_verticals].each do |vertical|
+          vertical = [namespace, vertical].join(".")
+          verticals[vertical] << name.to_s
+          Registry.verticals << vertical
+        end
+      end
+
+      # @api private
+      def define_collection name, options
+        define_method("#{name}s") do
+          children[name.to_s]
+        end
+
+        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 || options[:default]
+        end
+      end
+
+      # @api private
+      def define_single name, options, args, processor
+        define_method(name) do
+          properties[name.to_s] || options[:default]
+        end
+
+        define_method("#{name}=") do |value|
+          # @todo figure out a sane way to distinguish subobject properties
+          unless value.is_a? Object
+            value.downcase! if options[:downcase]
+            value = processor.call(value, *args, options)
+          end
+          properties[name.to_s] = value
+        end
+      end
+
       # Alias to trick YARD
       singleton_class.send(:alias_method, :define_type_no_doc, :define_type)
 
+      # The processor for the content attribute.
+      #
+      # @api private
+      # @return [Proc]
+      attr_reader :content_processor
+
       # @overload namespace
       #   Get the namespace of this object.
       #
@@ -91,7 +114,7 @@ module OpenGraphReader
       #     namespace :og, :image
       def namespace *names
         return @namespace if names.empty?
-        @namespace = names.join(':')
+        @namespace = names.join(":")
         Registry.register @namespace, self
       end
 
@@ -136,14 +159,6 @@ module OpenGraphReader
         @processors ||= {}
       end
 
-      # The processor for the content attribute.
-      #
-      # @api private
-      # @return [Proc]
-      def content_processor
-        @content_processor
-      end
-
       # A map from vertical names to attributes that belong to them.
       #
       # @api private

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

@@ -1,7 +1,7 @@
-require 'date'
-require 'uri'
+require "date"
+require "uri"
 
-require 'open_graph_reader/object/dsl'
+require "open_graph_reader/object/dsl"
 
 module OpenGraphReader
   module Object
@@ -19,28 +19,33 @@ module OpenGraphReader
       define_type_no_doc :url do |value, options|
         value = value.to_s
 
-        unless value.start_with?('http://') || value.start_with?('https://')
-          if options[:image] && OpenGraphReader.config.synthesize_image_url
-            unless OpenGraphReader.current_origin
-              raise ArgumentError, "Enabled image url synthesization but didn't pass an origin"
-            end
-
-            # Synthesize scheme hack to https (//example.org/foo/bar.png)
-            if value.start_with?('//') && value.split('/', 4)[2] =~ URI::HOST
-              value = "https:#{value}"
-            else # Synthesize absolute path (/foo/bar.png)
-              begin
-                value = "/#{value}" unless value.start_with? '/' # Normalize to absolute path
-                uri = URI.parse(OpenGraphReader.current_origin)
-                uri.path = value
-                value = uri.to_s
-              rescue
-                raise InvalidObjectError, "URL #{value.inspect} does not start with http:// or https:// and failed to synthesize a full URL"
-              end
-            end
-          elsif options.has_key?(:to) && OpenGraphReader.config.validate_references
-            raise InvalidObjectError, "URL #{value.inspect} does not start with http:// or https://"
+        next value if value.start_with?("http://") || value.start_with?("https://")
+
+        if options[:image] && OpenGraphReader.config.synthesize_image_url || OpenGraphReader.config.synthesize_url
+          unless OpenGraphReader.current_origin
+            next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
+
+            raise ArgumentError, "Enabled image url synthesization but didn't pass an origin"
+          end
+
+          # Synthesize scheme hack to https (//example.org/foo/bar.png)
+          next "https:#{value}" if value.start_with?("//") && value.split("/", 4)[2] =~ URI::HOST
+
+          # Synthesize absolute path (/foo/bar.png)
+          begin
+            value = "/#{value}" unless value.start_with? "/" # Normalize to absolute path
+            uri = URI.parse(OpenGraphReader.current_origin)
+            uri.path = value
+            value = uri.to_s
+          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"
           end
+        elsif options.has_key?(:to) && OpenGraphReader.config.validate_references
+          next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
+          raise InvalidObjectError, "URL #{value.inspect} does not start with http:// or https://"
         end
 
         value
@@ -50,46 +55,57 @@ module OpenGraphReader
       #   @param [Array<String>] allowed the list of allowed values
       #   @!macro define_type_description
       #   @see http://ogp.me/#enum
-      define_type_no_doc :enum do |value, allowed|
+      define_type_no_doc :enum do |value, allowed, options|
+        value = value.to_s
+
         unless allowed.include? value
+          next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
           raise InvalidObjectError, "Expected one of #{allowed.inspect} but was #{value.inspect}"
         end
 
-        value.to_s
+        value
       end
 
       # @see http://ogp.me/#integer
-      define_type :integer do  |value|
+      define_type :integer do  |value, options|
         begin
           Integer(value)
-        rescue  ArgumentError => e
+        rescue ArgumentError
+          next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
           raise InvalidObjectError, "Integer expected, but was #{value.inspect}"
         end
       end
 
       # @see http://ogp.me/#datetime
-      define_type :datetime do |value|
+      define_type :datetime do |value, options|
         begin
-          DateTime.iso8601 value
-        rescue ArgumentError => e
+          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
       end
 
       # @see http://ogp.me/#bool
-      define_type :boolean do |value|
-        {'true' => true, 'false' => false, '1' => true, '0' => false}[value].tap {|bool|
+      define_type :boolean do |value, options|
+        {"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}"
           end
         }
       end
 
       # @see http://ogp.me/#float
-      define_type :float do |value|
+      define_type :float do |value, options|
         begin
           Float(value)
-        rescue ArgumentError => e
+        rescue ArgumentError
+          next unless options[:required] || !OpenGraphReader.config.discard_invalid_optional_properties
           raise InvalidObjectError, "Float expected, but was #{value.inspect}"
         end
       end

data/lib/open_graph_reader/object/registry.rb

@@ -1,6 +1,6 @@
-require 'singleton'
-require 'forwardable'
-require 'set'
+require "singleton"
+require "forwardable"
+require "set"
 
 module OpenGraphReader
   module Object

data/lib/open_graph_reader/parser.rb

@@ -1,6 +1,6 @@
-require 'nokogiri'
+require "nokogiri"
 
-require 'open_graph_reader/parser/graph'
+require "open_graph_reader/parser/graph"
 
 module OpenGraphReader
   # Parse OpenGraph tags in a HTML document into a graph.
@@ -8,14 +8,14 @@ module OpenGraphReader
   # @api private
   class Parser
     # Some helper methods for Nokogiri
-    XPathHelpers = Class.new do
+    module XPathHelpers
       # Helper to lowercase all given properties
-      def ci_starts_with node_set, string
+      def self.ci_starts_with node_set, string
         node_set.select {|node|
           node.to_s.downcase.start_with? string.downcase
         }
       end
-    end.new
+    end
 
     # Namespaces found in the passed documents head tag
     #
@@ -35,7 +35,7 @@ module OpenGraphReader
     # Whether there are any OpenGraph tags at all.
     #
     # @return [Bool]
-    def has_tags?
+    def any_tags?
       !graph.empty?
     end
 
@@ -50,45 +50,46 @@ module OpenGraphReader
     #
     # @return [String]
     def title
-      @doc.xpath('/html/head/title').first.text
+      @doc.xpath("/html/head/title").first.text
     end
 
     private
 
     def build_graph
       graph = Graph.new
-      head = @doc.xpath('/html/head').first
+
+      meta_tags.each do |tag|
+        *path, leaf = tag["property"].downcase.split(":")
+        node = graph.find_or_create_path path
+
+        # @todo make stripping configurable?
+        node << Graph::Node.new(leaf, tag["content"].strip)
+      end
+
+      graph
+    end
+
+    def meta_tags
+      head = @doc.xpath("/html/head").first
 
       raise NoOpenGraphDataError, "There's no head tag in #{@doc}" unless head
 
+      head.xpath("meta[#{xpath_condition(head)}]", XPathHelpers)
+    end
+
+    def xpath_condition head
       condition = "ci_starts_with(@property, 'og:')"
-      if head['prefix']
-        @additional_namespaces = head['prefix'].scan(/(\w+):\s*([^ ]+)/)
+
+      if head["prefix"]
+        @additional_namespaces = head["prefix"].scan(/(\w+):\s*([^ ]+)/)
         @additional_namespaces.map! {|prefix, _| prefix.downcase }
         @additional_namespaces.each do |additional_namespace|
-          next if additional_namespace == 'og'
+          next if additional_namespace == "og"
           condition << " or ci_starts_with(@property, '#{additional_namespace}')"
         end
       end
 
-      head.xpath("meta[#{condition}]", XPathHelpers).each do |tag|
-        *path, leaf = tag['property'].downcase.split(':')
-        node = path.inject(graph.root) {|node, name|
-          child = node.children.reverse.find {|child| child.name == name }
-
-          unless child
-            child = Graph::Node.new name
-            node << child
-          end
-
-          child
-        }
-
-        # @todo make stripping configurable?
-        node << Graph::Node.new(leaf, tag['content'].strip)
-      end
-
-      graph
+      condition
     end
 
     def to_doc html