tinybucket2 1.0.0

data/lib/tinybucket/api/commits_api.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    # Commits Api client
+    #
+    # @!attribute [rw] repo_owner
+    #   @return [String] repository owner name.
+    # @!attribute [rw] repo_slug
+    #   @return [String] {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D repository slug}.
+    class CommitsApi < BaseApi
+      include Tinybucket::Api::Helper::CommitsHelper
+
+      attr_accessor :repo_owner, :repo_slug
+
+      # Send 'GET a commits list for a repository' request
+      #
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commits#get
+      #   GET a commits list for a repository
+      #
+      # @note This method does not support 'compare commits across branches'
+      #   API call, yet.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
+      def list(options = {})
+        get_path(
+          path_to_list,
+          options,
+          get_parser(:collection, Tinybucket::Model::Commit)
+        )
+      end
+
+      # Send 'GET an individual commit' request
+      #
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commits/%7Brevision%7D#get
+      #   GET an individual commit
+      #
+      # @param revision [String] A SHA1 value for the commit.
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Commit]
+      def find(revision, options = {})
+        get_path(
+          path_to_find(revision),
+          options,
+          get_parser(:object, Tinybucket::Model::Commit)
+        )
+      end
+
+      # Send 'POST a commit approval' request
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/approve#post
+      #   POST a commit approval request
+      #
+      # @param revision [String]
+      # @param options [Hash]
+      # @return [true, false]
+      def approve(revision, options = {})
+        result = post_path(path_to_approve(revision), options)
+        (result['approved'] == true)
+      rescue Tinybucket::Error::Conflict => e
+        logger.debug 'Already approved: ' + e.inspect
+        true
+      end
+
+      # Send 'DELETE a commit approval' request
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/approve#delete
+      #   DELETE a commit approval (unapprove the commit)
+      #
+      # @param revision [String]
+      # @param options [Hash]
+      # @return [true, false]
+      def unapprove(revision, options = {})
+        delete_path(path_to_approve(revision), options)
+        true
+      rescue Tinybucket::Error::NotFound => e
+        logger.debug 'Already unapproved: ' + e.inspect
+        true
+      end
+
+      # Send 'GET commits for a branch' request
+      #
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commits
+      #   GET an individual commit
+      #
+      # @param name [String] The branch name or a SHA1 value for the commit.
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Commit]
+      def branch(name, options = {})
+        get_path(
+          path_to_branch(name),
+          options,
+          get_parser(:collection, Tinybucket::Model::Commit)
+        )
+      end
+    end
+  end
+end

data/lib/tinybucket/api/diff_api.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    # Diff Api client
+    #
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/diff/%7Bspec%7D
+    #   diff Resource
+    #
+    # @!attribute [rw] repo_owner
+    #   @return [String] repository owner name.
+    # @!attribute [rw] repo_slug
+    #   @return [String] {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D repository slug}.
+    class DiffApi < BaseApi
+      include Tinybucket::Api::Helper::DiffHelper
+
+      attr_accessor :repo_owner, :repo_slug
+
+      # Send 'GET a diff' request
+      #
+      # @param spec [String] A specification such as a branch name,
+      #   revision, or commit SHA.
+      # @param options [Hash]
+      # @return [String] diff as raw text
+      def find(spec, options = {})
+        get_path(path_to_find(spec), options)
+      end
+
+      # Send 'GET a patch' request
+      #
+      # @param spec [String] A specification such as a branch name,
+      #   revision, or commit SHA.
+      # @param options [Hash]
+      # @return [String] patch as raw text
+      def find_patch(spec, options = {})
+        get_path(path_to_patch(spec), options)
+      end
+    end
+  end
+end

data/lib/tinybucket/api/helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    module Helper
+      extend ActiveSupport::Autoload
+
+      [
+        :ApiHelper,
+        :BranchesHelper,
+        :BranchRestrictionsHelper,
+        :BuildStatusHelper,
+        :CommitsHelper,
+        :CommentsHelper,
+        :DiffHelper,
+        :ReposHelper,
+        :RepoHelper,
+        :PullRequestsHelper,
+        :ProjectsHelper,
+        :TeamHelper,
+        :UserHelper
+      ].each do |klass_name|
+        autoload klass_name
+      end
+    end
+  end
+end

data/lib/tinybucket/api/helper/api_helper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    module Helper
+      module ApiHelper
+        private
+
+        def next_proc(method, options)
+          lambda do |next_options|
+            send(method, options.merge(next_options))
+          end
+        end
+
+        def urlencode(v, key)
+          if v.blank? || (escaped = CGI.escape(v.to_s)).blank?
+            msg = "Invalid #{key} parameter. (#{v})"
+            raise ArgumentError, msg
+          end
+
+          escaped
+        end
+
+        def build_path(base_path, *components)
+          components.reduce(base_path) do |path, component|
+            part = if component.is_a?(Array)
+                     urlencode(*component)
+                   else
+                     component.to_s
+                   end
+            path + '/' + part
+          end
+        rescue ArgumentError => e
+          raise ArgumentError, "Failed to build request URL: #{e}"
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/api/helper/branch_restrictions_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    module Helper
+      module BranchRestrictionsHelper
+        include ::Tinybucket::Api::Helper::ApiHelper
+
+        private
+
+        def path_to_list
+          base_path
+        end
+
+        def path_to_find(restriction_id)
+          build_path(base_path,
+                     [restriction_id, 'restriction_id'])
+        end
+
+        def base_path
+          build_path('/repositories',
+                     [repo_owner, 'repo_owner'],
+                     [repo_slug, 'repo_slug'],
+                     'branch-restrictions')
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/api/helper/branches_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    module Helper
+      module BranchesHelper
+        include ::Tinybucket::Api::Helper::ApiHelper
+
+        private
+
+        def path_to_list
+          build_path(base_path)
+        end
+
+        def path_to_find(branch)
+          build_path(base_path,
+                     [branch, 'branch'])
+        end
+
+        def base_path
+          build_path('/repositories',
+                     [repo_owner, 'repo_owner'],
+                     [repo_slug, 'repo_slug'],
+                     'refs', 'branches')
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/api/helper/build_status_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    module Helper
+      module BuildStatusHelper
+        include ::Tinybucket::Api::Helper::ApiHelper
+
+        private
+
+        def path_to_list
+          build_path('/repositories',
+                     [repo_owner, 'repo_owner'],
+                     [repo_slug,  'repo_slug'],
+                     'commit',
+                     [revision, 'revision'],
+                     'statuses')
+        end
+
+        def path_to_find(revision, key)
+          build_path(base_path(revision),
+                     [key, 'key'])
+        end
+
+        def path_to_post(revision)
+          base_path(revision)
+        end
+
+        def path_to_put(revision, key)
+          build_path(base_path(revision),
+                     [key, 'key'])
+        end
+
+        def base_path(revision)
+          build_path('/repositories',
+                     [repo_owner, 'repo_owner'],
+                     [repo_slug,  'repo_slug'],
+                     'commit',
+                     [revision, 'revision'],
+                     'statuses',
+                     'build')
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/api/helper/comments_helper.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    module Helper
+      module CommentsHelper
+        include ::Tinybucket::Api::Helper::ApiHelper
+
+        private
+
+        def path_to_list
+          base_path
+        end
+
+        def path_to_find(comment_id)
+          build_path(base_path,
+                     [comment_id, 'comment_id'])
+        end
+
+        def base_path
+          case commented_to
+          when Tinybucket::Model::Commit
+            base_path_of_commit
+          when Tinybucket::Model::PullRequest
+            base_path_of_pullrequest
+          else
+            raise ArgumentError, 'commented_to must be a pull_request or commit'
+          end
+        end
+
+        def base_path_of_commit
+          build_path('/repositories',
+                     [repo_owner, 'repo_owner'],
+                     [repo_slug,  'repo_slug'],
+                     'commit',
+                     [commented_to.hash, 'revision'],
+                     'comments')
+        end
+
+        def base_path_of_pullrequest
+          build_path('/repositories',
+                     [repo_owner, 'repo_owner'],
+                     [repo_slug,  'repo_slug'],
+                     'pullrequests',
+                     [commented_to.id, 'pull_request_id'],
+                     'comments')
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/api/helper/commits_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    module Helper
+      module CommitsHelper
+        include ::Tinybucket::Api::Helper::ApiHelper
+
+        private
+
+        def path_to_list
+          build_path(base_path, 'commits')
+        end
+
+        def path_to_find(revision)
+          build_path(base_path,
+                     'commit',
+                     [revision, 'revision'])
+        end
+
+        def path_to_branch(branch)
+          build_path(base_path,
+                     'commits',
+                     [branch, 'branch'])
+        end
+
+        def path_to_approve(revision)
+          build_path(base_path,
+                     'commit',
+                     [revision, 'revision'],
+                     'approve')
+        end
+
+        def base_path
+          build_path('/repositories',
+                     [repo_owner, 'repo_owner'],
+                     [repo_slug, 'repo_slug'])
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/api/helper/diff_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    module Helper
+      module DiffHelper
+        include ::Tinybucket::Api::Helper::ApiHelper
+
+        private
+
+        def path_to_find(spec)
+          build_path(base_path,
+                     'diff',
+                     [spec, 'spec'])
+        end
+
+        def path_to_patch(spec)
+          build_path(base_path,
+                     'patch',
+                     [spec, 'spec'])
+        end
+
+        def base_path
+          build_path('/repositories',
+                     [repo_owner, 'repo_owner'],
+                     [repo_slug, 'repo_slug'])
+        end
+      end
+    end
+  end
+end