Class: Github::Client::Repos::Statuses

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/client/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 collapse

VALID_STATUS_PARAM_NAMES =
%w[
  state
  target_url
  description
  context
].freeze
REQUIRED_PARAMS =

:nodoc:

%w[ state ].freeze

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Constants included from Github::Constants

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

Instance Attribute Summary

Attributes inherited from API

#current_options

Instance Method Summary collapse

Methods inherited from API

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #execute, extend_with_actions, extra_methods, #extract_basic_auth, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, request_methods, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Github::ClassMethods

#configuration, #configure, #require_all

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

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

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"

Parameters:


80
81
82
83
84
85
86
87
# File 'lib/github_api/client/repos/statuses.rb', line 80

def create(*args)
  arguments(args, required: [:user, :repo, :sha]) do
    permit VALID_STATUS_PARAM_NAMES, recursive: false
    assert_required REQUIRED_PARAMS
  end

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

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

List Statuses for a specific SHA

Get the combined Status for a specific Ref

Examples:

github = Github.new
github.repos.statuses.list 'user-name', 'repo-name', 'ref'
github.repos.statuses.list 'user-name', 'repo-name', 'ref' { |status| ... }
github = Github.new
github.repos.statuses.list 'user', 'repo', 'ref', combined: true

Parameters:

  • :ref (String)

    Ref to fetch the status for. It can be a SHA, a branch name, or a tag name.


36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/github_api/client/repos/statuses.rb', line 36

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

  response = if params.delete('combined')
    get_request("/repos/#{user}/#{repo}/commits/#{ref}/status", params)
  else
    get_request("/repos/#{user}/#{repo}/commits/#{ref}/statuses", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end