Class: Tinybucket::Api::TagsApi

Inherits:
BaseApi
  • Object
show all
Includes:
Helper::TagsHelper
Defined in:
lib/tinybucket/api/tags_api.rb

Overview

Tags Api client

Constant Summary

Constants included from Connection

Connection::DEFAULT_USER_AGENT

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Connection

#caching?, #clear_cache, #connection

Instance Attribute Details

#repo_owner ⇒ String

Returns repository owner name.

Returns:

  • (String) —

    repository owner name.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/tinybucket/api/tags_api.rb', line 11

class TagsApi < BaseApi
  include Tinybucket::Api::Helper::TagsHelper

  attr_accessor :repo_owner, :repo_slug

  # Send 'GET a tags list for a repository' request
  #
  # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/tags#get
  #   GET a tags list for a repository
  #
  # @param options [Hash]
  # @return [Tinybucket::Model::Page]
  def list(options = {})
    get_path(
      path_to_list,
      options,
      get_parser(:collection, Tinybucket::Model::Tag)
    )
  end

  # Send 'GET an individual tag' request
  #
  # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/tags/%7Bname%7D#get
  #   GET an individual tag
  #
  # @param name [String] The tag name
  # @param options [Hash]
  # @return [Tinybucket::Model::Tag]
  def find(name, options = {})
    get_path(
      path_to_find(name),
      options,
      get_parser(:object, Tinybucket::Model::Tag)
    )
  end
end

#repo_slug ⇒ String

Returns repo_slug.

Returns:



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/tinybucket/api/tags_api.rb', line 11

class TagsApi < BaseApi
  include Tinybucket::Api::Helper::TagsHelper

  attr_accessor :repo_owner, :repo_slug

  # Send 'GET a tags list for a repository' request
  #
  # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/tags#get
  #   GET a tags list for a repository
  #
  # @param options [Hash]
  # @return [Tinybucket::Model::Page]
  def list(options = {})
    get_path(
      path_to_list,
      options,
      get_parser(:collection, Tinybucket::Model::Tag)
    )
  end

  # Send 'GET an individual tag' request
  #
  # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/tags/%7Bname%7D#get
  #   GET an individual tag
  #
  # @param name [String] The tag name
  # @param options [Hash]
  # @return [Tinybucket::Model::Tag]
  def find(name, options = {})
    get_path(
      path_to_find(name),
      options,
      get_parser(:object, Tinybucket::Model::Tag)
    )
  end
end

Instance Method Details

#find(name, options = {}) ⇒ Tinybucket::Model::Tag

Send ‘GET an individual tag’ request

Parameters:

  • name (String) —

    The tag name

  • options (Hash) (defaults to: {})

Returns:

See Also:



39
40
41
42
43
44
45
 
# File 'lib/tinybucket/api/tags_api.rb', line 39

def find(name, options = {})
  get_path(
    path_to_find(name),
    options,
    get_parser(:object, Tinybucket::Model::Tag)
  )
end

#list(options = {}) ⇒ Tinybucket::Model::Page

Send ‘GET a tags list for a repository’ request

Parameters:

  • options (Hash) (defaults to: {})

Returns:

See Also:



23
24
25
26
27
28
29
 
# File 'lib/tinybucket/api/tags_api.rb', line 23

def list(options = {})
  get_path(
    path_to_list,
    options,
    get_parser(:collection, Tinybucket::Model::Tag)
  )
end