link-preview 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGRiMDRjOTI2ODE4MTQzZDBlNDdlNjBjZjMzN2Q3NmU4Mjk4N2YxMA==
+  data.tar.gz: !binary |-
+    NzdhYTkyMmYwNGQwMDAzYzE3NTNjZDdhY2U1ZmRjNTJlZmEzZDU5Mg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NGI4ODQyMjU3MzhhMGQ0MThmYjE3ODk1NjBiNjg3ZTNhMTMwOGUyMDQ2MDgx
+    ZTU3NTlmY2E3MDlmYmY5NTk1NTgxNDdjNjliMWM1Mzc4YjEwYTEyOGM3OWYy
+    ZjljM2Y0ODUzMTU4Y2U1NTIxNmM0OTNmYWE0OWUwN2ZjZGE2YmI=
+  data.tar.gz: !binary |-
+    M2UyYjI2ZWM2ODIyYzU1MzMwOTk0NjgyMTA4Y2MxN2ViOTcxNzM0ODI1NGMw
+    Zjg1OTgxNmVmMDE4MjE3MWY0OTBiZTFiM2UzNjNiMTk3ZTZhMzJlMWI4N2M4
+    MTY4NDJmMzhiYjE5NDdjMmJkOGFkNjI2YTlmMzA5ZWVlYTBkMDc=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in link_preview.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tomas D'Stefano
+
+MIT License
+
+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.md

@@ -0,0 +1,53 @@
+# LinkPreview
+
+Link preview feature find open graph or normal meta tags.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'link-preview'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install link-preview
+
+## Usage
+
+```ruby
+   page = LinkPreview::Page.new('http://globoesporte.globo.com/futebol/times/corinthians/noticia/2013/06/sheik-cobra-responsabilidade-dos-companheiros-durante-folga.html')
+
+   # Return the title of the page
+   #
+   page.title
+
+   # Return the description of the page.
+   #
+   page.description
+
+   # Return all images from page
+   #
+   page.images
+
+   # Return the favicon link
+   #
+   page.favicon
+
+   # Return the uri
+   #
+   page.uri
+```
+
+Obs.: The Page class is compatible with Active Model Serializers, :).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/link_preview.rb

@@ -0,0 +1,14 @@
+require 'link_preview/version'
+require 'httparty'
+require 'nokogiri'
+require 'active_support/core_ext/object'
+
+module LinkPreview
+  autoload :ExternalDescription, 'link_preview/external_description'
+  autoload :ExternalFavicon,     'link_preview/external_favicon'
+  autoload :ExternalImage,       'link_preview/external_image'
+  autoload :ExternalResource,    'link_preview/external_resource'
+  autoload :ExternalTitle,       'link_preview/external_title'
+  autoload :Parser,              'link_preview/parser'
+  autoload :Page,                'link_preview/page'
+end

data/lib/link_preview/external_description.rb

@@ -0,0 +1,23 @@
+module LinkPreview
+  class ExternalDescription < ExternalResource
+    attr_reader :document
+
+    def initialize(document)
+      @document = document
+
+      super(text.to_s)
+    end
+
+    def text
+      open_graph_description || meta_description
+    end
+
+    def open_graph_description
+      find_value(document.css("*[property~='og:description']").first)
+    end
+
+    def meta_description
+      find_value(document.css("*[name~='description']").first)
+    end
+  end
+end

data/lib/link_preview/external_favicon.rb

@@ -0,0 +1,28 @@
+module LinkPreview
+  class ExternalFavicon < ExternalImage
+    attr_reader :uri, :document, :favicon_element, :itemprop_element, :open_graph_element
+
+    def initialize(uri, document)
+      @uri      = uri
+      @document = document
+
+      super(uri, favicon_path.to_s)
+    end
+
+    def favicon_path
+      find_value(open_graph_element) || favicon_element['href'] || find_value(itemprop_element)
+    end
+
+    def open_graph_element
+      @open_graph_element ||= document.css("*[property~='og:image']").first
+    end
+
+    def favicon_element
+      @favicon_element ||= document.css("*[rel~='icon']").first || {}
+    end
+
+    def itemprop_element
+      @itemprop_element ||= document.css("*[itemprop~='image']").first
+    end
+  end
+end

data/lib/link_preview/external_image.rb

@@ -0,0 +1,28 @@
+module LinkPreview
+  class ExternalImage < ExternalResource
+    attr_reader :image_path
+
+    def self.parse(uri, document)
+      document.css("img").collect { |image|
+        self.new(uri, image.attributes['src'].value) if image.attributes['src'].present?
+      }
+    end
+
+    def initialize(uri, image_path)
+      @uri        = uri
+      @image_path = image_path
+
+      super(path)
+    end
+
+    def path
+      return '' if image_path.blank?
+
+      if URI.regexp !~ image_path
+        "#{File.join(@uri, image_path)}"
+      else
+        image_path
+      end
+    end
+  end
+end

data/lib/link_preview/external_resource.rb

@@ -0,0 +1,7 @@
+module LinkPreview
+  class ExternalResource < String
+    def find_value(element)
+      element.attributes['content'] if element.present?
+    end
+  end
+end

data/lib/link_preview/external_title.rb

@@ -0,0 +1,13 @@
+module LinkPreview
+  class ExternalTitle < ExternalResource
+    def initialize(document)
+      @document = document
+
+      super(text)
+    end
+
+    def text
+      find_value(@document.css("*[property~='og:title']").first) || @document.css('title').text
+    end
+  end
+end

data/lib/link_preview/page.rb

@@ -0,0 +1,4 @@
+module LinkPreview
+  class Page < Parser
+  end
+end

data/lib/link_preview/parser.rb

@@ -0,0 +1,76 @@
+module LinkPreview
+  class Parser < Hash
+    attr_reader :document, :title, :images, :uri
+
+    def initialize(uri)
+      @uri = uri
+
+      super()
+    end
+
+    # Parse title, favicon and images from an external page.
+    #
+    def parse!
+      merge!(link: @uri, title: title, favicon: favicon, images: images, type: type, description: description)
+    rescue StandardError => exception
+      merge!(error: exception.message)
+    end
+
+    # @return [True, False] return false if self contain error node. True otherwise.
+    #
+    def valid?
+      self[:error].blank?
+    end
+
+    # Return the title from HTML document.
+    #
+    # @return [String]
+    #
+    def title
+      LinkPreview::ExternalTitle.new(document)
+    end
+
+    # Return the description from HTML document.
+    #
+    # @return [String]
+    #
+    def description
+      LinkPreview::ExternalDescription.new(document)
+    end
+
+    # For now all links are considering external.
+    # In the future this could be: external, youtube, images.
+    #
+    def type
+      'external'
+    end
+
+    # Return the absolute path from a favicon element.
+    #
+    # @return [String]
+    #
+    def favicon
+      @favicon ||= LinkPreview::ExternalFavicon.new(uri, document)
+    end
+
+    # Return all images from the page.
+    #
+    # @return [Array]
+    #
+    def images
+      @images ||= LinkPreview::ExternalImage.parse(uri, document).unshift(favicon).reject(&:blank?)
+    end
+
+    # Convenience method to be used in the active model serializers.
+    #
+    def read_attribute_for_serialization(attribute)
+      self[attribute.to_sym]
+    end
+
+    private
+
+    def document
+      @document ||= Nokogiri::HTML(HTTParty.get(@uri))
+    end
+  end
+end

data/lib/link_preview/version.rb

@@ -0,0 +1,3 @@
+module LinkPreview
+  VERSION = "0.0.3"
+end

data/link_preview.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'link_preview/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "link-preview"
+  spec.version       = LinkPreview::VERSION
+  spec.authors       = ["Tomas D'Stefano"]
+  spec.email         = ["tomas_stefano@successoft.com"]
+  spec.description   = %q{Link Preview parser feature.}
+  spec.summary       = %q{Link Preview parser feature.}
+  spec.homepage      = "https://github.com/tomas-stefano/link_preview"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency 'rspec'
+end

data/spec/link_preview/parser_spec.rb

@@ -0,0 +1,229 @@
+require 'spec_helper'
+
+module LinkPreview
+  describe Parser do
+    let(:html) do
+      %{<html>
+          <head>
+            <title>Foobar</title>
+            <link rel='icon' href='/favicon.ico'>
+          </head>
+          <body>
+            <p>Hello World</p>
+            <a href='/foo' rel='nofollow'>Foo</a>
+          </body>
+        </html>
+      }
+    end
+    let(:link_preview_parser) { Parser.new('http://foobar.com') }
+
+    before  { HTTParty.stub(:get).and_return(html) }
+
+    describe '#title' do
+      context 'when title is nil' do
+        let(:html) { '<html><head></head><body><p>Hello World</p></body></html>' }
+        subject { link_preview_parser.title }
+
+        it { should eq '' }
+      end
+
+      context 'when the page had title' do
+        subject { link_preview_parser.title }
+
+        it { should eq 'Foobar' }
+      end
+    end
+
+    describe '#favicon' do
+      context 'when had favicon' do
+        subject { link_preview_parser.favicon }
+
+        it { should eq 'http://foobar.com/favicon.ico' }
+      end
+
+      context 'when had other implementation of favicon' do
+        let(:html) do
+          %{<html>
+              <head>
+                <title>Google</title>
+                <meta itemprop="image" content="/images/google_favicon_128.png">
+              </head>
+              <body>
+                <p>Google Search</p>
+              </body>
+            </html>
+          }
+        end
+        subject { Parser.new('http://google.com').favicon }
+
+        it { should eq 'http://google.com/images/google_favicon_128.png' }
+      end
+
+      context 'when favicon is a link to other domain' do
+        let(:html) do
+          %{<html>
+              <head>
+                <title>Globo</title>
+                <link rel="icon" href="http://s.glbimg.com/es/ge/static/globoesporte/img/favicon.png">
+              </head>
+              <body>
+                <p>Google Search</p>
+              </body>
+            </html>
+          }
+        end
+        subject { Parser.new('http://globoesporte.com').favicon }
+
+        it { should eq 'http://s.glbimg.com/es/ge/static/globoesporte/img/favicon.png' }
+      end
+
+      context 'when do not had favicon' do
+        let(:html) { '<html><head></head><body><p>Hello World</p></body></html>' }
+        subject    { link_preview_parser.favicon }
+
+        it { should eq '' }
+      end
+    end
+
+    describe '#images' do
+      subject { link_preview_parser.images }
+
+      context 'when contain images from domain' do
+        let(:html) do
+          %{<html>
+              <head>
+                <title>Foobar</title>
+              </head>
+              <body>
+                <p>Hello World</p>
+                <img src='/foo.png' />
+              </body>
+            </html>
+          }
+        end
+
+        it { should eq ['http://foobar.com/foo.png'] }
+      end
+
+      context 'when contain images from the request domain' do
+        subject { Parser.new('trello.com').images }
+
+        let(:html) do
+          %{<html>
+              <head>
+                <title>Foobar</title>
+              </head>
+              <body>
+                <p>Hello World</p>
+                <img src='/foo.png' />
+              </body>
+            </html>
+          }
+        end
+
+        it { should eq ['trello.com/foo.png'] }
+      end
+
+      context 'when contain images from other domain' do
+        let(:html) do
+          %{<html>
+              <head>
+                <title>Foobar</title>
+              </head>
+              <body>
+                <p>Hello World</p>
+                <img src='http://youtube.com/foo.png' />
+              </body>
+            </html>
+          }
+        end
+
+        it { should eq ['http://youtube.com/foo.png'] }
+      end
+
+      context 'when contain images without src attribute' do
+        let(:html) do
+          %{<html>
+              <head>
+                <title>Foobar</title>
+              </head>
+              <body>
+                <p>Hello World</p>
+                <img />
+              </body>
+            </html>
+          }
+        end
+
+        it { should eq [] }
+      end
+    end
+
+    describe '#parse!' do
+      context 'merge the properties' do
+        let(:html) do
+          %{<html>
+              <head>
+                <title>GitHub - Build software better, together.</title>
+                <link rel='icon' href='/favicon.ico'>
+              </head>
+              <body>
+                <p>Hello World</p>
+                <img src="https://a248.e.akamai.net/assets.github.com/images/network.png?1355422571" />
+              </body>
+            </html>
+          }
+        end
+        subject { Parser.new('github.com').parse! }
+
+        it { should eq({ link: 'github.com', type: 'external', title: 'GitHub - Build software better, together.', favicon: 'github.com/favicon.ico', images: ['github.com/favicon.ico', 'https://a248.e.akamai.net/assets.github.com/images/network.png?1355422571'], description: ''}) }
+      end
+
+      context 'when raises exception trying to access the page' do
+        subject { link_preview_parser.parse! }
+        before { HTTParty.should_receive(:get).and_raise(Errno::ECONNREFUSED) }
+
+        it { should eq({ error: 'Connection refused' }) }
+      end
+
+      context 'with open graph content' do
+        let(:html) do
+          %{
+            <html>
+              <head>
+                <meta property="og:title" content="globoesporte.com">
+                <meta property="og:type" content="website">
+                <meta property="og:url" content="globoesporte.globo.com">
+                <meta property="og:image" content="http://s.glbimg.com/es/ge/static/globoesporte/img/logo-globoesporte-facebook.jpg">
+                <meta property="og:site_name" content="globoesporte.com">
+                <meta property="og:description" content="globoesporte.com a melhor cobertura sobre o Futebol.">
+              </head>
+            </html>
+          }
+        end
+        subject { Parser.new('globoesporte.com') }
+        before { subject.parse! }
+
+        its([:title]) { should eq 'globoesporte.com' }
+        its([:description]) { should eq 'globoesporte.com a melhor cobertura sobre o Futebol.' }
+        its([:images]) { should eq ['http://s.glbimg.com/es/ge/static/globoesporte/img/logo-globoesporte-facebook.jpg'] }
+      end
+    end
+
+    describe '#valid?' do
+      subject { Parser.new('http://github.com') }
+
+      context 'when parse page' do
+        before { subject[:link] = 'foo' }
+
+        it { should be_valid }
+      end
+
+      context 'when raises error parsing page' do
+        before { subject[:error] = 'SSL_connect state=SSLv3 bad ecpoint' }
+
+        it { should_not be_valid }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: link-preview
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Tomas D'Stefano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Link Preview parser feature.
+email:
+- tomas_stefano@successoft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/link_preview.rb
+- lib/link_preview/external_description.rb
+- lib/link_preview/external_favicon.rb
+- lib/link_preview/external_image.rb
+- lib/link_preview/external_resource.rb
+- lib/link_preview/external_title.rb
+- lib/link_preview/page.rb
+- lib/link_preview/parser.rb
+- lib/link_preview/version.rb
+- link_preview.gemspec
+- spec/link_preview/parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tomas-stefano/link_preview
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Link Preview parser feature.
+test_files:
+- spec/link_preview/parser_spec.rb
+- spec/spec_helper.rb