restparty 0.0.3 → 0.1.0

data/README.rdoc

@@ -1,6 +1,48 @@
 = restparty
 
-Description goes here.
+RestParty is a simple wrapper around HTTParty allowing you to handle simple operation with a restful webservice.
+
+ class User < RestParty
+  resource_for :users
+  format :json
+ end
+
+This simple piece of code will generate basics CRUD operations and allow you to :
+
+  User.find(1)
+  User.find(:all)
+  User.create({:name => "Mike", :email => "mike@mike.com"})
+  User.delete(1)
+
+All of this methods can take a 2nd optional argument :
+
+  User.find(:all, {:q => "Mike"})
+
+The resource_for can also take few arguments :
+
+* only, except
+
+    resource_for :user_sessions, :only => [:create, :delete]
+
+* member, collection
+
+    resource_for :auditions, :except => [:delete, :update], :member => {:rate => :post, :comment => :post}, :collection => {:search => :get}
+
+This will allow you to add basic operations as :
+
+  Audition.rate(1, options)
+  Audition.comment(2, {:comment => "Now we're talking !"})
+  Audition.search(:q => "Mike")
+
+Of course You can use your RestParty class like a basic HTTparty class everything works as expected :
+
+ class User < RestParty
+  resource_for :users
+  format :json
+  base_uri 'localhost:3000'
+  auth_digest "login", "pass"
+ end
+
 
 == Contributing to restparty
  

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/lib/restparty.rb

@@ -1,91 +1,98 @@
+require "httparty"
+
 class RestParty
   include HTTParty
 
   attr_reader :resource
+  attr_reader :resource_methods
+
+  class << self
 
-  def self.resource_for(resource, options = {:methods => [:create, :index, :show, :update, :delete], :member => {}, :collection => {}})
-    @resource = resource.to_s
-    resource_methods = options[:methods]
+    def resource_for(resource, options = {:methods => [:create, :index, :show, :update, :delete], :member => {}, :collection => {}})
+      @resource = resource.to_s
+      @resource_methods = options[:methods]
+
+      if !options[:only].blank?
+        @resource_methods = options[:only]
+      elsif !options[:except].blank?
+        @resource_methods = [:create, :index, :show, :update, :delete]
+        @resource_methods.delete_if{|m| options[:except].include?(m)}
+      end
 
-    if !options[:only].blank?
-      resource_methods = options[:only]
-    elsif !options[:except].blank?
-      resource_methods = [:create, :index, :show, :update, :delete]
-      resource_methods.delete_if{|m| options[:except].include?(m)}
+      build_members(options[:member]) if options[:member]
+      build_collections(options[:collection]) if options[:collection]
+      build_create if @resource_methods.include?(:create)
+      build_get if @resource_methods.include?(:index) || @resource_methods.include?(:show)
+      build_update if @resource_methods.include?(:update)
+      build_delete if @resource_methods.include?(:delete)
     end
 
-    build_members(options[:member]) if options[:member]
-    build_collections(options[:collection]) if options[:collection]
-    build_create if resource_methods.include?(:create)
-    build_get if resource_methods.include?(:index) || resource_methods.include?(:show)
-    build_update if resource_methods.include?(:update)
-    build_delete if resource_methods.include?(:delete)
-  end
+    private
 
-  private
-    
     def build_delete
       class_eval %{
         def self.delete(id, options = {})
-          delete('/#{resource}/'+id.to_s, :query => options)
+          delete('/#{@resource}/'+id.to_s, :query => options)
         end
       }
     end
-    
+
     def build_update
       class_eval %{
         def self.update(id, options = {})
-          put('/#{resource}/'+id.to_s, :query => options, :headers => {'Content-Length' => '0'})
+          put('/#{@resource}/'+id.to_s, :query => options, :headers => {'Content-Length' => '0'})
         end
       }
     end
-    
+
     def build_get
       class_eval %{
         def self.find(id, options = {})
           response = ""
-          if id.to_s == "all" and #{resource_methods.include?(:index)}
-            response = get('/#{resource}', :query => options)
-          elsif id.to_s =~ /^[-+]?[0-9]+$/ and #{resource_methods.include?(:show)}
-            response = get('/#{resource}/'+id.to_s, :query => options)
+          if id.to_s == "all" and #{@resource_methods.include?(:index)}
+            response = get('/#{@resource}', :query => options)
+          elsif id.to_s =~ /^[-+]?[0-9]+$/ and #{@resource_methods.include?(:show)}
+            response = get('/#{@resource}/'+id.to_s, :query => options)
           else
             raise "error"
           end
         end
       }
     end
-    
+
     def build_create
       class_eval %{
         def self.create(options = {})
-          post('/#{resource}', :query => options)
+          post('/#{@resource}', :query => options)
         end
       }
     end
-    
+
     def build_collections(collections)
       collections.each_pair do |collection, method|
         raise 'error_http_method' unless valid_http_method?(method)
         class_eval %{
           def self.#{collection}(options = {})
-            #{method}('/#{@resource}/#{collection}', :query => options)
+          #{method}('/#{@resource}/#{collection}', :query => options)
           end
         }
       end
     end
-    
+
     def build_members(members)
       members.each_pair do |member, method|
         raise 'error_method' unless valid_http_method?(method)
         class_eval %{
           def self.#{member}(id, options = {})
-            #{method}('/#{@resource}/'+id.to_s+'/#{member}', :query => options)
+          #{method}('/#{@resource}/'+id.to_s+'/#{member}', :query => options)
           end
         }
       end
     end
-  
-    def self.valid_http_method?(method)
+
+    def valid_http_method?(method)
       ['post', 'get', 'put', 'delete', 'head'].include? method.to_s
     end
+
+  end
 end

data/restparty.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{restparty}
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Bensoussan", "Pierre Boutbel"]

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Michael Bensoussan
@@ -111,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3301224439384266850
+      hash: 692511520615816357
       segments: 
       - 0
       version: "0"