class Github::Arguments

Request arguments handler

Constants

AUTO_PAGINATION

Attributes

api[R]

The request api

optional[R]

Optional arguments

params[R]

Parameters passed to request

remaining[R]
required[R]

Required arguments

Public Class Methods

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

Takes api, filters and required arguments

Parameters

:required - arguments that must be present before request is fired
# File lib/github_api/arguments.rb, line 36
def initialize(api, options={})
  normalize! options
  @api      = api
  @required = options.fetch('required', []).map(&:to_s)
  @optional = options.fetch('optional', []).map(&:to_s)
end

Public Instance Methods

assert_required(required) click to toggle source

Check if required keys are present inside parameters hash.

# File lib/github_api/arguments.rb, line 75
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.

# File lib/github_api/arguments.rb, line 82
def assert_values(values, key=nil)
  assert_valid_values values, (key.nil? ? params : params[key])
  self
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.

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

  if !args.size.zero?
    parse_arguments *args
  else
    # Arguments are inside the parameters hash
    parse_options options
  end
  @params = options
  @remaining = extract_remaining(args)
  extract_pagination(options)
  yield_or_eval(&block)
  self
end
sift(keys, key=nil, options={}) click to toggle source

Remove unkown keys from parameters hash.

Parameters

:recursive - boolean that toggles whether nested filtering should be applied
# File lib/github_api/arguments.rb, line 68
def sift(keys, key=nil, options={})
  filter! keys, (key.nil? ? params : params[key]), options if keys.any?
  self
end

Private Instance Methods

check_assignment!(options) click to toggle source

Check if required arguments have been set on instance.

# File lib/github_api/arguments.rb, line 135
def check_assignment!(options)
  result = required.inject({}) { |hash, arg|
    if api.respond_to?(:"#{arg}") && (value = api.send(:"#{arg}"))
      hash[arg] = value
    end
    hash
  }
  assert_presence_of result
  result
end
check_requirement!(*args) click to toggle source

Check if required arguments are present.

# File lib/github_api/arguments.rb, line 148
def check_requirement!(*args)
  args_length     = args.length
  required_length = required.length

  if args_length < required_length
    ::Kernel.raise ArgumentError, "wrong number of arguments (#{args_length} for #{required_length})"
  end
end
extract_pagination(options) click to toggle source

Fine auto_pagination parameter in options hash

# File lib/github_api/arguments.rb, line 107
def extract_pagination(options)
  if (value = options.delete(AUTO_PAGINATION))
    api.auto_pagination = value
  end
end
extract_remaining(args) click to toggle source

Find remaining arguments

# File lib/github_api/arguments.rb, line 101
def extract_remaining(args)
  args[required.size..-1]
end
parse_arguments(*args) click to toggle source

Check and set all requried arguments.

# File lib/github_api/arguments.rb, line 91
def parse_arguments(*args)
  assert_presence_of *args
  required.each_with_index do |req, indx|
    api.set req, args[indx]
  end
  check_requirement!(*args)
end
parse_options(options) click to toggle source

Remove required arguments from parameters and validate their presence(if not nil or empty string).

# File lib/github_api/arguments.rb, line 116
def parse_options(options)
  options.each { |key, val| remove_required(options, key, val) }
  provided_args = check_assignment!(options)
  check_requirement!(*provided_args.keys)
end
remove_required(options, key, val) click to toggle source

Remove required argument from parameters

# File lib/github_api/arguments.rb, line 124
def remove_required(options, key, val)
  key = key.to_s
  if required.include? key
    assert_presence_of val
    options.delete key
    api.set key, val
  end
end
yield_or_eval() { |self| ... } click to toggle source

Evaluate block

# File lib/github_api/arguments.rb, line 159
def yield_or_eval(&block)
  return unless block
  block.arity > 0 ? yield(self) : self.instance_eval(&block)
end