metapage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bae1882c2b1169f6554b9b26de750fe67087f09
+  data.tar.gz: 10e23f034e67140017cd0d828d84e0f38466f66d
+SHA512:
+  metadata.gz: 4a84d1afcda95d171349f35c4fa6af500d488cbfebd4a516ebfedfdd058586988a0ea4fbac9775d5f8c36d05cd8eec8bba01d549c7a89f7ae4a2f1e80d7b9b6b
+  data.tar.gz: fcd70936980172149326f7856656daf7873ac05145c862924c50568e6c5bc387a669cead087cea734b5668015a4c23917c5cbc0ec07a66dadb619ebe72d195db

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/fixtures/vcr_cassettes
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christoph Olszowka
+
+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,54 @@
+# Metapage
+
+[![Build Status](https://travis-ci.org/colszowka/metapage.svg)](https://travis-ci.org/colszowka/metapage)
+
+A tiny class for extracting title, description and some further information from given urls using [open graph](http://www.ogp.me) and regular meta tags.
+
+**Why?** For example this can be used for enriching urls submitted in a chat application.
+
+## Features
+  
+  * Fetch open graph info for a page, with fallback to regular meta tags to give *something* for most HTML urls
+  * Bulk-fetch info for any urls contained in a given text snippet
+  * Checks if the given URL's host resolves via [Google DNS](https://developers.google.com/speed/public-dns/) and
+    is not on a [private netowrk](https://en.wikipedia.org/wiki/Private_network) subnet to slow down clever people
+    from entering private urls like `http://localhost:3000/secret` to explore your network.
+
+## Installing
+
+Add `gem 'metapage'` to your `Gemfile` or `gem install metapage` on your command line.
+
+## Usage
+
+Fetch a specific URL. Returns `nil` if the content is not html or loading fails due to invalid url, http response or timeout.
+
+    Metapage.fetch('https://github.com/colszowka/simplecov').to_h
+    {:title=>"colszowka/simplecov",
+     :description=>"simplecov - Code coverage for Ruby 1.9+ with a powerful configuration library and automatic merging of coverage across test suites",
+     :image_url=>"https://avatars0.githubusercontent.com/u/13972?v=3&s=400",
+     :type=>"object",
+     :canonical_url=>"https://github.com/colszowka/simplecov",
+     :site_name=>"GitHub"}
+
+Extract urls from a given string and fetch the metadata for them. Only returns successfully retrieved results.
+
+    msg = "The text is http://github.com/colszowka/simplecov and links to http://hamburg.onruby.de?foo=bar but also to invalid http://fooooooooonoexist.com"
+    Metapage.extract(msg).map(&:title)
+    #=> ['colszowka/simplecov', 'Hamburg on Ruby - Heimathafen der Hamburger Ruby Community']
+
+Both `Metapage.fetch` and `Metapage.extract` have equivalent bang methods `fetch!` and `extract!` that will bubble HTTP or parsing exceptions instead of returning
+nil or silently ignoring invalid urls.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/colszowka/metapage/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :env do
+  require 'metapage'
+end
+
+desc "Generates examples for the readme on the fly"
+task examples: :env do
+  require 'pp'
+  cmd = "pp Metapage.fetch('https://github.com/colszowka/simplecov').to_h"
+  puts cmd
+  eval cmd
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "metapage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/metapage/version.rb

@@ -0,0 +1,3 @@
+module Metapage
+  VERSION = "0.1.0"
+end

data/lib/metapage.rb

@@ -0,0 +1,189 @@
+require "metapage/version"
+require 'nokogiri'
+require 'httpclient'
+require 'uri'
+require 'resolv'
+require 'ipaddr'
+require 'digest/sha1'
+
+module Metapage
+  class ResolveError < StandardError; end;
+  class HTTPResponseError < StandardError; end;
+  class ContentTypeError < StandardError; end;
+  ERROR_CLASSES = [ResolveError, HTTPResponseError, ContentTypeError]
+
+  class << self
+    def fetch(url)
+      fetch! url
+    rescue *ERROR_CLASSES => err
+      nil
+    end
+
+    def fetch!(url)
+      Metadata.new(url)
+    end
+
+    def extract(text)
+      URI.extract(text, ['http', 'https']).map {|url| fetch(url.gsub(/[\.\,]+\Z/, '')) }.compact
+    end
+
+    def extract!(text)
+      URI.extract(text, ['http', 'https']).map {|url| fetch!(url.gsub(/[\.\,]+\Z/, '')) }.compact
+    end
+  end
+
+  class Metadata
+    attr_reader :url
+    def initialize(url)
+      @url = url
+      title
+    end
+
+    def title
+      @title ||= metatag_content('og:title') || html_content('title')
+    end
+
+    def description
+      @description ||= metatag_content('og:description') || metatag_content('description')
+    end
+
+    def image_url
+      # Fallback to apple-touch-icon, fluid-icon, ms-tileicon etc
+      @image_url ||= metatag_content('og:image:secure_url') || metatag_content('og:image') || link_rel('apple-touch-icon-precomposed')
+    end
+
+    def type
+      @type ||= metatag_content('og:type') || 'website'
+    end
+
+    def canonical_url
+      @canonical_url ||= metatag_content('og:url') || link_rel('canonical') || url
+    end
+
+    def id
+      if canonical_url
+        @id ||= Digest::SHA1.hexdigest(canonical_url)
+      end
+    end
+
+    def site_name
+      @site_name ||= metatag_content('og:site_name') || host
+    end
+
+    def to_h
+      {
+        id: id,
+        title: title,
+        description: description,
+        image_url: image_url,
+        type: type,
+        canonical_url: canonical_url,
+        site_name: site_name
+      }
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+
+    private
+
+      def uri
+        @uri ||= URI(canonical_url)
+      end
+
+      def host
+        @host ||= uri.host
+      end
+
+      def scheme
+        @scheme ||= uri.scheme
+      end
+
+      def absolute_url(href)
+        if href.start_with?('http')
+          href
+        else
+          scheme + '://' + File.join(host, href)
+        end
+      end
+
+      def link_rel(rel)
+        if tag = doc.css('link[rel="'+rel+'"]').first
+          absolute_url tag['href']
+        else
+          nil
+        end
+      end
+
+      def metatag_content(tag_name)
+        if tag = doc.css('meta[property="'+ tag_name +'"]').first
+          tag["content"]
+        elsif tag = doc.css('meta[name="'+ tag_name +'"]').first
+          tag["content"]
+        end
+      end
+
+      def html_content(selector)
+        if tag = doc.css(selector).first
+          tag.text
+        end
+      end
+
+      def doc
+        @doc ||= Nokogiri::HTML.parse(content).tap do |doc|
+          raise ContentTypeError, "Document does not seem to be valid html" if doc.css('div').empty?
+        end
+      end
+
+      def content
+        http_response.body        
+      end
+
+      def http_response
+        begin
+          raise Metapage::HTTPResponseError, "Invalid scheme for #{url}" unless valid_scheme?
+          raise Metapage::ResolveError, "Could not find any DNS records for #{url}" unless valid_dns?
+        rescue ArgumentError
+          raise Metapage::ResolveError, "Cannot parse url #{url.inspect}"
+        end
+
+        @http_response ||= begin
+          http_client.get(url, follow_redirect: true).tap do |response|
+            unless (200..299).include? response.status
+              raise Metapage::HTTPResponseError, "Invalid response status #{response.status}"
+            end
+          end
+        end
+      rescue SocketError, HTTPClient::ReceiveTimeoutError => err
+        raise Metapage::HTTPResponseError, err.to_s
+      end
+
+      def valid_scheme?
+        %w(http https).include? URI(url).scheme
+      end
+
+      def valid_dns?
+        dns = Resolv::DNS.new(nameserver: ['8.8.8.8', '8.8.4.4'])
+        address = dns.getaddress(URI(url).host).to_s
+        not private_subnets.any? {|net| net.include? IPAddr.new(address) }
+      rescue Resolv::ResolvError
+        false
+      end
+
+      def private_subnets
+        @private_subnets ||= ['127.0.0.0/8', '10.0.0.0/8', '172.16.0.0/12', '192.168.0.0/16'].map {|cidr| IPAddr.new cidr }
+      end
+
+      def http_client
+        http_client ||= HTTPClient.new.tap do |http_client|
+          http_client.receive_timeout = 3
+          http_client.connect_timeout = 3
+          http_client.send_timeout = 3
+          http_client.keep_alive_timeout = 3
+          http_client.ssl_config.timeout = 3
+        end
+      end
+  end
+end

data/metapage.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metapage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "metapage"
+  spec.version       = Metapage::VERSION
+  spec.authors       = ["Christoph Olszowka"]
+  spec.email         = ["christoph at olszowka de"]
+
+  spec.summary       = %q{Extract metadata about a given HTML url from open graph and regular meta tags}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/colszowka/metapage"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httpclient'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'mini_magick'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: metapage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christoph Olszowka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  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: mini_magick
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Extract metadata about a given HTML url from open graph and regular meta
+  tags
+email:
+- christoph at olszowka de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/metapage.rb
+- lib/metapage/version.rb
+- metapage.gemspec
+homepage: https://github.com/colszowka/metapage
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Extract metadata about a given HTML url from open graph and regular meta
+  tags
+test_files: []
+has_rdoc: