class Github::Client::Repos

def branch(*args)

Other tags:
    Api: - public
def branch(*args)
  arguments(args, required: [:user, :repo, :branch])
  get_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}", arguments.params)
end

def branches(*args)

Other tags:
    Api: - public
def branches(*args)
  arguments(args, required: [:user, :repo])
  response = get_request("/repos/#{arguments.user}/#{arguments.repo}/branches", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

def contributors(*args)

Other tags:
    Api: - public

Options Hash: (**params)
  • :anon (Boolean) --

Parameters:
  • params (Hash) --
def contributors(*args)
  arguments(args, required: [:user, :repo]) do
    permit %w[ anon ]
  end
  params = arguments.params
  response = get_request("/repos/#{arguments.user}/#{arguments.repo}/contributors", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

def contributors(*args)

Other tags:
    Api: - public

Options Hash: (**params)
  • :anon (Boolean) --

Parameters:
  • params (Hash) --
def contributors(*args)
  arguments(args, required: [:user, :repo]) do
    permit ['anon']
  end
  response = get_request("/repos/#{arguments.user}/#{arguments.repo}/contributors", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

def create(*args)

Options Hash: (**params)
  • :gitignore_template (String) --
  • :auto_init (Boolean) --
  • :team_id (Numeric) --
  • :org (String) --
  • :has_downloads (Boolean) --
  • :has_wiki (Boolean) --
  • :has_issues (Boolean) --
  • :private (Boolean) --
  • :homepage (String) --
  • :description (String) --
  • :name (String) --

Parameters:
  • params (Hash) --
def create(*args)
  arguments(args) do
    permit VALID_REPO_OPTIONS + %w[ org ]
    assert_required %w[ name ]
  end
  params = arguments.params
  # Requires authenticated user
  if (org = params.delete('org') || org)
    post_request("/orgs/#{org}/repos", params)
  else
    post_request("/user/repos", params)
  end
end

def delete(*args)

Other tags:
    Api: - public
def delete(*args)
  arguments(args, required: [:user, :repo])
  delete_request("/repos/#{arguments.user}/#{arguments.repo}", arguments.params)
end

def delete(*args)

Other tags:
    Api: - public
def delete(*args)
  arguments(args, required: [:user, :repo])
  params = arguments.params
  delete_request("/repos/#{arguments.user}/#{arguments.repo}", arguments.params)
end

def edit(*args)

Options Hash: (**params)
  • :default_branch (String) --
  • :has_downloads (Boolean) --
  • :has_wiki (Boolean) --
  • :has_issues (Boolean) --
  • :private (Boolean) --
  • :homepage (String) --
  • :description (String) --
  • :name (String) --

Parameters:
  • params (Hash) --
def edit(*args)
  arguments(args, required: [:user, :repo]) do
    permit VALID_REPO_OPTIONS
    assert_required %w[ name ]
  end
  patch_request("/repos/#{arguments.user}/#{arguments.repo}", arguments.params)
end

def get(*args)


github.repos(user: 'user-name', repo: 'repo-name').get
github.repos.get user: 'user-name', repo: 'repo-name'
github.repos.get 'user-name', 'repo-name'
github = Github.new
@example

Get a repository
def get(*args)
  arguments(args, required: [:user, :repo])
  get_request("/repos/#{arguments.user}/#{arguments.repo}", arguments.params)
end

def get_by_id(*args)


github.repos(id: 'repo-id').get_by_id
github.repos.get_by_id id: 'repo-id'
github.repos.get_by_id 'repo-id'
github = Github.new
@example

Get a repository
def get_by_id(*args)
  arguments(args, required: [:id])
  get_request("/repositories/#{arguments.id}", arguments.params)
end

def languages(*args)

Other tags:
    Api: - public
def languages(*args)
  arguments(args, required: [:user, :repo])
  response = get_request("/repos/#{arguments.user}/#{arguments.repo}/languages", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

def list(*args)

Other tags:
    Api: - public

Options Hash: (**params)
  • :since (Integer) --

Parameters:
  • params (Hash) --
def list(*args)
  arguments(args) do
    permit %w[ user org type sort direction since ]
  end
  params = arguments.params
  unless params.symbolize_keys[:per_page]
    params.merge!(Pagination.per_page_as_param(current_options[:per_page]))
  end
  response = if (user_name = params.delete('user') || user)
    get_request("/users/#{user_name}/repos", params)
  elsif (org_name = params.delete('org') || org)
    get_request("/orgs/#{org_name}/repos", params)
  elsif args.map(&:to_s).include?('every')
    get_request('/repositories', params)
  else
    # For authenticated user
    get_request('/user/repos', params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end

def tags(*args)

Other tags:
    Api: - public
def tags(*args)
  arguments(args, required: [:user, :repo])
  response = get_request("/repos/#{arguments.user}/#{arguments.repo}/tags", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

def teams(*args)

Other tags:
    Api: - public
def teams(*args)
  arguments(args, required: [:user, :repo])
  response = get_request("/repos/#{arguments.user}/#{arguments.repo}/teams", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end