jeffrafter-resource_party 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jeff Rafter
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,150 @@
+resource_party
+==============
+
+ResourceParty is a simple wrapper around HTTParty that allows you to do basic
+operations with a restful resource (presumably implemented in rails). It 
+assumes a scaffolded resource in the following form:
+
+  class FoosController < ApplicationController
+    # GET /foo
+    # GET /foo.xml
+    def index
+      @foo = Foo.find(:all)
+      respond_to do |format|
+        format.html # index.rhtml
+        format.xml  { render :xml => @foo.to_xml }
+      end
+    end
+
+    # GET /foo/1
+    # GET /foo/1.xml
+    def show
+      @foo = Foo.find(params[:id])
+      respond_to do |format|
+        format.html # show.rhtml
+        format.xml  { render :xml => @foo.to_xml }
+      end
+    rescue ActiveRecord::RecordNotFound => rnf
+      render :text => rnf.message, :status => :not_found
+    rescue Exception => e
+      render :text => e.message, :status => :error    
+    end
+
+    # GET /foo/new
+    def new
+      @foo = Foo.new
+      respond_to do |format|
+        format.html # new.rhtml
+        format.xml  { render :xml => @foo.to_xml }
+      end
+    end
+
+    # GET /foo/1;edit
+    def edit
+      @foo = Foo.find(params[:id])
+    end
+
+    # POST /foo
+    # POST /foo.xml
+    def create
+      @foo = Foo.new(params[:foo])
+      respond_to do |format|
+        if @foo.save
+          flash[:notice] = 'Foo type was successfully created.'
+          format.html { redirect_to foo_url(@foo) }
+          format.xml  { render :xml => @foo.to_xml }
+        else
+          format.html { render :action => "new" }
+          format.xml  { render :xml => @foo.errors.to_xml }
+        end
+      end
+    rescue Exception => e
+      render :text => e.message, :status => :error    
+    end
+
+    # PUT /foo/1
+    # PUT /foo/1.xml
+    def update
+      @foo = Foo.find(params[:id])
+      respond_to do |format|
+        if @foo.update_attributes(params[:foo])
+          flash[:notice] = 'Foo type was successfully updated.'
+          format.html { redirect_to foo_url(@foo) }
+          format.xml  { render :xml => @foo.to_xml }
+        else
+          format.html { render :action => "edit" }
+          format.xml  { render :xml => @foo.errors.to_xml }
+        end
+      end
+    rescue ActiveRecord::RecordNotFound => rnf
+      render :text => rnf.message, :status => :not_found
+    rescue Exception => e
+      render :text => e.message, :status => :error    
+    end
+
+    # DELETE /foo/1
+    # DELETE /foo/1.xml
+    def destroy
+      @foo = Foo.find(params[:id])
+      @foo.destroy
+      respond_to do |format|
+        format.html { redirect_to foo_url }
+        format.xml  { head :ok }
+      end
+    rescue ActiveRecord::RecordNotFound => rnf
+      render :text => rnf.message, :status => :not_found
+    rescue Exception => e
+      render :text => e.message, :status => :error    
+    end
+  end
+
+Returning head :ok for create and update is permissable (though I find returning
+the actual resource is potentially more helpful as there may have been changes
+made in the model before_create or before_update).
+
+Notice that there is explicit exception handling which improves the 
+communication. This will hopefully be expanded to include better validation 
+error handling.
+
+To make your models join the party:
+
+  require 'resource_party'
+
+  class Foo < ResourceParty::Base
+    base_uri 'http://localhost:3000'
+    route_for 'foos'
+    resource_for 'foo'
+  end
+
++route_for+ will be used to generate the path, i.e. "/{route_for}/4.xml"
++resource_for+ will be used when building params (like form_for)
+
+I know both of these are automatic if you are already using active_support by
+using class.to_s.downcase.singularize and friends. But hey.
+
+Once this is built you should be able to 
+
+  Foo.all
+  => returns an array of Foos (from the index)
+  
+  Foo.find(id)
+  => returns a foo or a ResourceParty::RecordNotFound
+  
+  Foo.destroy(id) or foo.destroy
+  => Deletes the foo, returns true if successful
+  
+  Foo.update(id, {:my_field => "this is the change!"}) or foo.update(...)
+  => Updates the foo with the params, returns true if the controller 
+  => responds with :head, otherwise returns the foo
+
+  Foo.create({:my_field => "this is the new stuff"})
+  => Creates the foo with the params, returns true if the controller 
+  => responds with :head, otherwise returns the foo
+  
+  Foo.new
+  => Fetches a blank foo so that defaulted params are possible
+  
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Jeff Rafter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "resource_party"
+    s.summary = "Simplified resource interaction using HTTParty"
+    s.email = "jeff@baobabhealth.org"
+    s.homepage = "http://github.com/jeffrafter/resource_party"
+    s.description = "Simple wrapper for HTTParty for basic operations with a restful resource"
+    s.authors = ["Jeff Rafter"]
+    s.add_dependency "jnunemaker-httparty"
+    s.files =  FileList["[A-Z]*", "{lib,test}/**/*"] 
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'resource_party'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :test

data/VERSION.yml

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

data/lib/resource_party.rb

@@ -0,0 +1,99 @@
+require 'httparty'
+
+module ResourceParty
+  class ServerError < RuntimeError; end
+  class RecordNotFound < RuntimeError; end
+  class Base
+    include HTTParty
+
+    attr_accessor :attributes
+    
+    def self.route_for(val)
+      class_eval("def self.route; '#{val}'; end")
+    end
+    
+    def self.resource_for(val)
+      class_eval("def self.resource; '#{val}'; end")
+    end
+    
+    def initialize(params = {}, query = {}, no_defaults = false) 
+      return self if no_defaults
+      response = self.class.get("/#{self.route}/new.xml")
+      raise ServerError.new(response.body) if response.code != "200"
+      hash = Hash.from_xml(response.body).values.first
+      hash.merge! params
+      self.class.from_xml hash, self
+    end
+
+    def self.find(id, query = {})
+      response = self.get("/#{self.route}/#{id}.xml", :query => query) 
+      raise RecordNotFound.new(response.body) if response.code == "404"
+      raise ServerError.new(response.body) if response.code != "200"
+      hash = Hash.from_xml(response.body).values.first
+      self.from_xml hash
+    end
+    
+    def self.create(params = {}, query = {})
+      response = self.post("/#{self.route}.xml", :body => body_for(params), :query => query) 
+      raise ServerError.new(response.body) if response.code != "200"
+      hash = Hash.from_xml(response.body).values.first
+      self.from_xml hash    
+    end
+    
+    def self.update(id, params = {}, query = {})
+      response = self.put("/#{self.route}/#{id}.xml", :body => body_for(params), :query => query) 
+      raise RecordNotFound.new(response.body) if response.code == "404"
+      raise ServerError.new(response.body) if response.code != "200"
+      hash = Hash.from_xml(response.body).values.first
+      self.from_xml hash    
+    end
+    
+    def update(params = {}, query = {})
+      self.class.update(self.id, params, query)
+    end
+
+    def self.destroy(id, query = {}) 
+      response = self.delete("/#{self.route}/#{id}.xml", :query => query, :format => :text) 
+      raise RecordNotFound.new(response.body) if response.code == "404"
+      raise ServerError.new(response.body) if response.code != "200"
+      true
+    end
+    
+    def destroy(query = {})
+      self.class.destroy(self.id, query)
+    end
+
+    def self.all(query = {})
+      response = self.get("/#{self.route}.xml", :query => query) 
+      raise ServerError.new(response.body) if response.code != "200"
+      items = response.values.first
+      items.map{|hash| self.from_xml hash }        
+    end
+
+  private
+
+    def self.body_for(params)
+      body = {}
+      params.each{|n,v| body["#{self.resource}[#{n}]"] = v }
+      body.to_query
+    end
+    
+    def self.from_xml(params, obj = nil)
+      obj ||= self.new({}, {}, true)
+      obj.attributes = params
+      mod = Module.new do
+        obj.attributes.keys.each do |k|
+          define_method(k) do
+            return self.attributes[k]
+          end
+        
+          define_method("#{k}=") do |val|
+            self.attributes[k] = val
+          end
+        end
+      end    
+      obj.send(:extend, mod)
+      obj
+    end
+  end
+end

data/test/resource_party_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ResourcePartyTest < Test::Unit::TestCase
+  should "be usable by the masses" do
+    assert_not_nil ResourceParty::Base
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'resource_party')
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: jeffrafter-resource_party
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jeff Rafter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-httparty
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple wrapper for HTTParty for basic operations with a restful resource
+email: jeff@baobabhealth.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Rakefile
+- README
+- VERSION.yml
+- lib/resource_party.rb
+- test/resource_party_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/jeffrafter/resource_party
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simplified resource interaction using HTTParty
+test_files: []
+