class Octokit::Repository
Class to parse GitHub repository owner and name from URLs and to generate URLs
Constants
- NAME_WITH_OWNER_PATTERN
Attributes
id[RW]
name[RW]
owner[RW]
repo[RW]
user[RW]
username[RW]
Public Class Methods
from_url(url)
click to toggle source
Instantiate from a GitHub repository URL
@return [Repository]
# File lib/octokit/repository.rb, line 12 def self.from_url(url) Repository.new(URI.parse(url).path[1..-1]) end
new(repo)
click to toggle source
@raise [Octokit::InvalidRepository] if the repository
has an invalid format
# File lib/octokit/repository.rb, line 18 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
path(repo)
click to toggle source
Get the api path for a repo @param repo [Integer, String, Hash, Repository] A GitHub repository. @return [String] Api path.
# File lib/octokit/repository.rb, line 54 def self.path repo new(repo).path end
Public Instance Methods
id_api_path()
click to toggle source
@return [String] Api path for id identified repos
# File lib/octokit/repository.rb, line 64 def id_api_path "repositories/#{@id}" end
named_api_path()
click to toggle source
@return [String] Api path for owner/name identified repos
# File lib/octokit/repository.rb, line 59 def named_api_path "repos/#{slug}" end
path()
click to toggle source
@return [String] Repository API path
# File lib/octokit/repository.rb, line 46 def path return named_api_path if @owner && @name return id_api_path if @id end
slug()
click to toggle source
Repository owner/name @return [String]
# File lib/octokit/repository.rb, line 40 def slug "#{@owner}/#{@name}" end
Also aliased as: to_s
url()
click to toggle source
Repository URL based on {Octokit::Client#web_endpoint} @return [String]
# File lib/octokit/repository.rb, line 70 def url "#{Octokit.web_endpoint}#{slug}" end
Private Instance Methods
raise_invalid_repository!()
click to toggle source
# File lib/octokit/repository.rb, line 86 def raise_invalid_repository! raise Octokit::InvalidRepository, "Invalid Repository. Use user/repo format." end
validate_owner_and_name!()
click to toggle source
# File lib/octokit/repository.rb, line 80 def validate_owner_and_name! if @owner.include?('/') || @name.include?('/') || !url.match(/\A#{URI.regexp}\z/) raise_invalid_repository! end end