tinybucket 0.1.7 → 1.0.0

data/lib/tinybucket/model/repository.rb

@@ -1,96 +1,237 @@
 module Tinybucket
   module Model
+    # Repository
+    #
+    # @see https://confluence.atlassian.com/bitbucket/repositories-endpoint-423626330.html#repositoriesEndpoint-Overview
+    #   Repository Endpoint - Bitbucket Cloud REST API document
+    #
+    # @!attribute [rw] scm
+    #   @return [String]
+    # @!attribute [rw] has_wiki
+    #   @return [true, false]
+    # @!attribute [rw] description
+    #   @return [String]
+    # @!attribute [rw] links
+    #   @return [Hash]
+    # @!attribute [rw] updated_on
+    #   @return [String]
+    # @!attribute [rw] fork_policy
+    #   @return [String]
+    # @!attribute [rw] created_on
+    #   @return [String]
+    # @!attribute [rw] owner
+    #   @return [Hash]
+    # @!attribute [rw] size
+    #   @return [Fixnum]
+    # @!attribute [rw] parent
+    #   @return [Hash, NillClass]
+    # @!attribute [rw] uuid
+    #   @return [String]
+    # @!attribute [rw] has_issues
+    #   @return [true, false]
+    # @!attribute [rw] is_private
+    #   @return [true, false]
+    # @!attribute [rw] full_name
+    #   @return [String]
+    # @!attribute [rw] name
+    #   @return [String]
+    # @!attribute [rw] language
+    #   @return [String]
+    # @!attribute [rw] website
+    #   @return [String]
+    # @!attribute [rw] type
+    #   @return [String]
     class Repository < Base
       include Tinybucket::Model::Concerns::RepositoryKeys
-      include Tinybucket::Model::Concerns::Reloadable
 
       acceptable_attributes \
         :scm, :has_wiki, :description, :links, :updated_on,
         :fork_policy, :created_on, :owner, :size, :parent, :uuid,
-        :has_issues, :is_private, :full_name, :name, :language
+        :has_issues, :is_private, :full_name, :name, :language,
+        :website, :type
 
+      def initialize(json)
+        super(json)
+
+        if full_name && full_name.split('/').size == 2
+          @repo_owner, @repo_slug = full_name.split('/')
+        end
+      end
+
+      # Create a new repository.
+      #
+      # @todo to be implemented.
+      # @raise [NotImplementedError] to be implemented.
       def create(_params)
         raise NotImplementedError
       end
 
+      # Remove this repository
+      #
+      # @todo to be implemented.
+      # @raise [NotImplementedError] to be implemented.
       def destroy
         raise NotImplementedError
       end
 
+      # Get pull requests on thie repository.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Enumerator] an enumerator to enumerate
+      #   pull requests as {Tinybucket::Model::PullRequest} instance.
       def pull_requests(options = {})
-        list = pull_requests_api(options).list(options)
-        inject_repo_keys(list)
-      end
-
+        enumerator(
+          pull_requests_api,
+          :list,
+          options
+        ) do |m|
+          inject_repo_keys(m)
+          block_given? ? yield(m) : m
+        end
+      end
+
+      # Get the specific pull request on this repository.
+      #
+      # @param pullrequest_id [String]
+      # @param options [Hash]
+      # @return [Tinybucket::Model::PullRequest]
       def pull_request(pullrequest_id = nil, options = {})
         m = if pullrequest_id.present?
-              pull_requests_api(options).find(pullrequest_id, options)
+              pull_requests_api.find(pullrequest_id, options)
             else
               Tinybucket::Model::PullRequest.new({})
             end
         inject_repo_keys(m)
       end
 
+      # Get watchers on this repository.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Enumerator] an enumerator to enumerate watchers
+      #   as {Tinybucket::Model::Profile} instance.
       def watchers(options = {})
-        repo_api(options).watchers(options)
-      end
-
+        enumerator(
+          repo_api,
+          :watchers,
+          options
+        ) do |m|
+          inject_repo_keys(m)
+          block_given? ? yield(m) : m
+        end
+      end
+
+      # Get repository forks.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Enumerator] an enumerator to enumerate forks
+      #   as {Tinybucket::Model::Repository} instance.
       def forks(options = {})
-        repo_api(options).forks(options)
-      end
-
+        enumerator(
+          repo_api,
+          :forks,
+          options
+        ) do |m|
+          inject_repo_keys(m)
+          block_given? ? yield(m) : m
+        end
+      end
+
+      # Get commits on this repository.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Enumerator] an enumerator to enumerate commits
+      #   as {Tinybucket::Model::Commit} instance.
       def commits(options = {})
-        list = commits_api(options).list(options)
-        inject_repo_keys(list)
-      end
-
+        enumerator(
+          commits_api,
+          :list,
+          options
+        ) do |m|
+          inject_repo_keys(m)
+          block_given? ? yield(m) : m
+        end
+      end
+
+      # Get the specific commit on this repository.
+      #
+      # @param revision [String]
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Commit]
       def commit(revision, options = {})
-        m = commits_api(options).find(revision, options)
+        m = commits_api.find(revision, options)
         inject_repo_keys(m)
       end
 
+      # Get the branch restriction information associated with this repository.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Enumerator] an enumerator to enumerate
+      #   branch restriction information as
+      #   {Tinybucket::Model::BranchRestriction} instance.
       def branch_restrictions(options = {})
-        list = restrictions_api(options).list(options)
-        inject_repo_keys(list)
-      end
-
+        enumerator(
+          restrictions_api,
+          :list,
+          options
+        ) do |m|
+          inject_repo_keys(m)
+          block_given? ? yield(m) : m
+        end
+      end
+
+      # Get the specific branch restriction information on this repository.
+      #
+      # @param restriction_id [String]
+      # @param options [Hash]
+      # @return [Tinybucket::Model::BranchRestriction]
       def branch_restriction(restriction_id, options = {})
-        m = restrictions_api(options).find(restriction_id, options)
+        m = restrictions_api.find(restriction_id, options)
         inject_repo_keys(m)
       end
 
+      # Get the diff for this repository.
+      #
+      # @param spec [String] A specification such as a branch name,
+      #   revision, or commit SHA.
+      # @param options [Hash]
+      # @return [String] diff as raw text.
       def diff(spec, options = {})
-        diff_api(options).find(spec, options)
+        diff_api.find(spec, options)
       end
 
+      # Get the patch for the specification.
+      #
+      # @param spec [String] A specification such as a branch name,
+      #   revision, or commit SHA.
+      # @return [String] patch as raw text.
       def patch(spec, options = {})
-        diff_api(options).find_patch(spec, options)
+        diff_api.find_patch(spec, options)
       end
 
       private
 
-      def pull_requests_api(options)
-        create_api('PullRequests', repo_keys, options)
+      def pull_requests_api
+        create_api('PullRequests', repo_keys)
       end
 
-      def repo_api(options)
-        create_api('Repo', repo_keys, options)
+      def repo_api
+        create_api('Repo', repo_keys)
       end
 
-      def commits_api(options)
-        create_api('Commits', repo_keys, options)
+      def commits_api
+        create_api('Commits', repo_keys)
       end
 
-      def restrictions_api(options)
-        create_api('BranchRestrictions', repo_keys, options)
+      def restrictions_api
+        create_api('BranchRestrictions', repo_keys)
       end
 
-      def diff_api(options)
-        create_api('Diff', repo_keys, options)
+      def diff_api
+        create_api('Diff', repo_keys)
       end
 
       def load_model
-        repo_api({}).find()
+        repo_api.find()
       end
     end
   end

data/lib/tinybucket/model/team.rb

@@ -1,38 +1,98 @@
 module Tinybucket
   module Model
+    # Team
+    #
+    # @see https://confluence.atlassian.com/bitbucket/teams-endpoint-423626335.html#teamsEndpoint-Overview
+    #   teams Endpoint - Bitbucket Cloud REST API document
+    #
+    # @!attribute [rw] username
+    #   @return [String]
+    # @!attribute [rw] kind
+    #   @return [String, NillClass]
+    # @!attribute [rw] website
+    #   @return [String, NillClass]
+    # @!attribute [rw] display_name
+    #   @return [String]
+    # @!attribute [rw] uuid
+    #   @return [String]
+    # @!attribute [rw] links
+    #   @return [Hash]
+    # @!attribute [rw] created_on
+    #   @return [String]
+    # @!attribute [rw] location
+    #   @return [String, NillClass]
+    # @!attribute [rw] type
+    #   @return [String]
     class Team < Base
-      include Tinybucket::Model::Concerns::Reloadable
-
       acceptable_attributes \
         :username, :kind, :website, :display_name, :uuid,
         :links, :created_on, :location, :type
 
+      # Get this team's members.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Enumerator] an enumerator to enumerate members
+      #   as {Tinybucket::Model::Team} instance.
       def members(options = {})
-        team_api(options).members(username, options)
+        enumerator(
+          team_api,
+          :members,
+          username,
+          options
+        ) { |m| block_given? ? yield(m) : m }
       end
 
+      # Get this team's followers.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Enumerator] an enumerator to enumerate followers
+      #   as {Tinybucket::Model::Team} instance.
       def followers(options = {})
-        team_api(options).followers(username, options)
+        enumerator(
+          team_api,
+          :followers,
+          username,
+          options
+        ) { |m| block_given? ? yield(m) : m }
       end
 
+      # Get users which this team is following.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Enumerator] an enumerator to enumerate followings
+      #   as {Tinybucket::Model::Team} instance.
       def following(options = {})
-        team_api(options).following(username, options)
+        enumerator(
+          team_api,
+          :following,
+          username,
+          options
+        ) { |m| block_given? ? yield(m) : m }
       end
 
+      # Get this team's repositories.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Enumerator] an enumerator to enumerate repositories
+      #   as {Tinybucket::Model::Repository} instance.
       def repos(options = {})
-        team_api(options).repos(username, options)
+        enumerator(
+          team_api,
+          :repos,
+          username,
+          options
+        ) { |m| block_given? ? yield(m) : m }
       end
 
       private
 
-      def team_api(options)
+      def team_api
         return @team if @team
-
-        @team = create_instance 'Team', options
+        @team = create_instance('Team')
       end
 
       def load_model
-        team_api({}).find(username)
+        team_api.find(username)
       end
     end
   end

data/lib/tinybucket/request.rb

@@ -1,5 +1,7 @@
 module Tinybucket
   module Request
+    protected
+
     def get_path(path, params = {}, parser = nil, options = {})
       request(:get, path, params, parser, options)
     end

data/lib/tinybucket/response.rb

@@ -2,6 +2,6 @@ module Tinybucket
   module Response
     extend ActiveSupport::Autoload
 
-    autoload :ErrorHandler
+    autoload :Handler
   end
 end

data/lib/tinybucket/response/handler.rb

@@ -0,0 +1,21 @@
+module Tinybucket
+  module Response
+    class Handler < Faraday::Response::Middleware
+      def on_complete(env)
+        status_code = env[:status].to_i
+
+        return if status_code < 400
+
+        case status_code
+        when 404
+          raise Tinybucket::Error::NotFound.new(env)
+        when 409
+          raise Tinybucket::Error::Conflict.new(env)
+        else
+          Tinybucket.logger.error "Invalid response code:#{status_code}"
+          raise Tinybucket::Error::ServiceError.new(env)
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/version.rb

@@ -1,3 +1,3 @@
 module Tinybucket
-  VERSION = '0.1.7'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/spec/fixtures/repositories/test_owner/test_repo/commit/1/approve/post.json

@@ -0,0 +1,16 @@
+{
+    "role": "PARTICIPANT",
+    "user": {
+        "username": "evzijst",
+        "display_name": "Erik van Zijst",
+        "links": {
+            "self": {
+                "href": "https://api.bitbucket.org/2.0/users/evzijst"
+            },
+            "avatar": {
+                "href": "https://bitbucket-staging-assetroot.s3.amazonaws.com/c/photos/2013/Oct/28/evzijst-avatar-3454044670-3_avatar.png"
+            }
+        }
+    },
+    "approved": true
+}

data/spec/lib/tinybucket/api/branch_restrictions_api_spec.rb

@@ -7,9 +7,8 @@ RSpec.describe Tinybucket::Api::BranchRestrictionsApi do
   let(:slug) { 'test_repo' }
   let(:request_path) { nil }
 
-  let(:api_config) { {} }
   let(:api) do
-    api = Tinybucket::Api::BranchRestrictionsApi.new(api_config)
+    api = Tinybucket::Api::BranchRestrictionsApi.new
     api.repo_owner = owner
     api.repo_slug = slug
     api