tinybucket 0.1.7 → 1.0.0

data/lib/tinybucket/api_factory.rb

@@ -1,9 +1,7 @@
 module Tinybucket
   class ApiFactory
     class << self
-      def create_instance(klass_name, config, options)
-        options.symbolize_keys!
-
+      def create_instance(klass_name)
         klass =
           begin
             name = "#{klass_name}Api".intern
@@ -14,7 +12,7 @@ module Tinybucket
             raise ArgumentError, 'must provide klass to be instantiated'
           end
 
-        klass.new config, options
+        klass.new
       end
     end
   end

data/lib/tinybucket/client.rb

@@ -1,14 +1,6 @@
 module Tinybucket
   class Client
-    include ActiveSupport::Configurable
-
-    def initialize(options = {})
-      options.each_pair do |key, value|
-        config.send("#{key}=", value)
-      end
-
-      yield(config) if block_given?
-    end
+    include ::Tinybucket::Model::Concerns::Enumerable
 
     # Get Repositories
     #
@@ -25,7 +17,8 @@ module Tinybucket
     # @overload repos(options)
     #   get public repositories.
     #   @option options [Hash] a hash with options
-    # @return Tinybucket::Model::Page model instance.
+    # @return [Tinybucket::Enumerator] enumerator to enumerate repositories
+    #   as [Tinybucket::Model::Repository]
     def repos(*args)
       case args.size
       when 0
@@ -46,25 +39,36 @@ module Tinybucket
       end
     end
 
+    # 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})
+    # @return [Tinybucket::Model::Repository]
     def repo(owner, repo_slug)
       m = Tinybucket::Model::Repository.new({})
       m.repo_owner = owner
       m.repo_slug = repo_slug
-      m.api_config = config.dup
       m
     end
 
+    # Get the team
+    #
+    # @param teamname [String] the team name.
+    # @return [Tinybucket::Model::Team]
     def team(teamname)
       m = Tinybucket::Model::Team.new({})
       m.username = teamname
-      m.api_config = config.dup
       m
     end
 
+    # Get the user profile
+    #
+    # @param username [String] the user name.
+    # @return [Tinybucket::Model::Profile]
     def user(username)
       m = Tinybucket::Model::Profile.new({})
       m.username = username
-      m.api_config = config.dup
       m
     end
 
@@ -74,8 +78,11 @@ module Tinybucket
       options = args.empty? ? {} : args.first
       raise ArgumentError unless options.is_a?(Hash)
 
-      @repos ||= create_instance('Repos', options)
-      @repos.list(options)
+      enumerator(
+        repos_api,
+        :list,
+        options
+      )
     end
 
     def owners_repos(*args)
@@ -83,13 +90,25 @@ module Tinybucket
       options = (args.size == 2) ? args[1] : {}
       raise ArgumentError unless options.is_a?(Hash)
 
-      @user ||= create_instance('User', options)
-      @user.username = owner
-      @user.repos(options)
+      enumerator(
+        user_api(owner),
+        :repos,
+        options
+      )
+    end
+
+    def repos_api
+      create_instance('Repos')
+    end
+
+    def user_api(owner)
+      api = create_instance('User')
+      api.username = owner
+      api
     end
 
-    def create_instance(name, options)
-      ApiFactory.create_instance(name, config, options)
+    def create_instance(name)
+      ApiFactory.create_instance(name)
     end
   end
 end

data/lib/tinybucket/config.rb

@@ -1,6 +1,6 @@
 module Tinybucket
   class Config
     include ActiveSupport::Configurable
-    config_accessor :logger
+    config_accessor :logger, :oauth_token, :oauth_secret
   end
 end

data/lib/tinybucket/connection.rb

@@ -32,8 +32,8 @@ module Tinybucket
     def default_middleware(_options)
       proc do |conn|
         oauth_secrets = {
-          consumer_key: config(:oauth_token),
-          consumer_secret: config(:oauth_secret)
+          consumer_key:    Tinybucket.config.oauth_token,
+          consumer_secret: Tinybucket.config.oauth_secret
         }
 
         conn.request :multipart
@@ -42,7 +42,7 @@ module Tinybucket
 
         conn.response :follow_oauth_redirects, oauth_secrets
         conn.response :json, content_type: /\bjson$/
-        conn.use Tinybucket::Response::ErrorHandler
+        conn.use Tinybucket::Response::Handler
         conn.use :instrumentation
 
         conn.adapter Faraday.default_adapter

data/lib/tinybucket/enumerator.rb

@@ -0,0 +1,44 @@
+module Tinybucket
+  class Enumerator < ::Enumerator
+    # Constructor
+    #
+    # This method create a enumerator to enumerate each items of iterator.
+    #
+    # @note This method return Lazy Enumerator if run on ruby 2.0.0 later.
+    #
+    # @param iterator [Tinybucket::Iterator] iterator instance.
+    # @param block [Proc] a proc object to handle each item.
+    def initialize(iterator, block)
+      @iterator = iterator
+
+      super() do |y|
+        loop do
+          m = y.yield(@iterator.next)
+          m = block.call(m) if block
+          m
+        end
+      end
+
+      lazy if lazy_enumerable?
+    end
+
+    # Get collection size.
+    #
+    # @see Tinybucket::Iterator#size
+    #
+    # @return [Fixnum, NillClass] collection size.
+    def size
+      @iterator.size
+    end
+
+    private
+
+    def lazy_enumerable?
+      ruby_major_version >= 2
+    end
+
+    def ruby_major_version
+      RUBY_VERSION.split('.')[0].to_i
+    end
+  end
+end

data/lib/tinybucket/error.rb

@@ -4,5 +4,7 @@ module Tinybucket
 
     autoload :BaseError
     autoload :ServiceError
+    autoload :Conflict
+    autoload :NotFound
   end
 end

data/lib/tinybucket/error/conflict.rb

@@ -0,0 +1,6 @@
+module Tinybucket
+  module Error
+    class Conflict < ServiceError
+    end
+  end
+end

data/lib/tinybucket/error/not_found.rb

@@ -0,0 +1,6 @@
+module Tinybucket
+  module Error
+    class NotFound < ServiceError
+    end
+  end
+end

data/lib/tinybucket/error/service_error.rb

@@ -2,18 +2,22 @@ module Tinybucket
   module Error
     class ServiceError < BaseError
       attr_accessor :http_headers
+      attr_reader :http_method, :request_url, :status_code, :response_body
 
       def initialize(env)
         super generate_message(env)
         @http_headers = env[:response_headers]
       end
 
+      private
+
       def generate_message(env)
-        http_method = env[:method].to_s.upcase
-        url = env[:url].to_s
-        status = env[:status]
+        @http_method = env[:method].to_s.upcase
+        @request_url = env[:url].to_s
+        @status_code = env[:status]
+        @response_body = env[:body]
 
-        "#{http_method} #{url} #{status} #{env[:body]}"
+        "#{@http_method} #{@request_url} #{@status_code} #{@response_body}"
       end
     end
   end

data/lib/tinybucket/iterator.rb

@@ -0,0 +1,77 @@
+module Tinybucket
+  # Iterator
+  #
+  # This iterator iterate items by sending request ot Bitbucket Cloud REST API.
+  class Iterator
+    # Constructor
+    #
+    # @param api_client [Tinybucket::Api::Base] an instance of Api Client class.
+    # @param method [Symbol] method name to invoke api_client method.
+    # @param args [Array<Object>] arguments to pass method call of
+    #   api_client as arguments.
+    def initialize(api_client, method, *args)
+      @client = api_client
+      @method = method
+      @args = args
+
+      @attrs = {}
+      @values = []
+      @pos = nil
+    end
+
+    def next
+      next_value
+    end
+
+    # Get collection size.
+    #
+    # @note This method return {https://confluence.atlassian.com/bitbucket/version-2-423626329.html#Version2-Pagingthroughobjectcollections
+    #   size attribute of object collection wrapper}.
+    #   So this method may return nil.
+    #
+    # @see https://confluence.atlassian.com/bitbucket/version-2-423626329.html#Version2-Pagingthroughobjectcollections
+    #   Paging through object collections
+    #
+    # @return [Fixnum, NillClas] collection size.
+    def size
+      load_next if next?
+      @attrs[:size]
+    end
+
+    private
+
+    def next_value
+      load_next if next?
+
+      @values.fetch(@pos).tap { @pos += 1 }
+    rescue IndexError
+      raise StopIteration
+    end
+
+    def next?
+      @pos.nil? || (@values.size == @pos && @attrs[:next])
+    end
+
+    def load_next
+      @pos = 0 if @pos.nil?
+
+      page = @client.send(@method, *next_params)
+
+      @attrs = page.attrs
+      @values.concat(page.items)
+    end
+
+    def next_params
+      params =
+        if @attrs.empty?
+          {}
+        else
+          unescaped_query = URI.unescape(URI.parse(@attrs[:next]).query)
+          Hash[*unescaped_query.split(/&|=/)]
+        end
+
+      @args[-1].merge!(params)
+      @args
+    end
+  end
+end

data/lib/tinybucket/model/base.rb

@@ -3,7 +3,8 @@ module Tinybucket
     class Base
       include ::ActiveModel::Serializers::JSON
       include Concerns::AcceptableAttributes
-      attr_accessor :api_config
+      include Concerns::Enumerable
+      include Concerns::Reloadable
 
       def self.concern_included?(concern_name)
         mod_name = "Tinybucket::Model::Concerns::#{concern_name}".constantize
@@ -12,7 +13,6 @@ module Tinybucket
 
       def initialize(json)
         self.attributes = json
-        @api_config = {}
         @_loaded = !json.empty?
       end
 
@@ -36,12 +36,12 @@ module Tinybucket
 
       protected
 
-      def create_api(api_key, keys, options)
+      def create_api(api_key, keys)
         key = ('@' + api_key.underscore).intern
         api = instance_variable_get(key)
         return api if api.present?
 
-        api = create_instance(api_key, options)
+        api = create_instance(api_key)
         api.repo_owner = keys[:repo_owner]
         api.repo_slug  = keys[:repo_slug]
         instance_variable_set(key, api)
@@ -49,8 +49,8 @@ module Tinybucket
         api
       end
 
-      def create_instance(klass_name, options)
-        ApiFactory.create_instance(klass_name, api_config, options)
+      def create_instance(klass_name)
+        ApiFactory.create_instance(klass_name)
       end
 
       def logger

data/lib/tinybucket/model/branch_restriction.rb

@@ -1,14 +1,41 @@
 module Tinybucket
   module Model
+    # BranchRestriction
+    #
+    # @see https://confluence.atlassian.com/bitbucket/branch-restrictions-resource-387449181.html
+    #   branch-restrictions Resource - Bitbucket Cloud REST API document
+    #
+    # @!attribute [rw] groups
+    #   @return [Array]
+    # @!attribute [rw] id
+    #   @return [Fixnum]
+    # @!attribute [rw] kind
+    #   @return [String]
+    # @!attribute [rw] links
+    #   @return [Hash]
+    # @!attribute [rw] pattern
+    #   @return [String]
+    # @!attribute [rw] users
+    #   @return [Array]
+    # @!attribute [rw] uuid
+    #   @return [NillClass]
     class BranchRestriction < Base
       include Tinybucket::Model::Concerns::RepositoryKeys
 
       acceptable_attributes :groups, :id, :kind, :links, :pattern, :users, :uuid
 
+      # Update this branch restriction
+      #
+      # @todo to be implemented
+      # @raise [NotImplementedError] to be implemented.
       def update(_params)
         raise NotImplementedError
       end
 
+      # Delete this branch restriction
+      #
+      # @todo to be implemented
+      # @raise [NotImplementedError] to be implemented.
       def destroy
         raise NotImplementedError
       end

data/lib/tinybucket/model/comment.rb

@@ -1,32 +1,58 @@
 module Tinybucket
   module Model
+    # Comment
+    #
+    # @see https://confluence.atlassian.com/bitbucket/pullrequests-resource-423626332.html#pullrequestsResource-GETalistofapullrequestcomments
+    #   Comment resource - Bitbucket Cloud REST API document
+    #
+    # @!attribute [rw] links
+    #   @return [Hash]
+    # @!attribute [rw] id
+    #   @return [Fixnum]
+    # @!attribute [rw] parent
+    #   @return [Hash]
+    # @!attribute [rw] filename
+    #   @return [String]
+    # @!attribute [rw] content
+    #   @return [Hash]
+    # @!attribute [rw] user
+    #   @return [Hash]
+    # @!attribute [rw] inline
+    #   @return [Hash]
+    # @!attribute [rw] created_on
+    #   @return [String]
+    # @!attribute [rw] updated_on
+    #   @return [String]
+    # @!attribute [rw] uuid
+    #   @return [NillClass]
     class Comment < Base
       include Tinybucket::Model::Concerns::RepositoryKeys
-      include Tinybucket::Model::Concerns::Reloadable
 
       acceptable_attributes \
         :links, :id, :parent, :filename, :content, :user, :inline, \
         :created_on, :updated_on, :uuid
 
+      # @!attribute [rw] commented_to
+      #   @return [Tinybucket::Model::PullRequest, Tinybucket::Model::Commit]
       attr_accessor :commented_to
 
       private
 
       def commit_api
-        create_api('Comments', repo_keys, options)
+        create_api('Comments', repo_keys)
       end
 
-      def pull_request_api(options)
-        create_api('PullRequests', repo_keys, options)
+      def pull_request_api
+        create_api('PullRequests', repo_keys)
       end
 
       def load_model
         api =
           case commented_to
           when Tinybucket::Model::Commit
-            commit_api({})
+            commit_api
           when Tinybucket::Model::PullRequest
-            pull_request_api({})
+            pull_request_api
           else
             raise ArgumentError, 'commented_to was invalid'
           end