Class: BitBucket::Client::Repos
- Defined in:
- lib/bitbucket_rest_api/client/repos.rb
Defined Under Namespace
Classes: Changesets, Following, Keys, PullRequests, Services, Sources
Constant Summary collapse
- DEFAULT_REPO_OPTIONS =
{ "website" => "", "is_private" => false, "has_issues" => false, "has_wiki" => false, "scm" => "git", "no_public_forks" => false }.freeze
- VALID_REPO_OPTIONS =
%w[ owner name description website is_private has_issues has_wiki no_public_forks language scm ].freeze
Constants included from Validations
Constants included from Validations::Token
Validations::Token::TOKEN_REQUIRED, Validations::Token::TOKEN_REQUIRED_REGEXP
Constants included from BitBucket::Constants
BitBucket::Constants::ACCEPT, BitBucket::Constants::ACCEPT_CHARSET, BitBucket::Constants::CACHE_CONTROL, BitBucket::Constants::CONTENT_LENGTH, BitBucket::Constants::CONTENT_TYPE, BitBucket::Constants::DATE, BitBucket::Constants::ETAG, BitBucket::Constants::LOCATION, BitBucket::Constants::META_FIRST, BitBucket::Constants::META_LAST, BitBucket::Constants::META_NEXT, BitBucket::Constants::META_PREV, BitBucket::Constants::META_REL, BitBucket::Constants::PARAM_PAGE, BitBucket::Constants::PARAM_START_PAGE, BitBucket::Constants::QUERY_STR_SEP, BitBucket::Constants::RATELIMIT_LIMIT, BitBucket::Constants::RATELIMIT_REMAINING, BitBucket::Constants::SERVER, BitBucket::Constants::USER_AGENT
Instance Attribute Summary
Attributes inherited from API
Instance Method Summary collapse
-
#branches(user_name, repo_name, params = { }) ⇒ Object
(also: #list_branches)
List branches.
-
#create(*args) ⇒ Object
Create a new repository for the authenticated user.
-
#delete(user_name, repo_name) ⇒ Object
Delete a repository.
-
#edit(user_name, repo_name, params = { }) ⇒ Object
Edit a repository.
-
#get(user_name, repo_name, params = { }) ⇒ Object
(also: #find)
Get a repository.
-
#list(*args) ⇒ Object
(also: #all)
List repositories for the authenticated user.
-
#tags(user_name, repo_name, params = { }) ⇒ Object
(also: #list_tags, #repo_tags, #repository_tags)
List tags.
Methods inherited from API
#_merge_user_into_params!, #_merge_user_repo_into_params!, #_update_user_repo_params, #api_methods_in, #append_arguments, #arguments, extract_class_name, inherited, #initialize, #method_missing, namespace, #process_basic_auth, #set, #set_api_client, #setup, #with, #yield_or_eval
Methods included from BitBucket::ClassMethods
#configuration, #configure, #require_all
Methods included from Normalizer
Methods included from ParameterFilter
Methods included from Validations::Required
Methods included from Validations::Token
Methods included from Validations::Format
Methods included from Validations::Presence
Methods included from Request::Verbs
#delete_request, #get_request, #options_request, #patch_request, #post_request, #put_request
Methods included from Authorization
#authenticated?, #authentication, #basic_authed?
Constructor Details
This class inherits a constructor from BitBucket::API
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class BitBucket::API
Instance Method Details
#branches(user_name, repo_name, params = { }) ⇒ Object Also known as: list_branches
66 67 68 69 70 71 72 73 74 |
# File 'lib/bitbucket_rest_api/client/repos.rb', line 66 def branches(user_name, repo_name, params={ }) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless (user? && repo?) normalize! params response = get_request("/repositories/#{user}/#{repo.downcase}/branches/", params) return response unless block_given? response.each { |el| yield el } end |
#create(*args) ⇒ Object
Create a new repository for the authenticated user.
Parameters
<tt>:name</tt> - Required string
<tt>:description</tt> - Optional string
<tt>:website</tt> - Optional string
<tt>:is_private</tt> - Optional boolean - <tt>true</tt> to create a private repository, <tt>false</tt> to create a public one.
<tt>:has_issues</tt> - Optional boolean - <tt>true</tt> to enable issues for this repository, <tt>false</tt> to disable them
<tt>:has_wiki</tt> - Optional boolean - <tt>true</tt> to enable the wiki for this repository, <tt>false</tt> to disable it. Default is <tt>true</tt>
<tt>:owner</tt> Optional string - The team in which this repository will be created
Examples
bitbucket = BitBucket.new
bitbucket.repos.create "name" => 'repo-name'
"description": "This is your first repo",
"website": "https://bitbucket.com",
"is_private": false,
"has_issues": true,
"has_wiki": true
Create a new repository in this team. The authenticated user must be a member of this team
Examples:
bitbucket = BitBucket.new :oauth_token => '...', :oauth_secret => '...'
bitbucket.repos.create :name => 'repo-name', :owner => 'team-name'
105 106 107 108 109 110 111 112 113 |
# File 'lib/bitbucket_rest_api/client/repos.rb', line 105 def create(*args) params = args. normalize! params filter! VALID_REPO_OPTIONS + %w[ org ], params assert_required_keys(%w[ name ], params) # Requires authenticated user post_request("/repositories/", DEFAULT_REPO_OPTIONS.merge(params)) end |
#delete(user_name, repo_name) ⇒ Object
167 168 169 170 171 172 |
# File 'lib/bitbucket_rest_api/client/repos.rb', line 167 def delete(user_name, repo_name) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? delete_request("/repositories/#{user}/#{repo.downcase}") end |
#edit(user_name, repo_name, params = { }) ⇒ Object
Edit a repository
Parameters
-
:name
Required string -
:description
Optional string -
:website
Optional string -
:private
- Optional boolean -false
to create public reps,false
to create a private one -
:has_issues
Optional boolean -true
to enable issues for this repository,false
to disable them -
:has_wiki
Optional boolean -true
to enable the wiki for this repository,false
to disable it. Default istrue
-
:has_downloads
Optional boolean -true
to enable downloads for this repository
Examples
bitbucket = BitBucket.new
bitbucket.repos.edit 'user-name', 'repo-name',
:name => 'hello-world',
:description => 'This is your first repo',
:website => "https://bitbucket.com",
:public => true, :has_issues => true
135 136 137 138 139 140 141 142 143 |
# File 'lib/bitbucket_rest_api/client/repos.rb', line 135 def edit(user_name, repo_name, params={ }) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? normalize! params filter! VALID_REPO_OPTIONS, params put_request("/repositories/#{user}/#{repo.downcase}/", DEFAULT_REPO_OPTIONS.merge(params)) end |
#get(user_name, repo_name, params = { }) ⇒ Object Also known as: find
151 152 153 154 155 156 157 |
# File 'lib/bitbucket_rest_api/client/repos.rb', line 151 def get(user_name, repo_name, params={ }) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? normalize! params get_request("/repositories/#{user}/#{repo.downcase}", params) end |
#list(*args) ⇒ Object Also known as: all
List repositories for the authenticated user
Examples
bitbucket = BitBucket.new :oauth_token => '...', :oauth_secret => '...'
bitbucket.repos.list
bitbucket.repos.list { |repo| ... }
List public repositories for the specified user.
Examples
bitbucket = BitBucket.new
bitbucket.repos.list :user => 'user-name'
bitbucket.repos.list :user => 'user-name', { |repo| ... }
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/bitbucket_rest_api/client/repos.rb', line 187 def list(*args) #_merge_user_into_params!(params) unless params.has_key?('user') arguments(args) do permit %w[ user type ] end params = arguments.params response = get_request("/user/repositories", params) return response unless block_given? response.each { |el| yield el } end |
#tags(user_name, repo_name, params = { }) ⇒ Object Also known as: , ,
List tags
Examples
bitbucket = BitBucket.new
bitbucket.repos.tags 'user-name', 'repo-name'
bitbucket.repos.tags 'user-name', 'repo-name' { |tag| ... }
209 210 211 212 213 214 215 216 217 |
# File 'lib/bitbucket_rest_api/client/repos.rb', line 209 def (user_name, repo_name, params={ }) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? normalize! params response = get_request("/repositories/#{user}/#{repo.downcase}/tags/", params) return response unless block_given? response.each { |el| yield el } end |