wrest 0.0.5 → 0.0.6

data/README.rdoc

@@ -2,7 +2,9 @@
 
 (c) Copyright 2009 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
 
-Wrest is a ruby REST client library which allows you to quickly build object oriented wrappers around any web service. It has two components - Wrest Core and Wrest::Resource.
+Wrest is a ruby REST client library which allows you to quickly build object oriented wrappers around any web service. It has two components - Wrest Core and Wrest::Resource. 
+
+Since no single framework can provide an object oriented wrapper suitable for _all_ available web services, it follows that Wrest should focus on providing you with the tools to help you roll your own with ease. Wrest::Resource is an example of this - an object oriented wrapper for the kind of REST APIs exposed by Rails applications built using Wrest Core.
 
 == Installation
 
@@ -10,13 +12,12 @@ The source is available at git://github.com/kaiwren/wrest.git
 
 To install as a Rails plugin, do <tt>script/plugin install git://github.com/kaiwren/wrest.git</tt>
 
-To install the Wrest gem, do <tt>sudo gem install wrest</tt>
+To install the Wrest gem, do <tt>sudo gem install wrest</tt>; Wrest is also available as a gem for JRuby using the same command.
 
 == Wrest Core
 
 * Designed to be used as a library, not just a command line REST client
-* Provides basic infrastructure (including an interactive shell) and convenient HTTP wrappers
-* Makes it easy to extend and modify both serialisation, deserialisation and object creation
+* Provides infrastructure components such as convenient HTTP wrappers api, caching, redirect handling, serialisation, deserialisation etc.
 * Isn't coupled to Rails (usable in a pure Ruby application to consume any REST api)
 * Can be used both stand alone as well as to build object oriented abstractions around web services (Wrest::Resource is an example of the latter)
 
@@ -46,14 +47,22 @@ A couple of ways to get the Yahoo news as hash map (needs the JSON gem - gem ins
 * This example simply does a get on a uri and figures out the appropriate deserialiser using the content-type (in this case 'text/javascript', which uses Wrest::Translators::Json). See content_types.rb under lib/wrest/mappers/translators.
  "http://search.yahooapis.com/NewsSearchService/V1/newsSearch?appid=YahooDemo&output=json&query=India&results=3&start=1".to_uri.get.deserialise
 
-* This example does a get on a base uri with several parameters passed to it, resulting in a uri essentially the same as the one above. It also shows how you can use a custom deserialiser to produce a hash-map from the response. 
- "http://search.yahooapis.com/NewsSearchService/V1/newsSearch".to_uri.get(
-									:appid  => 'YahooDemo', 
-									:output => 'xml',
-									:query  => 'India',
-									:results=> '3',
-									:start  => '1'
-								).deserialise_using(Wrest::Translators::Xml)
+* This example does a get on a base uri with several parameters passed to it, resulting in a uri essentially the same as the one above. It also shows how you can specify a custom deserialiser to produce a hash-map from the response, as well as a hash mutator to clean up the deserialised hash.
+  require 'rubygems'
+  require 'wrest'
+
+  include Wrest::Components
+  p "http://search.yahooapis.com/NewsSearchService/V1/newsSearch".to_uri.get(
+																			  :appid  => 'YahooDemo', 
+																			  :output => 'xml',
+																			  :query  => 'India',
+																			  :results=> '3',
+																			  :start  => '1'
+																			).deserialise_using(
+																			  Translators::Xml
+																			).mutate_using(
+																			  Mutators::XmlSimpleTypeCaster.new
+																			)
 
 
 === Logging
@@ -67,12 +76,13 @@ Standard options are available and can be listed using <tt>rake -T</tt>. Use rak
 
 == Documentation
 
-Wrest RDocs can be found at http://wrest.rubyforge.org/
+Wrest RDocs can be found at http://wrest.rubyforge.org
 
 == Wrest::Resource 
 
-Wrest::Resource is an alternative to ActiveResource which targets Rails REST services; it is currently under development.
+Wrest::Resource is an alternative to ActiveResource. It targets Rails REST services and is currently under development.
 
+* No more pretending that REST resources are the same as database records
 * Out of the box support for collections
 * Out of the box support for collection pagination (including support for WillPaginate), both header based and xml attribute based
 * Out of the box support for operations on all the records on the collection
@@ -85,13 +95,17 @@ Wrest::Resource is an alternative to ActiveResource which targets Rails REST ser
 
 == Dependencies
 
+=== Source
 * gems
 * xmlsimple
-* json
-* rspec
-* rcov
+* json (json-jruby on JRuby)
 * active_support
 
+=== Build
+* rspec
+* rcov (unsupported on JRuby)
+* jeweler
+
 == Support
 
 This project uses Assembla for ticketing: http://www.assembla.com/spaces/wrest/tickets

data/Rakefile

@@ -7,13 +7,14 @@
 # is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and limitations under the License.
 
+require 'rubygems'
 gem 'rspec'
 require 'rake'
-require 'rake/rdoctask'
+require 'hanna/rdoctask'
 require 'spec'
 require 'spec/rake/spectask'
-require 'rcov'
-require 'rcov/rcovtask'
+
+puts "Building on Ruby #{RUBY_VERSION}, #{RUBY_RELEASE_DATE}, #{RUBY_PLATFORM}"
 
 desc 'Default: run spec tests.'
 task :default => :spec
@@ -27,21 +28,27 @@ end
 desc 'Generate documentation for Wrest'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = 'WRest'
+  rdoc.title = 'Wrest Documentation'
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-desc "Run all specs in spec directory with RCov"
-Spec::Rake::SpecTask.new(:rcov) do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList["spec/wrest/**/*_spec.rb"]
-  t.rcov = true
-  t.rcov_opts = lambda do
-    IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+begin
+  require 'rcov'
+  require 'rcov/rcovtask'
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "spec/spec.opts"]
+    t.spec_files = FileList["spec/wrest/**/*_spec.rb"]
+    t.rcov = true
+    t.rcov_opts = lambda do
+      IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+    end
+    # t.verbose = true
   end
-  # t.verbose = true
+rescue LoadError
+  puts "Rcov not available."
 end
 
 begin
@@ -55,14 +62,20 @@ begin
     gemspec.homepage = "http://github.com/kaiwren/wrest"
     gemspec.has_rdoc = true
     gemspec.rubyforge_project = 'wrest'
-    gemspec.platform = Gem::Platform::RUBY
     gemspec.executables = ['wrest']
     gemspec.require_path = "lib"
     gemspec.files.exclude 'spec/wrest/meh_spec.rb'
     gemspec.test_files.exclude 'spec/wrest/meh_spec.rb'
-    gemspec.add_dependency('activesupport', '>= 2.1.0')    
-    gemspec.add_dependency('json', '>= 1.1.3')    
-    gemspec.add_dependency('xml-simple', '>= 1.0.11')    
+    gemspec.add_dependency('activesupport', '>= 2.1.0')
+    gemspec.add_dependency('xml-simple', '>= 1.0.11')
+    case RUBY_PLATFORM
+    when /java/
+      gemspec.add_dependency('json-jruby', '>= 1.1.3')  
+      gemspec.platform = 'java'
+    else
+      gemspec.add_dependency('json', '>= 1.1.3')  
+      gemspec.platform = Gem::Platform::RUBY
+    end
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
@@ -79,7 +92,7 @@ begin
       desc "Publish RDoc to RubyForge."
       task :docs => [:rdoc] do
         config = YAML.load(
-            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        File.read(File.expand_path('~/.rubyforge/user-config.yml'))
         )
 
         host = "#{config['username']}@rubyforge.org"
@@ -100,131 +113,131 @@ namespace (:benchmark) do
   task :setup_test_classes do
     require 'active_resource'
     require 'wrest'
-    
-    class Ooga < Wrest::Mappers::Resource::Base;end
-    class Booga < ActiveResource::Base; self.site='';end
-  end
-  
-  desc "Benchmark when objects are created each time before getting data; i.e there are few queries per instantiation"
-  task :create_and_get => :setup_test_classes do |t|    
-    
-    n = 10000
-    puts "Running #{n} times per report"
-    Benchmark.bmbm(10) do |rpt|
-      rpt.report("Wrest::Resource") do
-        n.times { 
-          ooga = Ooga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
-          ooga.profession
-          ooga.profession?
-          ooga.enhanced_by 
-          ooga.enhanced_by? 
-        }
-      end
 
-      rpt.report("ActiveResource") do
-        n.times { 
-          booga = Booga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
-          booga.profession
-          booga.profession?
-          booga.enhanced_by 
-          booga.enhanced_by?
-        }
-      end
-    end
-  end
-  
-  desc "Benchmark when objects are created beforehand; i.e there are many queries per instantiation"
-  task :create_once_and_get => :setup_test_classes do |t|    
-
-    n = 10000
-    puts "Running #{n} times per report"
-    
-    Benchmark.bmbm(10) do |rpt|      
-      rpt.report("Wrest::Resource") do
-        ooga = Ooga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
-        
-        n.times { 
-          ooga.profession
-          ooga.profession?
-          ooga.enhanced_by 
-          ooga.enhanced_by?
-        }
+    class Ooga < Wrest::Mappers::Resource::Base;end
+      class Booga < ActiveResource::Base; self.site='';end
       end
 
-      rpt.report("ActiveResource") do
-        booga = Booga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
-                
-        n.times { 
-          booga.profession
-          booga.profession?
-          booga.enhanced_by 
-          booga.enhanced_by?
-        }
-      end
-    end
-  end
-  
-  desc "Benchmark objects respond_to? performance without invocation"
-  task :responds_to_before => :setup_test_classes do |t|    
-
-    n = 10000
-    puts "Running #{n} times per report"
-    
-    Benchmark.bmbm(10) do |rpt|      
-      rpt.report("Wrest::Resource") do
-        ooga = Ooga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
-        
-        n.times { 
-          ooga.respond_to?(:profession)
-          ooga.respond_to?(:profession?)
-          ooga.respond_to?(:profession=)
-        }
+      desc "Benchmark when objects are created each time before getting data; i.e there are few queries per instantiation"
+      task :create_and_get => :setup_test_classes do |t|
+
+        n = 10000
+        puts "Running #{n} times per report"
+        Benchmark.bmbm(10) do |rpt|
+          rpt.report("Wrest::Resource") do
+            n.times {
+              ooga = Ooga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
+              ooga.profession
+              ooga.profession?
+              ooga.enhanced_by
+              ooga.enhanced_by?
+            }
+          end
+
+          rpt.report("ActiveResource") do
+            n.times {
+              booga = Booga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
+              booga.profession
+              booga.profession?
+              booga.enhanced_by
+              booga.enhanced_by?
+            }
+          end
+        end
       end
 
-      rpt.report("ActiveResource") do
-        booga = Booga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
-                
-        n.times { 
-          booga.respond_to?(:profession)
-          booga.respond_to?(:profession?)
-          booga.respond_to?(:profession=)
-        }
+      desc "Benchmark when objects are created beforehand; i.e there are many queries per instantiation"
+      task :create_once_and_get => :setup_test_classes do |t|
+
+        n = 10000
+        puts "Running #{n} times per report"
+
+        Benchmark.bmbm(10) do |rpt|
+          rpt.report("Wrest::Resource") do
+            ooga = Ooga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
+
+            n.times {
+              ooga.profession
+              ooga.profession?
+              ooga.enhanced_by
+              ooga.enhanced_by?
+            }
+          end
+
+          rpt.report("ActiveResource") do
+            booga = Booga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
+
+            n.times {
+              booga.profession
+              booga.profession?
+              booga.enhanced_by
+              booga.enhanced_by?
+            }
+          end
+        end
       end
-    end
-  end
 
-  desc "Benchmark objects respond_to? performance after invocation"
-  task :responds_to_after => :setup_test_classes do |t|    
-
-    n = 10000
-    puts "Running #{n} times per report"
-    
-    Benchmark.bmbm(10) do |rpt|      
-      rpt.report("Wrest::Resource") do
-        ooga = Ooga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
-        ooga.profession
-        ooga.profession?
-        ooga.profession = ''
-        
-        n.times { 
-          ooga.respond_to?(:profession)
-          ooga.respond_to?(:profession?)
-          ooga.respond_to?(:profession=)
-        }
+      desc "Benchmark objects respond_to? performance without invocation"
+      task :responds_to_before => :setup_test_classes do |t|
+
+        n = 10000
+        puts "Running #{n} times per report"
+
+        Benchmark.bmbm(10) do |rpt|
+          rpt.report("Wrest::Resource") do
+            ooga = Ooga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
+
+            n.times {
+              ooga.respond_to?(:profession)
+              ooga.respond_to?(:profession?)
+              ooga.respond_to?(:profession=)
+            }
+          end
+
+          rpt.report("ActiveResource") do
+            booga = Booga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
+
+            n.times {
+              booga.respond_to?(:profession)
+              booga.respond_to?(:profession?)
+              booga.respond_to?(:profession=)
+            }
+          end
+        end
       end
 
-      rpt.report("ActiveResource") do
-        booga = Booga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
-        booga.profession
-        booga.profession?
-        booga.profession = ''
-                        
-        n.times { 
-          booga.respond_to?(:profession)
-          booga.respond_to?(:profession?)
-          booga.respond_to?(:profession=)
-        }
+      desc "Benchmark objects respond_to? performance after invocation"
+      task :responds_to_after => :setup_test_classes do |t|
+
+        n = 10000
+        puts "Running #{n} times per report"
+
+        Benchmark.bmbm(10) do |rpt|
+          rpt.report("Wrest::Resource") do
+            ooga = Ooga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
+            ooga.profession
+            ooga.profession?
+            ooga.profession = ''
+
+            n.times {
+              ooga.respond_to?(:profession)
+              ooga.respond_to?(:profession?)
+              ooga.respond_to?(:profession=)
+            }
+          end
+
+          rpt.report("ActiveResource") do
+            booga = Booga.new(:id => 5, :profession => 'Natural Magician', :enhanced_by => 'Kai Wren')
+            booga.profession
+            booga.profession?
+            booga.profession = ''
+
+            n.times {
+              booga.respond_to?(:profession)
+              booga.respond_to?(:profession?)
+              booga.respond_to?(:profession=)
+            }
+          end
+        end
       end
     end
-  end
-end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 5
+:patch: 6
 :minor: 0
 :major: 0

data/bin/jwrest

@@ -0,0 +1,3 @@
+#!/usr/bin/env jruby
+
+load(File.dirname(__FILE__)+'/wrest_shell.rb')

data/bin/wrest

@@ -1,22 +1,3 @@
 #!/usr/bin/env ruby
 
-#!/usr/bin/env ruby
-entry_point = "#{File.dirname(__FILE__)}/../lib/wrest.rb"
-version = "#{File.dirname(__FILE__)}/../lib/wrest/version"
-
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-require 'optparse'
-options = { :irb => irb }
-OptionParser.new do |opt|
-  opt.banner = "Usage: console [options]"
-  opt.on("--irb=[#{irb}]", 'Invoke a different irb.') { |v| options[:irb] = v }
-  opt.parse!(ARGV)
-end
-
-libs =  " -r irb/completion"
-libs << " -r #{entry_point}"
-
-require version
-puts "Loading (Wrest #{Wrest::VERSION::STRING})"
-exec "#{options[:irb]} #{libs} --simple-prompt"
+load(File.dirname(__FILE__)+'/wrest_shell.rb')