bitbuckets 0.2.0

data/lib/bitbucket_rest_api/repos/changesets.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+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("/1.0/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("/1.0/repositories/#{user}/#{repo.downcase}/changesets/#{sha}", params)
+    end
+    alias find get
+  end # Repos::Commits
+end # BitBucket

data/lib/bitbucket_rest_api/repos/commits.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module BitBucket
+  class Repos::Commits < API
+    VALID_KEY_PARAM_NAMES = %w[include exclude].freeze
+
+    # Gets the commit information associated with a repository. By default, this
+    # call returns all the commits across all branches, bookmarks, and tags. The
+    # newest commit is first.
+    #
+    # = Parameters
+    # *<tt>include</tt> - The SHA, branch, bookmark, or tag to include, for example, v10 or master. You can repeat the parameter multiple times.
+    # *<tt>exclude</tt> - The SHA, branch, bookmark, or tag to exclude, for example, v10 or master . You can repeat the parameter multiple times.
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.commits.list 'user-name', 'repo-name'
+    #  bitbucket.repos.commits.list 'user-name', 'repo-name', 'master'
+    #  bitbucket.repos.commits.list 'user-name', 'repo-name' { |key| ... }
+    #  bitbucket.repos.commits.list 'user-name', 'repo-name', nil,
+    #    "include" => "feature-branch",
+    #    "exclude" =>  "master"
+    #
+    def list(user_name, repo_name, branchortag = nil, 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
+
+      path = "/2.0/repositories/#{user}/#{repo.downcase}/commits"
+      path << "/#{branchortag}" if branchortag
+      response = get_request(path, params)
+      return response unless block_given?
+
+      response.each { |el| yield el }
+    end
+    alias all list
+  end # Repos::Commits
+end # BitBucket

data/lib/bitbucket_rest_api/repos/components.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module BitBucket
+  class Repos::Components < API
+    # List components
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.components.list 'user-name', 'repo-name'
+    #  bitbucket.repos.components.list 'user-name', 'repo-name' { |component| ... }
+    #
+    def list(user_name, repo_name, params = {})
+      update_and_validate_user_repo_params(user_name, repo_name)
+      normalize! params
+
+      response = get_request("/2.0/repositories/#{user}/#{repo.downcase}/components", params)
+      return response['values'] unless block_given?
+
+      response['values'].each { |el| yield el }
+    end
+    alias all list
+
+    # Get a component by it's ID
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.components.get 'user-name', 'repo-name', 1
+    #
+    def get(user_name, repo_name, component_id, params = {})
+      update_and_validate_user_repo_params(user_name, repo_name)
+      normalize! params
+
+      get_request("/2.0/repositories/#{user}/#{repo.downcase}/components/#{component_id}", params)
+    end
+  end
+end

data/lib/bitbucket_rest_api/repos/default_reviewers.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+module BitBucket
+  class Repos::DefaultReviewers < API
+    # List default reviewers
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.default_reviewers.list 'user-name', 'repo-name'
+    #  bitbucket.repos.default_reviewers.list 'user-name', 'repo-name' { |reviewer| ... }
+    #
+    def list(user_name, repo_name, params = {})
+      update_and_validate_user_repo_params(user_name, repo_name)
+      normalize! params
+
+      response = get_request("/2.0/repositories/#{user_name}/#{repo_name}/default-reviewers", params)
+      return response unless block_given?
+
+      response.each { |el| yield el }
+    end
+    alias all list
+
+    # Get a default reviewer's info
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.default_reviewers.get 'user-name', 'repo-name', 'reviewer-username'
+    #
+    def get(user_name, repo_name, reviewer_username, params = {})
+      update_and_validate_user_repo_params(user_name, repo_name)
+      normalize! params
+
+      get_request("/2.0/repositories/#{user_name}/#{repo_name}/default-reviewers/#{reviewer_username}", params)
+    end
+
+    # Add a user to the default-reviewers list for the repo
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.default_reviewers.add 'user-name', 'repo-name', 'reviewer-username'
+    #
+    def add(user_name, repo_name, reviewer_username, params = {})
+      update_and_validate_user_repo_params(user_name, repo_name)
+      normalize! params
+
+      put_request("/2.0/repositories/#{user_name}/#{repo_name}/default-reviewers/#{reviewer_username}", params)
+    end
+
+    # Remove a user from the default-reviewers list for the repo
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.default_reviewers.remove 'user-name', 'repo-name', 'reviewer-username'
+    #
+    def remove(user_name, repo_name, reviewer_username, params = {})
+      update_and_validate_user_repo_params(user_name, repo_name)
+      normalize! params
+      delete_request("/2.0/repositories/#{user_name}/#{repo_name}/default-reviewers/#{reviewer_username}", params)
+    end
+  end
+end

data/lib/bitbucket_rest_api/repos/download.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module BitBucket
+  class Repos::Download < API
+    REQUIRED_KEY_PARAM_NAMES = %w[commit_hash].freeze
+    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
+      #       assert_required_keys(REQUIRED_KEY_PARAM_NAMES, params)
+
+      # https://bitbucket.org/jhanley85/eternum_canvas_demo/get/fd931f96f12d.zip
+      "https://bitbucket.org/#{user}/#{repo.downcase}/get/#{params[:commit_hash]}.tar.gz"
+    end
+  end # Repos::Keys
+end # BitBucket

data/lib/bitbucket_rest_api/repos/following.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+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("/1.0/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('/1.0/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/forks.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+module BitBucket
+  class Repos::Forks < API
+    REQUIRED_KEY_PARAM_NAMES = %w[name].freeze
+    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
+
+    # List forks of a repo
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.forks.list 'user-name', 'repo-name'
+    #  bitbucket.repos.forks.list 'user-name', 'repo-name' { |fork| ... }
+    #
+    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}/forks/", params)
+      return response unless block_given?
+
+      response.each { |el| yield el }
+    end
+    alias all list
+
+    # Create a fork
+    #
+    # = Inputs
+    # * <tt>:type</tt> - One of the supported services. The type is a case-insensitive value.
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.forks.create 'user-name', 'repo-name',
+    #    "name"           => "Basecamp",
+    #
+    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)
+      filter! VALID_REPO_OPTIONS, params
+
+      post_request("/1.0/repositories/#{user}/#{repo.downcase}/fork", params)
+    end
+  end # Repos::Keys
+end # BitBucket

data/lib/bitbucket_rest_api/repos/keys.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+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("/1.0/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)
+
+      options = { headers: { 'Content-Type' => 'application/json' } }
+      post_request("/1.0/repositories/#{user}/#{repo}/deploy-keys/", params, options)
+    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("/1.0/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("/1.0/repositories/#{user}/#{repo}/deploy-keys/#{key_id}", params)
+    end
+  end # Repos::Keys
+end # BitBucket

data/lib/bitbucket_rest_api/repos/pull_request.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+module BitBucket
+  class Repos::PullRequest < API
+    # List pull requests
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_request.list 'user-name', 'repo-name'
+    #  bitbucket.repos.pull_request.list 'user-name', 'repo-name' { |status| ... }
+    #
+    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}/pullrequests", params)
+      return response unless block_given?
+
+      response.each { |el| yield el }
+    end
+    alias all list
+
+    # List pull request participants
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_request.list 'user-name', 'repo-name'
+    #  bitbucket.repos.pull_request.list 'user-name', 'repo-name' { |status| ... }
+    #
+    def participants(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = get_request("/1.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/participants", params)
+      return response unless block_given?
+
+      response.each { |el| yield el }
+    end
+
+    def get(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}", params)
+      return response unless block_given?
+    end
+
+    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
+
+      response = request(:post, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests", params)
+      return response unless block_given?
+    end
+
+    def update(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:put, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}", params)
+      return response unless block_given?
+    end
+
+    def commits(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/commits", params)
+      return response unless block_given?
+    end
+
+    def approve(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:post, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/approve", params)
+      return response unless block_given?
+    end
+
+    def delete_approval(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:delete, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/approve", params)
+      return response unless block_given?
+    end
+
+    def diff(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/diff", params)
+      return response unless block_given?
+    end
+
+    def all_activity(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 = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/activity", params)
+      return response unless block_given?
+    end
+
+    def activity(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/activity", params)
+      return response unless block_given?
+    end
+
+    def merge(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:post, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/merge", params)
+      return response unless block_given?
+    end
+
+    def decline(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:post, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/decline", params)
+      return response unless block_given?
+    end
+
+    def comments(user_name, repo_name, pull_request_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/comments", params)
+      return response unless block_given?
+    end
+
+    def comment(user_name, repo_name, pull_request_id, comment_id, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/comments/#{comment_id}", params)
+      return response unless block_given?
+    end
+  end # Repos::Keys
+end # BitBucket