Class: Github::Client::GitData::Tags
- Defined in:
- lib/github_api/client/git_data/tags.rb
Constant Summary collapse
- VALID_TAG_PARAM_NAMES =
This tags api only deals with tag objects - so only annotated tags, not lightweight tags. Refer developer.github.com/v3/git/tags/#parameters
%w[ tag message object type name email date tagger ].freeze
- VALID_TAG_PARAM_VALUES =
{ 'type' => %w[ blob tree commit ] }
Constants included from MimeType
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
Instance Method Summary collapse
-
#create(*args) ⇒ Object
Create a tag object.
-
#get(*args) ⇒ Object
(also: #find)
Get a tag.
Methods inherited from API
after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #disable_redirects, #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, require_all, #respond_to?, root!, #run_callbacks, #set, #yield_or_eval
Methods included from Request::Verbs
#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request
Methods included from RateLimit
#ratelimit, #ratelimit_remaining, #ratelimit_reset
Methods included from MimeType
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 tag object
Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/ reference. If you want to create a lightweight tag, you simply have to create the reference - this call would be unnecessary.
The tagger hash contains the following keys:
86 87 88 89 90 91 92 93 |
# File 'lib/github_api/client/git_data/tags.rb', line 86 def create(*args) arguments(args, required: [:user, :repo]) do permit VALID_TAG_PARAM_NAMES assert_values VALID_TAG_PARAM_VALUES end post_request("/repos/#{arguments.user}/#{arguments.repo}/git/tags", arguments.params) end |
#get(*args) ⇒ Object Also known as: find
Get a tag
33 34 35 36 37 38 |
# File 'lib/github_api/client/git_data/tags.rb', line 33 def get(*args) arguments(args, required: [:user, :repo, :sha]) params = arguments.params get_request("/repos/#{arguments.user}/#{arguments.repo}/git/tags/#{arguments.sha}", params) end |