pox_paginate 0.1.0 → 0.1.1

data/CHANGELOG

@@ -0,0 +1,8 @@
+== Coming Soon
+  * Support for Rails 3.0.0.rc
+
+== 0.1.1
+  * Updated dependencies to require < 3.0.0 to avoid conflicts
+
+== 0.1.0
+  * First release

data/README.rdoc

@@ -1,5 +1,60 @@
-= PoxPaginate
+= PoxPaginate 0.1.1
 
 PoxPaginate is an extension to WillPaginate and ActiveResource that makes it possible to transparently paginate over a collection of XML serialised resources.
 
-It currently depends on a patch to fix a bug in Rails that is documented in this {Lighthouse ticket}[https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/3217-parsing-an-xml-file-with-multiple-records-and-extra-attributes-besides-type-fails].
+This gem is based on our experience building largish distributed systems consisting of multiple Rails apps integrated over POX (Plain Old XML). Yes, it is in production. No, unfortunately we aren't allowed to talk about it.
+
+== Installation
+
+PoxPaginate is available as a gem.
+  gem install pox_paginate
+  
+and in your Rails environment.rb
+  config.gem "pox_paginate", :version => '>= 0.1.0', :lib => "pox_paginate"
+  
+We also strongly recommend you use Ruby LibXML or Nokogiri rather than the standard REXML for deserialisation. While PoxPaginate supports all three, REXML is simply too slow for use in production. To switch to using either gem:
+  (sudo) gem install libxml-ruby
+or
+  (sudo) gem install nokogiri
+
+After this, you need to instruct Rails to use them. In environment.rb, do
+  ActiveSupport::XmlMini.backend = 'LibXML'
+or
+  ActiveSupport::XmlMini.backend = 'Nokogiri'
+  
+Before you ask, yes we're working on adding support for jdom so PoxPaginate can be used on JRuby :)
+
+== Usage
+
+When constructing the xml serialised form of a resource in a controller, add pagination - like so:
+  class ProductsController < ApplicationController
+  
+    # GET /products
+    # GET /products.xml
+    def index
+      @products = Product.paginate :page => params[:page], :per_page => params[:per_page]
+      respond_to do |format|
+        format.html # index.html.erb
+        format.xml  { render :xml => @products }
+      end
+    end
+    ...
+    ...
+    ...
+  end
+
+PoxPaginate extends WillPaginate::Collection to add 'current_page,' 'per_page' and 'total_entries' as attributes on the root node of the collection xml.
+
+On the client, you do the usual:
+  class Product < ActiveResource::Base
+    self.site = 'http://oogabooga.in'
+  end
+  
+Now whenever you do
+  Product.find(:all, :params => {:page => 2, :per_page => 5})
+
+PoxPaginate will kick in if pagination related attributes are present on the root node, and will result in the creation of a PoxPaginate::RemoteCollection, which is a subclass of WillPaginate::Collection and so behaves in exactly the same manner.
+
+=== Note
+* PoxPaginate currently overrides the Hash.from_xml method to fix a bug in Rails that is documented in this {Lighthouse ticket}[https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/3217-parsing-an-xml-file-with-multiple-records-and-extra-attributes-besides-type-fails]
+* PoxPaginate must needs be installed on both the client and the server Rails instance

data/Rakefile

@@ -1,3 +1,7 @@
+require 'rubygems'
+gem 'activesupport', '~> 2.3.5'
+gem 'rspec', '~> 1.3.0'
+
 require 'spec'
 require 'spec/rake/spectask'
 
@@ -8,7 +12,6 @@ namespace :spec do
   desc "Run all unit specs"
   Spec::Rake::SpecTask.new(:unit) do |task|
     task.spec_files = FileList['spec/pox_paginate/**/*_spec.rb']
-    # task.spec_opts = ['--options', 'spec/spec.opts']
   end
 end
 
@@ -16,18 +19,21 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "pox_paginate"
-    gemspec.summary = "Transparent support for pagination using WillPaginate using POX (Plain Old Xml) and ActiveResource"
-    gemspec.description = "Wrest is a HTTP and REST client library which allows you to quickly build well encapsulated, object oriented wrappers around any web service."
+    gemspec.summary = "Transparent support for pagination using WillPaginate with POX (Plain Old Xml) and ActiveResource"
+    gemspec.description = "Transparent support for pagination using WillPaginate with POX (Plain Old Xml) and ActiveResource. This gem is based on C42 Engineering's experience building largish distributed systems consisting of multiple Rails apps integrated over POX (Plain Old XML)."
     gemspec.authors = ["Sidu Ponnappa", "Niranjan Paranjape"]
     gemspec.email = "opensource@c42.in"
-    gemspec.homepage = "http://github.com/kaiwren/wrest"
+    gemspec.homepage = "http://c42.in/open_source"
     gemspec.has_rdoc = false
     gemspec.require_path = "lib"
     gemspec.files.exclude *['.gitignore']
+
     gemspec.test_files.exclude *['.gitignore']
-    gemspec.add_dependency('activesupport', '>= 2.3.5')
-    gemspec.add_dependency('activeresource', '>= 2.3.5')
-    gemspec.add_dependency('will_paginate', '>= 2.3.12')
+    gemspec.add_dependency('activesupport', '~> 2.3.5')
+    gemspec.add_dependency('activeresource', '~> 2.3.5')
+    gemspec.add_dependency('will_paginate', '~> 2.3.12')
+    gemspec.add_development_dependency('rspec', '~> 1.3.0')
+    gemspec.add_development_dependency('activerecord', '~> 2.3.5')
   end
 
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/pox_paginate.rb

@@ -1,7 +1,18 @@
+# Copyright 2009 C42 Engineering
+
+# Licensed under the Apache License, Version 2.0 (the "License"); 
+# you may not use this file except in compliance with the License. 
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 
+# Unless required by applicable law or agreed to in writing, software distributed under the License 
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+# See the License for the specific language governing permissions and limitations under the License. 
+
 require 'rubygems'
+gem 'activeresource', '~> 2.3.5'
+gem 'activesupport', '~> 2.3.5'
 require 'active_resource'
-require 'will_paginate'
 require 'active_support'
+require 'will_paginate'
 
 module PoxPaginate
   Root = File.dirname(__FILE__)

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
-require 'pp'
 require 'rubygems'
+gem 'rspec', '~> 1.3.0'
+gem 'activerecord', '~> 2.3.5'
+gem 'activeresource', '~> 2.3.5'
+
+require 'pp'
 require 'spec'
 require 'active_record'
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: pox_paginate
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Sidu Ponnappa
@@ -10,40 +15,80 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-09 00:00:00 +05:30
+date: 2010-07-29 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
         version: 2.3.5
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: activeresource
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
         version: 2.3.5
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: will_paginate
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 12
         version: 2.3.12
-    version: 
-description: Wrest is a HTTP and REST client library which allows you to quickly build well encapsulated, object oriented wrappers around any web service.
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id005
+description: Transparent support for pagination using WillPaginate with POX (Plain Old Xml) and ActiveResource. This gem is based on C42 Engineering's experience building largish distributed systems consisting of multiple Rails apps integrated over POX (Plain Old XML).
 email: opensource@c42.in
 executables: []
 
@@ -52,6 +97,7 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- CHANGELOG
 - README.rdoc
 - Rakefile
 - VERSION
@@ -76,7 +122,7 @@ files:
 - spec/pox_paginate/xml_mini_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/kaiwren/wrest
+homepage: http://c42.in/open_source
 licenses: []
 
 post_install_message: 
@@ -88,21 +134,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Transparent support for pagination using WillPaginate using POX (Plain Old Xml) and ActiveResource
+summary: Transparent support for pagination using WillPaginate with POX (Plain Old Xml) and ActiveResource
 test_files: 
 - spec/db/migrate/001_create_oogas.rb
 - spec/pox_paginate/active_resource/xml_format_spec.rb