restr 0.4.0 → 0.5.0

data/History.txt

@@ -1,3 +1,11 @@
+== 0.5.0 :: 2009-01-07
+
+* A logger can be provided on a per-call basis, rather than just for the
+  Restr class as a whole. 
+  e.g.:
+    kitten_logger = Logger.new('kitten.log'} 
+    Restr.get('http://example.com/kittens/1.xml, {}, {:logger => kitten_logger}) 
+
 == 0.4.0 :: 2008-06-19
 
 * Better recognition of XML content; response MIME types ending in "/xml" and

data/README.txt

@@ -35,7 +35,7 @@ it under the terms of the GNU Lesser General Public License as published
 by the Free Software Foundation; either version 3 of the License, or
 (at your option) any later version.
 
-Reststop is distributed in the hope that it will be useful,
+Restr is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

data/config/hoe.rb

@@ -1,5 +1,3 @@
-require 'restr/version'
-
 AUTHOR = 'Matt Zukowski'  # can also be an array of Authors
 EMAIL = "matt@roughest.net"
 DESCRIPTION = "A very simple REST client."

data/lib/restr.rb

@@ -60,38 +60,57 @@ end
 #
 #   logger = Logger.new('restr.log')
 #   logger.level = Logger::DEBUG
-#   Restr.log = logger
+#   Restr.logger = logger
 #
-# Restr will now log its activity to the given Logger. Be careful when using
+# Restr will now log its activity to the given Logger.
+# The default_logger can be overridden by supplying a :logger option to
+# a client call:
+#
+#   kitten_logger = Logger.new('kitten.log'}
+#   Restr.get('http://example.com/kittens/1.xml, {}, 
+#     {:logger => kitten_logger)
 class Restr
   
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 4
+    MINOR = 5
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
   
   
-  @@log = nil
+  @@logger = nil
   @@request_timeout = 3.minutes
   
   cattr_accessor :request_timeout
   
   def self.logger=(logger)
-    @@log = logger.dup
+    @@logger = logger.dup
     # ActiveSupport's BufferedLogger doesn't seem to support progname= :(
-    @@log.progname = self.name if @@log.respond_to?(:progname)
+    @@logger.progname = self.name if @@logger.respond_to?(:progname)
+  end
+  
+  def self.logger
+    @@logger
   end
   
   def self.method_missing(method, *args)
     self.do(method, args[0], args[1] || {}, args[2])
   end
   
-  def self.do(method, url, params = {}, auth = nil)
+  def self.do(method, url, params = {}, options = {})
+    puts "METHOD:  #{method.inspect}"
+    puts "URL:     #{url.inspect}"
+    puts "PARAMS:  #{params.inspect}"
+    puts "OPTIONS: #{options.inspect}"
+    
     uri = URI.parse(url)
+    
     params = {} unless params
+    options = {} unless options
+    
+    logger = options[:logger] || self.logger
       
     method_mod = method.to_s.downcase.capitalize
     unless Net::HTTP.const_defined?(method_mod)
@@ -111,19 +130,16 @@ class Restr
     req = Net::HTTP.const_get(method_mod).new(uri.request_uri)
     
     
-    if auth
-      raise ArgumentError, 
-        "The `auth` parameter must be a Hash with a :username and :password value." unless 
-        auth.kind_of? Hash
-      req.basic_auth auth[:username] || auth['username'], auth[:password] || auth['password']
+    if options[:username] || options['username']
+      req.basic_auth options[:username] || options['username'], options[:password] || options['password']
     end
     
     if params.kind_of?(Hash) && method_mod != 'Get' && method_mod != 'get'
       req.set_form_data(params, '&')
     end
     
-    @@log.debug("Sending #{method.inspect} request to #{url.inspect} with data #{params.inspect}"+
-        (auth ? " with authentication" : "")+".") if @@log
+    logger.debug("Sending #{method.inspect} request to #{url.inspect} with data #{params.inspect}"+
+        (options ? " with options" : "")+".") if logger
  
     client = Net::HTTP.new(uri.host, uri.port)
     client.use_ssl = (uri.scheme == 'https')
@@ -142,24 +158,25 @@ class Restr
     case res
     when Net::HTTPSuccess
       if res.content_type =~ /[\/+]xml$/
-        @@log.debug("Got XML response: \n#{res.body}") if @@log
+        logger.debug("Got XML response: \n#{res.body}") if logger
         return XmlSimple.xml_in_string(res.body,
           'forcearray'   => false,
           'keeproot'     => false
         )
       else
-        @@log.debug("Got #{res.content_type.inspect} response: \n#{res.body}") if @@log
+        logger.debug("Got #{res.content_type.inspect} response: \n#{res.body}") if logger
         return res.body
       end
     when TimeoutError
-      @@log.debug(res) if @@log
+      logger.debug(res) if logger
       return XmlSimple.xml_in_string(res,
           'forcearray'   => false,
           'keeproot'     => false
         )
     else
       $LAST_ERROR_BODY = res.body # FIXME: this is dumb... need a better way of reporting errors
-      @@log.error("Got error response '#{res.message}(#{res.code})': #{$LAST_ERROR_BODY}") if @@log
+      $LAST_ERROR_RESPONSE = res # this is currently unused within Restr, but may be useful for debugging 
+      logger.error("Got error response '#{res.message}(#{res.code})': #{res.body.blank? ? '(blank response body)' : res.body}") if logger
       res.error!
     end
   end

data/script/txt2html

@@ -11,7 +11,7 @@ end
 require 'redcloth'
 require 'syntax/convertors/html'
 require 'erb'
-require File.dirname(__FILE__) + '/../lib/restr/version.rb'
+require File.dirname(__FILE__) + '/../lib/restr.rb'
 
 version  = Restr::VERSION::STRING
 download = 'http://rubyforge.org/projects/restr'

data/website/index.html

@@ -33,83 +33,51 @@
     <h1>restr</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/restr"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/restr" class="numbers">0.3.0</a>
+      <a href="http://rubyforge.org/projects/restr" class="numbers">0.5.0</a>
     </div>
-    <h1>&#x2192; &#8216;restr&#8217;</h1>
-
-
-	<h3>Copyright&#169; 2008 Urbacon Ltd.</h3>
-
-
-	<h2>What is it?</h2>
-
-
-	<p><b>Restr is a very simple client for <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">RESTful</a> web services.</b> 
+    <h3>Copyright &#169; 2008 Urbacon Ltd.</h3>
+<h2>What is it?</h2>
+<p><b>Restr is a very simple client for <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">RESTful</a> web services.</b> <br />
 It was developed as a lightweight alternative to <a href="http://api.rubyonrails.com/files/vendor/rails/activeresource/README.html">ActiveResource</a>.</p>
-
-
-	<p>For project info and downloads please see the Restr&#8217;s <a href="http://rubyforge.org/projects/restr">RubyForge Page</a></p>
-
-
-	<h2>Installing</h2>
-
-
-	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">restr</span></pre></p>
-
-
-	<h2>Usage Example</h2>
-
-
-	<p>Fetch Kitten with id 1 and print out its name and colour:</p>
-
-
-	<pre><code>require 'restr'
-kitten = Restr.get('http://example.com/kittens/1.xml')
-puts kitten['name']
-puts kitten['colour']</code></pre>
-
-
-	<p>Change the Kitten&#8217;s colour and store the modification:</p>
-
-
-	<pre><code>kitten['colour'] = 'black'
-kitten = Restr.put('http://example.com/kittens/1.xml', kitten)</code></pre>
-
-
-	<h2>Further Resources</h2>
-
-
-	<ul>
-	<li><a href="http://restr.rubyforge.org/rdoc/" title="RDocs">Full <span class="caps">API</span> Documentation</a></li>
-	</ul>
-
-
-	<h2>How to submit patches</h2>
-
-
-	<ul>
+<p>For project info and downloads please see the Restr&#8217;s <br />
+<a href="http://rubyforge.org/projects/restr">RubyForge Page</a></p>
+<h2>Installing</h2>
+<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">restr</span></pre></p>
+<h2>Usage Example</h2>
+<p>Fetch Kitten with id 1 and print out its name and colour:</p>
+<p><pre class='syntax'>
+<span class="ident">require</span> <span class="punct">'</span><span class="string">restr</span><span class="punct">'</span>
+<span class="ident">kitten</span> <span class="punct">=</span> <span class="constant">Restr</span><span class="punct">.</span><span class="ident">get</span><span class="punct">('</span><span class="string">http://example.com/kittens/1.xml</span><span class="punct">')</span>
+<span class="ident">puts</span> <span class="ident">kitten</span><span class="punct">['</span><span class="string">name</span><span class="punct">']</span>
+<span class="ident">puts</span> <span class="ident">kitten</span><span class="punct">['</span><span class="string">colour</span><span class="punct">']</span>
+</pre></p>
+<p>Change the Kitten&#8217;s colour and store the modification:</p>
+<p><pre class='syntax'>
+<span class="ident">kitten</span><span class="punct">['</span><span class="string">colour</span><span class="punct">']</span> <span class="punct">=</span> <span class="punct">'</span><span class="string">black</span><span class="punct">'</span>
+<span class="ident">kitten</span> <span class="punct">=</span> <span class="constant">Restr</span><span class="punct">.</span><span class="ident">put</span><span class="punct">('</span><span class="string">http://example.com/kittens/1.xml</span><span class="punct">',</span> <span class="ident">kitten</span><span class="punct">)</span>
+</pre></p>
+<h2>Further Resources</h2>
+<ul>
+	<li><a href="http://restr.rubyforge.org/rdoc/">Full <span class="caps">API</span> Documentation RDocs</a></li>
+	<li><a href="http://rubyforge.org/projects/reststop/">Reststop</a> &#8212; makes it easy to implement RESTful controllers in the Camping microframework</li>
+	<li><a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">Wikipedia Article on <span class="caps">REST</span></a></li>
+</ul>
+<h2>How to submit patches</h2>
+<ul>
 	<li>See below for author&#8217;s contact info.</li>
-		<li>The trunk repository is <code>svn://rubyforge.org/var/svn/restr/trunk</code> for anonymous access.</li>
-	</ul>
-
-
-	<h2>License</h2>
-
-
-	<ul>
+	<li>The trunk repository is <code>svn://rubyforge.org/var/svn/restr/trunk</code> for anonymous access.</li>
+</ul>
+<h2>License</h2>
+<ul>
 	<li><a href="http://www.gnu.org/licenses/lgpl.html">Lesser <span class="caps">GPL</span> Version 3</a></li>
-	</ul>
-
-
-	<h2>Contact</h2>
-
-
-	<ul>
+</ul>
+<h2>Contact</h2>
+<ul>
 	<li><a href="http://rubyforge.org/users/gunark/">Author&#8217;s Rubyforge Page</a></li>
-		<li><a href="http://rubyforge.org/forum/?group_id=5848">Restr RubyForge Forum</a></li>
-	</ul>
+	<li><a href="http://rubyforge.org/forum/?group_id=5848">Restr RubyForge Forum</a></li>
+</ul>
     <p class="coda">
-      <a href="FIXME email">FIXME full name</a>, 3rd April 2008<br>
+      <a href="mailto:matt@roughest.net">Matt Zukowski</a>, 20th October 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -1,7 +1,5 @@
 h1. restr
 
-h1. → 'restr'
-
 h3. Copyright (c) 2008 Urbacon Ltd.
 
 h2. What is it?
@@ -9,7 +7,8 @@ h2. What is it?
 <b>Restr is a very simple client for "RESTful":http://en.wikipedia.org/wiki/Representational_State_Transfer web services.</b> 
 It was developed as a lightweight alternative to "ActiveResource":http://api.rubyonrails.com/files/vendor/rails/activeresource/README.html.
 
-For project info and downloads please see the Restr's "RubyForge Page":http://rubyforge.org/projects/restr
+For project info and downloads please see the Restr's 
+"RubyForge Page":http://rubyforge.org/projects/restr
 
 h2. Installing
 
@@ -19,19 +18,25 @@ h2. Usage Example
 
 Fetch Kitten with id 1 and print out its name and colour:
 
-  require 'restr'
-  kitten = Restr.get('http://example.com/kittens/1.xml')
-  puts kitten['name']
-  puts kitten['colour']
-  
+<pre syntax="ruby">
+require 'restr'
+kitten = Restr.get('http://example.com/kittens/1.xml')
+puts kitten['name']
+puts kitten['colour']
+</pre>
+
 Change the Kitten's colour and store the modification:
-  
-  kitten['colour'] = 'black'
-  kitten = Restr.put('http://example.com/kittens/1.xml', kitten)
+
+<pre syntax="ruby">
+kitten['colour'] = 'black'
+kitten = Restr.put('http://example.com/kittens/1.xml', kitten)
+</pre>
 
 h2. Further Resources
 
-* "Full API Documentation (RDocs)":http://restr.rubyforge.org/rdoc/
+* "Full API Documentation RDocs":http://restr.rubyforge.org/rdoc/
+* "Reststop":http://rubyforge.org/projects/reststop/ -- makes it easy to implement RESTful controllers in the Camping microframework
+* "Wikipedia Article on REST":http://en.wikipedia.org/wiki/Representational_State_Transfer 
 
 h2. How to submit patches
 

data/website/template.rhtml

@@ -37,7 +37,7 @@
     </div>
     <%= body %>
     <p class="coda">
-      <a href="FIXME email">FIXME full name</a>, <%= modified.pretty %><br>
+      <a href="mailto:matt@roughest.net">Matt Zukowski</a>, <%= modified.pretty %><br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: restr
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Matt Zukowski
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-19 00:00:00 -04:00
+date: 2009-01-07 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
 description: A very simple REST client.
 email: 
 - matt@roughest.net
@@ -75,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: restr
-rubygems_version: 1.0.1
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A very simple REST client.