restr 0.3.0

data/.loadpath

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<loadpath>
+	<pathentry path="" type="src"/>
+	<pathentry path="org.rubypeople.rdt.launching.RUBY_CONTAINER" type="con"/>
+</loadpath>

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>restr</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.rubypeople.rdt.core.rubybuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.rubypeople.rdt.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/History.txt

@@ -0,0 +1,3 @@
+== 0.3.0 :: 2008-04-03
+
+* First public release -- moved out from the Reststop library into its own gem.

data/License.txt

@@ -0,0 +1,165 @@
+       GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Manifest.txt

@@ -0,0 +1,25 @@
+.loadpath
+.project
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/restr.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_restr.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,44 @@
+= Restr
+
+<b>Restr is a very simple client for RESTful[http://en.wikipedia.org/wiki/Representational_State_Transfer] 
+web services.</b> It is developed as a lightweight alternative to 
+ActiveResource[http://api.rubyonrails.com/files/vendor/rails/activeresource/README.html]. 
+
+For project info and downloads please see http://rubyforge.org/projects/restr
+
+
+*Author*::    Matt Zukowski (matt at roughest dot net)
+*Copyright*:: Copyright (c) 2008 Urbacon Ltd.
+*License*::   GNU Lesser General Public License Version 3
+
+
+
+Restr is basically a wrapper around Ruby's Net::HTTP, offering
+a more RESTfully meaningful interface.
+
+See the Restr class documentation for more info, but here's a simple
+example of RESTful interaction with Restr:
+
+  require 'restr'
+  kitten = Restr.get('http://example.com/kittens/1.xml')
+  puts kitten['name']
+  puts kitten['colour']
+  
+  kitten['colour'] = 'black'
+  kitten = Restr.put('http://example.com/kittens/1.xml', kitten)
+
+
+== License
+
+Restr is free software; you can redistribute it and/or modify
+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,
+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.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,72 @@
+require 'restr/version'
+
+AUTHOR = 'Matt Zukowski'  # can also be an array of Authors
+EMAIL = "matt@roughest.net"
+DESCRIPTION = "A very simple REST client."
+GEM_NAME = 'restr'
+RUBYFORGE_PROJECT = 'restr' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+ENV['NODOT'] = '1'
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+#REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Restr::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'restr documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--lib",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'restr'

data/lib/restr.rb

@@ -0,0 +1,139 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'cgi'
+
+begin
+  require 'xml_simple'
+rescue LoadError
+  require 'rubygems'
+  require 'active_support'
+  begin
+  require 'xml_simple'
+  rescue LoadError
+    require 'xmlsimple'
+  end
+end
+
+
+# A very simple REST client, best explained by example:
+#
+#   # Retrieve a Kitten and print its name and colour
+#   kitten = Restr.get('http://example.com/kittens/1.xml')
+#   puts kitten['name']
+#   puts kitten['colour']
+#
+#   # Create a Kitten
+#   kitten = Restr.post('http://example.com/kittens.xml', 
+#     :name => 'batman', :colour => 'black')
+#
+#   # Update a Kitten
+#   kitten = Restr.put('http://example.com/kittens/1.xml', 
+#     :age => '6 months')
+#
+#   # Delete a Kitten :(
+#   kitten = Restr.delete('http://example.com/kittens/1.xml')
+#
+#   # Retrieve a list of Kittens
+#   kittens = Restr.get('http://example.com/kittens.xml')
+#
+# When the response to a Restr request has content type 'text/xml', the
+# response body will be parsed from XML into a nested Hash (using XmlSimple 
+# -- see http://xml-simple.rubyforge.org/). Otherwise the response is  
+# returned untouched, as a String.
+#
+# If the remote REST resource requires authentication (Restr only supports
+# HTTP Basic authentication, for now):
+#
+#   Restr.get('http://example.com/kittens/1.xml, {}, 
+#     {:username => 'foo', :password => 'bar'})
+#
+class Restr
+  
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 3
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+  
+  
+  @@log = nil
+  
+  def self.logger=(logger)
+    @@log = logger.dup
+    # ActiveSupport's BufferedLogger doesn't seem to support progname= :(
+    @@log.progname = self.name if @@log.respond_to?(:progname)
+  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)
+    uri = URI.parse(url)
+    params = {} unless params
+      
+    method_mod = method.to_s.downcase.capitalize
+    unless Net::HTTP.const_defined?(method_mod)
+      raise InvalidRequestMethod, 
+        "Callback method #{method.inspect} is not a valid HTTP request method."
+    end
+    
+    if method_mod == 'Get'
+      q = params.collect{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"}.join("&")
+      if uri.query
+        uri.query += "&#{q}"
+      else
+        uri.query = q
+      end
+    end
+    
+    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']
+    end
+    
+    unless 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
+ 
+    client = Net::HTTP.new(uri.host, uri.port)
+    client.use_ssl = (uri.scheme == 'https')
+    res = client.start do |http|
+      http.request(req)
+    end
+    
+    case res
+    when Net::HTTPSuccess
+      if res.content_type == 'text/xml'
+        @@log.debug("Got XML response.") if @@log
+        return XmlSimple.xml_in_string(res.body,
+          'forcearray'   => false,
+          'keeproot'     => false
+        )
+      else
+        @@log.debug("Got #{res.content_type.inspect} response.") if @@log
+        return res.body
+      end
+    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
+      res.error!      
+    end
+  end
+  
+  class InvalidRequestMethod < Exception
+  end
+end