wrest 0.0.7 → 0.0.8

data/README.rdoc

@@ -1,10 +1,21 @@
-= Wrest
+= Wrest 
 
 (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. 
 
-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.
+If you were wondering why the words 'demon', 'chi' and 'puppies' (among others) show up in nearly every example and spec, it's because they all refer to characters and ideas from {Roger Zelazny's}[http://en.wikipedia.org/wiki/Roger_Zelazny] last book, 'Lord Demon.'
+
+== Wrest Core: Features
+
+* Provides convenient HTTP wrappers, serialisation and deserialisation with caching and redirect handling in the works.
+* Designed to be used as a library, not just a command line REST client (fewer class methods, more object oriented)
+* Isn't coupled to Rails (usable in a pure Ruby application to consume any HTTP/REST api)
+* Can be used both stand alone as well as to build object oriented abstractions around resources and web services (Wrest::Resource is an example of the latter)
+
+== Examples
+
+See http://github.com/kaiwren/wrest/tree/master/examples
 
 == Installation
 
@@ -12,20 +23,14 @@ 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>; 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 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)
+To install the Wrest gem, do <tt>(sudo) gem install wrest</tt>
+Wrest is also available as a gem for JRuby; you can instally it by running <tt>(sudo) jruby -S gem install wrest</tt>.
 
 === Usage: Shell
 
 You can launch the interactive Wrest shell by running bin/wrest if you have the source or invoking <tt>wrest</tt> from your prompt if you've installed the gem.
   $ wrest
-  >> "http://search.yahooapis.com/NewsSearchService/V1/newsSearch?appid=YahooDemo&output=json&query=India&results=3&start=1".to_uri.get
+  >> y 'http://twitter.com/statuses/public_timeline.json'.to_uri.get.deserialise
 
 === Usage: Library
 
@@ -38,11 +43,11 @@ You can launch the interactive Wrest shell by running bin/wrest if you have the
 									:results=> '3',
 									:start  => '1'
 								)
-=== Basic Http Calls
+=== Usage: Basic Http Calls
 
 ==== GET
 
-A couple of ways to get the Yahoo news as hash map. 
+A couple of ways to get Yahoo news as a hash map. 
 
 * 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
@@ -60,8 +65,20 @@ A couple of ways to get the Yahoo news as hash map.
 								).deserialise_using(
 									Translators::Xml
 								).mutate_using(
-									Mutators::XmlSimpleTypeCaster.new
-								)									  
+									Mutators::XmlMiniTypeCaster.new
+								)
+
+==== DELETE
+
+To delete a resource:
+
+ 'https://api.del.icio.us/v1/posts/delete'.to_uri(
+                                              :username => 'kaiwren',
+                                              :password => 'fupupp1es'
+                                            ).delete(
+                                              :url => 'http://c2.com'
+                                            )
+ 
 
 ==== OPTIONS
 
@@ -70,7 +87,7 @@ To find out what actions are permitted on a URI:
  'http://www.yahoo.com'.to_uri.options.headers['allow']
 
 
-=== Attributes Container
+=== Usage: Attributes Container
 
 Allows any class to hold an attributes hash, somewhat like ActiveResource. It also supports several extensions to this base fuctionality such as support for typecasting attribute values.
 
@@ -80,18 +97,18 @@ Example:
    include Wrest::Components::AttributesContainer
    include Wrest::Components::AttributesContainer::Typecaster
 
-   always_has	    :id  
+   always_has	      :id  
    typecast         :age          =>  as_integer,
                     :chi          =>  lambda{|chi| Chi.new(chi)}
  end
 
  kai_wren = Demon.new('id => '1', 'age' => '1500', 'chi' => '1024', 'teacher' => 'Viss')
- kai_wren.id            # => '1'
- kai_wren.age           # => 1500
- kai_wren.chi           # => #<Chi:0x113af8c @count="1024">
+ kai_wren.id			# => '1'
+ kai_wren.age			# => 1500
+ kai_wren.chi			# => #<Chi:0x113af8c @count="1024">
  kai_wren.teacher		# => 'Viss'
 
-=== Logging
+=== Usage: Logging
 
 The Wrest logger can be set and accessed through Wrest.logger and is configured by default to log to STDOUT. If you're using Wrest in a Rails application, you can configure logging by placing the following line in your environment file:
   Wrest.logger = ActiveRecord::Base.logger
@@ -106,7 +123,8 @@ Wrest RDocs can be found at http://wrest.rubyforge.org
 
 == Wrest::Resource 
 
-Wrest::Resource is an alternative to ActiveResource. It targets Rails REST (well, POX - turns out Rails isn't really REST) services and is currently under development.
+Wrest::Resource is an alternative to Rails' ActiveResource. It targets Rails REST (well, POX, since Rails isn't really RESTful) services and is currently under development. Since no single REST library 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. Wrest::Resource is an example of this - an object oriented wrapper for the kind of REST APIs exposed by Rails applications, that you would otherwise use ActiveResource to consume.
+
 
 * No more pretending that REST resources are the same as records in a database (yeah, no more freaking ActiveResource::Connection)
 * Treat put as 'create or update,' not just 'update'
@@ -123,6 +141,7 @@ Wrest::Resource is an alternative to ActiveResource. It targets Rails REST (well
 * More natural mapping of deserialised entities to existing classes
 * No communication via exceptions for http error status codes
 * Better extensibility - allows access to request/response objects, avoids class variables, favours symbols over strings etc.
+* Content Types in request headers
 * Consider support for OPTIONS and response codes 100/417
 
 == Dependencies

data/Rakefile

@@ -7,13 +7,24 @@
 # 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 'spec'
-require 'spec/rake/spectask'
-
 puts "Building on Ruby #{RUBY_VERSION}, #{RUBY_RELEASE_DATE}, #{RUBY_PLATFORM}"
+puts "Note that some optional libraries/gems that the build (not Wrest itself) uses may not be available on all implementations of Ruby."
+
+if Object.const_defined?('RAILS_ROOT')
+  require File.dirname(__FILE__) + '/../../../config/environment'
+else
+  require 'rubygems'
+  gem 'rspec'
+  require 'rake'
+  require 'spec'
+  require 'spec/rake/spectask'
+  
+  begin
+    require 'metric_fu'
+  rescue LoadError
+    puts 'metric_fu is not available. Install it with: gem install jscruggs-metric_fu -s http://gems.github.com'
+  end
+end
 
 desc 'Default: run spec tests.'
 task :default => :spec
@@ -27,9 +38,9 @@ end
 begin
   require 'hanna/rdoctask'
 rescue LoadError
-  puts 'Hanna not available, using standard Rake rdoctask. Fix this by running gem install mislav-hanna.'
+  puts 'Hanna not available, using standard Rake rdoctask. Install it with: gem install mislav-hanna.'
   require 'rake/rdoctask'
-end  
+end
 desc 'Generate documentation for Wrest'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -74,15 +85,15 @@ begin
     gemspec.add_dependency('activesupport', '>= 2.3.2')
     case RUBY_PLATFORM
     when /java/
-      gemspec.add_dependency('json-jruby', '>= 1.1.3')  
+      gemspec.add_dependency('json-jruby', '>= 1.1.3')
       gemspec.platform = 'java'
     else
-      gemspec.add_dependency('json', '>= 1.1.3')  
+      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"
+  puts "Jeweler not available. Install it with: gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
 begin

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 7
+:patch: 8
 :minor: 0
 :major: 0

data/examples/delicious.rb

@@ -0,0 +1,58 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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 File.expand_path(File.dirname(__FILE__) + "/../lib/wrest")
+require 'pp'
+
+Wrest.logger = Logger.new(STDOUT)
+Wrest.logger.level = Logger::DEBUG  # Set this to Logger::INFO or higher to disable request logging
+
+# API reference: http://delicious.com/help/api
+class Delicious
+  def initialize(options)
+    @uri = "https://api.del.icio.us/v1/posts".to_uri(options)
+  end
+  
+  def bookmarks(parameters = {})
+    @uri['/get'].get(parameters)
+  end
+  
+  def recent(parameters = {})
+    @uri['/recent'].get(parameters)
+  end
+  
+  def bookmark(parameters)
+    @uri['/add'].post('', {}, parameters)
+  end
+  
+  def delete(parameters)
+    @uri['/delete'].delete(parameters)
+  end
+end
+
+account = Delicious.new :username => 'kaiwren', :password => 'fupupp1es'
+
+pp account.bookmark(
+    :url => 'http://blog.sidu.in/search/label/ruby',
+    :description => 'The Ruby related posts on my blog!',
+    :extended => "All posts tagged with 'ruby'",
+    :tags => 'ruby hacking'
+  ).deserialise
+  
+puts '----------'
+
+pp account.bookmarks(:tag => 'rails', :dt => '20090712').deserialise
+
+puts '----------'
+
+pp recently_saved_uris = account.recent(:tag => 'ruby').deserialise["posts"]["post"].collect{|bookmark| bookmark['href']}
+
+puts '----------'
+
+pp account.delete(:url => 'http://blog.sidu.in/search/label/ruby').deserialise

data/examples/wow_realm_status.rb

@@ -0,0 +1,57 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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 File.expand_path(File.dirname(__FILE__) + "/../lib/wrest")
+
+Wrest.logger = Logger.new(STDOUT)
+Wrest.logger.level = Logger::DEBUG  # Set this to Logger::INFO or higher to disable request logging
+
+include Wrest
+
+class Realm
+  include Components::AttributesContainer
+  include Components::AttributesContainer::Typecaster
+
+  typecast  :t => lambda{|type| 
+                    case type
+                      when '1' then 'Normal'
+                      when '2' then 'PvP'
+                      when '3' then 'RP'
+                      when '4' then 'RP PvP'
+                    end    
+                  },
+            :s => lambda{|status| 
+                    case status
+                      when '1' then 'Available'
+                      else 'Unavailable'
+                    end  
+                  },
+            :l => lambda{|load|
+                    case load
+                      when '1' then 'Low'
+                      when '2' then 'Normal'
+                      when '3' then 'High'
+                      when '4' then 'Max'
+                    end  
+                  }
+  
+  def available?
+    self.s == 'Available'
+  end                
+end
+
+realms = "http://www.worldofwarcraft.com/realmstatus/status.xml".to_uri.get.deserialise['page']['rs']['r'].collect{|data| Realm.new(data)}
+
+puts "Status of Nagrand: #{realms.find{|realm| realm.n == 'Nagrand'}.s}"
+puts
+puts "All Available Realms:"
+puts
+puts "Realm\tLoad\tType"
+puts "-----------"
+realms.select(&:available?).each{|realm| puts "#{realm.n}\t#{realm.l}\t#{realm.t}" }

data/lib/wrest/components/attributes_container.rb

@@ -100,8 +100,6 @@ module Wrest::Components
       # own class.
       def initialize(attributes = {})
         @attributes = attributes.symbolize_keys
-        @interface = Module.new
-        self.extend @interface
       end
 
       def [](key)
@@ -124,11 +122,11 @@ module Wrest::Components
         if @attributes.include?(attribute_name.to_sym) || method_name.last == '='
           case method_name.last
           when '='
-            @interface.module_eval AttributesContainer.build_attribute_setter(attribute_name)
+            self.instance_eval AttributesContainer.build_attribute_setter(attribute_name)
           when '?'
-            @interface.module_eval AttributesContainer.build_attribute_queryer(attribute_name)
+            self.instance_eval AttributesContainer.build_attribute_queryer(attribute_name)
           else
-            @interface.module_eval AttributesContainer.build_attribute_getter(attribute_name)
+            self.instance_eval AttributesContainer.build_attribute_getter(attribute_name)
           end
           send(method_sym, *arguments)
         else

data/lib/wrest/core_ext/string/conversions.rb

@@ -14,8 +14,8 @@ module Wrest
       module Conversions
 
         # A convenience method equivalent to Wrest::Uri.new(string)
-        def to_uri
-          Wrest::Uri.new(self)
+        def to_uri(options = {})
+          Wrest::Uri.new(self, options)
         end
       end
     end

data/lib/wrest/http/delete.rb

@@ -0,0 +1,23 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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.
+
+module Wrest::Http
+  class Delete < Request
+    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+      super(
+            wrest_uri, 
+            Net::HTTP::Delete, 
+            parameters,
+            nil,
+            headers,
+            options
+          )
+    end
+  end
+end

data/lib/wrest/http/get.rb

@@ -0,0 +1,23 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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.
+
+module Wrest::Http
+  class Get < Request
+    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+      super(
+            wrest_uri, 
+            Net::HTTP::Get, 
+            parameters,
+            nil,
+            headers,
+            options
+          )
+    end
+  end
+end

data/lib/wrest/http/options.rb

@@ -0,0 +1,23 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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.
+
+module Wrest::Http
+  class Options < Request
+    def initialize(wrest_uri, options = {})
+      super(
+            wrest_uri, 
+            Net::HTTP::Options, 
+            {},
+            nil,
+            {},
+            options
+          )
+    end
+  end
+end

data/lib/wrest/http/post.rb

@@ -0,0 +1,23 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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.
+
+module Wrest::Http
+  class Post < Request
+    def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
+      super(
+        wrest_uri,
+        Net::HTTP::Post,
+        parameters,
+        body,
+        headers,
+        options
+      )
+    end
+  end
+end

data/lib/wrest/http/put.rb

@@ -0,0 +1,23 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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.
+
+module Wrest::Http
+  class Put < Request
+    def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
+      super(
+        wrest_uri,
+        Net::HTTP::Put,
+        parameters,
+        body,
+        headers,
+        options
+      )
+    end
+  end
+end

data/lib/wrest/http/request.rb

@@ -0,0 +1,48 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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.
+
+module Wrest::Http
+  class Request
+    attr_reader :http_request, :uri, :body, :headers, :username, :password
+    def initialize(wrest_uri, http_request_klass, parameters = {}, body = nil, headers = {}, options = {})
+      @uri = wrest_uri
+      @headers = headers.stringify_keys
+      @http_request = http_request_klass.new(parameters.empty? ? wrest_uri.full_path : "#{wrest_uri.full_path}?#{parameters.to_query}", @headers)
+      @body = body
+      @options = options
+      @username = options[:username]
+      @password = options[:password]
+    end
+
+    # Makes a request and returns a Wrest::Http::Response. 
+    # Data about the request is and logged to Wrest.logger
+    def invoke
+      response = nil
+
+      prefix = "#{http_request.method} #{http_request.hash}"
+      http_request.basic_auth username, password
+
+      Wrest.logger.debug "--> (#{prefix}) #{@uri.protocol}://#{@uri.host}:#{@uri.port}#{@http_request.path}"
+      time = Benchmark.realtime { response = Wrest::Http::Response.new( http.request(@http_request, @body) ) }
+      Wrest.logger.debug "<-- (#{prefix}) %d %s (%d bytes %.2fs)" % [response.code, response.message, response.body ? response.body.length : 0, time]
+
+      response
+    end
+
+    private
+    def http
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      if @uri.https?
+        http.use_ssl     = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http
+    end
+  end
+end

data/lib/wrest/http/response.rb

@@ -0,0 +1,44 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License"); 
+# you may not use this file except in compliance with the License. 
+# You may obtain a copy of the License at Http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License 
+# 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. 
+
+module Wrest #:nodoc:
+  module Http #:nodoc:
+    # Decorates a response providing support for deserialisation.
+    #
+    # The following methods are also available (unlisted by rdoc because they're forwarded):
+    #
+    # <tt>:@Http_response,  :code, :message, :body, :Http_version,
+    # :[], :content_length, :content_type, :each_header, :each_name, :each_value, :fetch,
+    # :get_fields, :key?, :type_params</tt>
+    #
+    # They behave exactly like their Net::HttpResponse equivalents.
+    class Response
+      extend Forwardable
+      def_delegators  :@http_response,  :code, :message, :body, :Http_version,
+              :[], :content_length, :content_type, :each_header, :each_name, :each_value, :fetch,
+              :get_fields, :key?, :type_params
+
+      def initialize(http_response)
+        @http_response = http_response
+      end
+
+      def deserialise
+        deserialise_using(Wrest::Components::Translators.lookup(@http_response.content_type))
+      end
+
+      def deserialise_using(translator)
+        translator.deserialise(@http_response)
+      end
+
+      def headers
+        @http_response.to_hash
+      end
+    end
+  end
+end

data/lib/wrest/http.rb

@@ -0,0 +1,24 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# 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.
+
+module Wrest #:nodoc:
+
+  # Contains all HTTP protocol related classes such as
+  # Get, Post, Request, Response etc.
+  module Http
+  end
+end
+
+require "#{WREST_ROOT}/wrest/http/response"
+require "#{WREST_ROOT}/wrest/http/request"
+require "#{WREST_ROOT}/wrest/http/get"
+require "#{WREST_ROOT}/wrest/http/put"
+require "#{WREST_ROOT}/wrest/http/post"
+require "#{WREST_ROOT}/wrest/http/delete"
+require "#{WREST_ROOT}/wrest/http/options"