Module: FetcheableOnApi

Defined in:

lib/fetcheable_on_api.rb,
lib/fetcheable_on_api/version.rb,
lib/fetcheable_on_api/pageable.rb,
lib/fetcheable_on_api/sortable.rb,
lib/fetcheable_on_api/filterable.rb,
lib/fetcheable_on_api/configuration.rb,
lib/generators/fetcheable_on_api/install_generator.rb

Overview

FetcheableOnApi provides standardized sorting, filtering and pagination for you API controllers.

Defined Under Namespace

Modules: Filterable, Generators, Pageable, Sortable Classes: Configuration

Constant Summary

ArgumentError =

Supports

Class.new(ArgumentError)

NotImplementedError =

Class.new(NotImplementedError)

VERSION =

'0.3.1'.freeze

Class Method Summary

• .configuration ⇒ Configuration

  Global configuration settings for FetcheableOnApi.

• .configure {|Configuration| ... } ⇒ Object

  Configure FetcheableOnApi using a block.

• .included(klass) ⇒ Object

  Public class methods.

Class Method Details

.configuration ⇒ Configuration

Global configuration settings for FetcheableOnApi

Examples:

Set default pagination size

FetcheableOnApi.configuration.pagination_default_size = 25

Returns:

• (Configuration) —

  The global configuration instance

# File 'lib/fetcheable_on_api.rb', line 22

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|Configuration| ... } ⇒ Object

Configure FetcheableOnApi using a block.

Examples:

Set default pagination size

FetcheableOnApi.configure do |config|
  config.pagination_default_size = 25
end

Yields:

• (Configuration) —

  Gives the global instance to the block.

# File 'lib/fetcheable_on_api.rb', line 34

def self.configure
  yield(configuration)
end

.included(klass) ⇒ Object

Public class methods

# File 'lib/fetcheable_on_api.rb', line 47

def self.included(klass)
  klass.class_eval do
    include Filterable
    include Sortable
    include Pageable
  end
end