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

Constant Summary

NAME_WITH_OWNER_PATTERN =
/\A[\w.-]+\/[\w.-]+\z/i

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Repository) initialize(repo)

Returns a new instance of Repository

Raises:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/octokit/repository.rb', line 21

def initialize(repo)
  case repo
  when Integer
    @id = repo
  when NAME_WITH_OWNER_PATTERN
    @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]
  else
    raise_invalid_repository!
  end
  if @owner && @name
    validate_owner_and_name!
  end
end

Instance Attribute Details

- (Object) id

Returns the value of attribute id



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

def id
  @id
end

- (Object) name Also known as: repo

Returns the value of attribute name



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

def name
  @name
end

- (Object) owner 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

+ (Repository) from_url(url)

Instantiate from a GitHub repository URL

Returns:



12
13
14
15
16
17
# File 'lib/octokit/repository.rb', line 12

def self.from_url(url)
  new URI.parse(url).path[1..-1].
    gsub(/^repos\//,'').
    split('/', 3)[0..1].
    join('/')
end

+ (String) path(repo)

Get the api path for a repo

Parameters:

  • repo (Integer, String, Hash, Repository)

    A GitHub repository.

Returns:

  • (String)

    Api path.



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

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

Instance Method Details

- (String) id_api_path

Returns Api path for id identified repos

Returns:

  • (String)

    Api path for id identified repos



67
68
69
# File 'lib/octokit/repository.rb', line 67

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

- (String) named_api_path

Returns Api path for owner/name identified repos

Returns:

  • (String)

    Api path for owner/name identified repos



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

def named_api_path
  "repos/#{slug}"
end

- (String) path

Returns Repository API path

Returns:

  • (String)

    Repository API path



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

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

- (String) slug Also known as: to_s

Repository owner/name

Returns:

  • (String)


43
44
45
# File 'lib/octokit/repository.rb', line 43

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

- (String) url

Repository URL based on Client#web_endpoint

Returns:

  • (String)


73
74
75
# File 'lib/octokit/repository.rb', line 73

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