bitbucket_rest_api 0.1.0

data/lib/bitbucket_rest_api/constants.rb

@@ -0,0 +1,58 @@
+module BitBucket
+  module Constants
+    extend self
+
+    # Response headers
+    RATELIMIT_REMAINING = 'X-RateLimit-Remaining'.freeze
+
+    RATELIMIT_LIMIT = 'X-RateLimit-Limit'.freeze
+
+    CONTENT_TYPE = 'Content-Type'.freeze
+
+    CONTENT_LENGTH = 'content-length'.freeze
+
+    CACHE_CONTROL = 'cache-control'.freeze
+
+    ETAG = 'ETag'.freeze
+
+    SERVER = 'Server'.freeze
+
+    DATE = 'Date'.freeze
+
+    LOCATION = 'Location'.freeze
+
+    USER_AGENT = 'User-Agent'.freeze
+
+    ACCEPT = 'Accept'.freeze
+
+    ACCEPT_CHARSET = 'Accept-Charset'.freeze
+
+    # Link headers
+    HEADER_LINK = "Link".freeze
+
+    HEADER_NEXT = "X-Next".freeze
+
+    HEADER_LAST = "X-Last".freeze
+
+    META_REL = "rel".freeze
+
+    META_LAST = "last".freeze
+
+    META_NEXT = "next".freeze
+
+    META_FIRST = "first".freeze
+
+    META_PREV = "prev".freeze
+
+    PARAM_PAGE = "page".freeze
+
+    PARAM_PER_PAGE = "per_page".freeze
+
+    PARAM_START_PAGE = "start_page".freeze
+
+    # URI parsing
+    QUERY_STR_SEP = '?'.freeze
+
+
+  end # Constants
+end # BitBucket

data/lib/bitbucket_rest_api/core_ext/array.rb

@@ -0,0 +1,17 @@
+class Array # :nodoc:
+
+  def except(*keys) # :nodoc:
+    self.dup.except!(*keys)
+  end unless method_defined?(:except)
+
+  def except!(*items) # :nodoc:
+    copy = self.dup
+    copy.reject! { |item| items.include? item }
+    copy
+  end unless method_defined?(:except!)
+
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+
+end # Array

data/lib/bitbucket_rest_api/core_ext/hash.rb

@@ -0,0 +1,56 @@
+class Hash # :nodoc:
+
+  def except(*items) # :nodoc:
+    self.dup.except!(*items)
+  end unless method_defined?(:except)
+
+  def except!(*keys) # :nodoc:
+    copy = self.dup
+    keys.each { |key| copy.delete!(key) }
+    copy
+  end unless method_defined?(:except!)
+
+  def symbolize_keys  # :nodoc:
+    inject({}) do |hash, (key, value)|
+      hash[(key.to_sym rescue key) || key] = value
+      hash
+    end
+  end unless method_defined?(:symbolize_keys)
+
+  def symbolize_keys! # :nodoc:
+    hash = symbolize_keys
+    hash.each do |key, val|
+      hash[key] = case val
+                  when Hash
+                    val.symbolize_keys!
+                  when Array
+                    val.map do |item|
+                      item.is_a?(Hash) ? item.symbolize_keys! : item
+                    end
+                  else
+                    val
+                  end
+    end
+    return hash
+  end unless method_defined?(:symbolize_keys!)
+
+  def serialize # :nodoc:
+    self.map { |key, val| [key, val].join("=") }.join("&")
+  end unless method_defined?(:serialize)
+
+  def all_keys # :nodoc:
+    keys = self.keys
+    keys.each do |key|
+      if self[key].is_a?(Hash)
+        keys << self[key].all_keys.compact.flatten
+        next
+      end
+    end
+    keys.flatten
+  end unless method_defined?(:all_keys)
+
+  def has_deep_key?(key)
+    self.all_keys.include? key
+  end unless method_defined?(:has_deep_key?)
+
+end # Hash

data/lib/bitbucket_rest_api/core_ext/ordered_hash.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+
+module BitBucket
+  module CoreExt #:nodoc:
+
+    if RUBY_VERSION >= '1.9'
+      class OrderedHash < ::Hash; end
+    else
+      class OrderedHash < ::Hash
+        attr_accessor :order
+
+        class << self
+          def [](*args)
+            hsh = OrderedHash.new
+            if Hash == args[0]
+              hsh.replace args[0]
+            elsif (args.size % 2) != 0
+              pp args
+              raise ArgumentError, "odd number of elements for Hash"
+            else
+              0.step(args.size - 1, 2) do |a|
+                b = a + 1
+                hsh[args[a]] = args[b]
+              end
+            end
+            hsh
+          end
+        end
+
+        def initialize(*args, &block)
+          super
+          @order = []
+        end
+
+        def []=(key, value)
+          @order.push key unless member?(key)
+          super key, value
+        end
+
+        def ==(hsh2)
+          return false if @order != hsh2.order
+          super hsh2
+        end
+
+        def clear
+          @order = []
+          super
+        end
+
+        def delete(key)
+          @order.delete key
+          super
+        end
+
+        def each_key
+          @order.each { |k| yield k }
+          self
+        end
+
+        def each_value
+          @order.each { |k| yield self[k] }
+          self
+        end
+
+        def each
+          @order.each { |k| yield k, self[k] }
+          self
+        end
+        alias :each_pair :each
+
+        def delete_if
+          @order.clone.each { |k| delete k if yield }
+          self
+        end
+
+        def values
+          ary = []
+          @order.each { |k| ary.push self[k] }
+          ary
+        end
+
+        def keys
+          @order
+        end
+
+        def replace(hsh2)
+          @order = hsh2.keys
+          super hsh2
+        end
+
+        def shift
+          key = @order.first
+          key ? [key, delete(key)] : super
+        end
+
+        def class
+          Hash
+        end
+
+        def __class__
+          OrderedHash
+        end
+      end # OrderedHash
+    end
+
+  end # CoreExt
+end # BitBucket

data/lib/bitbucket_rest_api/deprecation.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module BitBucket
+
+  DEPRECATION_PREFIX = "[BitBucketAPI] Deprecation warning:"
+
+  class << self
+
+    attr_writer :deprecation_tracker
+
+    def deprecation_tracker
+      @deprecation_tracker ||= []
+    end
+
+    # Displays deprecation message to the user.
+    # Each message is printed once.
+    def deprecate(method, alternate_method=nil)
+      return if deprecation_tracker.include? method
+      deprecation_tracker << method
+
+      message = <<-NOTICE
+#{DEPRECATION_PREFIX}
+
+* #{method} is deprecated.
+      NOTICE
+      if alternate_method
+        message << <<-ADDITIONAL
+* please use #{alternate_method} instead.
+        ADDITIONAL
+      end
+      warn_deprecation(message)
+    end
+
+    def warn_deprecation(message)
+      send :warn, message
+    end
+  end
+
+end # BitBucket

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/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/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/error.rb

@@ -0,0 +1,35 @@
+# 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
+].each do |error|
+  require "bitbucket_rest_api/error/#{error}"
+end

data/lib/bitbucket_rest_api/issues/comments.rb

@@ -0,0 +1,118 @@
+# encoding: utf-8
+
+module BitBucket
+  class Issues::Comments < API
+
+    VALID_ISSUE_COMMENT_PARAM_NAME = %w[
+      content
+    ].freeze
+
+    # Creates new Issues::Comments API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List comments on an issue
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.all 'user-name', 'repo-name', 'issue-id'
+    #  bitbucket.issues.comments.all 'user-name', 'repo-name', 'issue-id' {|com| .. }
+    #
+    def list(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_comment, params)
+
+      response = get_request("/repositories/#{user}/#{repo}/issues/#{issue_id}/comments/", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single comment
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.find 'user-name', 'repo-name', 'comment-id'
+    #
+    def get(user_name, repo_name, comment_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of comment_id
+
+      normalize! params
+      # _merge_mime_type(:issue_comment, params)
+
+      get_request("/repositories/#{user}/#{repo}/issues/comments/#{comment_id}", params)
+    end
+    alias :find :get
+
+    # Create a comment
+    #
+    # = Inputs
+    #  <tt>:content</tt> Required string
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.create 'user-name', 'repo-name', 'issue-id',
+    #     "content" => 'a new comment'
+    #
+    def create(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_comment, params)
+      filter! VALID_ISSUE_COMMENT_PARAM_NAME, params
+      assert_required_keys(%w[ content ], params)
+
+      post_request("/repositories/#{user}/#{repo}/issues/#{issue_id}/comments/", params)
+    end
+
+    # Edit a comment
+    #
+    # = Inputs
+    #  <tt>:content</tt> Required string
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.edit 'user-name', 'repo-name', 'comment-id',
+    #     "content" => 'a new comment'
+    #
+    def edit(user_name, repo_name, comment_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of comment_id
+
+      normalize! params
+      # _merge_mime_type(:issue_comment, params)
+      filter! VALID_ISSUE_COMMENT_PARAM_NAME, params
+      assert_required_keys(%w[ content ], params)
+
+      put_request("/repositories/#{user}/#{repo}/issues/comments/#{comment_id}")
+    end
+
+    # Delete a comment
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.comments.delete 'user-name', 'repo-name', 'comment-id'
+    #
+    def delete(user_name, repo_name, comment_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of comment_id
+
+      normalize! params
+      # _merge_mime_type(:issue_comment, params)
+
+      delete_request("/repositories/#{user}/#{repo}/issues/comments/#{comment_id}", params)
+    end
+
+  end # Issues::Comments
+end # BitBucket