oembed 0.0.1

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/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alex Soulim
+
+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,86 @@
+# Introductions
+
+[**oEmbed**](http://oembed.com/) is a format for allowing an embedded representation of a URL on third
+party sites. The simple API allows a website to display embedded content
+(such as photos or videos) when a user posts a link to that resource, without
+having to parse the resource directly.
+
+**oembed gem** is a simple to use and slim (~150 LOC) library to work with oEmbed format. It has no external dependencies at runtime. All you need to have is Ruby itself.
+
+The library shares a behaviour of oEmbed client with any Ruby object. Just `include Oembed::Client` into that object and you are good to go.
+
+**oembed gem** is provider agnostic. It has no pre-configured providers.
+You can build a client for any oEmbed provider of the world :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oembed'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oembed
+
+## Usage
+
+You have to do a few things to build an oEmbed client with `oembed` gem.
+
+- `include Oembed::Client` into your object,
+- add instance method `#endpoint_uri` to that object. This method has to return
+  a string with URI of oEmbed endpoint.
+
+Lets start with a simple example. It will be a client for the awesome
+[Speaker Deck](http://speakerdeck.com).
+
+```ruby
+require 'oembed'
+
+# Speaker Deck client
+class SpeakerDeck
+  include Oembed::Client
+
+  # Read more about endpoint on https://speakerdeck.com/faq#oembed
+  def endpoint_uri
+    'http://speakerdeck.com/oembed.json'
+  end
+end
+```
+
+That's it. Now you can use a method `#fetch` to get data from oEmbed enpoint of Speaker Deck.
+
+```ruby
+client = SpeakerDeck.new
+p client.fetch('https://speakerdeck.com/u/soulim/p/rails')
+```
+
+The method `#fetch` will return a hash with oEmded data.
+
+```json
+{
+  "type" => "rich",
+  "version" => 1.0,
+  "provider_name" => "Speaker Deck", 
+  "provider_url" => "https://speakerdeck.com/",
+  "title" => "Локализация приложения на базе Rails. Личный опыт и советы", 
+  "author_name" => "Alex Soulim", 
+  "author_url" => "https://speakerdeck.com/u/soulim",
+  "html" => "<iframe style=\"border:0; padding:0; margin:0; background:transparent;\" mozallowfullscreen=\"true\" webkitallowfullscreen=\"true\" frameBorder=\"0\" allowTransparency=\"true\" id=\"presentation_frame_4fd3874cebb4b2001f0277e5\" src=\"//speakerdeck.com/embed/4fd3874cebb4b2001f0277e5\" width=\"710\" height=\"596\"></iframe>\n",
+  "width" => 710,
+  "height" => 596
+}
+```
+
+At the moment `oembed` gem supports the JSON format only. I will fix it soon. Stay tuned! :)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/oembed.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'net/http'
+require 'json'
+require 'uri'
+
+module Oembed
+  class Error < StandardError; end
+
+  class ResponseError < Error
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+  end
+
+  class RedirectionTooDeepError < Error; end
+
+  class ParserError < Error
+    attr_reader :original
+
+    def initialize(original)
+      @original = original
+    end
+  end
+
+  class NotSupportedFormatError < Error; end
+
+  autoload :Client, 'oembed/client'
+  autoload :Parser, 'oembed/parser'
+  autoload :Http, 'oembed/http'
+  autoload :Uri, 'oembed/uri'
+end
+
+require 'oembed/version'

data/lib/oembed/client.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Oembed
+  module Client
+    attr_writer :http
+
+    def endpoint_uri
+      raise NotImplementedError
+    end
+
+    def http
+      @http ||= Oembed::Http.new
+    end
+
+    def fetch(resource_uri)
+      begin
+        fetch!(resource_uri)
+      rescue Oembed::Error
+        nil
+      end
+    end
+
+    def fetch!(resource_uri)
+      uri = Oembed::Uri.new(endpoint_uri, resource_uri)
+      http.get(uri.to_s)
+    end
+  end
+end

data/lib/oembed/http.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Oembed
+  class Http
+    attr_writer :parser
+
+    def parser
+      @parser ||= Oembed::Parser.new
+    end
+
+    def get(path, options = {})
+      uri        = URI.parse(path)
+      connection = establish_connection(uri.host, uri.port)
+      response   = connection.get(uri.request_uri)
+
+      case response
+      when Net::HTTPRedirection
+        follow_redirection(response['location'], options.fetch(:limit, 10))
+      when Net::HTTPSuccess
+        parser.parse(response.body, response.content_type)
+      else
+        raise Oembed::ResponseError.new(response), 'HTTP error during request'
+      end
+    end
+
+    private
+
+    def establish_connection(host, port)
+      Net::HTTP.new(host, port).tap do |instance|
+        instance.use_ssl = port == URI::HTTPS::DEFAULT_PORT
+      end
+    end
+
+    def follow_redirection(location, limit)
+      if limit > 0
+        get(location, limit - 1)
+      else
+        raise Oembed::RedirectionTooDeepError, 'HTTP redirects too deep'
+      end
+    end
+  end
+end

data/lib/oembed/parser.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module Oembed
+  class Parser
+    SUPPORTED_FORMATS = {
+      'text/xml'               => :xml,
+      'application/json'       => :json,
+    }
+
+    def parse(body, content_type)
+      format = SUPPORTED_FORMATS[content_type]
+
+      if format
+        send(format, body)
+      else
+        raise Oembed::NotSupportedFormatError,
+            "parser does not support #{format.inspect} format"
+      end
+    end
+
+    private
+
+    def json(body)
+      begin
+        JSON.parse(body)
+      rescue JSON::JSONError => e
+        raise Oembed::ParserError.new(e), 'JSON parser error'
+      end
+    end
+
+    def xml(body)
+      raise NotImplementedError, 'XML parser is not implemented'
+    end
+  end
+end

data/lib/oembed/uri.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Oembed
+  class Uri
+    def initialize(endpoint_uri, resource_uri)
+      @uri = URI.parse(endpoint_uri)
+      @uri.query = URI.encode_www_form(url: resource_uri)
+    end
+
+    def to_s
+      @uri.to_s
+    end
+  end
+end

data/lib/oembed/version.rb

@@ -0,0 +1,3 @@
+module Oembed
+  VERSION = "0.0.1"
+end

data/oembed.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require File.expand_path('../lib/oembed/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alex Soulim"]
+  gem.email         = ["soulim@gmail.com"]
+  gem.description   = %q{A slim library to work with oEmbed format.}
+  gem.summary       = %q{A slim library to work with oEmbed format.}
+  gem.homepage      = "http://github.com/soulim/oembed"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "oembed"
+  gem.require_paths = ["lib"]
+  gem.version       = Oembed::VERSION
+
+  gem.add_development_dependency 'rspec', '~> 2.11.0'
+  gem.add_development_dependency 'simplecov', '~> 0.6.4'
+  gem.add_development_dependency 'fakeweb', '~> 1.3.0'
+end

data/spec/oembed/client_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Oembed::Client do
+  let(:http)         { double('Http', get: 'foo') }
+  let(:endpoint_uri) { 'http://example.com/oembed' }
+  let(:resource_uri) { 'http://example.com/foo' }
+
+  subject do
+    double('OembedClient',
+      http: http,
+      endpoint_uri: endpoint_uri
+    ).extend(Oembed::Client)
+  end
+
+  describe '#fetch' do
+    it 'should fetch the date using self.fetch!' do
+      subject.should_receive(:fetch!)
+      subject.fetch(resource_uri)
+    end
+
+    context 'when there is an error during request' do
+      before { http.stub(:get).and_raise(Oembed::Error) }
+
+      it 'should return nil' do
+        expect(subject.fetch(resource_uri)).to be_nil
+      end
+    end
+  end
+
+  describe '#fetch!' do
+    it 'should prepare request URI' do
+      Oembed::Uri.should_receive(:new).with(endpoint_uri, resource_uri)
+      subject.fetch!(resource_uri)
+    end
+
+    it 'should get oEmbed data via HTTP client' do
+      http.should_receive(:get)
+      subject.fetch!(resource_uri)
+    end
+  end
+end

data/spec/oembed/http_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'fakeweb'
+
+describe Oembed::Http do
+  let(:parser) { double('Parser', parse: 'foo') }
+  let(:uri)    { 'http://example.com/foo' }
+
+  subject { Oembed::Http.new.tap { |http| http.parser = parser  } }
+
+  before { FakeWeb.allow_net_connect = false }
+
+  describe '#get' do
+    context 'when response is successful' do
+      before do
+        FakeWeb.register_uri(:get, uri, body: 'OK', status: [200, 'OK'])
+      end
+
+      it 'should parse response body' do
+        parser.should_receive(:parse)
+        subject.get(uri)
+      end
+
+      it 'should return parsing result' do
+        expect(subject.get(uri)).to eq(parser.parse)
+      end
+    end
+
+    context 'when amount of redirects is above the limit' do
+      before do
+        FakeWeb.register_uri(:get, uri, body: 'Redirect', status: [301, 'Moved Permanently'])
+      end
+
+      it 'should raise TooManyRedirects exception' do
+        expect {
+          subject.get(uri, limit: 0)
+        }.to raise_error(Oembed::RedirectionTooDeepError)
+      end
+    end
+
+    context 'when response is HTTP error' do
+      before do
+        FakeWeb.register_uri(:get, uri, body: 'Internal Server Error', status: [500, 'Internal Server Error'])
+      end
+
+      it 'should raise HttpError exception' do
+        expect { subject.get(uri) }.to raise_error(Oembed::ResponseError)
+      end
+    end
+  end
+end

data/spec/oembed/parser_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Oembed::Parser do
+  let(:body)      { { 'foo' => 'bar', 'baz' => 1 } }
+  let(:json_body) { '{"foo":"bar","baz":1}' }
+  let(:xml_body)  { 'xml-body' }
+
+  describe '#parse' do
+    context 'when content type is JSON' do
+      it 'should return parsed body' do
+        expect(subject.parse(json_body, 'application/json')).to eq(body)
+      end
+    end
+
+    context 'when content type is XML' do
+      it 'should raise NotImplementedError' do
+        expect {
+          subject.parse(xml_body, 'text/xml')
+        }.to raise_error(NotImplementedError)
+      end
+    end
+
+    context 'when content type is not supported' do
+      it 'should raise Oembed::NotSupportedFormatError' do
+        expect {
+          subject.parse(json_body, 'wrong/type')
+        }.to raise_error(Oembed::NotSupportedFormatError)
+      end
+    end
+  end
+end

data/spec/oembed/uri_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Oembed::Uri do
+  let(:endpoint_uri) { 'http://example.com/oembed' }
+  let(:resource_uri) { 'http://example.com/foo' }
+
+  subject { Oembed::Uri.new(endpoint_uri, resource_uri) }
+
+  describe '#to_s' do
+    it 'should return oEmbed URI string' do
+      expect(subject.to_s).to eq('http://example.com/oembed?url=http%3A%2F%2Fexample.com%2Ffoo')
+    end
+  end
+end

data/spec/oembed_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+require 'oembed'
+
+describe Oembed do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+
+SimpleCov.start
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  # Disable should syntax
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+end
+
+require 'oembed'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: oembed
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alex Soulim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: A slim library to work with oEmbed format.
+email:
+- soulim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/oembed.rb
+- lib/oembed/client.rb
+- lib/oembed/http.rb
+- lib/oembed/parser.rb
+- lib/oembed/uri.rb
+- lib/oembed/version.rb
+- oembed.gemspec
+- spec/oembed/client_spec.rb
+- spec/oembed/http_spec.rb
+- spec/oembed/parser_spec.rb
+- spec/oembed/uri_spec.rb
+- spec/oembed_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/soulim/oembed
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A slim library to work with oEmbed format.
+test_files:
+- spec/oembed/client_spec.rb
+- spec/oembed/http_spec.rb
+- spec/oembed/parser_spec.rb
+- spec/oembed/uri_spec.rb
+- spec/oembed_spec.rb
+- spec/spec_helper.rb