tinybucket 1.3.0 → 1.4.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper
@@ -6,6 +8,15 @@ module Tinybucket
 
         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'])

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper
@@ -16,6 +18,12 @@ module Tinybucket
                      [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',

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper

data/lib/tinybucket/api/pull_requests_api.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # PullRequests Api client
     #
-    # @see https://confluence.atlassian.com/bitbucket/pullrequests-resource-423626332.html
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/pullrequests
     #   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})
+    #   @return [String] {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D repository slug}.
     class PullRequestsApi < BaseApi
       include Tinybucket::Api::Helper::PullRequestsHelper
 

data/lib/tinybucket/api/repo_api.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # Repo Api client
     #
-    # @see https://confluence.atlassian.com/bitbucket/repository-resource-423626331.html
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories
     #   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})
+    #   @return [String] {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D repository slug}.
     class RepoApi < BaseApi
       include Tinybucket::Api::Helper::RepoHelper
 

data/lib/tinybucket/api/repos_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # Repos Api client
@@ -6,7 +8,7 @@ module Tinybucket
 
       # Send 'GET a list of repositories for an account' request
       #
-      # @see https://confluence.atlassian.com/bitbucket/repositories-endpoint-423626330.html#repositoriesEndpoint-GETalistofrepositoriesforanaccount
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories
       #   GET a list of repositories for an account
       #
       # @param options [Hash]

data/lib/tinybucket/api/team_api.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # Team Api client
     #
-    # @see https://confluence.atlassian.com/bitbucket/teams-endpoint-423626335.html
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/teams
     #   teams Endpoint
     class TeamApi < BaseApi
       include Tinybucket::Api::Helper::TeamHelper
@@ -46,7 +48,7 @@ module Tinybucket
         )
       end
 
-      # Send 'GET a lisf of accounts the tema is following' request
+      # Send 'GET a lisf of accounts the team is following' request
       #
       # @param name [String] The team's name
       # @param options [Hash]

data/lib/tinybucket/api/user_api.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # User Api client
     #
-    # @see https://confluence.atlassian.com/bitbucket/users-endpoint-423626336.html
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/users/%7Busername%7D
     #   users Endpoint
     #
     # @!attribute [rw] username

data/lib/tinybucket/api_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   class ApiFactory
     class << self

data/lib/tinybucket/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   class Client
     include ::Tinybucket::Model::Concerns::Enumerable
@@ -41,8 +43,7 @@ module Tinybucket
     # Get the repository
     #
     # @param owner [String] repository owner name.
-    # @param repo_slug [String] repository slug. (about {https://confluence.atlassian.com/bitbucket/repositories-endpoint-423626330.html#repositoriesEndpoint-Overview
-    #     repo_slug})
+    # @param repo_slug [String] {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D repository slug}.
     # @return [Tinybucket::Model::Repository]
     def repo(owner, repo_slug)
       Tinybucket::Model::Repository.new({}).tap do |m|

data/lib/tinybucket/config.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module Tinybucket
   class Config
     include ActiveSupport::Configurable
-    config_accessor :logger, :oauth_token, :oauth_secret, :cache_store_options
+    config_accessor :logger, :oauth_token, :oauth_secret, \
+                    :cache_store_options, :access_token, \
+                    :client_id, :client_secret, :user_agent
   end
 end

data/lib/tinybucket/connection.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Connection
+    DEFAULT_USER_AGENT = 'Tinybucket Ruby Bitbucket REST client'.freeze
+
     def clear_cache
       @connection = nil
     end
@@ -23,7 +27,7 @@ module Tinybucket
     def default_options(_options)
       {
         headers: {
-          USER_AGENT: 'test client' # TODO: fix this !
+          USER_AGENT: Tinybucket.config.user_agent || DEFAULT_USER_AGENT
         },
         ssl: { verify: false },
         url: 'https://api.bitbucket.org/2.0'.freeze
@@ -32,18 +36,13 @@ module Tinybucket
 
     def default_middleware(_options)
       proc do |conn|
-        oauth_secrets = {
-          consumer_key:    Tinybucket.config.oauth_token,
-          consumer_secret: Tinybucket.config.oauth_secret
-        }
-
         configure_response_cache(conn)
 
         conn.request :multipart
         conn.request :url_encoded
-        conn.request :oauth, oauth_secrets
 
-        conn.response :follow_oauth_redirects, oauth_secrets
+        configure_auth(conn)
+
         conn.response :json, content_type: /\bjson$/
         conn.use Tinybucket::Response::Handler
         conn.use :instrumentation
@@ -52,6 +51,20 @@ module Tinybucket
       end
     end
 
+    def configure_auth(conn)
+      if Tinybucket.config.access_token
+        conn.request :oauth2, Tinybucket.config.access_token
+      else
+        oauth_secrets = {
+          consumer_key:    Tinybucket.config.oauth_token,
+          consumer_secret: Tinybucket.config.oauth_secret
+        }
+
+        conn.request :oauth, oauth_secrets
+        conn.response :follow_oauth_redirects, oauth_secrets
+      end
+    end
+
     def configure_response_cache(conn)
       return unless Tinybucket.config.cache_store_options
 

data/lib/tinybucket/constants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Constants
     MISSING_REPOSITORY_KEY = 'This method call require repository keys.'.freeze

data/lib/tinybucket/enumerator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   class Enumerator < ::Enumerator
     # Constructor

data/lib/tinybucket/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Error
     extend ActiveSupport::Autoload

data/lib/tinybucket/error/base_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Error
     class BaseError < StandardError

data/lib/tinybucket/error/conflict.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Error
     class Conflict < ServiceError

data/lib/tinybucket/error/not_found.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Error
     class NotFound < ServiceError

data/lib/tinybucket/error/service_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Error
     class ServiceError < BaseError

data/lib/tinybucket/iterator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   # Iterator
   #
@@ -25,11 +27,11 @@ module Tinybucket
 
     # Get collection size.
     #
-    # @note This method return {https://confluence.atlassian.com/bitbucket/version-2-423626329.html#Version2-Pagingthroughobjectcollections
+    # @note This method return {https://developer.atlassian.com/bitbucket/api/2/reference/meta/pagination
     #   size attribute of object collection wrapper}.
     #   So this method may return nil.
     #
-    # @see https://confluence.atlassian.com/bitbucket/version-2-423626329.html#Version2-Pagingthroughobjectcollections
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/meta/pagination
     #   Paging through object collections
     #
     # @return [Fixnum, NillClas] collection size.

data/lib/tinybucket/model.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Model
     extend ActiveSupport::Autoload
 
     [
       :Base,
+      :Branch,
       :BranchRestriction,
       :BuildStatus,
       :Comment,

data/lib/tinybucket/model/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Model
     class Base
@@ -22,9 +24,7 @@ module Tinybucket
           if acceptable_attribute?(key)
             send("#{key}=".intern, value)
           else
-            # rubocop:disable Metrics/LineLength
             logger.warn("Ignored '#{key}' attribute (value: #{value}). [#{self.class}]")
-            # rubocop:enable Metrics/LineLength
           end
         end
       end

data/lib/tinybucket/model/branch.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    # Branch
+    #
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches
+    #   Branch Resource
+    #
+    # @!attribute [rw] links
+    #   @return [Hash]
+    # @!attribute [rw] type
+    #   @return [String]
+    # @!attribute [rw] name
+    #   @return [String]
+    # @!attribute [rw] repository
+    #   @return [Hash]
+    # @!attribute [rw] target
+    #   @return [Hash]
+    class Branch < Base
+      include Tinybucket::Model::Concerns::RepositoryKeys
+
+      acceptable_attributes :links, :type, :name, :repository, :target
+
+      # Returns the commits available for the specific branch
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Resource::Commits]
+      def commits(options = {})
+        commits_resource.branch(name, options)
+      end
+
+      private
+
+      def commits_resource(options = {})
+        Tinybucket::Resource::Commits.new(self, options)
+      end
+
+      def branches_api
+        create_api('Branches', repo_keys)
+      end
+
+      def load_model
+        branches_api.find(name, {})
+      end
+    end
+  end
+end