Parent

Class/Module Index [+]

Quicksearch

Github::API::Arguments

A class responsible for handilng request arguments

Constants

AUTO_PAGINATION

Attributes

api[R]

The request api

params[R]

Parameters passed to request

remaining[R]

The remaining unparsed arguments

Public Class Methods

new(options = {}, &block) click to toggle source

Initialize an Arguments

@param [Hash] options

@option options [Array] :required

arguments that must be present before request is fired

@option options [Github::API] :api

the reference to the current api

@api public

# File lib/github_api/api/arguments.rb, line 32
def initialize(options = {}, &block)
  normalize! options

  @api      = options.fetch('api')
  @required = options.fetch('required', []).map(&:to_s)
  @optional = options.fetch('optional', []).map(&:to_s)
  @assigns  = {}

  yield_or_eval(&block)
end

Public Instance Methods

[](property) click to toggle source

Hash like access to request arguments

@param [String, Symbol] property

the property name

@api public

# File lib/github_api/api/arguments.rb, line 65
def [](property)
  @assigns[property.to_s]
end
[]=(property, value) click to toggle source
# File lib/github_api/api/arguments.rb, line 69
def []=(property, value)
  @assigns[property.to_s] = value
end
assert_required(required) click to toggle source

Check if required keys are present inside parameters hash.

@api public

# File lib/github_api/api/arguments.rb, line 120
def assert_required(required)
  assert_required_keys required, params
  self
end
assert_values(values, key=nil) click to toggle source

Check if parameters match expected values.

@api public

# File lib/github_api/api/arguments.rb, line 128
def assert_values(values, key=nil)
  assert_valid_values values, (key.nil? ? params : params[key])
  self
end
method_missing(method_name, *args, &block) click to toggle source
# File lib/github_api/api/arguments.rb, line 73
def method_missing(method_name, *args, &block)
  if @assigns.key?(method_name.to_s)
    self[method_name]
  else
    super
  end
end
optional(*attrs, &block) click to toggle source

Specify optional attribute(s)

@api public

# File lib/github_api/api/arguments.rb, line 56
def optional(*attrs, &block)
end
parse(*args, &block) click to toggle source

Parse arguments to allow for flexible api calls

Arguments can be part of parameters hash or be simple string arguments.

@api public

# File lib/github_api/api/arguments.rb, line 90
def parse(*args, &block)
  options = ParamsHash.new(args.extract_options!)
  normalize! options

  if args.size.zero?  # Arguments are inside the parameters hash
    parse_hash(options)
  else
    parse_array(*args)
  end
  @params    = options
  @remaining = args[@required.size..-1]
  extract_pagination(options)

  yield_or_eval(&block)
  self
end
permit(keys, key=nil, options={}) click to toggle source

Remove unknown keys from parameters hash.

Parameters

:recursive - boolean that toggles whether nested filtering should be applied
# File lib/github_api/api/arguments.rb, line 112
def permit(keys, key=nil, options={})
  filter! keys, (key.nil? ? params : params[key]), options if keys.any?
  self
end
require(*attrs, &block) click to toggle source

Specify required attribute(s)

@api public

# File lib/github_api/api/arguments.rb, line 46
def require(*attrs, &block)
  attrs_clone = attrs.clone
  @required = Array(attrs_clone)
  self
end
Also aliased as: required
required(*attrs, &block) click to toggle source
Alias for: require
respond_to_missing?(method_name, include_private = false) click to toggle source
# File lib/github_api/api/arguments.rb, line 81
def respond_to_missing?(method_name, include_private = false)
  @assigns.key?(method_name) || super
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.