tinybucket2 1.0.0

data/lib/tinybucket/model/commit.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    # Commit Resource
+    #
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit
+    #   Commit Resource
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commits
+    #   Commits Resource
+    #
+    # @!attribute [rw] hash
+    #   @return [String]
+    # @!attribute [rw] links
+    #   @return [Hash]
+    # @!attribute [rw] repository
+    #   @return [Hash]
+    # @!attribute [rw] author
+    #   @return [Hash]
+    # @!attribute [rw] parents
+    #   @return [Array]
+    # @!attribute [rw] date
+    #   @return [String]
+    # @!attribute [rw] message
+    #   @return [String]
+    # @!attribute [rw] participants
+    #   @return [Array]
+    # @!attribute [rw] uuid
+    #   @return [NillClass]
+    # @!attribute [rw] type
+    #   @return [String]
+    class Commit < Base
+      include Tinybucket::Model::Concerns::RepositoryKeys
+      include Tinybucket::Constants
+
+      acceptable_attributes \
+        :hash, :links, :repository, :author, :parents, :date,
+        :message, :participants, :uuid, :type
+
+      # Get comments which associate with this commit.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Resource::Commit::Comments]
+      def comments(options = {})
+        comments_resource(options)
+      end
+
+      # Get the specific commit comment which associate with this commit.
+      #
+      # @param comment_id [String] comment id
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Comment]
+      def comment(comment_id, options = {})
+        comments_resource.find(comment_id, options)
+      end
+
+      # Give approval on this commit.
+      #
+      # @param options [Hash]
+      # @return [true]
+      # @return [false]
+      def approve(options = {})
+        commit_api.approve(hash, options)
+      end
+
+      # Revoke approval on this commit.
+      #
+      # @param options [Hash]
+      # @return [true]
+      # @return [false]
+      def unapprove(options = {})
+        commit_api.unapprove(hash, options)
+      end
+
+      # Get build status resource
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Resource::Commit::BuildStatuses]
+      def build_statuses(options = {})
+        build_statuses_resource(options)
+      end
+
+      # Get the specific build status which associate with key.
+      #
+      # @param key [String]
+      # @param options [Hash]
+      # @return [Tinybucket::Model::BuildStatus]
+      # @return [nil] when build_status does not found.
+      def build_status(key, options = {})
+        build_statuses_resource.find(key, options)
+      rescue Tinybucket::Error::NotFound
+        nil
+      end
+
+      private
+
+      def comments_resource(options = {})
+        Tinybucket::Resource::Commit::Comments.new(self, options)
+      end
+
+      def build_statuses_resource(options = {})
+        Tinybucket::Resource::Commit::BuildStatuses.new(self, options)
+      end
+
+      def commit_api
+        create_api('Commits', repo_keys)
+      end
+
+      def load_model
+        commit_api.find(hash)
+      end
+    end
+  end
+end

data/lib/tinybucket/model/concerns.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    module Concerns
+      extend ActiveSupport::Autoload
+
+      [
+        :AcceptableAttributes,
+        :ApiCallable,
+        :Enumerable,
+        :RepositoryKeys,
+        :Reloadable
+      ].each do |mod_name|
+        autoload mod_name
+      end
+    end
+  end
+end

data/lib/tinybucket/model/concerns/acceptable_attributes.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    module Concerns
+      module AcceptableAttributes
+        extend ActiveSupport::Concern
+
+        included do
+          def self.acceptable_attributes(*attrs)
+            @_acceptable_attributes = attrs.map(&:intern)
+
+            attr_accessor(*attrs)
+          end
+
+          def self.acceptable_attribute?(key)
+            return false if @_acceptable_attributes.nil?
+            @_acceptable_attributes.include?(key.intern)
+          end
+
+          protected
+
+          def acceptable_attribute?(key)
+            self.class.acceptable_attribute?(key)
+          end
+
+          def acceptable_attributes
+            self.class.instance_variable_get(:@_acceptable_attributes) || []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/model/concerns/api_callable.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    module Concerns
+      module ApiCallable
+        protected
+
+        def create_api(name, keys = {})
+          api = ApiFactory.create_instance(name)
+          return api if keys.empty?
+
+          api.tap do |m|
+            m.repo_owner = keys[:repo_owner]
+            m.repo_slug  = keys[:repo_slug]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/model/concerns/enumerable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    module Concerns
+      module Enumerable
+        extend ActiveSupport::Concern
+
+        included do
+          protected
+
+          def enumerator(api_client, method, *args, &block)
+            iter = Tinybucket::Iterator.new(api_client, method, *args)
+            Tinybucket::Enumerator.new(iter, block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/model/concerns/reloadable.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    module Concerns
+      module Reloadable
+        extend ActiveSupport::Concern
+
+        included do
+          def load
+            return true if @_loaded
+
+            self.attributes = load_model.attributes
+            @_loaded = true
+          rescue => e
+            @_loaded = false
+            Tinybucket.logger.error e
+            raise e
+          end
+
+          def loaded?
+            @_loaded
+          end
+
+          def reload
+            @_loaded = false
+            # rubocop:disable all
+            self.load
+            # rubocop:enable all
+          end
+
+          private
+
+          def load_model
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/model/concerns/repository_keys.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    module Concerns
+      module RepositoryKeys
+        extend ActiveSupport::Concern
+
+        included do
+          attr_accessor :repo_owner, :repo_slug
+
+          def repo_keys?
+            repo_owner.present? && repo_slug.present?
+          end
+
+          def repo_keys
+            { repo_owner: repo_owner, repo_slug: repo_slug }
+          end
+
+          def repo_keys=(keys)
+            self.repo_owner = keys[:repo_owner]
+            self.repo_slug  = keys[:repo_slug]
+          end
+
+          private
+
+          def inject_repo_keys(result)
+            case result
+            when Tinybucket::Model::Page
+              result.items.map do |m|
+                next unless m.class.concern_included?(:RepositoryKeys)
+                m.repo_keys = repo_keys
+              end
+            when Tinybucket::Model::Base
+              result.repo_keys = repo_keys \
+                if result.class.concern_included?(:RepositoryKeys)
+            end
+
+            result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/model/error_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    # ErrorResponse
+    #
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/meta/uri-uuid#stand-error
+    #   Standardized error responses
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    # @!attribute [rw] fields
+    #   @return [Hash]
+    # @!attribute [rw] detail
+    #   @return [String]
+    # @!attribute [rw] id
+    #   @return [String]
+    # @!attribute [rw] uuid
+    #   @return [NillClass]
+    class ErrorResponse
+      acceptable_attributes :message, :fields, :detail, :id, :uuid
+    end
+  end
+end

data/lib/tinybucket/model/issue.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 Issue < 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.issue(name, options)
+      end
+
+      private
+
+      def commits_resource(options = {})
+        Tinybucket::Resource::Commits.new(self, options)
+      end
+
+      def issues_api
+        create_api('Issues', repo_keys)
+      end
+
+      def load_model
+        issues_api.find(name, {})
+      end
+    end
+  end
+end

data/lib/tinybucket/model/page.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    # Page
+    #
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/meta/pagination
+    #   Paging through object collections
+    #
+    # @!attribute [r] attrs
+    #   This attribute is a Hash object which contains
+    #   'size', 'page', 'pagelen', 'next', 'previous' key/value pairs.
+    #   @return [Hash]
+    # @!attribute [r] items
+    #   This attribute is a array of model instance created with
+    #   'values' attribute in json.
+    class Page
+      attr_reader :attrs
+      attr_reader :items
+
+      # Initialize with json and Model class.
+      #
+      # @param json [Hash]
+      # @param item_klass [Class]
+      def initialize(json, item_klass)
+        @attrs = parse_attrs(json)
+        @items = parse_values(json, item_klass)
+      end
+
+      private
+
+      def parse_attrs(json)
+        %w(size page pagelen next previous).map do |attr|
+          { attr.to_sym => json[attr] }
+        end.reduce(&:merge)
+      end
+
+      def parse_values(json, item_klass)
+        return [] if json['values'].nil? || !json['values'].is_a?(Array)
+
+        json['values'].map { |hash| item_klass.new(hash) }
+      end
+    end
+  end
+end

data/lib/tinybucket/model/profile.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Model
+    # Profile
+    #
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/users/%7Busername%7D
+    #   users Endpoint
+    #
+    # @!attribute [rw] username
+    #   @return [String]
+    # @!attribute [rw] kind
+    #   @return [NillClass]
+    # @!attribute [rw] website
+    #   @return [String]
+    # @!attribute [rw] display_name
+    #   @return [String]
+    # @!attribute [rw] links
+    #   @return [Hash]
+    # @!attribute [rw] created_on
+    #   @return [String]
+    # @!attribute [rw] location
+    #   @return [String]
+    # @!attribute [rw] type
+    #   @return [String]
+    # @!attribute [rw] uuid
+    #   @return [String]
+    class Profile < Base
+      acceptable_attributes \
+        :username, :kind, :website, :display_name,
+        :links, :created_on, :location, :type, :uuid
+
+      # Get this user's followers
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Resource::User::Followers]
+      def followers(options = {})
+        Tinybucket::Resource::User::Followers.new(username, options)
+      end
+
+      # Get users which this user is following
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Resource::User::Following]
+      def following(options = {})
+        Tinybucket::Resource::User::Following.new(username, options)
+      end
+
+      # Get this user's repositories
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Resource::User::Repos]
+      def repos(options = {})
+        Tinybucket::Resource::User::Repos.new(username, options)
+      end
+
+      private
+
+      def user_api
+        create_api('User').tap do |api|
+          api.username = username
+        end
+      end
+
+      def load_model
+        user_api.profile
+      end
+    end
+  end
+end