opengraph_parser 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Huy Ha
+
+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.rdoc

@@ -0,0 +1,45 @@
+= OpengraphParser
+
+OpengraphParser is a simple Ruby library for parsing Open Graph protocol information from a web site. Learn more about the protocol at:
+http://ogp.me
+
+== Installation
+  gem install opengraph_parser
+
+or add to Gemfile
+
+  gem "opengraph_parser"
+
+== Usage
+  og = OpenGraph.new("http://ogp.me")
+  og.title # => "Open Graph protocol"
+  og.type # => "website"
+  og.url # => "http://ogp.me/"
+  og.description # => "The Open Graph protocol enables any web page to become a rich object in a social graph."
+  og.images # => ["http://ogp.me/logo.png"]
+
+You can also get other Open Graph metadata as:
+  og.metadata # => {"og:image:type"=>"image/png", "og:image:width"=>"300", "og:image:height"=>"300"}
+
+If you try to parse Open Graph information for a website that doesn’t have any Open Graph metadata, the library will try to find other information in the website as the following rules:
+  <title> for title
+  <meta name="description"> for description
+  <link rel="image_src"> or all <img> tags for images
+
+You can disable this fallback lookup by passing false to init method:
+  og = OpenGraph.new("http://ogp.me", false)
+
+== Contributing to opengraph_parser
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Huy Ha. See LICENSE.txt for
+further details.

data/lib/open_graph.rb

@@ -0,0 +1,85 @@
+require 'nokogiri'
+require 'redirect_follower'
+
+class OpenGraph
+  attr_accessor :src, :url, :type, :title, :description, :images, :metadata, :response
+
+  def initialize(src, fallback = true)
+    @src = src
+    @images = []
+    @metadata = {}
+    parse_opengraph
+    load_fallback if fallback
+    check_images_path
+  end
+
+  def parse_opengraph
+    begin
+      @response = RedirectFollower.new(@src).resolve
+    rescue
+      @title = @url = @src
+      return
+    end
+
+    if @response && @response.body
+      attrs_list = %w(title url type description)
+      doc = Nokogiri.parse(@response.body)
+      doc.css('meta').each do |m|
+        if m.attribute('property') && m.attribute('property').to_s.match(/^og:(.+)$/i)
+          m_content = m.attribute('content').to_s.strip
+          case metadata_name = m.attribute('property').to_s.gsub("og:", "")
+            when *attrs_list
+              self.instance_variable_set("@#{metadata_name}", m_content) unless m_content.empty?
+            when "image"
+              add_image(m_content)
+            else
+              @metadata[m.attribute('property').to_s] = m_content
+          end
+        end
+      end
+    end
+  end
+
+  def load_fallback
+    if @response && @response.body
+      doc = Nokogiri.parse(@response.body)
+
+      if @title.to_s.empty? && doc.xpath("//head/title").size > 0
+        @title = doc.xpath("//head/title").first.text.to_s.strip
+      end
+
+      @url = @src if @url.to_s.empty?
+
+      if @description.to_s.empty? && description_meta = doc.xpath("//head/meta[@name='description']").first
+        @description = description_meta.attribute("content").to_s.strip
+      end
+
+      fetch_images(doc, "//head/link[@rel='image_src']", "href") if @images.empty?
+      fetch_images(doc, "//img", "src") if @images.empty?
+    end
+  end
+
+  def check_images_path
+    uri = URI.parse(URI.escape(@src))
+    imgs = @images.dup
+    @images = []
+    imgs.each do |img|
+      if URI.parse(URI.escape(img)).host.nil?
+        add_image("#{uri.scheme}://#{uri.host}:#{uri.port}#{img}")
+      else
+        add_image(img)
+      end
+    end
+  end
+
+  private
+  def add_image(image_url)
+    @images << image_url unless @images.include?(image_url) || image_url.to_s.empty?
+  end
+
+  def fetch_images(doc, xpath_str, attr)
+    doc.xpath(xpath_str).each do |link|
+      add_image(link.attribute(attr).to_s.strip)
+    end
+  end
+end

data/lib/opengraph_parser.rb

@@ -0,0 +1 @@
+require 'open_graph'

data/lib/redirect_follower.rb

@@ -0,0 +1,34 @@
+require 'net/http'
+
+class RedirectFollower
+  class TooManyRedirects < StandardError; end
+
+  attr_accessor :url, :body, :redirect_limit, :response
+
+  def initialize(url, limit = 5)
+    @url, @redirect_limit = url, limit
+  end
+
+  def resolve
+    raise TooManyRedirects if redirect_limit < 0
+
+    self.response = Net::HTTP.get_response(URI.parse(URI.escape(url)))
+
+    if response.kind_of?(Net::HTTPRedirection)
+      self.url = redirect_url
+      self.redirect_limit -= 1
+      resolve
+    end
+
+    self.body = response.body
+    self
+  end
+
+  def redirect_url
+    if response['location'].nil?
+      response.body.match(/<a href=\"([^>]+)\">/i)[1]
+    else
+      response['location']
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: opengraph_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Huy Ha
+- Duc Trinh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70116370351140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70116370351140
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70116370350460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70116370350460
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70116370349400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70116370349400
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70116370365040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70116370365040
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70116370364240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70116370364240
+description: A simple Ruby library for parsing Open Graph Protocol information from
+  a website. It also includes a fallback solution when the website has no Open Graph
+  information.
+email: hhuy424@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- lib/open_graph.rb
+- lib/opengraph_parser.rb
+- lib/redirect_follower.rb
+- LICENSE.txt
+- README.rdoc
+homepage: http://github.com/huyha85/opengraph_parser
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2116295098415564887
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A simple Ruby library for parsing Open Graph Protocol information from a
+  website.
+test_files: []