oembed 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19ab3e5fdab3cc390e18712c6d26d5bab0338dd5
+  data.tar.gz: 231c4cd3b7c6b17f56be151951ebc3ef6aba999b
+SHA512:
+  metadata.gz: 2d78ac99468c9c42c327501fe6c33734f489cb9a98919d2f4cbaa170a5acc28ca505ed7b272e95e92069d9466861c14cb0174ab2367042ca4237538de1e77328
+  data.tar.gz: 855b0578f055d9af46da9364c56227541acf2c4ddc4fe8127d7529ef264e43d6fbccf742c2edcc37e976bed16a92e08017597cae5aa0958115899d1e57590732

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 rvm:
-  - "1.9.2"
-  - "1.9.3"
-script: bundle exec rspec spec
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - ruby-head
+  - jruby
+before_install: gem update bundler

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Alex Soulim
+Copyright (c) 2012 Alex Sulim
 
 MIT License
 

data/README.md

@@ -1,4 +1,5 @@
-# Introductions
+# oembed gem
+[![Build Status](http://img.shields.io/travis/soulim/oembed.svg?style=flat)](http://travis-ci.org/soulim/oembed)  [![Code Climate](http://img.shields.io/codeclimate/github/soulim/oembed.svg?style=flat)](https://codeclimate.com/github/soulim/oembed)
 
 [**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
@@ -35,12 +36,12 @@ You have to do a few things to build an oEmbed client with `oembed` gem.
   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).
+[Speaker Deck](http://speakerdeck.com). Note that we call the service class NameApi - this is to avoid clashing with gems (such as twitter) that may have classes named after the service.
 
 ```ruby
 require 'oembed'
 
-class SpeakerDeck
+class SpeakerDeckApi
   include Oembed::Client
 
   # Read more about endpoint on https://speakerdeck.com/faq#oembed
@@ -53,7 +54,7 @@ end
 That's it. Now you can use a method `#fetch` to get data from oEmbed enpoint of Speaker Deck.
 
 ```ruby
-client = SpeakerDeck.new
+client = SpeakerDeckApi.new
 client.fetch('https://speakerdeck.com/u/soulim/p/rails')
 ```
 
@@ -63,13 +64,13 @@ The method `#fetch` will return a hash with oEmded data.
 {
   "type" => "rich",
   "version" => 1.0,
-  "provider_name" => "Speaker Deck", 
+  "provider_name" => "Speaker Deck",
   "provider_url" => "https://speakerdeck.com/",
-  "title" => "Локализация приложения на базе Rails. Личный опыт и советы", 
-  "author_name" => "Alex Soulim", 
+  "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,q
+  "width" => 710,
   "height" => 596
 }
 ```
@@ -80,7 +81,7 @@ client for XML endpoint.
 ```ruby
 require 'oembed'
 
-class Flickr
+class FlickrApi
   include Oembed::Client
 
   def endpoint_uri
@@ -88,7 +89,7 @@ class Flickr
   end
 end
 
-client = Flickr.new
+client = FlickrApi.new
 client.fetch('http://www.flickr.com/photos/alex_soulim/3593916989')
 ```
 
@@ -101,7 +102,7 @@ It will return:
   "author_name"=>"Alex Soulim", "author_url"=>"http://www.flickr.com/photos/alex_soulim/",
   "width"=>"683",
   "height"=>"1024",
-  "url"=>"http://farm4.staticflickr.com/3618/3593916989_3d8aa991ea_b.jpg", 
+  "url"=>"http://farm4.staticflickr.com/3618/3593916989_3d8aa991ea_b.jpg",
   "web_page"=>"http://www.flickr.com/photos/alex_soulim/3593916989/",
   "thumbnail_url"=>"http://farm4.staticflickr.com/3618/3593916989_3d8aa991ea_s.jpg",
   "thumbnail_width"=>"75",
@@ -122,7 +123,7 @@ Instagram and use `:maxwidth` parameter.
 ```ruby
 require 'oembed'
 
-class Instagram
+class InstagramApi
   include Oembed::Client
 
   def endpoint_uri
@@ -130,10 +131,31 @@ class Instagram
   end
 end
 
-client = Instagram.new
+client = InstagramApi.new
 client.fetch('http://instagr.am/p/BUG/', maxwidth: 300)
 ```
 
+If you need to always customise the fetch with additional parameters this can be done by providing a fetch method in the service class. In this example we are adding a maxwidth parameter to the request.
+
+```ruby
+require 'oembed'
+
+class YoutubeApi
+  include Oembed::Client
+
+  def endpoint_uri
+    'https://www.youtube.com/oembed'
+  end
+
+  def fetch(url, options={})
+    super url, options.merge(maxwidth: 620)
+  end
+end
+
+client = YoutubeApi.new
+client.fetch('https://www.youtube.com/watch?v=_DRNgL76OLc')
+```
+
 ## Contributing
 
 1. Fork it
@@ -142,9 +164,10 @@ client.fetch('http://instagr.am/p/BUG/', maxwidth: 300)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## Supported Ruby versions [![Build Status](https://secure.travis-ci.org/soulim/oembed.png)](http://travis-ci.org/soulim/oembed)  [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/soulim/oembed)
+## Supported Ruby versions
 
 This library is tested against the following Ruby implementations:
 
-- Ruby 1.9.2
-- Ruby 1.9.3
+- MRI Ruby 2.1
+- MRI Ruby 2.0
+- JRuby

data/Rakefile

@@ -1,2 +1,9 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |task|
+  task.ruby_opts = '-I lib'
+end
+
+task default: :spec

data/lib/oembed.rb

@@ -1,37 +1,12 @@
 # encoding: utf-8
-require 'net/http'
-require 'json'
-require 'uri'
-require 'rexml/document'
 
 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 :XmlParser, 'oembed/xml_parser'
   autoload :Http, 'oembed/http'
+  autoload :Parser, 'oembed/parser'
   autoload :Uri, 'oembed/uri'
+  autoload :XmlParser, 'oembed/xml_parser'
 end
 
+require 'oembed/errors'
 require 'oembed/version'

data/lib/oembed/client.rb

@@ -1,4 +1,7 @@
 # encoding: utf-8
+require 'oembed/errors'
+require 'oembed/http'
+require 'oembed/uri'
 
 module Oembed
   module Client

data/lib/oembed/errors.rb

@@ -0,0 +1,23 @@
+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
+end

data/lib/oembed/http.rb

@@ -1,4 +1,7 @@
 # encoding: utf-8
+require 'net/http'
+require 'oembed/errors'
+require 'uri'
 
 module Oembed
   class Http
@@ -33,7 +36,7 @@ module Oembed
 
     def follow_redirection(location, limit)
       if limit > 0
-        get(location, limit - 1)
+        get(location, limit: limit - 1)
       else
         raise Oembed::RedirectionTooDeepError, 'HTTP redirects too deep'
       end

data/lib/oembed/parser.rb

@@ -1,4 +1,7 @@
 # encoding: utf-8
+require 'json'
+require 'oembed/errors'
+require 'oembed/xml_parser'
 
 module Oembed
   class Parser

data/lib/oembed/version.rb

@@ -1,3 +1,3 @@
 module Oembed
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/oembed/xml_parser.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+require 'oembed/errors'
+require 'rexml/document'
 
 module Oembed
   class XmlParser

data/oembed.gemspec

@@ -2,11 +2,12 @@
 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.authors       = ["Alex Sulim"]
+  gem.email         = ["hello@sul.im"]
+  gem.description   = %q{A slim library to work with oEmbed format. It has no external dependencies at runtime. All you need to have is Ruby itself.}
   gem.summary       = %q{A slim library to work with oEmbed format.}
   gem.homepage      = "http://soulim.github.com/oembed"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,7 +16,8 @@ Gem::Specification.new do |gem|
   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'
+  gem.add_development_dependency 'fakeweb', '~> 1.3'
+  gem.add_development_dependency 'rake', '~> 11.2', '>= 11.2.2'
+  gem.add_development_dependency 'rspec', '~> 3.5'
+  gem.add_development_dependency 'simplecov', '~> 0.12.0'
 end

data/spec/oembed/client_spec.rb

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

data/spec/oembed/http_spec.rb

@@ -1,7 +1,7 @@
-require 'spec_helper'
 require 'fakeweb'
+require 'oembed/http'
 
-describe Oembed::Http do
+RSpec.describe Oembed::Http do
   let(:parser) { double('Parser', parse: 'foo') }
   let(:uri)    { 'http://example.com/foo' }
 
@@ -16,7 +16,7 @@ describe Oembed::Http do
       end
 
       it 'should parse response body' do
-        parser.should_receive(:parse)
+        expect(parser).to receive(:parse)
         subject.get(uri)
       end
 
@@ -25,6 +25,22 @@ describe Oembed::Http do
       end
     end
 
+    context 'when response is a redirect, followed by a redirect' do
+      let(:redirect_uri_one)    { 'http://example.com/redirect_one' }
+      let(:redirect_uri_two)    { 'http://example.com/redirect_two' }
+
+      before do
+        FakeWeb.register_uri(:get, uri, body: 'Redirect', status: [301, 'Moved Permanently'], location: redirect_uri_one)
+        FakeWeb.register_uri(:get, redirect_uri_one, body: 'Redirect', status: [301, 'Moved Permanently'], location: redirect_uri_two)
+        FakeWeb.register_uri(:get, redirect_uri_two, body: 'OK', status: [200, 'OK'])
+      end
+
+      it 'should parse response body, eventually' do
+        expect(parser).to receive(:parse)
+        subject.get(uri)
+      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'])

data/spec/oembed/parser_spec.rb

@@ -1,6 +1,6 @@
-require 'spec_helper'
+require 'oembed/parser'
 
-describe Oembed::Parser do
+RSpec.describe Oembed::Parser do
   let(:body)      { { 'foo' => 'bar', 'baz' => "1" } }
   let(:json_body) { '{"foo":"bar","baz":"1"}' }
   let(:xml_body)  do

data/spec/oembed/uri_spec.rb

@@ -1,6 +1,6 @@
-require 'spec_helper'
+require 'oembed/uri'
 
-describe Oembed::Uri do
+RSpec.describe Oembed::Uri do
   let(:endpoint_uri) { 'http://example.com/oembed' }
   let(:resource_uri) { 'http://example.com/foo' }
 

data/spec/oembed/xml_parser_spec.rb

@@ -1,6 +1,6 @@
-require 'spec_helper'
+require 'oembed/xml_parser'
 
-describe Oembed::XmlParser do
+RSpec.describe Oembed::XmlParser do
   let(:source) do
     %q(<?xml version="1.0" encoding="utf-8" standalone="yes"?>
        <oembed>
@@ -19,7 +19,9 @@ describe Oembed::XmlParser do
 
     context 'when there is an exception during parsing' do
       before do
-        REXML::Document.stub(:new).and_raise(REXML::ParseException.new('error'))
+        allow(REXML::Document).to receive(:new).and_raise(
+          REXML::ParseException.new('error')
+        )
       end
 
       it 'should raise Oembed::ParserError' do

data/spec/oembed_spec.rb

@@ -1,5 +1,5 @@
-require 'spec_helper'
 require 'oembed'
 
-describe Oembed do
+RSpec.describe Oembed do
+  pending
 end

data/spec/spec_helper.rb

@@ -1,19 +1,30 @@
 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
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
 
-require 'oembed'
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -1,80 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: oembed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
-- Alex Soulim
+- Alex Sulim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-16 00:00:00.000000000 Z
+date: 2016-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.4
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 0.12.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.
+        version: 0.12.0
+description: A slim library to work with oEmbed format. It has no external dependencies
+  at runtime. All you need to have is Ruby itself.
 email:
-- soulim@gmail.com
+- hello@sul.im
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/oembed.rb
 - lib/oembed/client.rb
+- lib/oembed/errors.rb
 - lib/oembed/http.rb
 - lib/oembed/parser.rb
 - lib/oembed/uri.rb
@@ -89,28 +104,28 @@ files:
 - spec/oembed_spec.rb
 - spec/spec_helper.rb
 homepage: http://soulim.github.com/oembed
-licenses: []
+licenses:
+- MIT
+metadata: {}
 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
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A slim library to work with oEmbed format.
 test_files:
 - spec/oembed/client_spec.rb