bitbucket_rest_api2 0.2.0

data/lib/bitbucket_rest_api/authorization.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+module BitBucket
+  module Authorization
+
+    # Check whether authentication credentials are present
+    def authenticated?
+      basic_authed? || oauth_token?
+    end
+
+    # Check whether basic authentication credentials are present
+    def basic_authed?
+      basic_auth? || (login? && password?)
+    end
+
+    # Select authentication parameters
+    def authentication
+      if basic_auth?
+        { :basic_auth => basic_auth }
+      elsif login? && password?
+        { :login => login, :password => password }
+      else
+        { }
+      end
+    end
+
+    private
+
+    def _verify_client # :nodoc:
+      raise ArgumentError, 'Need to provide client_id and client_secret' unless client_id? && client_secret?
+    end
+
+  end # Authorization
+end # BitBucket

data/lib/bitbucket_rest_api/client.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client < API
+
+    # 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 ||= ApiFactory.new 'Events', options
+    end
+
+    def issues(options = {})
+      @issues ||= ApiFactory.new 'Issues', options
+    end
+
+    # An API for users to manage their own tokens.
+    def oauth(options = {})
+      @oauth ||= ApiFactory.new 'Request::OAuth', options
+    end
+    alias :authorizations :oauth
+
+    def teams(options = {})
+      raise "Unimplemented"
+      #@teams ||= ApiFactory.new 'teams', options
+    end
+
+    def pull_requests(options = {})
+      @pull_requests ||= ApiFactory.new 'Repos::PullRequest', options
+    end
+
+    def repos(options = {})
+      @repos ||= ApiFactory.new 'Repos', options
+    end
+    alias :repositories :repos
+
+    def search(options = {})
+      raise "Unimplemented"
+      #@search ||= ApiFactory.new 'Search', options
+    end
+
+    # Many of the resources on the users API provide a shortcut for getting
+    # information about the currently authenticated user.
+    def users(options = {})
+      @users ||= ApiFactory.new 'Users', options
+    end
+
+    def user_api(options = {})
+      @user_api ||= ApiFactory.new 'User', options
+    end
+
+    def invitations(options = {})
+      @invitations ||= ApiFactory.new "Invitations", options
+    end
+  end # Client
+end # BitBucket

data/lib/bitbucket_rest_api/configuration.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+module BitBucket
+  module Configuration
+
+    VALID_OPTIONS_KEYS         = [
+        :adapter,
+        :client_id,
+        :client_secret,
+        :new_access_token,
+        :oauth_token,
+        :oauth_secret,
+        :endpoint,
+        :mime_type,
+        :user_agent,
+        :connection_options,
+        :repo,
+        :user,
+        :login,
+        :password,
+        :basic_auth
+    ].freeze
+
+    # Other adapters are :typhoeus, :patron, :em_synchrony, :excon, :test
+    DEFAULT_ADAPTER            = :net_http
+
+    # By default, don't set an application key
+    DEFAULT_CLIENT_ID          = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CLIENT_SECRET      = nil
+
+    # By default, don't set an access token
+    DEFAULT_ACCESS_TOKEN       = nil
+
+    # By default, don't set a user oauth access token
+    DEFAULT_OAUTH_TOKEN        = nil
+
+    # By default, don't set a user oauth access token secret
+    DEFAULT_OAUTH_SECRET       = nil
+
+    # By default, don't set a user login name
+    DEFAULT_LOGIN              = nil
+
+    # By default, don't set a user password
+    DEFAULT_PASSWORD           = nil
+
+    # By default, don't set a user basic authentication
+    DEFAULT_BASIC_AUTH         = nil
+
+    # The endpoint used to connect to BitBucket if none is set, in the event that BitBucket is ever available on location
+    DEFAULT_ENDPOINT           = 'https://api.bitbucket.org'.freeze
+
+    # The value sent in the http header for 'User-Agent' if none is set
+    DEFAULT_USER_AGENT         = "BitBucket Ruby Gem #{BitBucket::VERSION::STRING}".freeze
+
+    # By default the <tt>Accept</tt> header will make a request for <tt>JSON</tt>
+    DEFAULT_MIME_TYPE          = :json
+
+    # By default uses the Faraday connection options if none is set
+    DEFAULT_CONNECTION_OPTIONS = { }
+
+    # By default, don't set user name
+    DEFAULT_USER               = nil
+
+    # By default, don't set repository name
+    DEFAULT_REPO               = nil
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Convenience method to allow for global setting of configuration options
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.set_defaults
+    end
+
+    def options
+      options = { }
+      VALID_OPTIONS_KEYS.each { |k| options[k] = send(k) }
+      options
+    end
+
+    def set_defaults
+      self.adapter            = DEFAULT_ADAPTER
+      self.client_id          = DEFAULT_CLIENT_ID
+      self.client_secret      = DEFAULT_CLIENT_SECRET
+      self.new_access_token   = DEFAULT_ACCESS_TOKEN
+      self.oauth_token        = DEFAULT_OAUTH_TOKEN
+      self.oauth_secret       = DEFAULT_OAUTH_SECRET
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.mime_type          = DEFAULT_MIME_TYPE
+      self.user               = DEFAULT_USER
+      self.repo               = DEFAULT_REPO
+      self.login              = DEFAULT_LOGIN
+      self.password           = DEFAULT_PASSWORD
+      self.basic_auth         = DEFAULT_BASIC_AUTH
+      self
+    end
+
+  end # Configuration
+end # BitBucket

data/lib/bitbucket_rest_api/connection.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'faraday_middleware'
+require 'bitbucket_rest_api/response'
+require 'bitbucket_rest_api/response/mashify'
+require 'bitbucket_rest_api/response/jsonize'
+require 'bitbucket_rest_api/response/helpers'
+require 'bitbucket_rest_api/response/raise_error'
+require 'bitbucket_rest_api/request/oauth'
+require 'bitbucket_rest_api/request/basic_auth'
+require 'bitbucket_rest_api/request/jsonize'
+
+module BitBucket
+  module Connection
+    extend self
+    include BitBucket::Constants
+
+    ALLOWED_OPTIONS = [
+        :headers,
+        :url,
+        :params,
+        :request,
+        :ssl
+    ].freeze
+
+    def default_options(options={})
+      {
+          :headers => {
+              USER_AGENT       => user_agent
+          },
+          :ssl => { :verify => false },
+          :url => options.fetch(:endpoint) { BitBucket.endpoint }
+      }.merge(options)
+    end
+
+    # Default middleware stack that uses default adapter as specified at
+    # configuration stage.
+    #
+    def default_middleware(options={})
+      Proc.new do |builder|
+        #builder.use BitBucket::Request::Jsonize
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+        builder.use FaradayMiddleware::OAuth, {:consumer_key => client_id, :consumer_secret => client_secret, :token => oauth_token, :token_secret => oauth_secret} if client_id? and client_secret?
+        builder.use BitBucket::Request::BasicAuth, authentication if basic_authed?
+        builder.use FaradayMiddleware::EncodeJson
+
+        builder.use Faraday::Response::Logger if ENV['DEBUG']
+        builder.use BitBucket::Response::Helpers
+        unless options[:raw]
+          builder.use BitBucket::Response::Mashify
+          builder.use BitBucket::Response::Jsonize
+        end
+        builder.use BitBucket::Response::RaiseError
+        builder.adapter adapter
+      end
+    end
+
+    @connection = nil
+
+    @stack = nil
+
+    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={}, &block)
+      @stack ||= begin
+        if block_given?
+          Faraday::RackBuilder.new(&block)
+        else
+          Faraday::RackBuilder.new(&default_middleware(options))
+        end
+      end
+    end
+
+    # Returns a Fraday::Connection object
+    #
+    def connection(options = {})
+      conn_options = default_options(options)
+      clear_cache unless options.empty?
+      puts "OPTIONS:#{conn_options.inspect}" if ENV['DEBUG']
+
+      @connection ||= Faraday.new(conn_options.merge(:builder => stack(options))) do |faraday|
+        faraday.response :logger if ENV['DEBUG']
+      end
+    end
+
+  end # Connection
+end # BitBucket

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,7 @@
+class Array # :nodoc:
+
+  def extract_options!
+    last.is_a?(::Hash) ? pop : {}
+  end
+
+end # Array

data/lib/bitbucket_rest_api/core_ext/hash.rb

@@ -0,0 +1,46 @@
+class Hash # :nodoc:
+
+  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/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