active-resource-pagination 0.0.1

data/lib/active_resource/pagination.rb

@@ -0,0 +1,46 @@
+module ActiveResource
+  module Pagination
+    def self.included(base)
+      base.format = PagingFormatter.new(base.collection_name)
+    end
+
+    class PagedArray < Array
+      attr_accessor :total_pages
+      attr_accessor :current_page
+    end
+
+    # PagingFormatter expects a JSON response that looks like this (for a resource named "posts"):
+    # {
+    #   "total_pages": 5,
+    #   "current_page": 1,
+    #   "posts": [{
+    #     "id": 1
+    #   }]
+    # }
+    class PagingFormatter
+      include ActiveResource::Formats::JsonFormat
+
+      attr_accessor :collection_name
+
+      def initialize(name)
+        self.collection_name = name
+      end
+
+      def decode(json)
+        meta = super(json)
+        if meta.is_a?(Hash)
+          list = PagedArray.new(meta[collection_name])
+
+          list.total_pages  = meta['total_pages']
+          list.current_page = meta['current_page']
+
+          list
+        else
+          # unexpected result, fall back to default behavior
+          meta
+        end
+      end
+    end
+
+  end
+end

data/test/pagination_test.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+
+require 'active_resource'
+require 'active_resource/pagination'
+
+class Post < ActiveResource::Base
+  self.element_name = "post"
+
+  include ActiveResource::Pagination
+end
+
+class PaginationTest < Test::Unit::TestCase
+  def test_works
+    arr = ActiveResource::Pagination::PagedArray.new([1, 2, 3])
+    arr.total_pages = 5
+    arr.current_page = 1
+
+    assert_equal arr.total_pages, 5
+    assert_equal arr.current_page, 1
+  end
+
+  def test_paging_attributes
+    ActiveResource::HttpMock.respond_to do |mock|
+      fixture = <<-JSON
+        {
+          "total_pages" : 5,
+          "current_page" : 1,
+          "posts" : [{
+            "id" : 1,
+            "title" : "Hello World"
+          }]
+        }
+      JSON
+
+      mock.get "/posts.json", {}, fixture, 200
+    end
+
+    # late bind the site
+    Post.site = "http://localhost"
+    posts = Post.find(:all)
+
+    assert_equal posts.total_pages, 5
+    assert_equal posts.current_page, 1
+  end
+
+  def test_fallback
+    ActiveResource::HttpMock.respond_to do |mock|
+      fixture = <<-JSON
+        [{
+          "id" : 1,
+          "title" : "Hello World"
+        }]
+      JSON
+
+      mock.get "/posts.json", {}, fixture, 200
+    end
+
+    # late bind the site
+    Post.site = "http://localhost"
+    posts = Post.find(:all)
+
+    assert_equal posts.length, 1
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: active-resource-pagination
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Moss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Basic pagination support for ActiveResource
+email: jmoss@heavyobjects.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_resource/pagination.rb
+- test/pagination_test.rb
+homepage: https://github.com/jeffmoss/active-resource-pagination
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ActiveResource pagination
+test_files:
+- test/pagination_test.rb