tinybucket 0.1.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71d4192b2e8e49b41049f5b1f55fb6e76eb88aeb
-  data.tar.gz: 6f7140b93b530ffb03bce656742dfbbbb097cffc
+  metadata.gz: d07ebbc76492e41177f7ff796acae6d1c57f6444
+  data.tar.gz: 84b11267ed48262a4a47295f495cbfa55430c421
 SHA512:
-  metadata.gz: 15cefdad2130c594419751a8debd493e5362a1d6d4cb0d46b16dd7aea8f4bd86cdd0208052ab8747ea614f5ed428fc1e01eac29ca39700ccce9fac7ae4ccf6b4
-  data.tar.gz: 2439679903d2ae7ea9e7eabf51e02e3a1da7ff37b03de89f36dbc6000182102a57c37692b5e09376fed768217ab6378f2f6f6ee3efb74d5c186ead247fb83480
+  metadata.gz: 2d54aa23f2e5b42c4a16e7bd43319f66775cd222652116a53ec3ac9761dc86fcb30de11297bed60bb6ab26a27c8ded1e371f56f45f670e0f75b935bc94536c7b
+  data.tar.gz: 9646a04e42350d5f6878a0343e52afd22d929c29602ed3e192eae45874193bd2cab12bba3b58f91b573a1ecf57eb19c5db402990874dbaeef23f2ce5874fbea8

data/.gitignore

@@ -11,6 +11,9 @@ app.rb
 log/
 *.swp
 
+features
+.envrc
+
 ## from github ignore.
 
 /.config

data/.rubocop.yml

@@ -4,9 +4,10 @@ AllCops:
   Exclude:
     - 'app.rb'
     - 'spec/**/*'
+    - 'features/**/*'
     - 'test/**/*'
 
-Style/ClassLength:
+Metrics/ClassLength:
   Max: 150
 
 MethodLength:

data/Gemfile

@@ -6,11 +6,11 @@ gemspec
 gem 'rake', '~> 10.4'
 gem 'rspec', '~> 3.4'
 gem 'rspec-mocks', '~> 3.4'
-gem 'webmock', '~> 1.22'
-gem 'rubocop', '~> 0.35'
+gem 'webmock', '~> 1.24'
+gem 'rubocop', '~> 0.38'
 
-gem 'yard', '~> 0.8'
-gem 'yardstick', '~> 0.9.9'
+gem 'yard', '~> 0.8.7'
+gem 'yardstick', '~> 0.9'
 
 group :development, :test do
   gem 'pry'

data/README.md

@@ -11,8 +11,9 @@ This gem is inspired by [vongrippen/bitbucket](https://github.com/vongrippen/bit
 [![Build Status](https://travis-ci.org/hirakiuc/tinybucket.svg?branch=master)](https://travis-ci.org/hirakiuc/tinybucket)
 [![Code Climate](https://codeclimate.com/github/hirakiuc/tinybucket/badges/gpa.svg)](https://codeclimate.com/github/hirakiuc/tinybucket)
 [![Coverage Status](https://coveralls.io/repos/hirakiuc/tinybucket/badge.png?branch=master)](https://coveralls.io/r/hirakiuc/tinybucket?branch=master)
+[![Inline docs](http://inch-ci.org/github/hirakiuc/tinybucket.svg?branch=master)](http://inch-ci.org/github/hirakiuc/tinybucket)
 
-[![tinybucket API Documentation](https://www.omniref.com/ruby/gems/tinybucket.png)](https://www.omniref.com/ruby/gems/tinybucket)
+[yard doc](http://www.rubydoc.info/github/hirakiuc/tinybucket/master) (master branch)
 
 ## Installation
 
@@ -42,31 +43,58 @@ This gem use built-in null_logger in default.
 
 If you want to set your logger, configure like this.
 
-```
+```ruby
 logger = Logger.new($stdout)
 logger.level = Logger::WARN
 
 Tinybucket.configure do |config|
   config.logger = logger
+
+  # configure oauth_token/oauth_secret
+  config.oauth_token = 'key'
+  config.oauth_secret = 'secret'
 end
 ```
 
-### init
+### Pagination
 
-```
-bucket = Tinybucket.new(oauth_token: 'key', oauth_secret: 'secret')
-```
+After v1.0.0, tinybucket gem support [lazy enumerator](http://ruby-doc.org/core-2.2.0/Enumerator/Lazy.html) !
+
+This feature make your code more rubyish, like this.
 
+```ruby
+# get enumerator to enumerate repositories.
+repos = bucket.repos('myname')
+
+# Select repositories which has 2 pull requests to be reviewed.
+repos = repos('my_name').select do |repo|
+  repo.pull_requests.size > 2
+end.map(&:full_name)
 ```
-bucket = Tinybucket.new do |config|
-  config.oauth_token  = 'key'
-  config.oauth_secret = 'secret'
-end
+
+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.
+
+#### 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.
+
+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.
+
+So enumerator's `size` attribute may return `nil`.
+
+### init
+
+```ruby
+bucket = Tinybucket.new
 ```
 
+### Endpoints
+
 #### teams Endpoint
 
-```
+```ruby
 # [x] GET the team profile
 team = bucket.team('team name')
 
@@ -85,7 +113,7 @@ repos = team.repos
 
 #### users Endpoint
 
-```
+```ruby
 # [x] GET the user profile
 user = bucket.user('user name')
 
@@ -101,7 +129,7 @@ repos = user.repos
 
 #### repositories Endpoint
 
-```
+```ruby
 # [x] GET a list of all public repositories
 repos = bucket.repos
 
@@ -111,7 +139,7 @@ repos  = bucket.repos('someone')
 
 ##### repository Resource
 
-```
+```ruby
 # [x] GET a repository
 repo = bucket.repo('someone', 'great_repo')
 
@@ -134,7 +162,7 @@ repos = repo.forks
 
 ##### pullrequests Resource
 
-```
+```ruby
 repo = bucket.repo('someone', 'great_repo')
 
 # [x] GET a list of open pull requests
@@ -182,7 +210,7 @@ comment = pull_request.comment(comment_id)
 
 ##### commits or commit Resource
 
-```
+```ruby
 repo = bucket.repo('someone', 'great_repo')
 
 # [x] GET a commits list for a repository or compare commits across branches
@@ -198,16 +226,16 @@ comments = commit.comments
 # [x] GET an individual commit comment
 comment = commit.comment(comment_id)
 
-# [ ] POST a commit approval
+# [x] POST a commit approval
   commit.approve
 
-# [ ] DELETE a commit approval
+# [x] DELETE a commit approval
   commit.unapprove
 ```
 
 ##### branch-restrictions Resource
 
-```
+```ruby
 repo = bucket.repo('someone', 'great_repo').find
 
 # [x] GET the branch-restrictions
@@ -228,7 +256,7 @@ restriction = repo.branch_restriction(restriction_id)
 
 ##### diff Resource
 
-```
+```ruby
 repo = bucket.repo('someone', 'great_repo').find
 COMMIT_ID = '7e968c5'
 

data/Rakefile

@@ -14,6 +14,13 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 task :test => :spec
 
+if Dir.exist?('./features')
+  RSpec::Core::RakeTask.new(:features) do |t|
+    t.pattern = './features/**/*_spec.rb'
+    t.rspec_opts = '-I ./features'
+  end
+end
+
 begin
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new

data/lib/tinybucket.rb

@@ -14,13 +14,16 @@ require 'faraday_middleware/follow_oauth_redirects'
 require 'active_model'
 
 require 'logger'
+require 'uri'
+
+require 'tinybucket/enumerator'
+require 'tinybucket/iterator'
 
 require 'tinybucket/config'
 require 'tinybucket/null_logger'
 require 'tinybucket/api'
 require 'tinybucket/api_factory'
 require 'tinybucket/api/helper'
-require 'tinybucket/client'
 require 'tinybucket/connection'
 require 'tinybucket/constants'
 require 'tinybucket/error'
@@ -30,7 +33,7 @@ require 'tinybucket/parser'
 require 'tinybucket/request'
 require 'tinybucket/response'
 
-require 'uri'
+require 'tinybucket/client'
 
 require 'active_support/notifications'
 ActiveSupport::Notifications.subscribe('request.faraday') \
@@ -50,8 +53,8 @@ module Tinybucket
     include ActiveSupport::Configurable
     attr_accessor :logger, :api_client
 
-    def new(options = {}, &block)
-      @api_client = Tinybucket::Client.new(options, &block)
+    def new
+      @api_client = Tinybucket::Client.new
     end
 
     def configure

data/lib/tinybucket/api/base_api.rb

@@ -4,27 +4,10 @@ module Tinybucket
       include Tinybucket::Connection
       include Tinybucket::Request
 
-      def initialize(config, options = {})
-        @config = filter_config(config)
-        @options = options
-        yield if block_given?
-      end
-
-      protected
-
-      def option(key)
-        @options[key.intern]
-      end
-
-      def config(key)
-        @config[key.intern]
-      end
-
       private
 
-      def filter_config(config)
-        keys = %i(oauth_token oauth_secret)
-        config.select { |key, _| keys.include?(key) }
+      def logger
+        Tinybucket.logger
       end
     end
   end

data/lib/tinybucket/api/branch_restrictions_api.rb

@@ -1,25 +1,49 @@
 module Tinybucket
   module Api
+    # BranchRestrictions API client
+    #
+    # @see https://confluence.atlassian.com/bitbucket/branch-restrictions-resource-387449181.html
+    #   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})
     class BranchRestrictionsApi < BaseApi
       include Tinybucket::Api::Helper::BranchRestrictionsHelper
 
       attr_accessor :repo_owner, :repo_slug
 
+      # Send 'GET the branch-restrictions' request.
+      #
+      # @see https://confluence.atlassian.com/bitbucket/branch-restrictions-resource-387449181.html#branch-restrictionsResource-GETthebranch-restrictions
+      #   GET the branch-restrictions
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def list(options = {})
-        list = get_path(path_to_list,
-                        options,
-                        Tinybucket::Parser::BranchRestrictionsParser)
-
-        list.next_proc = next_proc(:list, options)
-        inject_api_config(list)
+        get_path(
+          path_to_list,
+          options,
+          Tinybucket::Parser::BranchRestrictionsParser
+        )
       end
 
+      # Send 'GET a specific restriction' request.
+      #
+      # @see https://confluence.atlassian.com/bitbucket/branch-restrictions-resource-387449181.html#branch-restrictionsResource-GETaspecificrestriction
+      #   GET a specific restriction
+      #
+      # @param restriction_id [String] The restriction's identifier
+      # @param options [Hash]
+      # @return [Tinybucket::Model::BranchRestriction]
       def find(restriction_id, options = {})
-        m = get_path(path_to_find(restriction_id),
-                     options,
-                     Tinybucket::Parser::BranchRestrictionParser)
-
-        inject_api_config(m)
+        get_path(
+          path_to_find(restriction_id),
+          options,
+          Tinybucket::Parser::BranchRestrictionParser
+        )
       end
     end
   end

data/lib/tinybucket/api/comments_api.rb

@@ -1,5 +1,14 @@
 module Tinybucket
   module Api
+    # Comments Api client
+    #
+    # @!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})
+    # @!attribute [rw] commented_to
+    #   @return [Tinybucket::Model::Commit, Tinybucket::Model::PullRequest]
     class CommentsApi < BaseApi
       include Tinybucket::Api::Helper::CommentsHelper
 
@@ -7,24 +16,49 @@ module Tinybucket
 
       attr_accessor :commented_to
 
+      # Send 'GET a list of comments' request.
+      #
+      # 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
+      #   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
+      #   GET a list of pull request comments}.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
       def list(options = {})
         list = get_path(path_to_list,
                         options,
                         Tinybucket::Parser::CommentsParser)
 
-        list.next_proc = next_proc(:list, options)
-
         associate_with_target(list)
-        inject_api_config(list)
+        list
       end
 
+      # Send 'GET a individual comment' request.
+      #
+      # 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
+      #   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
+      #   GET an individual pull request comment}.
+      #
+      # @param comment_id [String] comment identifier
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Comment]
       def find(comment_id, options = {})
         comment = get_path(path_to_find(comment_id),
                            options,
                            Tinybucket::Parser::CommentParser)
 
         associate_with_target(comment)
-        inject_api_config(comment)
+        comment
       end
 
       private

data/lib/tinybucket/api/commits_api.rb

@@ -1,25 +1,75 @@
 module Tinybucket
   module Api
+    # Commits Api client
+    #
+    # @!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 CommitsApi < BaseApi
       include Tinybucket::Api::Helper::CommitsHelper
 
       attr_accessor :repo_owner, :repo_slug
 
+      # Send 'GET a commits list for a repository' request
+      #
+      # @see https://confluence.atlassian.com/bitbucket/commits-or-commit-resource-389775478.html#commitsorcommitResource-GETacommitslistforarepositoryorcomparecommitsacrossbranches
+      #   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 = {})
-        list = get_path(path_to_list,
-                        options,
-                        Tinybucket::Parser::CommitsParser)
-
-        list.next_proc = next_proc(:list, options)
-        inject_api_config(list)
+        get_path(
+          path_to_list,
+          options,
+          Tinybucket::Parser::CommitsParser
+        )
       end
 
+      # Send 'GET an individual commit' request
+      #
+      # @see https://confluence.atlassian.com/bitbucket/commits-or-commit-resource-389775478.html#commitsorcommitResource-GETanindividualcommit
+      #   GET an individual commit
+      #
+      # @param revision [String] A SHA1 value for the commit.
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Commit]
       def find(revision, options = {})
-        m = get_path(path_to_find(revision),
-                     options,
-                     Tinybucket::Parser::CommitParser)
+        get_path(
+          path_to_find(revision),
+          options,
+          Tinybucket::Parser::CommitParser
+        )
+      end
+
+      # Send '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
 
-        inject_api_config(m)
+      # Send 'DELETE a commit approval' request
+      #
+      # @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
     end
   end