Class: Octokit::Repository

Inherits:
Object
  • Object
show all
Defined in:
lib/octokit/repository.rb

Overview

Class to parse GitHub repository owner and name from URLs and to generate URLs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(repo) ⇒ Repository

Returns a new instance of Repository



15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/octokit/repository.rb', line 15

def initialize(repo)
  case repo
  when Integer
    @id = repo
  when String
    @owner, @name = repo.split('/')
  when Repository
    @owner = repo.owner
    @name = repo.name
  when Hash
    @name = repo[:repo] ||= repo[:name]
    @owner = repo[:owner] ||= repo[:user] ||= repo[:username]
  end
end

Instance Attribute Details

#idObject

Returns the value of attribute id



6
7
8
# File 'lib/octokit/repository.rb', line 6

def id
  @id
end

#nameObject Also known as: repo

Returns the value of attribute name



6
7
8
# File 'lib/octokit/repository.rb', line 6

def name
  @name
end

#ownerObject Also known as: user, username

Returns the value of attribute owner



6
7
8
# File 'lib/octokit/repository.rb', line 6

def owner
  @owner
end

Class Method Details

.from_url(url) ⇒ Repository

Instantiate from a GitHub repository URL

Returns:



11
12
13
# File 'lib/octokit/repository.rb', line 11

def self.from_url(url)
  Repository.new(URI.parse(url).path[1..-1])
end

.path(repo) ⇒ String

Get the api path for a repo

Parameters:

  • repo (Integer, String, Hash, Repository)

    A GitHub repository.

Returns:

  • (String)

    Api path.



46
47
48
# File 'lib/octokit/repository.rb', line 46

def self.path repo
  new(repo).path
end

Instance Method Details

#id_api_pathString

Returns Api path for id identified repos

Returns:

  • (String)

    Api path for id identified repos



56
57
58
# File 'lib/octokit/repository.rb', line 56

def id_api_path
  "repositories/#{@id}"
end

#named_api_pathString

Returns Api path for owner/name identified repos

Returns:

  • (String)

    Api path for owner/name identified repos



51
52
53
# File 'lib/octokit/repository.rb', line 51

def named_api_path
  "repos/#{slug}"
end

#pathString

Returns Repository API path

Returns:

  • (String)

    Repository API path



38
39
40
41
# File 'lib/octokit/repository.rb', line 38

def path
  return named_api_path if @owner && @name
  return id_api_path if @id
end

#slugString Also known as: to_s

Repository owner/name

Returns:

  • (String)


32
33
34
# File 'lib/octokit/repository.rb', line 32

def slug
  "#{@owner}/#{@name}"
end

#urlString

Repository URL based on Client#web_endpoint

Returns:

  • (String)


62
63
64
# File 'lib/octokit/repository.rb', line 62

def url
  "#{Octokit.web_endpoint}#{slug}"
end