open_graphy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37f58ad61b985b57779656bf55788c7225cf4888
+  data.tar.gz: 600252251fcbdfe00fbec7b5749cda00b9f8aed2
+SHA512:
+  metadata.gz: 2de2b2042538b30620c834bfd5aea773de8d0bd0fd9d783ee5f6fc1d045dc64453b00722a7ba571a938f18f1797ef1e653848398272ae6cc91ca0711e7295b48
+  data.tar.gz: d752d82c76f92915b90221345c138fbb6404ad48ec28bca32789de863a3a68dbb69bb99c0ba91901c7c467a088534495e235177238d01c983e574e8b8f150c91

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3

data/.travis.yml

@@ -0,0 +1,6 @@
+before_install:
+  - gem install bundler
+rvm:
+  - 2.3.0
+  - 2.2
+  - jruby-9.1.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 On The Beach Ltd.
+
+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,68 @@
+# OpenGraphy  [![Build Status](https://travis-ci.org/onthebeach/open_graphy.svg)](https://travis-ci.org/onthebeach/open_graphy) [![Gem Version](https://badge.fury.io/rb/open_graphy.svg)](http://badge.fury.io/rb/open_graphy)
+
+This ruby gem allow you to fetch data that follows the opengraph protocol, and lets you fetch data from custom metatags also.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_graphy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_graphy
+
+## Usage
+
+Firstly require the gem using:
+```ruby
+require 'open_graphy'
+```
+
+To fetch opengraph data from a URL use:
+```ruby
+movie = OpenGraphy.fetch("https://www.rottentomatoes.com/m/coffee_and_cigarettes/")
+```
+The fetch method returns an object with methods defined that can be used to access the data retrieved. A is also defined so you can check the existence of data before using it.
+```ruby
+movie.title #=> "Coffee and Cigarettes"
+movie.image? #=> true
+movie.image #=> "https://resizing.flixster.com/9l1s-frU7dhkYqr0V-C0AlDpJuU=/740x290/v1.bjs3MDg4NTg7ajsxNzA2MzsxMjAwOzEyODA7NzIw"
+movie.type #=> "video.movie"
+```
+
+## Configuration
+By default the gem is set to look for og metatags.
+To fetch data from custom metatags you can configure the gem, the example below shows a typical configuration.
+
+```ruby
+OpenGraphy.configure do |config|
+  config.metatags = ["og:", "custom:tag:",]
+end
+```
+
+When fetching data the default useragent is `OpenGraphyBot`, the example below shows a custom user agent being set.
+
+```ruby
+OpenGraphy.configure do |config|
+  config.user_agent = 'DataBot/0.6'
+end
+```
+
+## Copyright
+
+Copyright (c) 2016 OnTheBeach Ltd. See LICENSE.txt for further details.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/open_graphy/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,12 @@
+require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Run the test suite'
+task :default => :spec

data/lib/open_graphy/configuration.rb

@@ -0,0 +1,11 @@
+module OpenGraphy
+  class Configuration
+    include Singleton
+    attr_accessor :metatags, :user_agent
+
+    def initialize
+      @metatags = ['og:']
+      @user_agent = 'OpenGraphyBot'
+    end
+  end
+end

data/lib/open_graphy/fetcher.rb

@@ -0,0 +1,67 @@
+module OpenGraphy
+  module Uri
+    class Fetcher
+      def initialize(uri_str, limit = 10)
+        @uri_str, @limit = uri_str, limit
+      end
+
+      def fetch
+        check_redirect_limit
+
+        http_response = response
+        case http_response
+        when Net::HTTPSuccess then
+          http_response
+        when Net::HTTPRedirection then
+          follow_redirection(http_response)
+        else
+          http_response.value
+        end
+      end
+
+      private
+
+      def follow_redirection(http_response)
+        @uri_str = http_response['location']
+        @limit -= 1
+        self.fetch
+      end
+
+      def check_redirect_limit
+        raise  Uri::RedirectLoopError, 'too many HTTP redirects' if @limit == 0
+      end
+
+      def uri
+        uri = URI(@uri_str)
+        raise BadUriError, 'the url is incomplete' if uri.host == nil
+
+        uri
+      end
+
+      def request
+        Net::HTTP::Get.new(uri.request_uri, headers)
+      end
+
+      def response
+        http.request(request)
+      end
+
+      def http
+        Net::HTTP.new(uri.host, uri.port).tap do |http|
+          http.use_ssl = ssl?
+        end
+      end
+
+      def ssl?
+        uri.scheme == 'https'
+      end
+
+      def headers
+        {
+          'User-Agent' => OpenGraphy.configuration.user_agent,
+        }
+      end
+
+    end
+  end
+end

data/lib/open_graphy/meta_tag.rb

@@ -0,0 +1,31 @@
+module OpenGraphy
+  class MetaTag
+    def initialize(doc, meta_tag)
+      @doc, @meta_tag = doc, meta_tag
+    end
+
+    def namespace
+      @namespace ||= TagNamespace.new(tag_name.split(':'))
+    end
+
+    def valid?
+      tag_name
+    end
+
+    def name
+      @meta_tag.attr('property').sub(tag_name, '')
+    end
+
+    def value
+      @meta_tag.attr('content').to_s
+    end
+
+    private
+
+    def tag_name
+      OpenGraphy.configuration.metatags.find do |valid_meta_tag_name|
+        @meta_tag.attr('property') =~ Regexp.new(valid_meta_tag_name)
+      end
+    end
+  end
+end

data/lib/open_graphy/meta_tags.rb

@@ -0,0 +1,88 @@
+module OpenGraphy
+  class MetaTags
+    def title
+      data.fetch('title', __html_title_tag)
+    end
+
+    def title?
+      !!title
+    end
+
+    def image
+      if valid_image_url?
+        image_url
+      else
+        raise NoMethodError
+      end
+    end
+
+    def image?
+      valid_image_url?
+    end
+
+    def add(key, value, namespace: TagNamespace.new)
+      data[key] = value
+      namespace.add_to(key, value, self)
+      self
+    end
+
+    def define_namespace(name)
+      if respond_to?(name)
+        public_send(name)
+      else
+        MetaTags.new.tap { |tag|
+          define_singleton_method(name, -> { tag })
+        }
+      end
+    end
+
+    def define_value(key, value)
+      if define_accessors?(key)
+        define_singleton_method key, -> { value }
+        define_singleton_method "#{key}?", -> { !!value }
+      end
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if method_sym.to_s.end_with?('?')
+        false
+      else
+        super
+      end
+    end
+
+    def respond_to?(method_name, include_private = false)
+      method_name.to_s.end_with?('?') || super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.end_with?('?') || super
+    end
+
+    private
+
+    def define_accessors?(key)
+      !black_list.include?(key)
+    end
+
+    def image_url
+      data.fetch('image', false)
+    end
+
+    def valid_image_url?
+      @valid_image_url ||= UrlValidator.new(image_url).valid?
+    end
+
+    def black_list
+      %w(image)
+    end
+
+    def data
+      @data ||= {}
+    end
+
+    def __html_title_tag
+      @data['__html_title_tag']
+    end
+  end
+end

data/lib/open_graphy/tag_namespace.rb

@@ -0,0 +1,40 @@
+module OpenGraphy
+  class TagNamespace
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :namespace, :empty?, :length, :each, :last, :first, :any?, :size, :[]
+
+    def initialize(namespace=[])
+      @namespace = namespace
+    end
+
+    def any?
+      namespace.any? && first != 'og'
+    end
+
+    def add_to(key, value, tag)
+      if any?
+        tag.define_namespace(child_name).add(key, value, namespace: self.next)
+      else
+        tag.define_value(key, value)
+      end
+    end
+
+    def child_name
+      namespace.first
+    end
+
+    def next
+      TagNamespace.new(
+        [namespace.size > 1 ? namespace.last : nil].compact
+      )
+    end
+
+    private
+
+    def namespace
+      @namespace
+    end
+  end
+end

data/lib/open_graphy/uri.rb

@@ -0,0 +1,18 @@
+require 'net/http'
+
+module OpenGraphy
+  module Uri
+    class RedirectLoopError < StandardError; end
+    class BadUriError < StandardError; end
+
+    def self.open(uri_str)
+      fetch(uri_str).body
+    end
+
+    private
+
+    def self.fetch(uri)
+      Fetcher.new(uri).fetch
+    end
+  end
+end

data/lib/open_graphy/url.rb

@@ -0,0 +1,40 @@
+module OpenGraphy
+  class Url
+    def initialize(uri)
+      @uri = uri
+    end
+
+    def self.fetch(uri)
+      new(uri).fetch
+    end
+
+    def fetch
+      data.add('url', @uri)
+      begin
+        valid_meta_tags.each { |tag| data.add(tag.name, tag.value, namespace: tag.namespace) }
+        data.add('__html_title_tag',  doc.css('title').text)
+      rescue SocketError, Net::HTTPServerException, Uri::RedirectLoopError, Uri::BadUriError
+      end
+
+      data
+    end
+
+    private
+
+    def valid_meta_tags
+      valid_meta_tags ||= meta_tags.select(&:valid?)
+    end
+
+    def meta_tags
+      doc.css('meta').map { |tag| MetaTag.new(doc, tag) }
+    end
+
+    def data
+      @data ||= MetaTags.new
+    end
+
+    def doc
+      @doc ||= Nokogiri::HTML(Uri.open(@uri))
+    end
+  end
+end

data/lib/open_graphy/url_validator.rb

@@ -0,0 +1,11 @@
+module OpenGraphy
+  class UrlValidator
+    def initialize(url)
+      @url = url
+    end
+
+    def valid?
+     !!(@url =~ /\A#{URI::regexp(['http', 'https'])}\z/)
+    end
+  end
+end

data/lib/open_graphy/version.rb

@@ -0,0 +1,3 @@
+module OpenGraphy
+  VERSION = "1.0.0"
+end

data/lib/open_graphy.rb

@@ -0,0 +1,26 @@
+require 'open_graphy/version'
+require 'nokogiri'
+require 'socket'
+require 'singleton'
+require 'open_graphy/configuration'
+require 'open_graphy/url'
+require 'open_graphy/uri'
+require 'open_graphy/tag_namespace'
+require 'open_graphy/meta_tags'
+require 'open_graphy/meta_tag'
+require 'open_graphy/fetcher'
+require 'open_graphy/url_validator'
+
+module OpenGraphy
+  def self.configuration
+    Configuration.instance
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.fetch(uri)
+    Url.fetch(uri)
+  end
+end

data/open_graphy.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_graphy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_graphy"
+  spec.version       = OpenGraphy::VERSION
+  spec.authors       = ["Craig Bradley", "James Cotterill"]
+  spec.email         = ["craig.bradley@onthebeach.co.uk", "james.cotterill@onthebeach.co.uk" ]
+  spec.summary       = %q{Open Graph Protocol wrapper}
+  spec.description   = %q{A simple ruby wrapper for the open graph protocol}
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "vcr", '~> 2.9'
+  spec.add_development_dependency "webmock", "~> 1.20"
+end

data/spec/cassettes/google/404.yml

@@ -0,0 +1,117 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://google.com/404.html
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - OpenGraphyBot
+  response:
+    status:
+      code: 301
+      message: Moved Permanently
+    headers:
+      Location:
+      - http://www.google.com/404.html
+      Content-Type:
+      - text/html; charset=UTF-8
+      X-Content-Type-Options:
+      - nosniff
+      Date:
+      - Mon, 01 Dec 2014 20:45:42 GMT
+      Expires:
+      - Wed, 31 Dec 2014 20:45:42 GMT
+      Cache-Control:
+      - public, max-age=2592000
+      Server:
+      - sffe
+      Content-Length:
+      - '227'
+      X-Xss-Protection:
+      - 1; mode=block
+      Alternate-Protocol:
+      - 80:quic,p=0.02
+    body:
+      encoding: UTF-8
+      string: "<HTML><HEAD><meta http-equiv=\"content-type\" content=\"text/html;charset=utf-8\">\n<TITLE>301
+        Moved</TITLE></HEAD><BODY>\n<H1>301 Moved</H1>\nThe document has moved\n<A
+        HREF=\"http://www.google.com/404.html\">here</A>.\r\n</BODY></HTML>\r\n"
+    http_version: 
+  recorded_at: Mon, 01 Dec 2014 20:45:42 GMT
+- request:
+    method: get
+    uri: http://www.google.com/404.html
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - OpenGraphyBot
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - text/html; charset=UTF-8
+      X-Content-Type-Options:
+      - nosniff
+      Date:
+      - Mon, 01 Dec 2014 20:45:43 GMT
+      Server:
+      - sffe
+      Content-Length:
+      - '1433'
+      X-Xss-Protection:
+      - 1; mode=block
+      Alternate-Protocol:
+      - 80:quic,p=0.02
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        PCFET0NUWVBFIGh0bWw+CjxodG1sIGxhbmc9ZW4+CiAgPG1ldGEgY2hhcnNl
+        dD11dGYtOD4KICA8bWV0YSBuYW1lPXZpZXdwb3J0IGNvbnRlbnQ9ImluaXRp
+        YWwtc2NhbGU9MSwgbWluaW11bS1zY2FsZT0xLCB3aWR0aD1kZXZpY2Utd2lk
+        dGgiPgogIDx0aXRsZT5FcnJvciA0MDQgKE5vdCBGb3VuZCkhITE8L3RpdGxl
+        PgogIDxzdHlsZT4KICAgICp7bWFyZ2luOjA7cGFkZGluZzowfWh0bWwsY29k
+        ZXtmb250OjE1cHgvMjJweCBhcmlhbCxzYW5zLXNlcmlmfWh0bWx7YmFja2dy
+        b3VuZDojZmZmO2NvbG9yOiMyMjI7cGFkZGluZzoxNXB4fWJvZHl7bWFyZ2lu
+        OjclIGF1dG8gMDttYXgtd2lkdGg6MzkwcHg7bWluLWhlaWdodDoxODBweDtw
+        YWRkaW5nOjMwcHggMCAxNXB4fSogPiBib2R5e2JhY2tncm91bmQ6dXJsKC8v
+        d3d3Lmdvb2dsZS5jb20vaW1hZ2VzL2Vycm9ycy9yb2JvdC5wbmcpIDEwMCUg
+        NXB4IG5vLXJlcGVhdDtwYWRkaW5nLXJpZ2h0OjIwNXB4fXB7bWFyZ2luOjEx
+        cHggMCAyMnB4O292ZXJmbG93OmhpZGRlbn1pbnN7Y29sb3I6Izc3Nzt0ZXh0
+        LWRlY29yYXRpb246bm9uZX1hIGltZ3tib3JkZXI6MH1AbWVkaWEgc2NyZWVu
+        IGFuZCAobWF4LXdpZHRoOjc3MnB4KXtib2R5e2JhY2tncm91bmQ6bm9uZTtt
+        YXJnaW4tdG9wOjA7bWF4LXdpZHRoOm5vbmU7cGFkZGluZy1yaWdodDowfX0j
+        bG9nb3tiYWNrZ3JvdW5kOnVybCgvL3d3dy5nb29nbGUuY29tL2ltYWdlcy9l
+        cnJvcnMvbG9nb19zbV8yLnBuZykgbm8tcmVwZWF0fUBtZWRpYSBvbmx5IHNj
+        cmVlbiBhbmQgKG1pbi1yZXNvbHV0aW9uOjE5MmRwaSl7I2xvZ297YmFja2dy
+        b3VuZDp1cmwoLy93d3cuZ29vZ2xlLmNvbS9pbWFnZXMvZXJyb3JzL2xvZ29f
+        c21fMl9oci5wbmcpIG5vLXJlcGVhdCAwJSAwJS8xMDAlIDEwMCU7LW1vei1i
+        b3JkZXItaW1hZ2U6dXJsKC8vd3d3Lmdvb2dsZS5jb20vaW1hZ2VzL2Vycm9y
+        cy9sb2dvX3NtXzJfaHIucG5nKSAwfX1AbWVkaWEgb25seSBzY3JlZW4gYW5k
+        ICgtd2Via2l0LW1pbi1kZXZpY2UtcGl4ZWwtcmF0aW86Mil7I2xvZ297YmFj
+        a2dyb3VuZDp1cmwoLy93d3cuZ29vZ2xlLmNvbS9pbWFnZXMvZXJyb3JzL2xv
+        Z29fc21fMl9oci5wbmcpIG5vLXJlcGVhdDstd2Via2l0LWJhY2tncm91bmQt
+        c2l6ZToxMDAlIDEwMCV9fSNsb2dve2Rpc3BsYXk6aW5saW5lLWJsb2NrO2hl
+        aWdodDo1NXB4O3dpZHRoOjE1MHB4fQogIDwvc3R5bGU+CiAgPGEgaHJlZj0v
+        L3d3dy5nb29nbGUuY29tLz48c3BhbiBpZD1sb2dvIGFyaWEtbGFiZWw9R29v
+        Z2xlPjwvc3Bhbj48L2E+CiAgPHA+PGI+NDA0LjwvYj4gPGlucz5UaGF04oCZ
+        cyBhbiBlcnJvci48L2lucz4KICA8cD5UaGUgcmVxdWVzdGVkIFVSTCA8Y29k
+        ZT4vNDA0Lmh0bWw8L2NvZGU+IHdhcyBub3QgZm91bmQgb24gdGhpcyBzZXJ2
+        ZXIuICA8aW5zPlRoYXTigJlzIGFsbCB3ZSBrbm93LjwvaW5zPgo=
+    http_version: 
+  recorded_at: Mon, 01 Dec 2014 20:45:43 GMT
+recorded_with: VCR 2.9.3