oembed 0.0.1 → 0.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+script: bundle exec rspec spec

data/README.md

@@ -40,7 +40,6 @@ Lets start with a simple example. It will be a client for the awesome
 ```ruby
 require 'oembed'
 
-# Speaker Deck client
 class SpeakerDeck
   include Oembed::Client
 
@@ -55,12 +54,12 @@ That's it. Now you can use a method `#fetch` to get data from oEmbed enpoint of
 
 ```ruby
 client = SpeakerDeck.new
-p client.fetch('https://speakerdeck.com/u/soulim/p/rails')
+client.fetch('https://speakerdeck.com/u/soulim/p/rails')
 ```
 
 The method `#fetch` will return a hash with oEmded data.
 
-```json
+```ruby
 {
   "type" => "rich",
   "version" => 1.0,
@@ -70,12 +69,70 @@ The method `#fetch` will return a hash with oEmded data.
   "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,
+  "width" => 710,q
   "height" => 596
 }
 ```
 
-At the moment `oembed` gem supports the JSON format only. I will fix it soon. Stay tuned! :)
+`oembed` gem supports JSON and XML response formats. Here is an example of
+client for XML endpoint.
+
+```ruby
+require 'oembed'
+
+class Flickr
+  include Oembed::Client
+
+  def endpoint_uri
+    'http://www.flickr.com/services/oembed.xml'
+  end
+end
+
+client = Flickr.new
+client.fetch('http://www.flickr.com/photos/alex_soulim/3593916989')
+```
+
+It will return:
+
+```ruby
+{
+  "type"=>"photo",
+  "title"=>"IMG_2072",
+  "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", 
+  "web_page"=>"http://www.flickr.com/photos/alex_soulim/3593916989/",
+  "thumbnail_url"=>"http://farm4.staticflickr.com/3618/3593916989_3d8aa991ea_s.jpg",
+  "thumbnail_width"=>"75",
+  "thumbnail_height"=>"75",
+  "web_page_short_url"=>"http://flic.kr/p/6tzLj2",
+  "license"=>"All Rights Reserved",
+  "license_id"=>"0",
+  "version"=>"1.0",
+  "cache_age"=>"3600",
+  "provider_name"=>"Flickr",
+  "provider_url"=>"http://www.flickr.com/"
+}
+```
+
+You can make requests with additional parameters. Let's build a client for
+Instagram and use `:maxwidth` parameter.
+
+```ruby
+require 'oembed'
+
+class Instagram
+  include Oembed::Client
+
+  def endpoint_uri
+    'http://api.instagram.com/oembed'
+  end
+end
+
+client = Instagram.new
+client.fetch('http://instagr.am/p/BUG/', maxwidth: 300)
+```
 
 ## Contributing
 
@@ -84,3 +141,10 @@ At the moment `oembed` gem supports the JSON format only. I will fix it soon. St
 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
+
+## 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)
+
+This library is tested against the following Ruby implementations:
+
+- Ruby 1.9.2
+- Ruby 1.9.3

data/lib/oembed/client.rb

@@ -12,16 +12,16 @@ module Oembed
       @http ||= Oembed::Http.new
     end
 
-    def fetch(resource_uri)
+    def fetch(resource_uri, params = {})
       begin
-        fetch!(resource_uri)
+        fetch!(resource_uri, params)
       rescue Oembed::Error
         nil
       end
     end
 
-    def fetch!(resource_uri)
-      uri = Oembed::Uri.new(endpoint_uri, resource_uri)
+    def fetch!(resource_uri, params = {})
+      uri = Oembed::Uri.new(endpoint_uri, resource_uri, params)
       http.get(uri.to_s)
     end
   end

data/lib/oembed/parser.rb

@@ -29,7 +29,7 @@ module Oembed
     end
 
     def xml(body)
-      raise NotImplementedError, 'XML parser is not implemented'
+      Oembed::XmlParser.parse(body)
     end
   end
 end

data/lib/oembed/uri.rb

@@ -2,9 +2,9 @@
 
 module Oembed
   class Uri
-    def initialize(endpoint_uri, resource_uri)
+    def initialize(endpoint_uri, resource_uri, params = {})
       @uri = URI.parse(endpoint_uri)
-      @uri.query = URI.encode_www_form(url: resource_uri)
+      @uri.query = URI.encode_www_form(params.merge(url: resource_uri))
     end
 
     def to_s

data/lib/oembed/version.rb

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

data/lib/oembed/xml_parser.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Oembed
+  class XmlParser
+    def self.parse(source)
+      begin
+        document = REXML::Document.new(source)
+        traverse(document.root)
+      rescue REXML::ParseException => e
+        raise Oembed::ParserError.new(e), 'XML parser error'
+      end
+    end
+
+    private
+
+    def self.traverse(node)
+      node.elements.to_a.inject({}) do |accum, elem|
+        accum[elem.name] = elem.has_elements? ? traverse(elem) : elem.text
+        accum
+      end
+    end
+  end
+end

data/lib/oembed.rb

@@ -2,6 +2,7 @@
 require 'net/http'
 require 'json'
 require 'uri'
+require 'rexml/document'
 
 module Oembed
   class Error < StandardError; end
@@ -28,6 +29,7 @@ module Oembed
 
   autoload :Client, 'oembed/client'
   autoload :Parser, 'oembed/parser'
+  autoload :XmlParser, 'oembed/xml_parser'
   autoload :Http, 'oembed/http'
   autoload :Uri, 'oembed/uri'
 end

data/oembed.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   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.homepage      = "http://soulim.github.com/oembed"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/oembed/client_spec.rb

@@ -13,6 +13,10 @@ describe Oembed::Client do
   end
 
   describe '#fetch' do
+    it 'should accept optional params' do
+      expect {subject.fetch(resource_uri, width: 100) }.not_to raise_error
+    end
+
     it 'should fetch the date using self.fetch!' do
       subject.should_receive(:fetch!)
       subject.fetch(resource_uri)
@@ -28,9 +32,13 @@ describe Oembed::Client do
   end
 
   describe '#fetch!' do
+    it 'should accept optional params' do
+      expect {subject.fetch(resource_uri, width: 100) }.not_to raise_error
+    end
+
     it 'should prepare request URI' do
-      Oembed::Uri.should_receive(:new).with(endpoint_uri, resource_uri)
-      subject.fetch!(resource_uri)
+      Oembed::Uri.should_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

data/spec/oembed/parser_spec.rb

@@ -1,9 +1,15 @@
 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' }
+  let(:body)      { { 'foo' => 'bar', 'baz' => "1" } }
+  let(:json_body) { '{"foo":"bar","baz":"1"}' }
+  let(:xml_body)  do
+    %q(<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+       <oembed>
+         <foo>bar</foo>
+         <baz>1</baz>
+       </oembed>)
+  end
 
   describe '#parse' do
     context 'when content type is JSON' do
@@ -13,10 +19,8 @@ describe Oembed::Parser do
     end
 
     context 'when content type is XML' do
-      it 'should raise NotImplementedError' do
-        expect {
-          subject.parse(xml_body, 'text/xml')
-        }.to raise_error(NotImplementedError)
+      it 'should return parsed body' do
+        expect(subject.parse(xml_body, 'text/xml')).to eq(body)
       end
     end
 

data/spec/oembed/uri_spec.rb

@@ -6,6 +6,16 @@ describe Oembed::Uri do
 
   subject { Oembed::Uri.new(endpoint_uri, resource_uri) }
 
+  it 'should accept optional params' do
+    uri = Oembed::Uri.new(endpoint_uri, resource_uri, width: 100)
+
+    query_string = URI.parse(uri.to_s).query
+    query_data   = URI.decode_www_form(query_string)
+    query        = Hash[query_data]
+
+    expect(query['width']).to eq('100')
+  end
+
   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')

data/spec/oembed/xml_parser_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Oembed::XmlParser do
+  let(:source) do
+    %q(<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+       <oembed>
+         <foo>text</foo>
+         <bar>
+           <baz>1</baz>
+         </bar>
+       </oembed>)
+  end
+  let(:result) { { 'foo' => 'text', 'bar' => { 'baz' => '1' } } }
+
+  describe '.parse' do
+    it 'should parse given source' do
+      expect(Oembed::XmlParser.parse(source)).to eq(result)
+    end
+
+    context 'when there is an exception during parsing' do
+      before do
+        REXML::Document.stub(:new).and_raise(REXML::ParseException.new('error'))
+      end
+
+      it 'should raise Oembed::ParserError' do
+        expect {
+          Oembed::XmlParser.parse(source)
+        }.to raise_error(Oembed::ParserError)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oembed
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
+date: 2012-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -68,6 +68,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -78,14 +79,16 @@ files:
 - lib/oembed/parser.rb
 - lib/oembed/uri.rb
 - lib/oembed/version.rb
+- lib/oembed/xml_parser.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/xml_parser_spec.rb
 - spec/oembed_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/soulim/oembed
+homepage: http://soulim.github.com/oembed
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -114,5 +117,6 @@ test_files:
 - spec/oembed/http_spec.rb
 - spec/oembed/parser_spec.rb
 - spec/oembed/uri_spec.rb
+- spec/oembed/xml_parser_spec.rb
 - spec/oembed_spec.rb
 - spec/spec_helper.rb