reenhanced_bitbucket_api 0.1.6

data/lib/bitbucket_rest_api/issues/comments.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+
+module BitBucket
+  class Issues::Comments < API
+
+    VALID_ISSUE_COMMENT_PARAM_NAME = %w[
+      content
+    ].freeze
+
+    # Creates new Issues::Comments API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List comments on an issue
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.all 'user-name', 'repo-name', 'issue-id'
+    #  bitbucket.issues.comments.all 'user-name', 'repo-name', 'issue-id' {|com| .. }
+    #
+    def list(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
+      # _merge_mime_type(:issue_comment, params)
+
+      response = get_request("/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}/comments/", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single comment
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.find 'user-name', 'repo-name', 'comment-id'
+    #
+    def get(user_name, repo_name, comment_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of comment_id
+
+      normalize! params
+      # _merge_mime_type(:issue_comment, params)
+
+      get_request("/repositories/#{user}/#{repo.downcase}/issues/comments/#{comment_id}", params)
+    end
+    alias :find :get
+
+    # Create a comment
+    #
+    # = Inputs
+    #  <tt>:content</tt> Required string
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.create 'user-name', 'repo-name', 'issue-id',
+    #     "content" => 'a new comment'
+    #
+    def create(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
+      # _merge_mime_type(:issue_comment, params)
+      filter! VALID_ISSUE_COMMENT_PARAM_NAME, params
+      assert_required_keys(%w[ content ], params)
+
+      post_request("/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}/comments/", params)
+    end
+
+    # Edit a comment
+    #
+    # = Inputs
+    #  <tt>:content</tt> Required string
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.edit 'user-name', 'repo-name', 'comment-id',
+    #     "content" => 'a new comment'
+    #
+    def edit(user_name, repo_name, comment_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of comment_id
+
+      normalize! params
+      # _merge_mime_type(:issue_comment, params)
+      filter! VALID_ISSUE_COMMENT_PARAM_NAME, params
+      assert_required_keys(%w[ content ], params)
+
+      put_request("/repositories/#{user}/#{repo.downcase}/issues/comments/#{comment_id}")
+    end
+
+    # Delete a comment
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.delete 'user-name', 'repo-name', 'comment-id'
+    #
+    def delete(user_name, repo_name, comment_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of comment_id
+
+      normalize! params
+      # _merge_mime_type(:issue_comment, params)
+
+      delete_request("/repositories/#{user}/#{repo.downcase}/issues/comments/#{comment_id}", params)
+    end
+
+  end # Issues::Comments
+end # BitBucket

data/lib/bitbucket_rest_api/issues/components.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+module BitBucket
+  class Issues::Components < API
+
+    VALID_COMPONENT_INPUTS = %w[ name ].freeze
+
+    # Creates new Issues::Components API
+    def initialize(options = {})
+      super(options)
+    end
+    # List all components for a repository
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.components.list
+    #  bitbucket.issues.components.list { |component| ... }
+    #
+    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/components", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single component
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.components.find 'user-name', 'repo-name', 'component-id'
+    #
+    def get(user_name, repo_name, component_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of component_id
+      normalize! params
+
+      get_request("/repositories/#{user}/#{repo.downcase}/issues/components/#{component_id}", params)
+    end
+    alias :find :get
+
+    # Create a component
+    #
+    # = Inputs
+    #  <tt>:name</tt> - Required string
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.components.create :name => 'API'
+    #
+    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_COMPONENT_INPUTS, params
+      assert_required_keys(VALID_COMPONENT_INPUTS, params)
+
+      post_request("/repositories/#{user}/#{repo.downcase}/issues/components", params)
+    end
+
+    # Update a component
+    #
+    # = Inputs
+    #  <tt>:name</tt> - Required string
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.issues.components.update 'user-name', 'repo-name', 'component-id',
+    #    :name => 'API'
+    #
+    def update(user_name, repo_name, component_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of component_id
+
+      normalize! params
+      filter! VALID_COMPONENT_INPUTS, params
+      assert_required_keys(VALID_COMPONENT_INPUTS, params)
+
+      put_request("/repositories/#{user}/#{repo.downcase}/issues/components/#{component_id}", params)
+    end
+    alias :edit :update
+
+    # Delete a component
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.components.delete 'user-name', 'repo-name', 'component-id'
+    #
+    def delete(user_name, repo_name, component_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      _validate_presence_of component_id
+      normalize! params
+
+      delete_request("/repositories/#{user}/#{repo.downcase}/labels/components/#{component_id}", params)
+    end
+
+  end # Issues::Components
+end # BitBucket

data/lib/bitbucket_rest_api/issues/milestones.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+
+module BitBucket
+  class Issues::Milestones < API
+
+    VALID_MILESTONE_INPUTS = %w[
+      name
+    ].freeze # :nodoc:
+
+    # Creates new Issues::Milestones API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # 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/issues.rb

@@ -0,0 +1,230 @@
+# encoding: utf-8
+
+module BitBucket
+  class Issues < API
+    extend AutoloadHelper
+
+    autoload_all 'bitbucket_rest_api/issues',
+                 :Comments   => 'comments',
+                 :Components => 'components',
+                 :Milestones => '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 ]
+    }
+
+    # Creates new Issues API
+    def initialize(options = { })
+      super(options)
+    end
+
+    # Access to Issues::Comments API
+    def comments
+      @comments ||= ApiFactory.new 'Issues::Comments'
+    end
+
+    # Access to Issues::Components API
+    def components
+      @components ||= ApiFactory.new 'Issues::Components'
+    end
+
+    # Access to Issues::Milestones API
+    def milestones
+      @milestones ||= ApiFactory.new 'Issues::Milestones'
+    end
+
+    # 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
+      # _merge_mime_type(:issue, 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
+      # _merge_mime_type(:issue, 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
+      # _merge_mime_type(:issue, 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')
+      # _merge_mime_type(:issue, params)
+      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
+      # _merge_mime_type(:issue, 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/normalizer.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+module BitBucket
+  # Deals with normalizing client supplied parameter keys.
+  module Normalizer
+
+    # Turns any keys from nested hashes including nested arrays into strings
+    #
+    def normalize!(params)
+      case params
+      when Hash
+        params.keys.each do |k|
+          params[k.to_s] = params.delete(k)
+          normalize!(params[k.to_s])
+        end
+      when Array
+        params.map! do |el|
+          normalize!(el)
+        end
+      else
+        params.to_s
+      end
+      return params
+    end
+
+  end # Normalizer
+end # BitBucket

data/lib/bitbucket_rest_api/parameter_filter.rb

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+module BitBucket
+  # Allows you to specify parameters keys which will be preserved
+  # in parameters hash and its subhashes. Any keys from the nested
+  # hash that do not match will be removed.
+  module ParameterFilter
+
+    # Removes any keys from nested hashes that don't match predefiend keys
+    #
+    def filter!(keys, params, options={:recursive => true})  # :nodoc:
+      case params
+      when Hash
+        params.keys.each do |k, v|
+          unless (keys.include?(k) or BitBucket::Validations::VALID_API_KEYS.include?(k))
+            params.delete(k)
+          else
+            filter!(keys, params[k]) if options[:recursive]
+          end
+        end
+      when Array
+        params.map! do |el|
+          filter!(keys, el) if options[:recursive]
+        end
+      else
+        params
+      end
+      return params
+    end
+
+  end # Filter
+end # BitBucket

data/lib/bitbucket_rest_api/repos/changesets.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+module BitBucket
+  class Repos::Changesets < API
+
+    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