Class: Github::Client::GitData::References

Inherits:
API
  • Object
show all
Defined in:
lib/github_api/client/git_data/references.rb

Constant Summary collapse

VALID_REF_PARAM_NAMES =
%w[ ref sha force ].freeze
REQUIRED_REF_PARAMS =
%w[ ref sha ].freeze
VALID_REF_PARAM_VALUES =
{
  'ref' => %r{^refs\/\w+(\/\w+)*} # test fully qualified reference
}

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 reference

Examples:

github = Github.new
github.git_data.references.create 'user-name', 'repo-name',
  ref: "refs/heads/master",
  sha:  "827efc6d56897b048c772eb4087f854f46256132"

Parameters:


83
84
85
86
87
88
89
90
91
92
# File 'lib/github_api/client/git_data/references.rb', line 83

def create(*args)
  arguments(args, required: [:user, :repo]) do
    permit VALID_REF_PARAM_NAMES
    assert_required REQUIRED_REF_PARAMS
  end
  params = arguments.params
  validate_reference params['ref']

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

#delete(*args) ⇒ Object Also known as: remove

Delete a reference

Examples:

github = Github.new
github.git_data.references.delete 'user-name', 'repo-name',
  ref: "refs/heads/master"

128
129
130
131
132
133
# File 'lib/github_api/client/git_data/references.rb', line 128

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

  delete_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs/#{arguments.ref}", params)
end

#get(*args) ⇒ Object Also known as: find

Get a reference

The ref in the URL must be formatted as heads/branch, not just branch. For example, the call to get the data for a branch named sc/featureA would be formatted as heads/sc/featureA

Examples:

github = Github.new
github.git_data.references.get 'user-name', 'repo-name', 'heads/branch'

57
58
59
60
61
62
63
# File 'lib/github_api/client/git_data/references.rb', line 57

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

  get_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs/#{arguments.ref}", params)
end

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

Get all references

This will return an array of all the references on the system, including things like notes and stashes if they exist on the server. Anything in the namespace, not just heads and tags, though that would be the most common.

Examples:

github = Github.new
github.git_data.references.list 'user-name', 'repo-name'
github.git_data.references.list 'user-name', 'repo-name', ref:'tags'

29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/github_api/client/git_data/references.rb', line 29

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

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

#update(*args) ⇒ Object

Update a reference

Examples:

github = Github.new
github.git_data.references.update 'user-name', 'repo-name', 'heads/master',
  sha:  "827efc6d56897b048c772eb4087f854f46256132",
  force: true

Parameters:


111
112
113
114
115
116
117
118
# File 'lib/github_api/client/git_data/references.rb', line 111

def update(*args)
  arguments(args, required: [:user, :repo, :ref]) do
    permit VALID_REF_PARAM_NAMES
    assert_required %w[ sha ]
  end

  patch_request("/repos/#{arguments.user}/#{arguments.repo}/git/refs/#{arguments.ref}", arguments.params)
end