Contents

module TheCity

  # This class is the base class for all TheCity objects and is meant to be inherited.
  #
  class ApiList
    
    attr_reader :total_entries, :total_pages, :per_page, :current_page
    
    def self.load(options = {}) 
      self.new(options)
    end

    # Checks if there is a next page.
    #
    # @return true for yes, false for no.
    def next_page?
      @current_page < @total_pages
    end

    # Gets the next page of results.
    # 
    # @return [UserList] or nil if there are no more pages.
    def next_page
      return nil unless next_page?
      self.class.new( @options.merge({:page => @options[:page]+1}) )
    end

    # Loads the next page of results and replaces self with the results.
    # 
    # @return true on success or otherwise false.
    def next_page!
      return false unless next_page?

      @options[:page] += 1
      @options[:reader] = @options[:reader].class.new(@options)
      @json_data = @options[:reader].load_feed

      @total_entries = @json_data['total_entries']
      @total_pages = @json_data['total_pages']
      @per_page = @json_data['per_page']
      @current_page = @json_data['current_page'] 

      return true
    end    

  end

end

Version data entries

12 entries across 12 versions & 1 rubygems

Version	Path
the-city-admin-0.7.1	lib/api/api_list.rb
the-city-admin-0.7.0	lib/api/api_list.rb
the-city-admin-0.6.9	lib/api/api_list.rb
the-city-admin-0.6.8	lib/api/api_list.rb
the-city-admin-0.6.7	lib/api/api_list.rb
the-city-admin-0.6.6	lib/api/api_list.rb
the-city-admin-0.6.5	lib/api/api_list.rb
the-city-admin-0.6.4	lib/api/api_list.rb
the-city-admin-0.6.3	lib/api/api_list.rb
the-city-admin-0.6.2	lib/api/api_list.rb
the-city-admin-0.6.1	lib/api/api_list.rb
the-city-admin-0.6.0	lib/api/api_list.rb