tinybucket 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef69fc38261a66035f6b72b1e767ec749151ef63
-  data.tar.gz: d286e78ed4b5d57e1ab9281e7387b5e3e53b5c8d
+  metadata.gz: ed12324002ab5952c612faf543af7d705047ed6c
+  data.tar.gz: db4392d5bbb95d6e40169ca48742baaa9051d8cd
 SHA512:
-  metadata.gz: 56e151d12522b22a2661d46a88d6f63cfaae6d233774e74ecaa79ceb0d5495d1a249b58184d1c678f054791c0e26414199eb946731cbc85b70240214f762f25f
-  data.tar.gz: 565f64d75e6100c5bb87297368dad0fc07da3ad3716885965ed56f118d0c98d5a897a25b1a547441ff8c257c34fb0a403d344ae88e260f1e82cfdf774796cba5
+  metadata.gz: 6ecc10dd11258c440125c0c302540ce6aec02024a00e19d0d82216afc65c5a73048d0bc7c7474f339e7c0b0b4d512785a59aac3998ceef55d3cc1507c7b0dff0
+  data.tar.gz: 72b1d6d150ce83c0b804264159fa37de12d7ab76992ceae6be809f2a80147ba700a62cffd151e51e2098bfee5f5f1a22dcab6b2ea064e84c1eeae980b3713bed

data/.rubocop.yml

@@ -2,7 +2,7 @@ AllCops:
   Include:
     - 'lib/**/*.rb'
   Exclude:
-    - 'app.rb'
+    - '*.rb'
     - 'spec/**/*'
     - 'features/**/*'
     - 'test/**/*'
@@ -44,5 +44,14 @@ Style/AlignHash:
 Style/RaiseArgs:
   Enabled: false
 
+Style/RedundantFreeze:
+  Enabled: false
+
 Metrics/AbcSize:
   Max: 18
+
+Metrics/LineLength:
+  Max: 100
+  IgnoredPatterns: [
+    '^\s*#'
+  ]

data/Gemfile

@@ -3,12 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in bitbucket.gemspec
 gemspec
 
-gem 'rake', '~> 10.4'
-gem 'rspec', '~> 3.4'
-gem 'rspec-mocks', '~> 3.4'
-gem 'webmock', '~> 1.24'
-gem 'rubocop', '~> 0.41'
-
+gem 'simple-auth', '~> 0.3.1'
 gem 'yard', '~> 0.8.7'
 gem 'yardstick', '~> 0.9'
 
@@ -23,10 +18,16 @@ group :development, :test do
 
   gem 'guard-rubocop'
   gem 'gem-release'
+
+  gem 'rake', '~> 10.4'
+  gem 'rspec', '~> 3.4'
+  gem 'rspec-mocks', '~> 3.4'
+  gem 'webmock', '~> 1.24'
+  gem 'rubocop', '~> 0.46.0'
 end
 
 group :test do
   gem 'simplecov', '~> 0.11', require: false
   gem 'coveralls', '~> 0.8', require: false
-  gem 'codeclimate-test-reporter', require: nil
+  gem 'codeclimate-test-reporter', '~> 1.0.0', require: nil
 end

data/README.md

@@ -27,7 +27,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install bitbucket
+    $ gem install tinybucket
 
 ## Usage
 
@@ -54,7 +54,11 @@ Tinybucket.configure do |config|
   # optional, default: nil (disable request cache)
   config.cache_store_options = { store: Rails.cache, logger: logger }
 
-  # Configure oauth_token/oauth_secret
+  # Configure access_token if you can prepare OAuth2 access_token.
+  config.access_token = 'your_access_token'
+
+  # Configure oauth_token/oauth_secret if you want to use OAuth1.0 authentication.
+  # (This config will be ignored if you configure OAuth2 access_token.)
   config.oauth_token = 'key'
   config.oauth_secret = 'secret'
 end
@@ -76,15 +80,15 @@ repos = repos('my_name').select do |repo|
 end.map(&:full_name)
 ```
 
-This enumerable feature depends on [Paging through object collections](https://confluence.atlassian.com/bitbucket/version-2-423626329.html#Version2-Pagingthroughobjectcollections) at Bitbucket Cloud REST API.
+This enumerable feature depends on [Paging through object collections](https://developer.atlassian.com/bitbucket/api/2/reference/meta/pagination) at Bitbucket Cloud REST API.
 
 #### NOTE: About `size` attribute
 
-[object collections wrapper](https://confluence.atlassian.com/bitbucket/version-2-423626329.html#Version2-Pagingthroughobjectcollections) has `size` attribute at Bitbucket Cloud REST API.
+[object collections wrapper](https://developer.atlassian.com/bitbucket/api/2/reference/meta/pagination) has `size` attribute at Bitbucket Cloud REST API.
 
 The `size` attribute describe as `optional` attribute.
 
-In tinybucket gem, collection size depend on `side` attribute of [object collections wrapper](https://confluence.atlassian.com/bitbucket/version-2-423626329.html#Version2-Pagingthroughobjectcollections) in Bitbucket Cloud REST API.
+In tinybucket gem, collection size depend on `side` attribute of [object collections wrapper](https://developer.atlassian.com/bitbucket/api/2/reference/meta/pagination) in Bitbucket Cloud REST API.
 
 So enumerator's `size` attribute may return `nil`.
 
@@ -261,6 +265,25 @@ commit.approve
 commit.unapprove
 ```
 
+##### branches Resource
+
+###### Collection Methods
+
+```ruby
+repo = bucket.repo('someone', 'great_repo')
+
+# [x ] GET a list of branches
+branches = repo.branches(options)
+```
+
+###### Object Methods
+```ruby
+repo = bucket.repo('someone', 'great_repo')
+
+# [x] GET a specific branch
+branch = repo.branch(branch_name)
+```
+
 ##### branch-restrictions Resource
 
 ###### Collection Methods

data/Rakefile

@@ -7,6 +7,7 @@ desc 'cleanup rcov, doc directories'
 task :clean do
   rm_rf 'coverage'
   rm_rf 'doc'
+  rm_rf 'measurement'
 end
 
 # https://github.com/sferik/twitter/blob/master/Rakefile

data/lib/faraday_middleware/follow_oauth_redirects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 
@@ -13,8 +15,9 @@ module FaradayMiddleware
       env = super(env, request_body, response)
 
       # update Authentication Header
-      env[:request_headers][OAuth::AUTH_HEADER] = \
-        oauth_header(env).to_s if oauth_signed_request?(env)
+      if oauth_signed_request?(env)
+        env[:request_headers][OAuth::AUTH_HEADER] = oauth_header(env).to_s
+      end
 
       env
     end

data/lib/tinybucket.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tinybucket/version'
 
 require 'active_support/dependencies/autoload'

data/lib/tinybucket/api.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     extend ActiveSupport::Autoload
 
     [
       :BaseApi,
+      :BranchesApi,
       :BranchRestrictionsApi,
       :BuildStatusApi,
       :CommitsApi,

data/lib/tinybucket/api/base_api.rb

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

data/lib/tinybucket/api/branch_restrictions_api.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # BranchRestrictions API client
     #
-    # @see https://confluence.atlassian.com/bitbucket/branch-restrictions-resource-387449181.html
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/branch-restrictions
     #   branch-restrictions 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 BranchRestrictionsApi < BaseApi
       include Tinybucket::Api::Helper::BranchRestrictionsHelper
 
@@ -17,7 +18,7 @@ module Tinybucket
 
       # Send 'GET the branch-restrictions' request.
       #
-      # @see https://confluence.atlassian.com/bitbucket/branch-restrictions-resource-387449181.html#branch-restrictionsResource-GETthebranch-restrictions
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/branch-restrictions#get
       #   GET the branch-restrictions
       #
       # @param options [Hash]
@@ -32,7 +33,7 @@ module Tinybucket
 
       # Send 'GET a specific restriction' request.
       #
-      # @see https://confluence.atlassian.com/bitbucket/branch-restrictions-resource-387449181.html#branch-restrictionsResource-GETaspecificrestriction
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/branch-restrictions/%7Bid%7D#get
       #   GET a specific restriction
       #
       # @param restriction_id [String] The restriction's identifier

data/lib/tinybucket/api/branches_api.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    # Branches 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 repo_slug}.
+    class BranchesApi < BaseApi
+      include Tinybucket::Api::Helper::BranchesHelper
+
+      attr_accessor :repo_owner, :repo_slug
+
+      # Send 'GET a branches list for a repository' request
+      #
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches#get
+      #   GET a branches list for a repository
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
+      def list(options = {})
+        get_path(
+          path_to_list,
+          options,
+          Tinybucket::Parser::BranchesParser
+        )
+      end
+
+      # Send 'GET an individual branch' request
+      #
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches/%7Bname%7D#get
+      #   GET an individual branch
+      #
+      # @param name [String] The branch name
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Branch]
+      def find(name, options = {})
+        get_path(
+          path_to_find(name),
+          options,
+          Tinybucket::Parser::BranchParser
+        )
+      end
+    end
+  end
+end

data/lib/tinybucket/api/build_status_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # BuildStatus Api client
@@ -7,7 +9,19 @@ module Tinybucket
     class BuildStatusApi < BaseApi
       include Tinybucket::Api::Helper::BuildStatusHelper
 
-      attr_accessor :repo_owner, :repo_slug
+      attr_accessor :revision, :repo_owner, :repo_slug
+
+      # Send 'GET a builds list for a commit' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
+      def list(options = {})
+        get_path(
+          path_to_list,
+          options,
+          Tinybucket::Parser::BuildsParser
+        )
+      end
 
       # Send 'GET the build status for a commit' request
       #

data/lib/tinybucket/api/comments_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # Comments Api client
@@ -5,8 +7,7 @@ module Tinybucket
     # @!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}.
     # @!attribute [rw] commented_to
     #   @return [Tinybucket::Model::Commit, Tinybucket::Model::PullRequest]
     class CommentsApi < BaseApi
@@ -21,10 +22,10 @@ module Tinybucket
       # This method send different request depend on 'commented_to' attribute.
       #
       # @note When 'commented_to' is {Tinybucket::Model::Commit} instance,
-      #   this method send {https://confluence.atlassian.com/bitbucket/commits-or-commit-resource-389775478.html#commitsorcommitResource-GETalistofcommitcomments
+      #   this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments#get
       #   GET a list of commit comments}.
       # @note When 'commented_to' is {Tinybucket::Model::PullRequest} instance,
-      #   this method send {https://confluence.atlassian.com/bitbucket/pullrequests-resource-423626332.html#pullrequestsResource-GETalistofapullrequestcomments
+      #   this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments#get
       #   GET a list of pull request comments}.
       #
       # @param options [Hash]
@@ -43,10 +44,10 @@ module Tinybucket
       # This method send different request depend on 'commented_to' attribute.
       #
       # @note When 'commented_to' is {Tinybucket::Model::Commit} instance,
-      #   this method send {https://confluence.atlassian.com/bitbucket/commits-or-commit-resource-389775478.html#commitsorcommitResource-GETanindividualcommitcomment
+      #   this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments/%7Bcomment_id%7D#get
       #   GET an individual commit comment}.
       # @note When 'commented_to' is {Tinybucket::Model::PullRequest} instance,
-      #   this method send {https://confluence.atlassian.com/bitbucket/pullrequests-resource-423626332.html#pullrequestsResource-GETanindividualpullrequestcomment
+      #   this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments/%7Bcomment_id%7D#get
       #   GET an individual pull request comment}.
       #
       # @param comment_id [String] comment identifier

data/lib/tinybucket/api/commits_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # Commits Api client
@@ -5,8 +7,7 @@ module Tinybucket
     # @!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 CommitsApi < BaseApi
       include Tinybucket::Api::Helper::CommitsHelper
 
@@ -14,7 +15,7 @@ module Tinybucket
 
       # Send 'GET a commits list for a repository' request
       #
-      # @see https://confluence.atlassian.com/bitbucket/commits-or-commit-resource-389775478.html#commitsorcommitResource-GETacommitslistforarepositoryorcomparecommitsacrossbranches
+      # @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'
@@ -32,7 +33,7 @@ module Tinybucket
 
       # Send 'GET an individual commit' request
       #
-      # @see https://confluence.atlassian.com/bitbucket/commits-or-commit-resource-389775478.html#commitsorcommitResource-GETanindividualcommit
+      # @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.
@@ -47,6 +48,8 @@ module Tinybucket
       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]
@@ -60,6 +63,8 @@ module Tinybucket
       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]
@@ -71,6 +76,22 @@ module Tinybucket
         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,
+          Tinybucket::Parser::CommitsParser
+        )
+      end
     end
   end
 end

data/lib/tinybucket/api/diff_api.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     # Diff Api client
     #
-    # @see https://confluence.atlassian.com/bitbucket/diff-resource-425462484.html
+    # @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] 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 DiffApi < BaseApi
       include Tinybucket::Api::Helper::DiffHelper
 

data/lib/tinybucket/api/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Tinybucket
   module Api
     module Helper
@@ -5,6 +7,7 @@ module Tinybucket
 
       [
         :ApiHelper,
+        :BranchesHelper,
         :BranchRestrictionsHelper,
         :BuildStatusHelper,
         :CommitsHelper,