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

- (Repository) initialize(repo)



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

- (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



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

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

+ (String) path(repo)

Get the api path for a repo



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

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

Instance Method Details

- (String) id_api_path



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

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

- (String) named_api_path



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

def named_api_path
  "repos/#{slug}"
end

- (String) 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

- (String) slug Also known as: to_s

Repository owner/name



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

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

- (String) url

Repository URL based on Client#web_endpoint



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

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