reenhanced_bitbucket_api 0.1.6 → 0.3.0

data/lib/bitbucket_rest_api/api.rb

@@ -1,36 +1,43 @@
 # -*- encoding: utf-8 -*-
 
 require 'bitbucket_rest_api/configuration'
-require 'bitbucket_rest_api/connection'
-require 'bitbucket_rest_api/validations'
-require 'bitbucket_rest_api/request'
 require 'bitbucket_rest_api/core_ext/hash'
 require 'bitbucket_rest_api/core_ext/array'
 require 'bitbucket_rest_api/compatibility'
+require 'bitbucket_rest_api/null_encoder'
+
+require 'bitbucket_rest_api/request/verbs'
+
 require 'bitbucket_rest_api/api/actions'
-require 'bitbucket_rest_api/api_factory'
+require 'bitbucket_rest_api/api/factory'
+require 'bitbucket_rest_api/api/arguments'
 
 module BitBucket
   class API
+    extend BitBucket::ClassMethods
+    include Constants
     include Authorization
-    include Connection
-    include Request
+    include Request::Verbs
 
     # TODO consider these optional in a stack
     include Validations
     include ParameterFilter
     include Normalizer
 
-    attr_reader *Configuration::VALID_OPTIONS_KEYS
+    @version = '1.0'
+
+    attr_reader *BitBucket.configuration.property_names
 
-    attr_accessor *VALID_API_KEYS
+    attr_accessor *Validations::VALID_API_KEYS
+
+    attr_accessor :current_options
 
     # Callback to update global configuration options
     class_eval do
-      Configuration::VALID_OPTIONS_KEYS.each do |key|
+      BitBucket.configuration.property_names.each do |key|
         define_method "#{key}=" do |arg|
           self.instance_variable_set("@#{key}", arg)
-          BitBucket.send("#{key}=", arg)
+          self.current_options.merge!({:"#{key}" => arg})
         end
       end
     end
@@ -38,15 +45,22 @@ module BitBucket
     # Creates new API
     def initialize(options={}, &block)
       super()
-      setup options
-      set_api_client
+      setup(options)
+      yield_or_eval(&block) if block_given?
+    end
 
-      self.instance_eval(&block) if block_given?
+    def yield_or_eval(&block)
+      return unless block
+      block.arity > 0 ? yield(self) : self.instance_eval(&block)
     end
 
     def setup(options={})
-      options = BitBucket.options.merge(options)
-      Configuration::VALID_OPTIONS_KEYS.each do |key|
+      options = BitBucket.configuration.fetch.merge(options)
+      self.current_options = options
+      if self.class.instance_variable_get('@version') == '2.0'
+        options[:endpoint] = BitBucket.endpoint.gsub(/\/api\/[0-9.]+/, "/api/2.0")
+      end
+      BitBucket.configuration.property_names.each do |key|
         send("#{key}=", options[key])
       end
       process_basic_auth(options[:basic_auth])
@@ -80,6 +94,99 @@ module BitBucket
       end
     end
 
+     # Acts as setter and getter for api requests arguments parsing.
+    #
+    # Returns Arguments instance.
+    #
+    def arguments(args=(not_set = true), options={}, &block)
+      if not_set
+        @arguments
+      else
+        @arguments = Arguments.new(options.merge!(api: self)).parse(*args, &block)
+      end
+    end
+
+    # Scope for passing request required arguments.
+    #
+    def with(args)
+      case args
+      when Hash
+        set args
+      when /.*\/.*/i
+        user, repo = args.split('/')
+        set :user => user, :repo => repo
+      else
+        ::Kernel.raise ArgumentError, 'This api does not support passed in arguments'
+      end
+    end
+
+    # Set a configuration option for a given namespace
+    #
+    # @param [String] option
+    # @param [Object] value
+    # @param [Boolean] ignore_setter
+    #
+    # @return [self]
+    #
+    # @api public
+    def set(option, value=(not_set=true), ignore_setter=false, &block)
+      raise ArgumentError, 'value not set' if block and !not_set
+      return self if !not_set and value.nil?
+
+      if not_set
+        set_options option
+        return self
+      end
+
+      if respond_to?("#{option}=") and not ignore_setter
+        return __send__("#{option}=", value)
+      end
+
+      define_accessors option, value
+      self
+    end
+
+    # Defines a namespace
+    #
+    # @param [Array[Symbol]] names
+    #   the name for the scope
+    #
+    # @return [self]
+    #
+    # @api public
+    def self.namespace(*names)
+      options = names.last.is_a?(Hash) ? names.pop : {}
+      names   = names.map(&:to_sym)
+      name    = names.pop
+      return if public_method_defined?(name)
+
+      class_name = extract_class_name(name, options)
+      define_method(name) do |*args, &block|
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        API::Factory.new(class_name, current_options.merge(options), &block)
+      end
+      self
+    end
+
+    # Extracts class name from options
+    #
+    # @param [Hash] options
+    # @option options [String] :full_name
+    #   the full name for the class
+    # @option options [Boolean] :root
+    #   if the class is at the root or not
+    #
+    # @return [String]
+    #
+    # @api private
+    def self.extract_class_name(name, options)
+      converted  = options.fetch(:full_name, name).to_s
+      converted  = converted.split('_').map(&:capitalize).join
+      class_name = options.fetch(:root, false) ? '': "#{self.name}::"
+      class_name += converted
+      class_name
+    end
+
     def _update_user_repo_params(user_name, repo_name=nil) # :nodoc:
       self.user = user_name || self.user
       self.repo = repo_name || self.repo
@@ -93,27 +200,42 @@ module BitBucket
       { 'user' => self.user, 'repo' => self.repo }.merge!(params)
     end
 
-    # TODO: See whether still needed, consider adding to core_exts
-    def _hash_traverse(hash, &block)
-      hash.each do |key, val|
-        block.call(key)
-        case val
-        when Hash
-          val.keys.each do |k|
-            _hash_traverse(val, &block)
-          end
-        when Array
-          val.each do |item|
-            _hash_traverse(item, &block)
-          end
-        end
+
+    private
+
+    # Set multiple options
+    #
+    # @api private
+    def set_options(options)
+      unless options.respond_to?(:each)
+        raise ArgumentError, 'cannot iterate over value'
       end
-      return hash
+      options.each { |key, value| set(key, value) }
+    end
+
+    # Define setters and getters
+    #
+    # @api private
+    def define_accessors(option, value)
+      setter = proc { |val|  set option, val, true }
+      getter = proc { value }
+
+      define_singleton_method("#{option}=", setter) if setter
+      define_singleton_method(option, getter) if getter
     end
 
-    def _merge_mime_type(resource, params) # :nodoc:
-                                           #       params['resource'] = resource
-                                           #       params['mime_type'] = params['mime_type'] || :raw
+    # Dynamically define a method for setting request option
+    #
+    # @api private
+    def define_singleton_method(method_name, content=Proc.new)
+      (class << self; self; end).class_eval do
+        undef_method(method_name) if method_defined?(method_name)
+        if String === content
+          class_eval("def #{method_name}() #{content}; end")
+        else
+          define_method(method_name, &content)
+        end
+      end
     end
 
   end # API

data/lib/bitbucket_rest_api/{invitations.rb → client/invitations.rb}

@@ -1,15 +1,16 @@
 # encoding: utf-8
 
 module BitBucket
-  class Invitations < API
+  class Client::Invitations < API
+    @version = '1.0'
+
     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("/invitations/#{user}/#{repo.downcase}/#{emailaddress}",
-                   permission: perm)
+      post_request("/invitations/#{user}/#{repo.downcase}/#{emailaddress}", permission: perm)
     end
   end
 end

data/lib/bitbucket_rest_api/{issues → client/issues}/comments.rb

@@ -1,17 +1,13 @@
 # encoding: utf-8
 
 module BitBucket
-  class Issues::Comments < API
+  class Client::Issues::Comments < API
+    @version = '1.0'
 
     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
@@ -25,7 +21,6 @@ module BitBucket
       _validate_presence_of issue_id
 
       normalize! params
-      # _merge_mime_type(:issue_comment, params)
 
       response = get_request("/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}/comments/", params)
       return response unless block_given?
@@ -45,7 +40,6 @@ module BitBucket
       _validate_presence_of comment_id
 
       normalize! params
-      # _merge_mime_type(:issue_comment, params)
 
       get_request("/repositories/#{user}/#{repo.downcase}/issues/comments/#{comment_id}", params)
     end
@@ -67,7 +61,6 @@ module BitBucket
       _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)
 
@@ -90,7 +83,6 @@ module BitBucket
       _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)
 
@@ -109,7 +101,6 @@ module BitBucket
       _validate_presence_of comment_id
 
       normalize! params
-      # _merge_mime_type(:issue_comment, params)
 
       delete_request("/repositories/#{user}/#{repo.downcase}/issues/comments/#{comment_id}", params)
     end

data/lib/bitbucket_rest_api/{issues → client/issues}/components.rb

@@ -1,14 +1,11 @@
 # encoding: utf-8
 
 module BitBucket
-  class Issues::Components < API
+  class Client::Issues::Components < API
+    @version = '1.0'
 
     VALID_COMPONENT_INPUTS = %w[ name ].freeze
 
-    # Creates new Issues::Components API
-    def initialize(options = {})
-      super(options)
-    end
     # List all components for a repository
     #
     # = Examples
@@ -103,4 +100,4 @@ module BitBucket
     end
 
   end # Issues::Components
-end # BitBucket
+end # BitBucket

data/lib/bitbucket_rest_api/{issues → client/issues}/milestones.rb

@@ -1,17 +1,13 @@
 # encoding: utf-8
 
 module BitBucket
-  class Issues::Milestones < API
+  class Client::Issues::Milestones < API
+    @version = '1.0'
 
     VALID_MILESTONE_INPUTS = %w[
       name
     ].freeze # :nodoc:
 
-    # Creates new Issues::Milestones API
-    def initialize(options = {})
-      super(options)
-    end
-
     # List milestones for a repository
     #
     # = Examples
@@ -104,4 +100,4 @@ module BitBucket
     end
 
   end # Issues::Milestones
-end # BitBucket
+end # BitBucket

data/lib/bitbucket_rest_api/{issues.rb → client/issues.rb}

@@ -1,13 +1,13 @@
 # encoding: utf-8
 
 module BitBucket
-  class Issues < API
-    extend AutoloadHelper
+  class Client::Issues < API
+    @version = '1.0'
 
-    autoload_all 'bitbucket_rest_api/issues',
-                 :Comments   => 'comments',
-                 :Components => 'components',
-                 :Milestones => 'milestones'
+    require_all 'bitbucket_rest_api/client/issues',
+      'comments',
+      'components',
+      'milestones'
 
     VALID_ISSUE_PARAM_NAMES = %w[
       title
@@ -32,25 +32,14 @@ module BitBucket
         '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
+    namespace :comments
 
     # Access to Issues::Components API
-    def components
-      @components ||= ApiFactory.new 'Issues::Components'
-    end
+    namespace :components
 
     # Access to Issues::Milestones API
-    def milestones
-      @milestones ||= ApiFactory.new 'Issues::Milestones'
-    end
+    namespace :milestones
 
     # List issues for a repository
     #
@@ -79,7 +68,6 @@ module BitBucket
 
       normalize! params
       filter! VALID_ISSUE_PARAM_NAMES, params
-      # _merge_mime_type(:issue, params)
       assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
 
       response = get_request("/repositories/#{user}/#{repo.downcase}/issues", params)
@@ -101,7 +89,6 @@ module BitBucket
       _validate_presence_of issue_id
 
       normalize! params
-      # _merge_mime_type(:issue, params)
 
       get_request("/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}", params)
     end
@@ -120,7 +107,6 @@ module BitBucket
       _validate_presence_of issue_id
 
       normalize! params
-      # _merge_mime_type(:issue, params)
 
       delete_request("/repositories/#{user}/#{repo}/issues/#{issue_id}", params)
     end
@@ -169,7 +155,6 @@ module BitBucket
 
       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)
 
@@ -220,7 +205,6 @@ module BitBucket
       _validate_presence_of issue_id
 
       normalize! params
-      # _merge_mime_type(:issue, params)
       filter! VALID_ISSUE_PARAM_NAMES, params
 
       put_request("/repositories/#{user}/#{repo.downcase}/issues/#{issue_id}/", params)

data/lib/bitbucket_rest_api/{repos → client/repos}/changesets.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
 module BitBucket
-  class Repos::Changesets < API
+  class Client::Repos::Changesets < API
+    @version = '1.0'
 
     REQUIRED_COMMENT_PARAMS = %w[
         body
@@ -51,4 +52,4 @@ module BitBucket
     alias :find :get
 
   end # Repos::Commits
-end # BitBucket
+end # BitBucket

data/lib/bitbucket_rest_api/{repos → client/repos}/following.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
 module BitBucket
-  class Repos::Following < API
+  class Client::Repos::Following < API
+    @version = '1.0'
 
     # List repo followers
     #

data/lib/bitbucket_rest_api/{repos → client/repos}/keys.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
 module BitBucket
-  class Repos::Keys < API
+  class Client::Repos::Keys < API
+    @version = '1.0'
 
     VALID_KEY_PARAM_NAMES = %w[ label key ].freeze
 

data/lib/bitbucket_rest_api/client/repos/pull_requests/activity.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::PullRequests::Activity < API
+    @version = '2.0'
+
+    # Get the activity for a pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.activity 'user-name', 'repo-name', 'pull-request-id'
+    #
+    def list(user_name, repo_name, pull_request_id)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of pull_request_id
+
+      get_request("/repositories/#{user}/#{repo}/pullrequests/#{pull_request_id}/activity")
+    end
+    alias :all :list
+  end
+end

data/lib/bitbucket_rest_api/client/repos/pull_requests/comments.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::PullRequests::Comments < API
+    @version = '2.0'
+
+    # List comments on a pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.comments.all 'user-name', 'repo-name', 'pull-request-id'
+    #
+    def list(user_name, repo_name, pull_request_id)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of pull_request_id
+
+      response = get_request("/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/comments")
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Gets a single comment
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.pull_requests.comments.get 'user-name', 'repo-name', 'pull-request-id')
+    #
+    def get(user_name, repo_name, pull_request_id, comment_id)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of pull_request_id
+      _validate_presence_of comment_id
+
+      get_request("/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/comments/#{comment_id}")
+    end
+    alias :find :get
+  end
+end

data/lib/bitbucket_rest_api/client/repos/pull_requests/commits.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module BitBucket
+  class Client::Repos::PullRequests::Commits < API
+    @version = '2.0'
+
+    # List commits on a pull request
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.pull_requests.commits.all 'user-name', 'repo-name', 'pull-request-id'
+    #
+    def list(user_name, repo_name, pull_request_id)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of pull_request_id
+
+      response = get_request("/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/commits")
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+  end
+end