bitbucket_rest_api2 0.2.0

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("/2.0/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("/2.0/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("/2.0/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("/2.0/repositories/#{user}/#{repo.downcase}/issues/comments/#{comment_id}", params)
+    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("/2.0/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("/2.0/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("/2.0/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("/2.0/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("/2.0/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("/2.0/repositories/#{user}/#{repo.downcase}/issues/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("/2.0/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("/2.0/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("/2.0/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("/2.0/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("/2.0/repositories/#{user}/#{repo.downcase}/issues/milestones/#{milestone_id}", params)
+    end
+
+  end # Issues::Milestones
+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.rb

@@ -0,0 +1,264 @@
+# encoding: utf-8
+
+module BitBucket
+  class Repos < API
+    extend AutoloadHelper
+
+    # Load all the modules after initializing Repos to avoid superclass mismatch
+    autoload_all 'bitbucket_rest_api/repos',
+                 :Changesets  => 'changesets',
+                 :Keys        => 'keys',
+                 :Services    => 'services',
+                 :Following   => 'following',
+                 :Sources     => 'sources',
+                 :Forks       => 'forks',
+                 :Commits     => 'commits',
+                 :Download    => 'download',
+                 :Webhooks    => 'webhooks',
+                 :PullRequest => 'pull_request',
+                 :DefaultReviewers => 'default_reviewers'
+
+    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
+
+    # Creates new Repositories API
+    def initialize(options = { })
+      super(options)
+    end
+
+    # Access to Repos::Commits API
+    def changesets
+      @changesets ||= ApiFactory.new 'Repos::Changesets'
+    end
+
+    # Access to Repos::Keys API
+    def keys
+      @keys ||= ApiFactory.new 'Repos::Keys'
+    end
+
+    # Access to Repos::Watchin API
+    def following
+      @following ||= ApiFactory.new 'Repos::Following'
+    end
+
+    # Access to Repos::Commits API
+    def sources
+      @sources ||= ApiFactory.new 'Repos::Sources'
+    end
+
+    # Access to Repos::Services API
+    def services
+      @services ||= ApiFactory.new 'Repos::Services'
+    end
+    def forks
+      @forks ||= ApiFactory.new 'Repos::Forks'
+    end
+    def commits
+      @commits ||=ApiFactory.new 'Repos::Commits'
+    end
+    def download
+      @download ||=ApiFactory.new "Repos::Download"
+    end
+
+    # Access to Repos::PullRequests API
+    def pull_request
+      @pull_request ||= ApiFactory.new 'Repos::PullRequest'
+    end
+
+    def default_reviewers
+      @default_reviewers ||= ApiFactory.new 'Repos::DefaultReviewers'
+    end
+
+    # 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("/2.0/repositories/#{user}/#{repo.downcase}/branches/", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    alias :list_branches :branches
+
+    # FIXME: 'POST a new repository' is a deprecated feature of the API
+    # 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("/2.0/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("/2.0/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("/2.0/repositories/#{user}/#{repo.downcase}", params)
+    end
+
+    alias :find :get
+
+    # FIXME: 'DELETE an existing repository' is a deprecated feature of the API
+    # 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("/2.0/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)
+      params = args.extract_options!
+      normalize! params
+      _merge_user_into_params!(params) unless params.has_key?('user')
+      filter! %w[ user type ], params
+
+      response = #if (user_name = params.delete("user"))
+                 #  get_request("/2.0/users/#{user_name}", params)
+                 #else
+                   # For authenticated user
+                   get_request("/2.0/user/repositories", params)
+                 #end
+      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("/2.0/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