codenamev_bitbucket_api 0.4.0

data/lib/bitbucket_rest_api/client/repos/pull_requests.rb

@@ -0,0 +1,199 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::PullRequests < API
+
+    # Load all the modules after initializing Repos to avoid superclass mismatch
+    require_all 'bitbucket_rest_api/client/repos/pull_requests',
+      'comments',
+      'commits'
+
+    REQUIRED_PULL_REQUEST_OPTIONS = %w[
+      title
+      source
+    ]
+
+    VALID_PULL_REQUEST_PARAM_NAMES = %w[
+      title
+      description
+      source
+      destination
+      reviewers
+      close_source_branch
+    ].freeze
+
+    VALID_PULL_REQUEST_STATE_VALUES = {
+      state: ['OPEN', 'MERGED', 'DECLINED']
+    }
+
+    @version = '2.0'
+
+    # Access to Client::Repos::PullRequests::Comments API
+    namespace :comments
+    namespace :commits
+
+    # List pull requests for a repository
+    #
+    # = Inputs
+    #  <tt>:state</tt> - Optional - State of the pull request (OPEN, MERGED, DECLINED)
+    #
+    def list(*args)
+      arguments(args, required: [:user, :repo], optional: [:state])
+      params = arguments.params
+      user   = arguments.user
+      repo   = arguments.repo
+
+      params['state'] ||= 'OPEN'
+      # Bitbucket requires the state to be all caps or it returns all
+      params['state']   = params['state'].upcase
+
+      response = get_request("/repositories/#{user}/#{repo}/pullrequests/", params)
+
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.find 'user-name', 'repo-name', 'pull-request-id'
+    #
+    def get(*args)
+      arguments(args, required: [:user, :repo, :pull_request_id])
+
+      get_request("/repositories/#{arguments.user}/#{arguments.repo.downcase}/pullrequests/#{arguments.pull_request_id}", arguments.params)
+    end
+
+    alias :find :get
+
+    # Create a pull request
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Required string
+    #  <tt>:description</tt> - Optional string
+    #  <tt>:source</tt> - Required hash - The source branch name and/or repository (for example, { develop)
+    #  * <tt>{ "branch": { "name": "REQUIRED branch_name" }, "repository": { "full_name": "owner/repo_slug" } }</tt>
+    #  <tt>:destination</tt> - Optional hash - The destination branch or commit
+    #  * <tt>{ "branch": { "name": "branch_name" }, "commit": { "hash": "name" } }</tt>
+    #  <tt>:reviewers</tt> - Optional array - Users currently reviewiing the pull
+    #  * <tt>[{ "username": "accountname" }]</tt>
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.create 'user-name', 'repo-name',
+    #    "title" => "Fixes a bug",
+    #    "description" => "Fixes not being able to see anything.",
+    #    "source" => { "branch" => { "name" => "bug-fixes" } },
+    #    "destination" => { "branch" => { "name" => "master" } },
+    #    "reviewers" => [ { "username" => "octocat" } ],
+    #    "close_source_branch" => true
+    #
+    def create(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_PULL_REQUEST_PARAM_NAMES
+        assert_required REQUIRED_PULL_REQUEST_OPTIONS
+      end
+
+      post_request("/repositories/#{arguments.user}/#{arguments.repo.downcase}/pullrequests", arguments.params)
+    end
+
+    # Edit a pull request
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Required string
+    #  <tt>:description</tt> - Optional string
+    #  <tt>:destination</tt> - Optional hash - The destination branch or commit
+    #  * <tt>{ "branch": { "name": "branch_name" }, "commit": { "hash": "name" } }</tt>
+    #  <tt>:reviewers</tt> - Optional array - Users currently reviewiing the pull
+    #  * <tt>[{ "username": "accountname" }]</tt>
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.update 'user-name', 'repo-name', 'pull-request-id',
+    #    "title" => "Fixes a bug",
+    #    "description" => "Fixes not being able to see anything.",
+    #    "destination" => { "branch" => { "name" => "master" } },
+    #    "reviewers" => [ { "username" => "octocat" } ],
+    #    "close_source_branch" => true
+    #
+    def update(*args)
+      arguments(args, required: [:user, :repo, :pull_request_id]) do
+        permit VALID_PULL_REQUEST_PARAM_NAMES
+      end
+
+      user            = arguments.user
+      repo            = arguments.repo
+      pull_request_id = arguments.pull_request_id
+
+      # BitBucket will drop any data if it is not included, so we have to check for pre-existing data
+      existing_pull = get(user, repo, pull_request_id)
+      existing_pull_data = {
+        'title' => existing_pull.title,
+        'description' => existing_pull.description,
+        'destination' => {
+          'branch' => existing_pull.destination.branch
+        },
+        'reviewers' => existing_pull.reviewers,
+        'close_source_branch' => existing_pull.close_source_branch
+      }
+      params = normalize!(existing_pull_data).merge!(normalize!(arguments.params))
+
+      put_request("/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/", params)
+    end
+    alias :edit :update
+
+    # Decline or reject a single pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.reject 'user-name', 'repo-name', 'pull-request-id'
+    #
+    def decline(user_name, repo_name, pull_request_id)
+      arguments(args, required: [:user, :repo, :pull_request_id])
+
+      post_request("/repositories/#{arguments.user}/#{arguments.repo}/pullrequests/#{arguments.pull_request_id}/decline")
+    end
+    alias :reject :decline
+
+    # Give approval on a pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.approve 'user-name', 'repo-name', 'pull-request-id'
+    #
+    def approve(user_name, repo_name, pull_request_id)
+      arguments(args, required: [:user, :repo, :pull_request_id])
+
+      post_request("/repositories/#{arguments.user}/#{arguments.repo}/pullrequests/#{arguments.pull_request_id}/approve")
+    end
+
+    # Get the diff for a pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.diff 'user-name', 'repo-name', 'pull-request-id'
+    #
+    def diff(user_name, repo_name, pull_request_id)
+      arguments(args, required: [:user, :repo, :pull_request_id])
+
+      get_request("/repositories/#{arguments.user}/#{arguments.repo}/pullrequests/#{arguments.pull_request_id}/diff")
+    end
+
+    # Get a log of all activity for a pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.activity 'user-name', 'repo-name'
+    #
+    def activity(*args)
+      arguments(args, required: [:user, :repo, :pull_request_id])
+
+      response = get_request("/repositories/#{arguments.user}/#{arguments.repo}/pullrequests/#{arguments.pull_request_id}/activity")
+
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+  end # Repos::PullRequests
+end # BitBucket

data/lib/bitbucket_rest_api/client/repos/services.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::Services < API
+    @version = '2.0'
+
+    REQUIRED_KEY_PARAM_NAMES = %w[ type ].freeze
+
+    # List services
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.services.list 'user-name', 'repo-name'
+    #  bitbucket.repos.services.list 'user-name', 'repo-name' { |service| ... }
+    #
+    def list(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}/services", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Gets a single service
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.services.get 'user-name', 'repo-name', 109172378)
+    #
+    def get(user_name, repo_name, service_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of(service_id)
+      normalize! params
+
+      get_request("/repositories/#{user}/#{repo.downcase}/services/#{service_id}", params)
+    end
+    alias :find :get
+
+    # Create a service
+    #
+    # = Inputs
+    # * <tt>:type</tt> - One of the supported services. The type is a case-insensitive value.
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.services.create 'user-name', 'repo-name',
+    #    "type"           => "Basecamp",
+    #    "Password"       => "...",
+    #    "Username"       => "...",
+    #    "Discussion URL" => "..."
+    #
+    def create(user_name, repo_name, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+      assert_required_keys(REQUIRED_KEY_PARAM_NAMES, params)
+
+      post_request("/repositories/#{user}/#{repo.downcase}/services", params)
+    end
+
+    # Edit a service
+    #
+    # = Inputs
+    # * <tt>:type</tt> - One of the supported services. The type is a case-insensitive value.
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.services.edit 'user-name', 'repo-name', 109172378,
+    #    "type"           => "Basecamp",
+    #    "Password"       => "...",
+    #    "Username"       => "...",
+    #    "Discussion URL" => "..."
+    #
+    def edit(user_name, repo_name, service_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of(service_id)
+
+      normalize! params
+
+      put_request("/repositories/#{user}/#{repo.downcase}/services/#{service_id}", params)
+    end
+
+    # Delete service
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.services.delete 'user-name', 'repo-name', 109172378
+    #
+    def delete(user_name, repo_name, service_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of(service_id)
+      normalize! params
+
+      delete_request("/repositories/#{user}/#{repo.downcase}/services/#{service_id}", params)
+    end
+
+  end # Repos::Keys
+end # BitBucket

data/lib/bitbucket_rest_api/client/repos/sources.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::Sources < API
+    @version = '1.0'
+
+    REQUIRED_COMMENT_PARAMS = %w[
+        body
+        changeset_id
+        line
+        path
+        position
+      ].freeze
+
+    # Gets a source of repo 
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.sources.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6', 'app/contorllers/')
+    #
+    def get(user_name, repo_name, sha, path, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of sha
+      normalize! params
+
+      get_request("/repositories/#{user}/#{repo.downcase}/src/#{sha}/#{path}", params)
+    end
+    alias :find :get
+
+  end # Repos::Sources
+end # BitBucket

data/lib/bitbucket_rest_api/client/repos.rb

@@ -0,0 +1,224 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos < API
+
+    require_all 'bitbucket_rest_api/client/repos',
+      'changesets',
+      'keys',
+      'services',
+      'following',
+      'sources',
+      'pull_requests'
+
+    @version = '1.0'
+
+    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
+
+    # Access to Repos::Commits API
+    namespace :changesets
+
+    # Access to Repos::Keys API
+    namespace :keys
+
+    # Access to Repos::Watchin API
+    namespace :following
+
+    # Access to Repos::Commits API
+    namespace :sources
+
+    # Access to Repos::Services API
+    namespace :services
+
+    # Access to Repos::PullRequests API
+    namespace :pull_requests
+
+    # List branches
+    #
+    # = Examples
+    #
+    #   bitbucket = BitBucket.new
+    #   bibucket.repos.branches 'user-name', 'repo-name'
+    #
+    #   repos = BitBucket::Repos.new
+    #   repos.branches 'user-name', 'repo-name'
+    #
+    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
+
+    alias :list_branches :branches
+
+    # 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'
+    #
+    def create(*args)
+      params = args.extract_options!
+      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
+
+    # Edit a repository
+    #
+    # = Parameters
+    # * <tt>:name</tt> Required string
+    # * <tt>:description</tt>   Optional string
+    # * <tt>:website</tt>       Optional string
+    # * <tt>:private</tt> - Optional boolean - <tt>false</tt> to create public reps, <tt>false</tt> to create a private 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>:has_downloads</tt> Optional boolean - <tt>true</tt> 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
+    #
+    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 a repository
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.get 'user-name', 'repo-name'
+    #
+    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
+
+    alias :find :get
+
+    # Delete a repository
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.delete 'user-name', 'repo-name'
+    #
+    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
+
+    # 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| ... }
+    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
+
+    alias :all :list
+
+    # List tags
+    #
+    # = Examples
+    #   bitbucket = BitBucket.new
+    #   bitbucket.repos.tags 'user-name', 'repo-name'
+    #   bitbucket.repos.tags 'user-name', 'repo-name' { |tag| ... }
+    #
+    def tags(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
+
+    alias :list_tags :tags
+    alias :repo_tags :tags
+    alias :repository_tags :tags
+
+  end # Repos
+end # BitBucket

data/lib/bitbucket_rest_api/client/user.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::User < API
+    @version = '1.0'
+
+    DEFAULT_USER_OPTIONS = {
+        "first_name"      => "",
+        "last_name"       => "",
+        "avatar"          => ""
+        # TODO: can this filed be modified?
+        # "resource_uri"    => ""
+    }.freeze
+
+    # Gets the basic information associated with an account and
+    # a list of all of the repositories owned by the user.
+    # See https://confluence.atlassian.com/display/BITBUCKET/user+Endpoint#userEndpoint-GETauserprofile
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.user_api.profile
+    #
+    def profile
+      get_request("/user")
+    end
+
+
+    # Update a user
+
+    # = Parameters
+    # * <tt>:first_name</tt>    Optional string
+    # * <tt>:last_name</tt>     Optional string
+    # * <tt>:avatar</tt>        Optional string
+    # * <tt>:resource_uri</tt>  Optional string
+    #
+    # = Examples
+    #
+    #  bitbucket = BitBucket.new
+    #  bitbucket.user_api.update :first_name => 'first-name', :last_name => 'last-name'
+    #
+
+    def update( params={ })
+      normalize! params
+      filter! DEFAULT_USER_OPTIONS, params
+
+      put_request("/user", DEFAULT_USER_OPTIONS.merge(params))
+
+    end
+
+
+    # GET a list of user privileges
+    def privileges
+      get_request("/user/privileges")
+    end
+
+
+
+    # GET a list of repositories an account follows
+    # Gets the details of the repositories that the individual or team account follows.
+    # This call returns the full data about the repositories including
+    # if the repository is a fork of another repository.
+    # An account always "follows" its own repositories.
+    def follows
+      get_request("/user/follows")
+    end
+
+
+    # GET a list of repositories visible to an account
+    # Gets the details of the repositories that the user owns
+    # or has at least read access to.
+    # Use this if you're looking for a full list of all of the repositories associated with a user.
+    def repositories
+      get_request("/user/repositories")
+    end
+
+    alias :repos :repositories
+
+
+
+    # GET a list of repositories the account is following
+    # Gets a list of the repositories the account follows.
+    # This is the same list that appears on the Following tab on your account dashboard.
+    def overview
+      get_request("/user/repositories/overview")
+    end
+
+
+
+    # GET the list of repositories on the dashboard
+    # Gets the repositories list from the account's dashboard.
+    def dashboard
+      get_request("/user/repositories/dashboard")
+    end
+
+  end # User
+end # BitBucket