Method: Veyor.project_settings

Defined in:
lib/veyor.rb

.project_settings(account: nil, project: nil, yaml: false, options: nil, verbose: false) ⇒ Array

Get project settings

Examples:

require 'veyor'
# get project history
x = Veyor.project_settings(project: 'cowsay')
x['settings']
x['settings']['configuration']
# get yaml data
x = Veyor.project_settings(project: 'cowsay', yaml: true)

Parameters:

  • account (String) (defaults to: nil)

    An Appveyor account name

  • project (String) (defaults to: nil)

    An Appveyor project name

  • yaml (Boolean) (defaults to: false)

    Return yaml version of project settings. Default: false

  • options (Hash) (defaults to: nil)

    Hash of options for configuring the request, passed on to Faraday.new

    • timeout [Fixnum] open/read timeout Integer in seconds

    • open_timeout [Fixnum] read timeout Integer in seconds

    • proxy [Hash] hash of proxy options

      • uri [String] Proxy Server URI

      • user [String] Proxy server username

      • password [String] Proxy server password

    • params_encoder [Hash] not sure what this is

    • bind [Hash] A hash with host and port values

    • boundary [String] of the boundary value

    • oauth [Hash] A hash with OAuth details

  • verbose (Boolean) (defaults to: false)

    Print request headers to stdout. Default: false

Returns:

  • (Array)

    An array of hashes



221
222
223
224
225
226
227
# File 'lib/veyor.rb', line 221

def self.project_settings(account: nil, project: nil, yaml: false, options: nil, verbose: false)
  route = sprintf('/projects/%s/%s/settings', (), project)
  if yaml
    route = route + '/yaml'
  end
  Request.new(route, {}, nil, options, verbose).get
end