codenamev_bitbucket_api 0.4.0

data/lib/bitbucket_rest_api/client/users/account.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Users::Account < API
+    @version = '1.0'
+
+    # API about users/account , please refer to 
+    # https://confluence.atlassian.com/display/BITBUCKET/account+Resource
+    #  
+
+
+    # GET the account profile
+    # 
+    def profile(accountname)
+      response = get_request("/users/#{accountname}")
+    end
+
+    # GET the account plan
+    def plan(accountname)
+      response = get_request("/users/#{accountname}/plan")
+    end
+
+    # GET the emails
+    def emails(accountname)
+      response = get_request("/users/#{accountname}/emails")
+    end
+
+    # GET the followers
+    def followers(accountname)
+      response = get_request("/users/#{accountname}/followers")
+    end
+
+    # GET the events
+    def events(accountname)
+      response = get_request("/users/#{accountname}/events")
+    end
+
+    #GET the keys
+    def keys(accountname)
+      response = get_request("/users/#{accountname}/ssh-keys")
+    end
+
+    #POST a new key
+    # params should be in format {key: "", label:""}
+    def new_key(accountname, params)
+      response = post_request("/users/#{accountname}/ssh-keys/", params)
+    end
+
+    #DELETE a key
+    def delete_key(accountname, key_id)
+      response = delete_request("/users/#{accountname}/ssh-keys/#{key_id}")
+    end
+  end # Users::Account
+end # BitBucket

data/lib/bitbucket_rest_api/client/users.rb

@@ -0,0 +1,14 @@
+
+# encoding: utf-8
+
+module BitBucket
+  class Client::Users < API
+
+    require_all 'bitbucket_rest_api/client/users', 'account'
+
+    @version = '1.0'
+
+    namespace :account
+
+  end # Client
+end # BitBucket

data/lib/bitbucket_rest_api/client.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client < API
+
+    require_all 'bitbucket_rest_api/client',
+      'issues',
+      'repos',
+      'users',
+      'invitations'
+
+    require_all 'bitbucket_rest_api/client/users', 'account'
+
+    namespace :issues
+
+    namespace :pull_requests
+
+    namespace :repos
+    alias :repositories :repos
+
+    # Many of the resources on the users API provide a shortcut for getting
+    # information about the currently authenticated user.
+    namespace :users
+
+    namespace :user
+    alias :user_api :user
+
+    namespace :invitations
+
+    # This is a read-only API to the BitBucket events.
+    # These events power the various activity streams on the site.
+    def events(options = {})
+      raise "Unimplemented"
+      #@events ||= Api::Factory.new 'Events', options
+    end
+
+    # An API for users to manage their own tokens.
+    def oauth(options = {})
+      raise "Unimpletmented"
+      #@oauth ||= Api::Factory.new 'Authorizations', options
+    end
+    alias :authorizations :oauth
+
+    def teams(options = {})
+      raise "Unimplemented"
+      #@teams ||= Api::Factory.new 'teams', options
+    end
+
+    def search(options = {})
+      raise "Unimplemented"
+      #@search ||= Api::Factory.new 'Search', options
+    end
+  end # Client
+end # BitBucket

data/lib/bitbucket_rest_api/compatibility.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+if RUBY_VERSION < "1.9"
+
+  def ruby_18 #:nodoc:
+    yield
+  end
+
+  def ruby_19 #:nodoc:
+    false
+  end
+
+else
+
+  def ruby_18 #:nodoc:
+    false
+  end
+
+  def ruby_19 #:nodoc:
+    yield
+  end
+
+end

data/lib/bitbucket_rest_api/configuration.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'bitbucket_rest_api/api/config'
+
+module BitBucket
+  # Stores the configuration
+  class Configuration < API::Config
+
+    # Other adapters are :typhoeus, :patron, :em_synchrony, :excon, :test
+    property :adapter, default: :net_http
+
+    # By default, don't set an application key
+    property :client_id, default: nil
+
+    # By default, don't set an application secret
+    property :client_secret, default: nil
+
+    # By default, don't set a user oauth access token
+    property :oauth_token, default: nil
+
+    # By default, don't set a user oauth access token secret
+    property :oauth_secret, default: nil
+
+    # By default, don't set a user login name
+    property :login, default: nil
+
+    # By default, don't set a user password
+    property :password, default: nil
+
+    # By default, don't set a user basic authentication
+    property :basic_auth, default: nil
+
+    # The endpoint used to connect to BitBucket if none is set, in the event that BitBucket is ever available on location
+    property :endpoint, default: 'https://bitbucket.org/api/1.0'.freeze
+    property :endpoint_v2, default: 'https://api.bitbucket.org/2.0'.freeze
+
+    # The value sent in the http header for 'User-Agent' if none is set
+    property :user_agent, default: "BitBucket Ruby Gem #{BitBucket::VERSION::STRING}".freeze
+
+    # By default the <tt>Accept</tt> header will make a request for <tt>JSON</tt>
+    property :mime_type, default: :json
+
+    # By default uses the Faraday connection options if none is set
+    property :connection_options, default: { }
+
+    # By default, don't set user name
+    property :user, default: nil
+
+    # By default, don't set repository name
+    property :repo, default: nil
+
+    # By default, don't auto-paginate results
+    property :auto_pagination, default: false
+
+    # Add Faraday::RackBuilder to overwrite middleware
+    property :stack
+
+  end # Configuration
+end # BitBucket

data/lib/bitbucket_rest_api/connection.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+module BitBucket
+  module Connection
+    extend self
+    include BitBucket::Constants
+
+    ALLOWED_OPTIONS = [
+        :headers,
+        :url,
+        :params,
+        :request,
+        :ssl,
+        :builder,
+        :api
+    ].freeze
+
+    def default_options(options={})
+      {
+          :headers => {
+              USER_AGENT       => options[:user_agent]
+          },
+          :ssl => { :verify => false },
+          :url => options.fetch(:endpoint) { BitBucket.endpoint }
+      }.merge(options)
+    end
+
+    def clear_cache
+      @connection = nil
+    end
+
+    def caching?
+      !@connection.nil?
+    end
+
+    # Exposes middleware builder to facilitate custom stacks and easy
+    # addition of new extensions such as cache adapter.
+    #
+    def stack(options={})
+      @stack ||= begin
+        builder_class = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
+        builder_class.new(&BitBucket.default_middleware(options))
+      end
+    end
+
+    # Returns a Fraday::Connection object
+    #
+    def connection(api, options = {})
+      connection_options = default_options(options)
+      clear_cache unless options.empty?
+      builder = api.stack ? api.stack : stack(options.merge!(api: api))
+      connection_options.merge!(builder: builder)
+      connection_options.keep_if {|key, value| ALLOWED_OPTIONS.include?(key) }
+
+      puts "OPTIONS:#{connection_options.inspect}" if ENV['DEBUG']
+
+      @connection ||= Faraday.new(connection_options)
+    end
+
+  end # Connection
+end # BitBucket

data/lib/bitbucket_rest_api/constants.rb

@@ -0,0 +1,50 @@
+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 params
+    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_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 unless method_defined?(:extract_options!)
+
+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 bitbucket 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 bitbucket 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