class Octokit::Repository
Class to parse GitHub repository owner and name from URLs and to generate URLs
Constants
- ABS_URI_REGEXP
- NAME_WITH_OWNER_PATTERN
Attributes
Public Class Methods
Source
# File lib/octokit/repository.rb, line 14 def self.from_url(url) new URI.parse(url).path[1..] .gsub(%r{^repos/}, '') .split('/', 3)[0..1] .join('/') end
Instantiate from a GitHub repository URL
@return [Repository]
Source
# File lib/octokit/repository.rb, line 23 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!(repo) end validate_owner_and_name!(repo) if @owner && @name end
@raise [Octokit::InvalidRepository] if the repository
has an invalid format
Source
# File lib/octokit/repository.rb, line 58 def self.path(repo) new(repo).path end
Get the api path for a repo @param repo [Integer, String, Hash, Repository] A GitHub repository. @return [String] Api path.
Public Instance Methods
Source
# File lib/octokit/repository.rb, line 68 def id_api_path "repositories/#{@id}" end
@return [String] Api path for id identified repos
Source
# File lib/octokit/repository.rb, line 63 def named_api_path "repos/#{slug}" end
@return [String] Api path for owner/name identified repos
Source
# File lib/octokit/repository.rb, line 49 def path return named_api_path if @owner && @name id_api_path if @id end
@return [String] Repository
API path
Source
# File lib/octokit/repository.rb, line 43 def slug "#{@owner}/#{@name}" end
Repository
owner/name @return [String]
Also aliased as: to_s
Source
# File lib/octokit/repository.rb, line 74 def url "#{Octokit.web_endpoint}#{slug}" end
Repository
URL based on {Octokit::Client#web_endpoint} @return [String]
Private Instance Methods
Source
# File lib/octokit/repository.rb, line 96 def raise_invalid_repository!(repo) msg = "#{repo.inspect} is invalid as a repository identifier. " \ 'Use the user/repo (String) format, or the repository ID (Integer), or a hash containing :repo and :user keys.' raise Octokit::InvalidRepository, msg end
Source
# File lib/octokit/repository.rb, line 90 def validate_owner_and_name!(repo) if @owner.include?('/') || @name.include?('/') || !url.match?(ABS_URI_REGEXP) raise_invalid_repository!(repo) end end