tinybucket 0.1.7 → 1.0.0

data/lib/tinybucket/api/diff_api.rb

@@ -1,14 +1,36 @@
 module Tinybucket
   module Api
+    # Diff Api client
+    #
+    # @see https://confluence.atlassian.com/bitbucket/diff-resource-425462484.html
+    #   diff Resource
+    #
+    # @!attribute [rw] repo_owner
+    #   @return [String] repository owner name.
+    # @!attribute [rw] repo_slug
+    #   @return [String] repository slug. (about {https://confluence.atlassian.com/bitbucket/repositories-endpoint-423626330.html#repositoriesEndpoint-Overview
+    #     repo_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

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

@@ -10,17 +10,6 @@ module Tinybucket
           end
         end
 
-        def inject_api_config(result)
-          case result
-          when Tinybucket::Model::Page
-            result.items.map { |m| m.api_config = @config.dup }
-          when Tinybucket::Model::Base
-            result.api_config = @config.dup
-          end
-
-          result
-        end
-
         def urlencode(v, key)
           if v.blank? || (escaped = CGI.escape(v.to_s)).blank?
             msg = "Invalid #{key} parameter. (#{v})"

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

@@ -16,6 +16,13 @@ module Tinybucket
                      [revision, 'revision'])
         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'],

data/lib/tinybucket/api/pull_requests_api.rb

@@ -1,56 +1,113 @@
 module Tinybucket
   module Api
+    # PullRequests Api client
+    #
+    # @see https://confluence.atlassian.com/bitbucket/pullrequests-resource-423626332.html
+    #   pullrequests Resource
+    #
+    # @!attribute [rw] repo_owner
+    #   @return [String] repository owner name.
+    # @!attribute [rw] repo_slug
+    #   @return [String] repository slug. (about {https://confluence.atlassian.com/bitbucket/repositories-endpoint-423626330.html#repositoriesEndpoint-Overview
+    #     repo_slug})
     class PullRequestsApi < BaseApi
       include Tinybucket::Api::Helper::PullRequestsHelper
 
       attr_accessor :repo_owner, :repo_slug
 
+      # Send 'GET a list of open pull requests' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def list(options = {})
-        list = get_path(path_to_list,
-                        options,
-                        Tinybucket::Parser::PullRequestsParser)
-
-        list.next_proc = next_proc(:list, options)
-        inject_api_config(list)
+        get_path(
+          path_to_list,
+          options,
+          Tinybucket::Parser::PullRequestsParser
+        )
       end
 
+      # Send 'GET a specific pull request' request
+      #
+      # @param pr_id [String] The pull request identifier
+      # @param options [Hash]
+      # @return [Tinybucket::Model::PullRequest]
       def find(pr_id, options = {})
-        m = get_path(path_to_find(pr_id),
-                     options,
-                     Tinybucket::Parser::PullRequestParser)
-
-        inject_api_config(m)
+        get_path(
+          path_to_find(pr_id),
+          options,
+          Tinybucket::Parser::PullRequestParser
+        )
       end
 
+      # Send 'GET the commits for a pull request' request
+      #
+      # @param pr_id [String] The pull request identifier
+      # @param options [Hash]
+      # @return [Tinybucket::Model::PullRequest]
       def commits(pr_id, options = {})
-        list = get_path(path_to_commits(pr_id),
-                        options,
-                        Tinybucket::Parser::CommitsParser)
-
-        list.next_proc = next_proc(:commits, options)
-        inject_api_config(list)
+        get_path(
+          path_to_commits(pr_id),
+          options,
+          Tinybucket::Parser::CommitsParser
+        )
       end
 
+      # Send 'POST a pull request approval' request
+      #
+      # @note This method return true if this pull request already approved.
+      #
+      # @param pr_id [String] The pull request identifier
+      # @param options [Hash]
+      # @return [true, false]
       def approve(pr_id, options = {})
         result = post_path(path_to_approve(pr_id), options)
         (result['approved'] == true)
+      rescue Tinybucket::Error::Conflict => e
+        logger.debug 'Already approved: ' + e.inspect
+        true
       end
 
+      # Send 'DELETE a pull request approval' request
+      #
+      # @note This method return true if this pull request is not approved yet.
+      #
+      # @param pr_id [String] The pull request identifier
+      # @param options [Hash]
+      # @return [true]
+      def unapprove(pr_id, options = {})
+        delete_path(path_to_approve(pr_id), options)
+        true
+      rescue Tinybucket::Error::NotFound => e
+        logger.debug 'Already unapproved: ' + e.inspect
+        true
+      end
+
+      # Send 'Decline or reject a pull request' request
+      #
+      # @param pr_id [String] The pull request identifier
+      # @param options [Hash]
+      # @return [true, false]
       def decline(pr_id, options = {})
         result = post_path(path_to_decline(pr_id), options)
         (result['state'] == 'DECLINED')
       end
 
-      def unapprove(pr_id, options = {})
-        result = delete_path(path_to_approve(pr_id), options)
-        (result['approved'] == false)
-      end
-
+      # Send 'Accept and merge a pull request' request
+      #
+      # @param pr_id [String] The pull request identifier
+      # @param options [Hash]
+      # @return [true, false]
       def merge(pr_id, options = {})
         result = post_path(path_to_merge(pr_id), options)
         (result['state'] == 'MERGED')
       end
 
+      # Send 'GET the diff for a pull request' request
+      #
+      # @param pr_id [String] The pull request identifier
+      # @param options [Hash]
+      # @return [String] diff as raw text.
       def diff(pr_id, options = {})
         get_path(path_to_diff(pr_id), options)
       end

data/lib/tinybucket/api/repo_api.rb

@@ -1,34 +1,54 @@
 module Tinybucket
   module Api
+    # Repo Api client
+    #
+    # @see https://confluence.atlassian.com/bitbucket/repository-resource-423626331.html
+    #   repository Resource
+    #
+    # @!attribute [rw] repo_owner
+    #   @return [String] repository owner name.
+    # @!attribute [rw] repo_slug
+    #   @return [String] repository slug. (about {https://confluence.atlassian.com/bitbucket/repositories-endpoint-423626330.html#repositoriesEndpoint-Overview
+    #     repo_slug})
     class RepoApi < BaseApi
       include Tinybucket::Api::Helper::RepoHelper
 
       attr_accessor :repo_owner, :repo_slug
 
+      # Send 'GET a repository' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Repository]
       def find(options = {})
-        repo = get_path(path_to_find,
-                        options,
-                        Tinybucket::Parser::RepoParser)
-
-        inject_api_config(repo)
+        get_path(
+          path_to_find,
+          options,
+          Tinybucket::Parser::RepoParser
+        )
       end
 
+      # Send 'GET a list of watchers' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def watchers(options = {})
-        list = get_path(path_to_watchers,
-                        options,
-                        Tinybucket::Parser::ProfilesParser)
-
-        list.next_proc = next_proc(:watchers, options)
-        inject_api_config(list)
+        get_path(
+          path_to_watchers,
+          options,
+          Tinybucket::Parser::ProfilesParser
+        )
       end
 
+      # Send 'GET a list of forks' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def forks(options = {})
-        list = get_path(path_to_forks,
-                        options,
-                        Tinybucket::Parser::ReposParser)
-
-        list.next_proc = next_proc(:forks, options)
-        inject_api_config(list)
+        get_path(
+          path_to_forks,
+          options,
+          Tinybucket::Parser::ReposParser
+        )
       end
     end
   end

data/lib/tinybucket/api/repos_api.rb

@@ -1,18 +1,25 @@
 module Tinybucket
   module Api
+    # Repos Api client
     class ReposApi < BaseApi
       include Tinybucket::Api::Helper::ReposHelper
 
+      # Send 'GET a list of repositories for an account' request
+      #
+      # @see https://confluence.atlassian.com/bitbucket/repositories-endpoint-423626330.html#repositoriesEndpoint-GETalistofrepositoriesforanaccount
+      #   GET a list of repositories for an account
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def list(options = {})
         opts = options.clone
         opts.delete(:owner)
 
-        list = get_path(path_to_list(options),
-                        opts,
-                        Tinybucket::Parser::ReposParser)
-
-        list.next_proc = next_proc(:list, options)
-        inject_api_config(list)
+        get_path(
+          path_to_list(options),
+          opts,
+          Tinybucket::Parser::ReposParser
+        )
       end
     end
   end

data/lib/tinybucket/api/team_api.rb

@@ -1,50 +1,75 @@
 module Tinybucket
   module Api
+    # Team Api client
+    #
+    # @see https://confluence.atlassian.com/bitbucket/teams-endpoint-423626335.html
+    #   teams Endpoint
     class TeamApi < BaseApi
       include Tinybucket::Api::Helper::TeamHelper
 
+      # Send 'GET the team profile' request
+      #
+      # @param name [String] The team's name
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Team]
       def find(name, options = {})
-        m = get_path(path_to_find(name),
-                     options,
-                     Tinybucket::Parser::TeamParser)
-
-        inject_api_config(m)
+        get_path(
+          path_to_find(name),
+          options,
+          Tinybucket::Parser::TeamParser
+        )
       end
 
+      # Send 'GET the team members' request
+      #
+      # @param name [String] The team's name
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def members(name, options = {})
-        list = get_path(path_to_members(name),
-                        options,
-                        Tinybucket::Parser::TeamsParser)
-
-        list.next_proc = next_proc(:members, options)
-        inject_api_config(list)
+        get_path(
+          path_to_members(name),
+          options,
+          Tinybucket::Parser::TeamsParser
+        )
       end
 
+      # Send 'GET the list of followers' request
+      #
+      # @param name [String] The team's name
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def followers(name, options = {})
-        list = get_path(path_to_followers(name),
-                        options,
-                        Tinybucket::Parser::TeamsParser)
-
-        list.next_proc = next_proc(:followers, options)
-        inject_api_config(list)
+        get_path(
+          path_to_followers(name),
+          options,
+          Tinybucket::Parser::TeamsParser
+        )
       end
 
+      # Send 'GET a lisf of accounts the tema is following' request
+      #
+      # @param name [String] The team's name
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def following(name, options = {})
-        list = get_path(path_to_following(name),
-                        options,
-                        Tinybucket::Parser::TeamsParser)
-
-        list.next_proc = next_proc(:following, options)
-        inject_api_config(list)
+        get_path(
+          path_to_following(name),
+          options,
+          Tinybucket::Parser::TeamsParser
+        )
       end
 
+      # Send 'GET the team's repositories' request
+      #
+      # @param name [String] The team's name
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def repos(name, options = {})
-        list = get_path(path_to_repos(name),
-                        options,
-                        Tinybucket::Parser::ReposParser)
-
-        list.next_proc = next_proc(:repos, options)
-        inject_api_config(list)
+        get_path(
+          path_to_repos(name),
+          options,
+          Tinybucket::Parser::ReposParser
+        )
       end
     end
   end

data/lib/tinybucket/api/user_api.rb

@@ -1,43 +1,63 @@
 module Tinybucket
   module Api
+    # User Api client
+    #
+    # @see https://confluence.atlassian.com/bitbucket/users-endpoint-423626336.html
+    #   users Endpoint
+    #
+    # @!attribute [rw] username
+    #   @return [String]
     class UserApi < BaseApi
       include Tinybucket::Api::Helper::UserHelper
 
       attr_accessor :username
 
+      # Send 'GET the user profile' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Profile]
       def profile(options = {})
-        m = get_path(path_to_find,
-                     options,
-                     Tinybucket::Parser::ProfileParser)
-
-        inject_api_config(m)
+        get_path(
+          path_to_find,
+          options,
+          Tinybucket::Parser::ProfileParser
+        )
       end
 
+      # Send 'GET the list of followers' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def followers(options = {})
-        list = get_path(path_to_followers,
-                        options,
-                        Tinybucket::Parser::ProfilesParser)
-
-        list.next_proc = next_proc(:followers, options)
-        inject_api_config(list)
+        get_path(
+          path_to_followers,
+          options,
+          Tinybucket::Parser::ProfilesParser
+        )
       end
 
+      # Send 'GET a list of accounts the user is following' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def following(options = {})
-        list = get_path(path_to_following,
-                        options,
-                        Tinybucket::Parser::ProfilesParser)
-
-        list.next_proc = next_proc(:following, options)
-        inject_api_config(list)
+        get_path(
+          path_to_following,
+          options,
+          Tinybucket::Parser::ProfilesParser
+        )
       end
 
+      # Send 'GET the user's repositories' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def repos(options = {})
-        list = get_path(path_to_repos,
-                        options,
-                        Tinybucket::Parser::ReposParser)
-
-        list.next_proc = next_proc(:repos, options)
-        inject_api_config(list)
+        get_path(
+          path_to_repos,
+          options,
+          Tinybucket::Parser::ReposParser
+        )
       end
     end
   end