codenamev_bitbucket_api 0.4.0

data/lib/bitbucket_rest_api/client/issues/milestones.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Issues::Milestones < API
+    @version = '1.0'
+
+    VALID_MILESTONE_INPUTS = %w[
+      name
+    ].freeze # :nodoc:
+
+    # List milestones for a repository
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.milestones.list
+    #
+    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}/issues/milestones", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single milestone
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.milestones.get 'user-name', 'repo-name', 'milestone-id'
+    #
+    def get(user_name, repo_name, milestone_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of milestone_id
+      normalize! params
+
+      get_request("/repositories/#{user}/#{repo.downcase}/issues/milestones/#{milestone_id}", params)
+    end
+    alias :find :get
+
+    # Create a milestone
+    #
+    # = Inputs
+    #  <tt>:name</tt> - Required string
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.milestones.create :name => 'hello-world'
+    #
+    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
+      filter! VALID_MILESTONE_INPUTS, params
+      assert_required_keys(%w[ name ], params)
+
+      post_request("/repositories/#{user}/#{repo.downcase}/issues/milestones", params)
+    end
+
+    # Update a milestone
+    #
+    # = Inputs
+    #  <tt>:name</tt> - Required string
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.milestones.update 'user-name', 'repo-name', 'milestone-id',
+    #    :name => 'hello-world'
+    #
+    def update(user_name, repo_name, milestone_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of milestone_id
+
+      normalize! params
+      filter! VALID_MILESTONE_INPUTS, params
+      assert_required_keys(%w[ name ], params)
+
+      put_request("/repositories/#{user}/#{repo.downcase}/issues/milestones/#{milestone_id}", params)
+    end
+
+    # Delete a milestone
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.milestones.delete 'user-name', 'repo-name', 'milestone-id'
+    #
+    def delete(user_name, repo_name, milestone_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of milestone_id
+      normalize! params
+
+      delete_request("/repositories/#{user}/#{repo.downcase}/issues/milestones/#{milestone_id}", params)
+    end
+
+  end # Issues::Milestones
+end # BitBucket

data/lib/bitbucket_rest_api/client/issues.rb

@@ -0,0 +1,214 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Issues < API
+    @version = '1.0'
+
+    require_all 'bitbucket_rest_api/client/issues',
+      'comments',
+      'components',
+      'milestones'
+
+    VALID_ISSUE_PARAM_NAMES = %w[
+      title
+      content
+      component
+      milestone
+      version
+      responsible
+      priority
+      status
+      kind
+      limit
+      start
+      search
+      sort
+      reported_by
+    ].freeze
+
+    VALID_ISSUE_PARAM_VALUES = {
+        'priority'    => %w[ trivial minor major critical blocker ],
+        'status'     => ['new', 'open', 'resolved', 'on hold', 'invalid', 'duplicate', 'wontfix'],
+        'kind'      => %w[ bug enhancement proposal task ]
+    }
+
+    # Access to Issues::Comments API
+    namespace :comments
+
+    # Access to Issues::Components API
+    namespace :components
+
+    # Access to Issues::Milestones API
+    namespace :milestones
+
+    # List issues for a repository
+    #
+    # = Inputs
+    #  <tt>:limit</tt> - Optional - Number of issues to retrieve, default 15
+    #  <tt>:start</tt> - Optional - Issue offset, default 0
+    #  <tt>:search</tt> - Optional - A string to search for
+    #  <tt>:sort</tt> - Optional - Sorts the output by any of the metadata fields
+    #  <tt>:title</tt> - Optional - Contains a filter operation to restrict the list of issues by the issue title
+    #  <tt>:content</tt> - Optional - Contains a filter operation to restrict the list of issues by the issue content
+    #  <tt>:version</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the version
+    #  <tt>:milestone</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the milestone
+    #  <tt>:component</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the component
+    #  <tt>:kind</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the issue kind
+    #  <tt>:status</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the issue status
+    #  <tt>:responsible</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the user responsible
+    #  <tt>:reported_by</tt> - Optional - Contains a filter operation to restrict the list of issues by the user that reported the issue
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.list_repo :filter => 'kind=bug&kind=enhancement'
+    #
+    def list_repo(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_ISSUE_PARAM_NAMES, params
+      assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
+
+      response = get_request("/repositories/#{user}/#{repo.downcase}/issues", params)
+      return response.issues unless block_given?
+      response.issues.each { |el| yield el }
+    end
+
+    alias :list_repository :list_repo
+
+    # Get a single issue
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.get 'user-name', 'repo-name', 'issue-id'
+    #
+    def get(user_name, repo_name, issue_id, params={ })
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of issue_id
+
+      normalize! params
+
+      get_request("/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}", params)
+    end
+
+    alias :find :get
+
+    # Delete a single issue
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.delete 'user-name', 'repo-name', 'issue-id'
+    #
+    def delete(user_name, repo_name, issue_id, params={ })
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of issue_id
+
+      normalize! params
+
+      delete_request("/repositories/#{user}/#{repo}/issues/#{issue_id}", params)
+    end
+
+    # Create an issue
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Required string
+    #  <tt>:content</tt> - Optional string
+    #  <tt>:responsible</tt> - Optional string - Login for the user that this issue should be assigned to.
+    #  <tt>:milestone</tt> - Optional number - Milestone to associate this issue with
+    #  <tt>:version</tt> - Optional number - Version to associate this issue with
+    #  <tt>:component</tt> - Optional number - Component to associate this issue with
+    #  <tt>:priority</tt> - Optional string - The priority of this issue
+    #  * <tt>trivial</tt>
+    #  * <tt>minor</tt>
+    #  * <tt>major</tt>
+    #  * <tt>critical</tt>
+    #  * <tt>blocker</tt>
+    #  <tt>:status</tt> - Optional string - The status of this issue
+    #  * <tt>new</tt>
+    #  * <tt>open</tt>
+    #  * <tt>resolved</tt>
+    #  * <tt>on hold</tt>
+    #  * <tt>invalid</tt>
+    #  * <tt>duplicate</tt>
+    #  * <tt>wontfix</tt>
+    #  <tt>:kind</tt> - Optional string - The kind of issue
+    #  * <tt>bug</tt>
+    #  * <tt>enhancement</tt>
+    #  * <tt>proposal</tt>
+    #  * <tt>task</tt>
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.create
+    #    "title" => "Found a bug",
+    #    "content" => "I'm having a problem with this.",
+    #    "responsible" => "octocat",
+    #    "milestone" => 1,
+    #    "priority" => "blocker"
+    #
+    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
+      _merge_user_into_params!(params) unless params.has_key?('user')
+      filter! VALID_ISSUE_PARAM_NAMES, params
+      assert_required_keys(%w[ title ], params)
+
+      post_request("/repositories/#{user}/#{repo.downcase}/issues/", params)
+    end
+
+    # Edit an issue
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Required string
+    #  <tt>:content</tt> - Optional string
+    #  <tt>:responsible</tt> - Optional string - Login for the user that this issue should be assigned to.
+    #  <tt>:milestone</tt> - Optional number - Milestone to associate this issue with
+    #  <tt>:version</tt> - Optional number - Version to associate this issue with
+    #  <tt>:component</tt> - Optional number - Component to associate this issue with
+    #  <tt>:priority</tt> - Optional string - The priority of this issue
+    #  * <tt>trivial</tt>
+    #  * <tt>minor</tt>
+    #  * <tt>major</tt>
+    #  * <tt>critical</tt>
+    #  * <tt>blocker</tt>
+    #  <tt>:status</tt> - Optional string - The status of this issue
+    #  * <tt>new</tt>
+    #  * <tt>open</tt>
+    #  * <tt>resolved</tt>
+    #  * <tt>on hold</tt>
+    #  * <tt>invalid</tt>
+    #  * <tt>duplicate</tt>
+    #  * <tt>wontfix</tt>
+    #  <tt>:kind</tt> - Optional string - The kind of issue
+    #  * <tt>bug</tt>
+    #  * <tt>enhancement</tt>
+    #  * <tt>proposal</tt>
+    #  * <tt>task</tt>
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.create
+    #    "title" => "Found a bug",
+    #    "content" => "I'm having a problem with this.",
+    #    "responsible" => "octocat",
+    #    "milestone" => 1,
+    #    "priority" => "blocker"
+    #
+    def edit(user_name, repo_name, issue_id, params={ })
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of issue_id
+
+      normalize! params
+      filter! VALID_ISSUE_PARAM_NAMES, params
+
+      put_request("/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}/", params)
+    end
+
+  end # Issues
+end # BitBucket

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

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::Changesets < API
+    @version = '1.0'
+
+    REQUIRED_COMMENT_PARAMS = %w[
+        body
+        changeset_id
+        line
+        path
+        position
+      ].freeze
+
+    # List changesets on a repository
+    #
+    # = Parameters
+    # * <tt>:limit</tt> Optional integer. An integer representing how many changesets to return. You can specify a limit between 0 and 50.
+    # * <tt>:start</tt> Optional string. A hash value representing the earliest node to start with.
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.changesets.list 'user-name', 'repo-name', :start => '...'
+    #  bitbucket.repos.changesets.list 'user-name', 'repo-name', :start => '...' { |changeset| ... }
+    #
+    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
+      filter! %w[ limit start], params
+
+      response = get_request("/repositories/#{user}/#{repo.downcase}/changesets", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Gets a single changeset
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.changesets.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6')
+    #
+    def get(user_name, repo_name, sha, 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}/changesets/#{sha}", params)
+    end
+    alias :find :get
+
+  end # Repos::Commits
+end # BitBucket

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

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::Following < API
+    @version = '1.0'
+
+    # List repo followers
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.repos.following.followers
+    #  bitbucket.repos.following.followers { |watcher| ... }
+    #
+    def followers(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}/followers/", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # List repos being followed by the authenticated user
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :oauth_token => '...', :oauth_secret => '...'
+    #  bitbucket.repos.following.followed
+    #
+    def followed(*args)
+      params = args.extract_options!
+      normalize! params
+
+      response = get_request("/user/follows", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+  end # Repos::Watching
+end # BitBucket

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

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::Keys < API
+    @version = '1.0'
+
+    VALID_KEY_PARAM_NAMES = %w[ label key ].freeze
+
+    # List deploy keys
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.keys.list 'user-name', 'repo-name'
+    #  bitbucket.repos.keys.list 'user-name', 'repo-name' { |key| ... }
+    #
+    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}/deploy-keys/", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Create a key
+    #
+    # = Inputs
+    # * <tt>:title</tt> - Required string.
+    # * <tt>:key</tt> - Required string.
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.keys.create 'user-name', 'repo-name',
+    #    "label" => "octocat@octomac",
+    #    "key" =>  "ssh-rsa AAA..."
+    #
+    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
+      filter! VALID_KEY_PARAM_NAMES, params
+      assert_required_keys(VALID_KEY_PARAM_NAMES, params)
+
+      post_request("/repositories/#{user}/#{repo.downcase}/deploy-keys/", params)
+    end
+
+    # Edit a key
+    #
+    # = Inputs
+    # * <tt>:title</tt> - Required string.
+    # * <tt>:key</tt> - Required string.
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.keys.edit 'user-name', 'repo-name',
+    #    "label" => "octocat@octomac",
+    #    "key" =>  "ssh-rsa AAA..."
+    #
+    def edit(user_name, repo_name, key_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of key_id
+
+      normalize! params
+      filter! VALID_KEY_PARAM_NAMES, params
+
+      put_request("/repositories/#{user}/#{repo.downcase}/deploy-keys/#{key_id}", params)
+    end
+
+    # Delete key
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.keys.delete 'user-name', 'repo-name', 'key-id'
+    #
+    def delete(user_name, repo_name, key_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of key_id
+      normalize! params
+
+      delete_request("/repositories/#{user}/#{repo.downcase}/deploy-keys/#{key_id}", params)
+    end
+
+  end # Repos::Keys
+end # BitBucket

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

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::PullRequests::Comments < API
+    @version = '2.0'
+
+    # List comments on a pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.comments.all 'user-name', 'repo-name', 'pull-request-id'
+    #
+    def list(*args)
+      arguments(args, required: [:user, :repo, :pull_request_id])
+      user            = arguments.user
+      repo            = arguments.repo
+      pull_request_id = arguments.pull_request_id
+
+      response = get_request("/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/comments")
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Gets a single comment
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.pull_requests.comments.get 'user-name', 'repo-name', 'pull-request-id')
+    #
+    def get(*args)
+      arguments(args, required: [:user, :repo, :pull_request_id, :comment_id])
+      user            = arguments.user
+      repo            = arguments.repo
+      pull_request_id = arguments.pull_request_id
+      comment_id      = arguments.comment_id
+
+      get_request("/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/comments/#{comment_id}")
+    end
+    alias :find :get
+  end
+end

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

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::PullRequests::Commits < API
+    @version = '2.0'
+
+    # List commits on a pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.commits.all 'user-name', 'repo-name', 'pull-request-id'
+    #
+    def list(user_name, repo_name, pull_request_id)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of pull_request_id
+
+      response = get_request("/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/commits")
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+  end
+end