link_previewer 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGQ3NjlkMWQ0MDY5ZDU5ZTc5ZDg0MTA5NTg1MjY5NTljZmNjNzg3NA==
+  data.tar.gz: !binary |-
+    MDQ4YWM0NmYzM2YyMmNkN2UwMWNkMzJhNWZkMjlhNmRlOWNlNzI1YQ==
+SHA512:
+  metadata.gz: !binary |-
+    MGVjMjI0YWY3ZjljZTZhMGUyNDcyZDRjZjljM2NmNzM2NDc2YTFhNmM1ODkw
+    YTI0NGY2MTQ0OTY2NjllMjZjY2EyNzgwNGYyNDVkMzdkMDc2NzcxZDA4ZTRk
+    MDhhNDJkYjgxZjIxM2FkNjk1NjA4MmM1ZmNmYTY0ZThjNWQ1YjI=
+  data.tar.gz: !binary |-
+    YzNjNDMwYjQ2MzM5ZmZjMjUzY2M5NTVkNWMwNGJkM2JiMDg4ODI2OTRjNDk4
+    Nzg4ZDk3ZDNlMDdlMmUxOWUwNzRhMGU1ZDU0NjUwYTI4ZGVlYmUxYmVlMWU5
+    ZmYyMjE0YjQzNDk1ODI5MzY5NjVhNmRjYjQ4NDFjN2JkNzU0OWU=

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/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 1.9.3
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - my@email.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lucas Polonio
+
+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,33 @@
+[![Build Status](https://travis-ci.org/lucaspolonio/link_previewer.svg?branch=master)](https://travis-ci.org/lucaspolonio/link_previewer)
+[![Code Climate](https://codeclimate.com/github/lucaspolonio/link_previewer.png)](https://codeclimate.com/github/lucaspolonio/link_previewer)
+
+# LinkPreviewer - alpha
+
+Ruby gem that generates URL previews similarly to what happens when you paste a link on facebook chat.
+Tries to detect the best title, description and images to preview a link.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'link_previewer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install link_previewer
+
+## Usage
+
+TODO
+
+## Contributing
+
+1. Fork it ( http://github.com/lucaspolonio/link_previewer/fork )
+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,11 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = "spec/**/*_spec.rb"
+  task.rspec_opts = ['--color']
+end
+
+task :default => :spec

data/lib/link_previewer.rb

@@ -0,0 +1,6 @@
+require 'link_previewer/version'
+require 'link_previewer/parser'
+require 'link_previewer/previewer'
+
+module LinkPreviewer
+end

data/lib/link_previewer/parser.rb

@@ -0,0 +1,34 @@
+require 'nokogiri'
+require 'open-uri'
+
+module LinkPreviewer
+  class Parser
+
+    def initialize(url)
+      @nokogiri_html = Nokogiri::HTML(open(url))
+    end
+
+    def tag_contents(tag)
+      el = @nokogiri_html.css(tag).first
+      el.content if el
+    end
+
+    def meta_tag_contents(meta_tag_selector)
+      el = @nokogiri_html.css(meta_tag_selector).first
+      el.attr('content') if el
+    end
+
+    def meta_tag_contents_by_property(property)
+      meta_tag_contents "meta[@property='#{property}']"
+    end
+
+    def meta_tag_contents_by_name(name)
+      meta_tag_contents "meta[name='#{name}']"
+    end
+
+    def image_src(css_selector)
+      @nokogiri_html.css(css_selector).map{|el| el['src']}
+    end
+
+  end
+end

data/lib/link_previewer/previewer.rb

@@ -0,0 +1,38 @@
+module LinkPreviewer
+  class Previewer
+
+    def initialize(url)
+      @parser = Parser.new(url)
+    end
+
+    def title
+      if (og_title = @parser.meta_tag_contents_by_property 'og:title') 
+        return og_title
+      elsif (twitter_title = @parser.meta_tag_contents_by_property 'twitter:title')
+        return twitter_title
+      elsif (meta_title = @parser.tag_contents 'title')
+        return meta_title
+      end
+    end
+
+    def description
+      if (og_description = @parser.meta_tag_contents_by_property 'og:description')
+        return og_description
+      elsif (twitter_description = @parser.meta_tag_contents_by_property 'twitter:description')
+        return twitter_description
+      elsif (meta_description = @parser.meta_tag_contents_by_name 'description')
+        return meta_description
+      end
+    end
+
+    def images
+      images = []
+      if (og_image = @parser.meta_tag_contents_by_property 'og:image')
+        return images << og_image
+      elsif (twitter_image = @parser.meta_tag_contents_by_property 'twitter:image')
+        return images << twitter_image
+      end
+    end
+
+  end
+end

data/lib/link_previewer/version.rb

@@ -0,0 +1,3 @@
+module LinkPreviewer
+  VERSION = "0.0.1.alpha"
+end

data/link_previewer.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'link_previewer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "link_previewer"
+  spec.version       = LinkPreviewer::VERSION
+  spec.authors       = ["Lucas Polonio"]
+  spec.email         = ["polonio.lucas@gmail.com"]
+  spec.summary       = "A facebook-style link previewer."
+  spec.description   = "A facebook-style link previewer (title, description and images)."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "nokogiri"
+  spec.add_development_dependency "webmock"
+  
+end

data/spec/fixtures/normal.html

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+
+    <title>Page title</title>
+    <meta name="description" content="Page description">
+
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href='http://fonts.googleapis.com/css?family=Roboto:300' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
+    <link rel="stylesheet" href="main.css">
+  </head>
+  <body>
+    <div class="container">
+      <div class="row">
+        example
+        <img id="first_image" src="image.jpg">
+      </div>
+    </div>
+  </body>
+</html>

data/spec/fixtures/opengraph.html

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+
+    <title>Page title</title>
+    <meta name="description" content="Page description">
+    <meta property="twitter:title" content="Page Twitter Tag title" />
+    <meta property="twitter:description" content="Page Twitter Tag description" />
+    <meta property="twitter:image" content="twitter-image.jpg" />
+    <meta property="og:title" content="Page Open Graph title" />
+    <meta property="og:description" content="Page Open Graph description" />
+    <meta property="og:image" content="opengraph-image.jpg" />
+
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href='http://fonts.googleapis.com/css?family=Roboto:300' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
+    <link rel="stylesheet" href="main.css">
+  </head>
+  <body>
+    <div class="container">
+      <div class="row">
+        example
+        <img id="first_image" src="image.jpg">
+      </div>
+    </div>
+  </body>
+</html>

data/spec/fixtures/twitter.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+
+    <title>Page title</title>
+    <meta name="description" content="Page description">
+    <meta property="twitter:title" content="Page Twitter Tag title" />
+    <meta property="twitter:description" content="Page Twitter Tag description" />
+    <meta property="twitter:image" content="twitter-image.jpg" />
+
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href='http://fonts.googleapis.com/css?family=Roboto:300' rel='stylesheet' type='text/css'>
+    <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
+    <link rel="stylesheet" href="main.css">
+  </head>
+  <body>
+    <div class="container">
+      <div class="row">
+        example
+        <img id="first_image" src="image.jpg">
+      </div>
+    </div>
+  </body>
+</html>

data/spec/parser_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module LinkPreviewer
+  class Parser
+
+    describe Parser do
+
+      let(:og_parser) { Parser.new('http://www.opengraph-example.com') }
+      let(:redirected_parser) { Parser.new('http://www.redirect-example.com') }
+
+      it 'gets contents of an HTML tag' do
+        expect(og_parser.tag_contents 'title').to eq('Page title')
+      end
+
+      it 'gets image src from selector' do
+        expect(og_parser.image_src('#first_image').first).to eq('image.jpg')
+      end
+
+      it 'gets meta tags contents' do 
+        expect(og_parser.meta_tag_contents "meta[@property='og:description']").to eq('Page Open Graph description')
+        expect(og_parser.meta_tag_contents "meta[name='description']").to eq('Page description')
+        expect(og_parser.meta_tag_contents_by_property 'og:description').to eq('Page Open Graph description')
+        expect(og_parser.meta_tag_contents_by_name 'description').to eq('Page description')
+      end
+
+      it 'follows redirects' do
+        expect(redirected_parser.tag_contents 'title').to eq('Page title')
+      end
+
+    end
+
+  end
+end

data/spec/previewer_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module LinkPreviewer
+  class Previewer
+
+    describe Previewer do
+
+      let(:previewer) { Previewer.new('http://www.example.com') }
+      let(:previewer_twitter) { Previewer.new('http://www.twitter-tag-example.com') }
+      let(:previewer_open_graph) { Previewer.new('http://www.opengraph-example.com') }
+
+      describe '#title' do
+        it 'gets a meta tag title' do
+          expect(previewer.title).to eq('Page title')
+        end
+        it 'gives twitter tags higher priority on titles' do
+          expect(previewer_twitter.title).to eq('Page Twitter Tag title')
+        end
+        it 'gives opengraph tags even higher priority on titles' do
+          expect(previewer_open_graph.title).to eq('Page Open Graph title')
+        end
+      end
+
+      describe '#description' do
+        it 'gets a meta tag description' do
+          expect(previewer.description).to eq('Page description')
+        end
+        it 'gives twitter tags higher priority on descriptions' do
+          expect(previewer_twitter.description).to eq('Page Twitter Tag description')
+        end
+        it 'gives opengraph tags even higher priority on descriptions' do
+          expect(previewer_open_graph.description).to eq('Page Open Graph description')
+        end
+      end
+
+      describe '#images' do
+        it 'gives twitter tags high priority on images' do
+          expect(previewer_twitter.images.first).to eq('twitter-image.jpg')
+        end
+        it 'gives opengraph tags even higher priority on images' do
+          expect(previewer_open_graph.images.first).to eq('opengraph-image.jpg')
+        end
+        it 'previews webpages images' do
+          #expect(previewer.images.size).to eq(1)
+          #expect(previewer.images.first).to eq('image.jpg')
+          pending
+          fail
+        end
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'pry'
+require 'webmock/rspec'
+require 'link_previewer'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:get, 'www.example.com').to_return(status: 200, body: File.new('spec/fixtures/normal.html'))
+    stub_request(:get, 'www.twitter-tag-example.com').to_return(status: 200, body: File.new('spec/fixtures/twitter.html'))
+    stub_request(:get, 'www.opengraph-example.com').to_return(status: 200, body: File.new('spec/fixtures/opengraph.html'))
+    stub_request(:get, 'www.redirect-example.com').to_return(:status => 301, :headers => {'Location' => 'http://www.example.com'})
+  end
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: link_previewer
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- Lucas Polonio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  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: guard
+  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: guard-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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-remote
+  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: pry-nav
+  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: nokogiri
+  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: webmock
+  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: A facebook-style link previewer (title, description and images).
+email:
+- polonio.lucas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/link_previewer.rb
+- lib/link_previewer/parser.rb
+- lib/link_previewer/previewer.rb
+- lib/link_previewer/version.rb
+- link_previewer.gemspec
+- spec/fixtures/normal.html
+- spec/fixtures/opengraph.html
+- spec/fixtures/twitter.html
+- spec/parser_spec.rb
+- spec/previewer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A facebook-style link previewer.
+test_files:
+- spec/fixtures/normal.html
+- spec/fixtures/opengraph.html
+- spec/fixtures/twitter.html
+- spec/parser_spec.rb
+- spec/previewer_spec.rb
+- spec/spec_helper.rb