oembed_client 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'multi_json'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'webmock'
+  gem 'vcr'
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.3.1)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.3)
+    rake (0.9.2)
+    rcov (0.9.11)
+    shoulda (2.11.3)
+    vcr (1.11.3)
+    webmock (1.7.6)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  multi_json
+  rcov
+  shoulda
+  vcr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Brian Landau
+
+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,48 @@
+# oEmbed Client
+
+A simple abstract oEmbed Client for ruby.
+
+## Install
+
+    gem install oembed_client
+    
+Or in your `Gemfile`:
+
+    gem 'oembed_client'
+
+## Usage
+
+Creating your own subclass:
+
+    require 'oembed_client'
+    
+    class YoutubeOembedClient < OembedClient
+      base_url 'http://www.youtube.com/oembed'
+      default_options iframe: '1', maxwidth: '520'
+    end
+    
+    c = YoutubeOembedClient.new('http://www.youtube.com/watch?v=4r7wHMg5Yjg')
+    c.embed_html # => "<iframe ..."
+
+Automagically create a new class for a oEmbed service URL:
+
+    require 'oembed_client'
+    
+    OembedClient.create_client_class_for('http://www.flickr.com/services/oembed')
+    c = OembedClient::Flickr.new('http://www.flickr.com/photos/brianlandau/6173724585/in/photostream')
+    c.url # => "http://farm7.static.flickr.com/6174/6173724585_8a984a740b.jpg"
+
+## Contributing to oembed_client
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+# Copyright
+
+Copyright (c) 2011 Brian Landau. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "oembed_client"
+  gem.homepage = "http://github.com/brianjlandau/oembed_client"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple abstract oEmbed Client for ruby.}
+  gem.description = %Q{A simple abstract oEmbed Client for ruby.}
+  gem.email = "brianjlandau@gmail.com"
+  gem.authors = ["Brian Landau"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+  test.rcov_opts << '--sort coverage'
+  test.rcov_opts << '--only-uncovered'
+end
+
+task :default => :test
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/oembed_client.rb

@@ -0,0 +1,93 @@
+require 'open-uri'
+require 'cgi'
+require 'multi_json'
+
+class OembedClient
+  attr_reader :url
+  
+  STANDARD_RESPONSE_PARAMS = %w(type version title author_name author_url provider_name
+   provider_url cache_age thumbnail_url thumbnail_width thumbnail_height
+   url width height)
+  
+  class << self
+    def create_client_class_for(url)
+      client_name = URI.parse(url).host.split('.')[-2].capitalize
+      klass = const_set(client_name, Class.new(self))
+      klass.base_url(url)
+      klass
+    end
+    
+    def base_url(url = nil)
+      if url.nil?
+        @base_url
+      else
+        @base_url = url
+      end
+    end
+    
+    def default_options(options = nil)
+      if options.nil?
+        @default_options ||= {}
+      else
+        @default_options = options
+      end
+    end
+  end
+  
+  def initialize(url, embed_options = {})
+    @url = url
+    @embed_options = embed_options
+  end
+  
+  def omembed_url
+    self.class.base_url+'?'+params
+  end
+  
+  def params
+    querify_params(self.class.default_options.merge(@embed_options).merge(:url => @url, :format => 'json'))
+  end
+  
+  def fetch
+    open(omembed_url)
+  end
+  
+  def response
+    @response ||= fetch.read
+  end
+  
+  def json
+    @json ||= MultiJson.decode(response)
+  end
+  
+  def embed_html
+    json['html']
+  end
+  
+  %w(photo video link rich).each do |embed_type|
+    define_method("#{embed_type}?") do
+      type == embed_type
+    end
+  end
+  
+  STANDARD_RESPONSE_PARAMS.each do |attribute|
+    define_method(attribute) do
+      json[attribute]
+    end
+  end
+  
+  def method_missing(name, *args, &block)
+    if json.keys.include?(name.to_s)
+      json[name.to_s]
+    else
+      super
+    end
+  end
+  
+  private
+  
+  def querify_params(params)
+    params.map {|key, value|
+      "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+    }.join('&')
+  end
+end

data/oembed_client.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{oembed_client}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Brian Landau}]
+  s.date = %q{2011-10-10}
+  s.description = %q{A simple abstract oEmbed Client for ruby.}
+  s.email = %q{brianjlandau@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/oembed_client.rb",
+    "oembed_client.gemspec",
+    "test/fixtures/vcr_cassettes/flickr_response.yml",
+    "test/fixtures/vcr_cassettes/response.yml",
+    "test/fixtures/vcr_cassettes/youtube_response.yml",
+    "test/helper.rb",
+    "test/test_oembed_client.rb"
+  ]
+  s.homepage = %q{http://github.com/brianjlandau/oembed_client}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{A simple abstract oEmbed Client for ruby.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<multi_json>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+    else
+      s.add_dependency(%q<multi_json>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<multi_json>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+  end
+end
+

data/test/fixtures/vcr_cassettes/flickr_response.yml

@@ -0,0 +1,44 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://www.flickr.com:80/services/oembed?format=json&url=http://www.flickr.com/photos/brianlandau/6173724585/in/photostream
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Mon, 10 Oct 2011 03:32:50 GMT
+      p3p:
+      - policyref="http://p3p.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM DEV
+        TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND PHY
+        ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE GOV"
+      set-cookie:
+      - localization=en-us%3Bus%3Bus; expires=Mon, 07-Oct-2013 03:32:50 GMT; path=/;
+        domain=.flickr.com
+      cache-control:
+      - private
+      x-served-by:
+      - www125.flickr.mud.yahoo.com
+      vary:
+      - Accept-Encoding
+      content-type:
+      - application/json
+      age:
+      - '0'
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      via:
+      - HTTP/1.1 r19.ycpi.mud.yahoo.net (YahooTrafficServer/1.20.4 [cMsSf ])
+      server:
+      - YTS/1.20.4
+    body: ! '{"version":"1.0","type":"photo","author_url":"http:\/\/www.flickr.com\/photos\/brianlandau\/","cache_age":3600,"provider_name":"Flickr","provider_url":"http:\/\/www.flickr.com\/","title":"IMG_3930","author_name":"Brian
+      Landau","width":"500","height":"375","url":"http:\/\/farm7.static.flickr.com\/6174\/6173724585_8a984a740b.jpg"}
+
+'
+    http_version: '1.1'

data/test/fixtures/vcr_cassettes/response.yml

@@ -0,0 +1,34 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://www.youtube.com:80/oembed?format=json&iframe=1&maxwidth=520&url=http://www.youtube.com/watch?v=4r7wHMg5Yjg
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Mon, 10 Oct 2011 03:24:09 GMT
+      server:
+      - Apache
+      x-content-type-options:
+      - nosniff
+      expires:
+      - Tue, 27 Apr 1971 19:44:06 EST
+      cache-control:
+      - no-cache
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+    body: ! '{"provider_url": "http:\/\/www.youtube.com\/", "title": "The Crazy Nastyass
+      Honey Badger (original narration by Randall)", "html": "\u003ciframe width=\"459\"
+      height=\"344\" src=\"http:\/\/www.youtube.com\/embed\/4r7wHMg5Yjg?fs=1\" frameborder=\"0\"
+      allowfullscreen\u003e\u003c\/iframe\u003e", "author_name": "czg123", "height":
+      344, "thumbnail_width": 480, "width": 459, "version": "1.0", "author_url": "http:\/\/www.youtube.com\/user\/czg123",
+      "provider_name": "YouTube", "thumbnail_url": "http:\/\/i1.ytimg.com\/vi\/4r7wHMg5Yjg\/hqdefault.jpg",
+      "type": "video", "thumbnail_height": 360}'
+    http_version: '1.1'

data/test/fixtures/vcr_cassettes/youtube_response.yml

@@ -0,0 +1,34 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://www.youtube.com:80/oembed?format=json&iframe=1&maxwidth=520&url=http://www.youtube.com/watch?v=4r7wHMg5Yjg
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Mon, 10 Oct 2011 03:32:26 GMT
+      server:
+      - Apache
+      x-content-type-options:
+      - nosniff
+      expires:
+      - Tue, 27 Apr 1971 19:44:06 EST
+      cache-control:
+      - no-cache
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+    body: ! '{"provider_url": "http:\/\/www.youtube.com\/", "title": "The Crazy Nastyass
+      Honey Badger (original narration by Randall)", "html": "\u003ciframe width=\"459\"
+      height=\"344\" src=\"http:\/\/www.youtube.com\/embed\/4r7wHMg5Yjg?fs=1\" frameborder=\"0\"
+      allowfullscreen\u003e\u003c\/iframe\u003e", "author_name": "czg123", "height":
+      344, "thumbnail_width": 480, "width": 459, "version": "1.0", "author_url": "http:\/\/www.youtube.com\/user\/czg123",
+      "provider_name": "YouTube", "thumbnail_url": "http:\/\/i1.ytimg.com\/vi\/4r7wHMg5Yjg\/hqdefault.jpg",
+      "type": "video", "thumbnail_height": 360}'
+    http_version: '1.1'

data/test/helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'vcr'
+require 'webmock'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'oembed_client'
+
+class YoutubeOembedClient < OembedClient
+  base_url 'http://www.youtube.com/oembed'
+  default_options :iframe => '1', :maxwidth => '520'
+end
+
+VCR.config do |c|
+  c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+  c.stub_with :webmock
+  c.default_cassette_options = { :record => :once }
+  c.allow_http_connections_when_no_cassette = true
+end
+
+class Test::Unit::TestCase
+end

data/test/test_oembed_client.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+class TestOembedClient < Test::Unit::TestCase
+  context 'OembedClient' do
+    should "be able to create a new client class on it's own" do
+      VCR.insert_cassette('flickr_response')
+      OembedClient.create_client_class_for('http://www.flickr.com/services/oembed')
+      OembedClient::Flickr.ancestors.include?(OembedClient)
+      assert_equal 'http://www.flickr.com/services/oembed', OembedClient::Flickr.base_url
+      c = OembedClient::Flickr.new('http://www.flickr.com/photos/brianlandau/6173724585/in/photostream')
+      assert_equal 'http://farm7.static.flickr.com/6174/6173724585_8a984a740b.jpg', c.url
+      assert c.photo?
+      VCR.eject_cassette
+    end
+    
+    context 'for existing YouTube client' do
+      setup do
+        VCR.insert_cassette('youtube_response')
+        @client = YoutubeOembedClient.new('http://www.youtube.com/watch?v=4r7wHMg5Yjg')
+      end
+
+      should 'correctly report that it is a video' do
+        assert @client.video?
+      end
+
+      should 'correctly report that it is not another type' do
+        assert !@client.photo?
+        assert !@client.link?
+        assert !@client.rich?
+      end
+
+      should 'correctly report the title' do
+        assert_equal 'The Crazy Nastyass Honey Badger (original narration by Randall)',
+          @client.title
+      end
+
+      should 'correctly report the embed html' do
+        assert_equal %q{<iframe width="459" height="344" src="http://www.youtube.com/embed/4r7wHMg5Yjg?fs=1" frameborder="0" allowfullscreen></iframe>},
+          @client.embed_html
+      end
+
+      teardown do
+        VCR.eject_cassette
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: oembed_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Landau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &2153207640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153207640
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2153207160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153207160
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153206680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153206680
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2153206200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2153206200
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2153205720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153205720
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2153205240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153205240
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &2153204760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153204760
+description: A simple abstract oEmbed Client for ruby.
+email: brianjlandau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/oembed_client.rb
+- oembed_client.gemspec
+- test/fixtures/vcr_cassettes/flickr_response.yml
+- test/fixtures/vcr_cassettes/response.yml
+- test/fixtures/vcr_cassettes/youtube_response.yml
+- test/helper.rb
+- test/test_oembed_client.rb
+homepage: http://github.com/brianjlandau/oembed_client
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2977244797834292682
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A simple abstract oEmbed Client for ruby.
+test_files: []