activeresource-response 0.0.2 → 0.0.3

data/README.rdoc

@@ -0,0 +1,50 @@
+= Activeresource-response
+
+This gem adds possibility to access http response object from result of activeresource call (see ActiveResource::Base#find)
+
+== Why It can be used?
+Such functionallity can be used for easily implementing pagination in a REST API so that an ActiveResource client can navigate paginated results.
+
+== How to use?
+Just open your ActiveResource class and add 
+ 
+  add_response_method :your_method_name
+
+== Full example of usage with kaminari gem
+
+Rest Client
+
+  class Order < ActiveResource::Base
+    self.format = :json
+    self.site = 'http://0.0.0.0:3000/'
+    self.element_name = "order" 
+    add_response_method :http_response  # our new method
+  end
+
+Server Side
+
+  class OrdersController < ApplicationController
+    def index
+      @orders = Order.page(params[:page]).per(params[:per_page])
+      response.headers["X-total"] = @orders.total_count.to_s
+      response.headers["X-offset"] = @orders.offset_value.to_s
+      response.headers["X-limit"] = @orders.limit_value.to_s
+      respond_with(@orders)
+    end
+  end
+
+Client Side
+
+  class OrdersController < ApplicationController
+    def index
+      orders = Order.all(:params=>params)     
+      @orders = Kaminari::PaginatableArray.new(
+        orders,{
+                :limit => orders.http_response['X-limit'].to_i,
+             	:offset =>orders.http_response['X-offset'].to_i,
+             	:total_count => orders.http_response['X-total'].to_i
+        }) 
+    end
+  end
+
+

data/activeresource-response.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["fedoronchuk@gmail.com"]
   s.homepage    = "https://github.com/Fivell/activeresource-response"
   s.summary     = %q{activeresoure extension}
-  s.description = %q{create method for ActiveResource::Base object to access to response }
+  s.description = %q{adding possibility to access http response object from result of activeresource call  }
 
 
   s.add_dependency('activeresource', '>= 3.1')

data/lib/activeresource-response/version.rb

@@ -1,3 +1,3 @@
 module ActiveresourceResponse
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -2,7 +2,7 @@
 name: activeresource-response
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Igor Fedoronchuk
@@ -23,7 +23,7 @@ dependencies:
         version: "3.1"
   type: :runtime
   version_requirements: *id001
-description: "create method for ActiveResource::Base object to access to response "
+description: "adding possibility to access http response object from result of activeresource call  "
 email: 
 - fedoronchuk@gmail.com
 executables: []
@@ -35,7 +35,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README
+- README.rdoc
 - Rakefile
 - activeresource-response.gemspec
 - lib/activeresource-response.rb

data/README

@@ -1 +0,0 @@
-Read Me!!