Class: Github::Repos::Statuses

Inherits:

API

• Object
• API
• Github::Repos::Statuses

Defined in:

lib/github_api/repos/statuses.rb

Overview

The Status API allows external services to mark commits with a success, failure, error, or pending state, which is then reflected in pull requests involving those commits.

Constant Summary

VALID_STATUS_PARAM_NAMES =

%w[
  state
  target_url
  description
].freeze

REQUIRED_PARAMS =

:nodoc:

%w[ state ].freeze

Constants included from Github::Request

Github::Request::METHODS, Github::Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

Constants::ACCEPT, Constants::ACCEPTED_OAUTH_SCOPES, Constants::ACCEPT_CHARSET, Constants::CACHE_CONTROL, Constants::CONTENT_LENGTH, Constants::CONTENT_TYPE, Constants::DATE, Constants::ETAG, Constants::HEADER_LAST, Constants::HEADER_LINK, Constants::HEADER_NEXT, Constants::LOCATION, Constants::META_FIRST, Constants::META_LAST, Constants::META_NEXT, Constants::META_PREV, Constants::META_REL, Constants::OAUTH_SCOPES, Constants::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::SERVER, Constants::USER_AGENT

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary

• #create(*args) ⇒ Object

  Create a status.

• #list(*args) ⇒ Object (also: #all)

  List Statuses for a specific SHA.

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from Github::RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Github::Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#create(*args) ⇒ Object

Create a status

Inputs

• :state - Required string - State of the status - can be one of

  pending, success, error, or failure.
  

• :target_url - Optional string - Target url to associate with this

  status. This URL will be linked from the GitHub UI to allow users
  to easily see the ‘source’ of the Status.
  

• :description - Optional string - Short description of the status

Examples

github = Github.new
github.repos.statuses.create 'user-name', 'repo-name', 'sha',
  "state" =>  "success",
  "target_url" => "http://ci.example.com/johndoe/my-repo/builds/sha",
  "description" => "Successful build #3 from origin/master"

# File 'lib/github_api/repos/statuses.rb', line 52

def create(*args)
  arguments(args, :required => [:user, :repo, :sha]) do
    sift VALID_STATUS_PARAM_NAMES, :recursive => false
    assert_required REQUIRED_PARAMS
  end
  params = arguments.params

  post_request("/repos/#{user}/#{repo}/statuses/#{sha}", params)
end

#list(*args) ⇒ Object Also known as: all

List Statuses for a specific SHA

Examples

github = Github.new
github.repos.statuses.list 'user-name', 'repo-name', 'sha'
github.repos.statuses.list 'user-name', 'repo-name', 'sha' { |status| ... }

# File 'lib/github_api/repos/statuses.rb', line 25

def list(*args)
  arguments(args, :required => [:user, :repo, :sha])
  params = arguments.params

  response = get_request("/repos/#{user}/#{repo}/statuses/#{sha}", params)
  return response unless block_given?
  response.each { |el| yield el }
end