zz_bitbucket_rest_api 0.1.8

data/lib/bitbucket_rest_api/error.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+module BitBucket
+  module Error
+    class BitBucketError < StandardError
+      attr_reader :response_message, :response_headers
+
+      def initialize(message)
+        super message
+        @response_message = message
+      end
+
+#       def inspect
+#         %(#<#{self.class}>)
+#       end
+    end
+  end # Error
+end # BitBucket
+
+%w[
+  service_error
+  not_found
+  forbidden
+  bad_request
+  unauthorized
+  service_unavailable
+  internal_server_error
+  unprocessable_entity
+  client_error
+  invalid_options
+  required_params
+  unknown_value
+  bad_events
+  no_events
+  blank_value
+].each do |error|
+  require "bitbucket_rest_api/error/#{error}"
+end

data/lib/bitbucket_rest_api/error/bad_events.rb

@@ -0,0 +1,9 @@
+module BitBucket
+  module Error
+    class BadEvents < ClientError
+      def initialize(event)
+        super "The event: '#{event}', does not exist :("
+      end
+    end
+  end
+end

data/lib/bitbucket_rest_api/error/bad_request.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module BitBucket
+  module Error
+    # Raised when BitBucket returns the HTTP status code 400
+    class BadRequest < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end
+end # BitBucket

data/lib/bitbucket_rest_api/error/blank_value.rb

@@ -0,0 +1,9 @@
+module BitBucket
+  module Error
+    class BlankValue < ClientError
+      def initialize(required_key)
+        super "The value for: '#{required_key}', cannot be blank :("
+      end
+    end
+  end
+end

data/lib/bitbucket_rest_api/error/client_error.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when BitBucket returns the HTTP status code 404
+  module Error
+    class ClientError < BitBucketError
+      attr_reader :problem, :summary, :resolution
+
+      def initialize(message)
+        super(message)
+      end
+
+      def generate_message(attributes)
+        "\nProblem:\n #{attributes[:problem]}"+
+        "\nSummary:\n #{attributes[:summary]}"+
+        "\nResolution:\n #{attributes[:resolution]}"
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/forbidden.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when BitBucket returns the HTTP status code 403
+  module Error
+    class Forbidden < BitBucketError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/internal_server_error.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when BitBucket returns the HTTP status code 500
+  module Error
+    class InternalServerError < BitBucketError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/invalid_options.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when invalid options are passed to a request body
+  module Error
+    class InvalidOptions < ClientError
+      def initialize(invalid, valid)
+        super(
+          generate_message(
+            :problem => "Invalid option #{invalid.keys.join(', ')} provided for this request.", 
+            :summary => "BitBucket gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
+            :resolution => "Valid options are: #{valid.join(', ')}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/no_events.rb

@@ -0,0 +1,9 @@
+module BitBucket
+  module Error
+    class NoEvents < ClientError
+      def initialize
+        super "At least one event is required, none given :("
+      end
+    end
+  end
+end

data/lib/bitbucket_rest_api/error/not_found.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when BitBucket returns the HTTP status code 404
+  module Error
+    class NotFound < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/required_params.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when invalid options are passed to a request body
+  module Error
+    class RequiredParams < ClientError
+      def initialize(provided, required)
+        super(
+          generate_message(
+            :problem => "Missing required parameters: #{provided.keys.join(', ')} provided for this request.",
+            :summary => "BitBucket gem checks the request parameters passed to ensure that github api is not hit unnecessairly and to fail fast.",
+            :resolution => "Required parameters are: #{required.join(', ')}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/service_error.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when BitBucket returns any of the HTTP status codes
+  module Error
+    class ServiceError < BitBucketError
+      attr_accessor :http_headers
+
+      def initialize(env)
+        super(generate_message(env))
+        @http_headers = env[:response_headers]
+      end
+
+      def generate_message(env)
+        "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{env[:status]} #{env[:body]}"
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/service_unavailable.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when BitBucket returns the HTTP status code 404
+  module Error
+    class ServiceUnavailable < BitBucketError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/unauthorized.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when BitBucket returns the HTTP status code 401
+  module Error
+    class Unauthorized < BitBucketError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/unknown_value.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when invalid options are passed to a request body
+  module Error
+    class UnknownValue < ClientError
+      def initialize(key, value, permitted)
+        super(
+          generate_message(
+            :problem => "Wrong value of '#{value}' for the parameter: #{key} provided for this request.",
+            :summary => "BitBucket gem checks the request parameters passed to ensure that github api is not hit unnecessairly and fails fast.",
+            :resolution => "Permitted values are: #{permitted}, make sure these are the ones you are using"
+          )
+        )
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/unprocessable_entity.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when BitBucket returns the HTTP status code 422
+  module Error
+    class UnprocessableEntity < BitBucketError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/error/validations.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module BitBucket #:nodoc
+  # Raised when passed parameters are missing or contain wrong values.
+  module Error
+    class Validations < ClientError
+      def initialize(errors)
+        super(
+          generate_message(
+            :problem => '',
+            :summary => '',
+            :resolution => ''
+          )
+        )
+      end
+    end
+  end # Error
+end # BitBucket

data/lib/bitbucket_rest_api/invitations.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module BitBucket
+  class Invitations < API
+    def invite(user_name, repo_name, emailaddress, perm)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of emailaddress
+      perm ||= "write"
+
+      post_request("/1.0/invitations/#{user}/#{repo.downcase}/#{emailaddress}",
+                   permission: perm)
+    end
+  end
+end

data/lib/bitbucket_rest_api/issues.rb

@@ -0,0 +1,230 @@
+# encoding: utf-8
+
+module BitBucket
+  class Issues < API
+    extend AutoloadHelper
+
+    autoload_all 'bitbucket_rest_api/issues',
+                 :Comments   => 'comments',
+                 :Components => 'components',
+                 :Milestones => 'milestones'
+
+    VALID_ISSUE_PARAM_NAMES = %w[
+      title
+      content
+      component
+      milestone
+      version
+      responsible
+      priority
+      status
+      kind
+      limit
+      start
+      search
+      sort
+      reported_by
+    ].freeze
+
+    VALID_ISSUE_PARAM_VALUES = {
+        'priority'    => %w[ trivial minor major critical blocker ],
+        'status'     => ['new', 'open', 'resolved', 'on hold', 'invalid', 'duplicate', 'wontfix'],
+        'kind'      => %w[ bug enhancement proposal task ]
+    }
+
+    # Creates new Issues API
+    def initialize(options = { })
+      super(options)
+    end
+
+    # Access to Issues::Comments API
+    def comments
+      @comments ||= ApiFactory.new 'Issues::Comments'
+    end
+
+    # Access to Issues::Components API
+    def components
+      @components ||= ApiFactory.new 'Issues::Components'
+    end
+
+    # Access to Issues::Milestones API
+    def milestones
+      @milestones ||= ApiFactory.new 'Issues::Milestones'
+    end
+
+    # List issues for a repository
+    #
+    # = Inputs
+    #  <tt>:limit</tt> - Optional - Number of issues to retrieve, default 15
+    #  <tt>:start</tt> - Optional - Issue offset, default 0
+    #  <tt>:search</tt> - Optional - A string to search for
+    #  <tt>:sort</tt> - Optional - Sorts the output by any of the metadata fields
+    #  <tt>:title</tt> - Optional - Contains a filter operation to restrict the list of issues by the issue title
+    #  <tt>:content</tt> - Optional - Contains a filter operation to restrict the list of issues by the issue content
+    #  <tt>:version</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the version
+    #  <tt>:milestone</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the milestone
+    #  <tt>:component</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the component
+    #  <tt>:kind</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the issue kind
+    #  <tt>:status</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the issue status
+    #  <tt>:responsible</tt> - Optional - Contains an is or ! ( is not) filter to restrict the list of issues by the user responsible
+    #  <tt>:reported_by</tt> - Optional - Contains a filter operation to restrict the list of issues by the user that reported the issue
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.list_repo :filter => 'kind=bug&kind=enhancement'
+    #
+    def list_repo(user_name, repo_name, params={ })
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      normalize! params
+      filter! VALID_ISSUE_PARAM_NAMES, params
+      # _merge_mime_type(:issue, params)
+      assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
+
+      response = get_request("/1.0/repositories/#{user}/#{repo.downcase}/issues", params)
+      return response.issues unless block_given?
+      response.issues.each { |el| yield el }
+    end
+
+    alias :list_repository :list_repo
+
+    # Get a single issue
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.get 'user-name', 'repo-name', 'issue-id'
+    #
+    def get(user_name, repo_name, issue_id, params={ })
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of issue_id
+
+      normalize! params
+      # _merge_mime_type(:issue, params)
+
+      get_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}", params)
+    end
+
+    alias :find :get
+
+    # Delete a single issue
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.delete 'user-name', 'repo-name', 'issue-id'
+    #
+    def delete(user_name, repo_name, issue_id, params={ })
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of issue_id
+
+      normalize! params
+      # _merge_mime_type(:issue, params)
+
+      delete_request("/1.0/repositories/#{user}/#{repo}/issues/#{issue_id}", params)
+    end
+
+    # Create an issue
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Required string
+    #  <tt>:content</tt> - Optional string
+    #  <tt>:responsible</tt> - Optional string - Login for the user that this issue should be assigned to.
+    #  <tt>:milestone</tt> - Optional number - Milestone to associate this issue with
+    #  <tt>:version</tt> - Optional number - Version to associate this issue with
+    #  <tt>:component</tt> - Optional number - Component to associate this issue with
+    #  <tt>:priority</tt> - Optional string - The priority of this issue
+    #  * <tt>trivial</tt>
+    #  * <tt>minor</tt>
+    #  * <tt>major</tt>
+    #  * <tt>critical</tt>
+    #  * <tt>blocker</tt>
+    #  <tt>:status</tt> - Optional string - The status of this issue
+    #  * <tt>new</tt>
+    #  * <tt>open</tt>
+    #  * <tt>resolved</tt>
+    #  * <tt>on hold</tt>
+    #  * <tt>invalid</tt>
+    #  * <tt>duplicate</tt>
+    #  * <tt>wontfix</tt>
+    #  <tt>:kind</tt> - Optional string - The kind of issue
+    #  * <tt>bug</tt>
+    #  * <tt>enhancement</tt>
+    #  * <tt>proposal</tt>
+    #  * <tt>task</tt>
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.create
+    #    "title" => "Found a bug",
+    #    "content" => "I'm having a problem with this.",
+    #    "responsible" => "octocat",
+    #    "milestone" => 1,
+    #    "priority" => "blocker"
+    #
+    def create(user_name, repo_name, params={ })
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      normalize! params
+      _merge_user_into_params!(params) unless params.has_key?('user')
+      # _merge_mime_type(:issue, params)
+      filter! VALID_ISSUE_PARAM_NAMES, params
+      assert_required_keys(%w[ title ], params)
+
+      post_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/", params)
+    end
+
+    # Edit an issue
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Required string
+    #  <tt>:content</tt> - Optional string
+    #  <tt>:responsible</tt> - Optional string - Login for the user that this issue should be assigned to.
+    #  <tt>:milestone</tt> - Optional number - Milestone to associate this issue with
+    #  <tt>:version</tt> - Optional number - Version to associate this issue with
+    #  <tt>:component</tt> - Optional number - Component to associate this issue with
+    #  <tt>:priority</tt> - Optional string - The priority of this issue
+    #  * <tt>trivial</tt>
+    #  * <tt>minor</tt>
+    #  * <tt>major</tt>
+    #  * <tt>critical</tt>
+    #  * <tt>blocker</tt>
+    #  <tt>:status</tt> - Optional string - The status of this issue
+    #  * <tt>new</tt>
+    #  * <tt>open</tt>
+    #  * <tt>resolved</tt>
+    #  * <tt>on hold</tt>
+    #  * <tt>invalid</tt>
+    #  * <tt>duplicate</tt>
+    #  * <tt>wontfix</tt>
+    #  <tt>:kind</tt> - Optional string - The kind of issue
+    #  * <tt>bug</tt>
+    #  * <tt>enhancement</tt>
+    #  * <tt>proposal</tt>
+    #  * <tt>task</tt>
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
+    #  bitbucket.issues.create
+    #    "title" => "Found a bug",
+    #    "content" => "I'm having a problem with this.",
+    #    "responsible" => "octocat",
+    #    "milestone" => 1,
+    #    "priority" => "blocker"
+    #
+    def edit(user_name, repo_name, issue_id, params={ })
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of issue_id
+
+      normalize! params
+      # _merge_mime_type(:issue, params)
+      filter! VALID_ISSUE_PARAM_NAMES, params
+
+      put_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}/", params)
+    end
+
+  end # Issues
+end # BitBucket