transcoder 0.1.0 → 0.2.0

data/CHANGES

@@ -0,0 +1,7 @@
+= 0.2.0
+  * Added Transcoder.for method for a shorter version of Transcoder::Parser.for
+  * Added Yaml parser
+  * Switched all parsers to use autoload for their associated library dependencies (http://gist.github.com/324367)
+
+= 0.1.0 (06/02/2010)
+  *  Initial release

data/README.md

@@ -8,6 +8,10 @@ Say you'd pulled an API based resource using `rest-client`
   * All that you wanted was a ruby object.
   * You don't want to know anything about the format that the API uses. 
   * You're pretty sure its something pretty common.
+  
+## Install
+
+    gem install transcoder
 
 ## Example
     $ irb -rubygems
@@ -17,7 +21,7 @@ Say you'd pulled an API based resource using `rest-client`
     
     >> rc = RestClient.get('http://vimeo.com/api/v2/benschwarz/likes.json')
     
-    >> Transcoder::Parser.for(rc.headers[:content_type]).parse(rc.to_s)
+    >> Transcoder.for(rc.headers[:content_type]).parse(rc.to_s)
     
 What you'll get back is a Ruby object. Lovley.
 
@@ -27,6 +31,11 @@ What you'll get back is a Ruby object. Lovley.
 * XML
 * RSS / Atom
 
+### Note about RSS / Atom
+
+Transcoder will return a SimpleRSS object rather than a straight up Ruby hash, this shouldn't be (much) of a reason for concern.
+This simply means that you'll want to call the properties of the returned object with method calls rather than hash access.
+
 ## Future thoughts
 
 * Add something to cast attributes to a native ruby object, eg - if its key is created_at, try to date parse it.

data/Rakefile

@@ -11,7 +11,7 @@ begin
     gem.homepage = "http://github.com/benschwarz/transcoder"
     gem.authors = ["Ben Schwarz"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "restclient"
+    gem.add_development_dependency "rest-client"
     gem.add_dependency "registry", ">= 0.1.2"
     gem.add_dependency "json"
     gem.add_dependency "crack"

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/core_ext/autoload.rb

@@ -0,0 +1,27 @@
+class Object
+  class << self
+    alias_method :_const_missing, :const_missing
+    private :_const_missing
+    
+    def const_missing(constant)
+      if Kernel._autoloads.key? constant
+        require Kernel._autoloads[constant]
+        const_get(constant)
+      else 
+        _const_missing(constant)
+      end
+    end
+  end
+end
+
+module Kernel
+  module_function :autoload
+  
+  def _autoloads
+    @@_autoloads
+  end
+  
+  def autoload(const, path)
+    (@@_autoloads||={})[const] = path
+  end
+end

data/lib/transcoder.rb

@@ -1,13 +1,24 @@
 require 'registry'
 
 module Transcoder
+  VERSION = File.read(File.join(File.dirname(__FILE__), "..", "VERSION"))
+  
   class Parser
     extend Registry
   end
+  
+  def self.for(mime)
+    Parser.for(mime)
+  end
 end
 
+# Autoload that works with Rubygems, 
+# rather than from the current $LOAD_PATH only
+require 'core_ext/autoload'
+
 $LOAD_PATH << File.dirname(__FILE__)
 
 require 'transcoder/parser/json'
 require 'transcoder/parser/xml'
-require 'transcoder/parser/feed'
+require 'transcoder/parser/feed'
+require 'transcoder/parser/yaml'

data/lib/transcoder/parser/feed.rb

@@ -1,4 +1,4 @@
-require "simple-rss"
+autoload :SimpleRSS, "simple-rss"
 
 module Transcoder
   class Feed < Parser
@@ -6,7 +6,7 @@ module Transcoder
                "application/rss+xml"
   
     def self.parse(raw)
-      ::SimpleRSS.parse(raw)
+      SimpleRSS.parse(raw)
     end
   end
 end

data/lib/transcoder/parser/json.rb

@@ -1,4 +1,4 @@
-require "json"
+autoload :JSON, "json"
 
 module Transcoder
   class Json < Parser
@@ -9,7 +9,7 @@ module Transcoder
                "text/x-json"
                
     def self.parse(raw)
-      ::JSON.parse(raw)
+      JSON.parse(raw)
     end
   end
 end

data/lib/transcoder/parser/xml.rb

@@ -1,4 +1,4 @@
-require "crack"
+autoload :Crack, "crack"
 
 module Transcoder
   class XML < Parser
@@ -6,7 +6,7 @@ module Transcoder
                "application/xml"
              
     def self.parse(raw)
-      ::Crack::XML.parse(raw)
+      Crack::XML.parse(raw)
     end
   end
 end

data/lib/transcoder/parser/yaml.rb

@@ -0,0 +1,14 @@
+autoload :YAML, "yaml"
+
+module Transcoder
+  class Yaml < Parser
+    identifier "text/yaml",
+               "text/x-yaml",
+               "application/yaml",
+               "application/x-yaml"
+    
+    def self.parse(raw)
+      YAML.load(raw)
+    end
+  end
+end

data/spec/parser/feed_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Transcoder::Feed do
+  it "should parse the feed and return a ruby object" do
+    atom = <<-ATOM
+      <?xml version="1.0" encoding="utf-8"?>
+
+      <feed xmlns="http://www.w3.org/2005/Atom">
+
+      	<title>Example Feed</title>
+      	<subtitle>A subtitle.</subtitle>
+      	<link href="http://example.org/feed/" rel="self" />
+      	<link href="http://example.org/" />
+      	<id>urn:uuid:60a76c80-d399-11d9-b91C-0003939e0af6</id>
+      	<updated>2003-12-13T18:30:02Z</updated>
+      	<author>
+      		<name>John Doe</name>
+      		<email>johndoe@example.com</email>
+      	</author>
+
+      	<entry>
+      		<title>Atom-Powered Robots Run Amok</title>
+      		<link href="http://example.org/2003/12/13/atom03" />
+      		<link rel="alternate" type="text/html" href="http://example.org/2003/12/13/atom03.html"/>
+      		<link rel="edit" href="http://example.org/2003/12/13/atom03/edit"/>
+      		<id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
+      		<updated>2003-12-13T18:30:02Z</updated>
+      		<summary>Some text.</summary>
+      	</entry>
+
+      </feed>
+    ATOM
+    
+    Transcoder.for("application/atom+xml").parse(atom).should be_an_instance_of(SimpleRSS)
+  end
+end

data/spec/parser/json_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Transcoder::Json do
+  it "should parse the json and return a ruby object" do
+    Transcoder.for("application/json").parse('{"key": "value"}').should == {"key" => "value"}
+  end
+end

data/spec/parser/xml_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Transcoder::XML do
+  it "should parse the xml and return a ruby object" do
+    Transcoder.for("application/xml").parse("<key>value</key>").should == {"key" => "value"}
+  end
+end

data/spec/parser/yaml_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Transcoder::Yaml do
+  it "should parse the yaml and return a ruby object" do
+    Transcoder.for("application/x-yaml").parse("key: value").should == {"key" => "value"}
+  end
+end

data/spec/spec.opts

@@ -1 +1,2 @@
 --color
+-b 

data/spec/transcoder_spec.rb

@@ -1,17 +1,26 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Transcoder" do
+  it "should alias Transcoder.for to Transcoder::Parser.for" do
+    Transcoder::Parser.should_receive(:for).with("application/json")
+    Transcoder.for("application/json")
+  end
+  
   describe "mime-types" do
     it "should parse json" do
-      Transcoder::Parser.for('application/json').should == Transcoder::Json
+      Transcoder.for('application/json').should == Transcoder::Json
     end
     
     it "should parse xml" do
-      Transcoder::Parser.for('text/xml').should == Transcoder::XML
+      Transcoder.for('text/xml').should == Transcoder::XML
     end
     
     it "should parse rss or atom" do
-      Transcoder::Parser.for('application/atom+xml').should == Transcoder::Feed
+      Transcoder.for('application/atom+xml').should == Transcoder::Feed
+    end
+    
+    it "should parse yaml" do
+      Transcoder.for('application/x-yaml').should == Transcoder::Yaml
     end
   end
 end

data/transcoder.gemspec

@@ -0,0 +1,84 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{transcoder}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Schwarz"]
+  s.date = %q{2010-03-08}
+  s.description = %q{Transcode from json, xml or atom/rss feeds to Ruby.}
+  s.email = %q{ben.schwarz@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGES",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/core_ext/autoload.rb",
+     "lib/transcoder.rb",
+     "lib/transcoder/parser/feed.rb",
+     "lib/transcoder/parser/json.rb",
+     "lib/transcoder/parser/xml.rb",
+     "lib/transcoder/parser/yaml.rb",
+     "spec/parser/feed_spec.rb",
+     "spec/parser/json_spec.rb",
+     "spec/parser/xml_spec.rb",
+     "spec/parser/yaml_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/transcoder_spec.rb",
+     "transcoder.gemspec"
+  ]
+  s.homepage = %q{http://github.com/benschwarz/transcoder}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Transcode from common web based formats into plain old Ruby.}
+  s.test_files = [
+    "spec/parser/feed_spec.rb",
+     "spec/parser/json_spec.rb",
+     "spec/parser/xml_spec.rb",
+     "spec/parser/yaml_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/transcoder_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<registry>, [">= 0.1.2"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<crack>, [">= 0"])
+      s.add_runtime_dependency(%q<simple-rss>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<registry>, [">= 0.1.2"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<crack>, [">= 0"])
+      s.add_dependency(%q<simple-rss>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<registry>, [">= 0.1.2"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<crack>, [">= 0"])
+    s.add_dependency(%q<simple-rss>, [">= 0"])
+  end
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ben Schwarz
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 +11:00
+date: 2010-03-08 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: restclient
+  name: rest-client
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
@@ -105,17 +105,25 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGES
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
+- lib/core_ext/autoload.rb
 - lib/transcoder.rb
 - lib/transcoder/parser/feed.rb
 - lib/transcoder/parser/json.rb
 - lib/transcoder/parser/xml.rb
+- lib/transcoder/parser/yaml.rb
+- spec/parser/feed_spec.rb
+- spec/parser/json_spec.rb
+- spec/parser/xml_spec.rb
+- spec/parser/yaml_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/transcoder_spec.rb
+- transcoder.gemspec
 has_rdoc: true
 homepage: http://github.com/benschwarz/transcoder
 licenses: []
@@ -147,5 +155,9 @@ signing_key:
 specification_version: 3
 summary: Transcode from common web based formats into plain old Ruby.
 test_files: 
+- spec/parser/feed_spec.rb
+- spec/parser/json_spec.rb
+- spec/parser/xml_spec.rb
+- spec/parser/yaml_spec.rb
 - spec/spec_helper.rb
 - spec/transcoder_spec.rb