bitbucket_rest_api 0.1.0

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}/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}/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}/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}/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}/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}/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}/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}/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}/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}/issues/milestones/#{milestone_id}", params)
+    end
+
+  end # Issues::Milestones
+end # BitBucket

data/lib/bitbucket_rest_api/issues.rb

@@ -0,0 +1,201 @@
+# 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[
+      filter
+      state
+      labels
+      sort
+      direction
+      since
+      milestone
+      assignee
+      mentioned
+      title
+      body
+      resource
+      mime_type
+    ].freeze
+
+    VALID_ISSUE_PARAM_VALUES = {
+        'filter'    => %w[ assigned created mentioned subscribed ],
+        'state'     => %w[ open closed ],
+        'sort'      => %w[ created updated comments ],
+        'direction' => %w[ desc asc ],
+        'since'     => %r{\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z}
+    }
+
+    # 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
+    #
+    # = Parameters
+    # <tt>:filter</tt> - Optional See https://confluence.atlassian.com/display/BITBUCKET/Issues#Issues-Filtering for building the filter string
+    #
+    # = 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}/issues", params)
+      return response unless block_given?
+      response.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}/issues/#{issue_id}", params)
+    end
+
+    alias :find :get
+
+    # 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_mime_type(:issue, params)
+      filter! VALID_ISSUE_PARAM_NAMES, params
+      assert_required_keys(%w[ title ], params)
+
+      post_request("/repositories/#{user}/#{repo}/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}/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>:sha</tt>   Optional string. Sha or branch to start listing changesets from.
+    # * <tt>:path</tt>  Optional string. Only changesets containing this file path will be returned
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.changesets.list 'user-name', 'repo-name', :sha => '...'
+    #  bitbucket.repos.changesets.list 'user-name', 'repo-name', :sha => '...' { |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[ sha path], params
+
+      response = get_request("/repositories/#{user}/#{repo}/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}/changesets/#{sha}", params)
+    end
+    alias :find :get
+
+  end # Repos::Commits
+end # BitBucket

data/lib/bitbucket_rest_api/repos/following.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module BitBucket
+  class Repos::Following < API
+
+    # 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}/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/repos/keys.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+module BitBucket
+  class Repos::Keys < API
+
+    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}/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}/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}/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}/deploy-keys/#{key_id}", params)
+    end
+
+  end # Repos::Keys
+end # BitBucket