Contents

# encoding: utf-8
#
module Mocrata
  # @attr [String] app_token A Socrata application token
  #
  class Configuration
    # The maximum number of rows allowed per request by Socrata
    MAX_PER_PAGE = 1000

    attr_accessor :app_token

    # @return [Integer] the value of the `per_page` configuration option
    #
    def per_page
      @per_page ||= MAX_PER_PAGE
    end

    # Sets the value of the `per_page` configuration option
    #
    # @param value [Integer] the number of results per page {http://dev.socrata.com SODA} resource url
    #
    # @return [Integer] the value
    #
    # @raise [Mocrata::Configuration::ConfigurationError] if the value is invalid
    #
    def per_page=(value)
      if value > MAX_PER_PAGE
        message = "Per page #{value} exceeds maximum value of #{MAX_PER_PAGE}"
        raise ConfigurationError.new(message)
      end

      @per_page = value
    end

    class ConfigurationError < StandardError; end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
mocrata-0.1.0	lib/mocrata/configuration.rb
mocrata-0.0.1	lib/mocrata/configuration.rb