Implement endpoints for webhooks

Add method to create webhooks

Add a console

adding BitBucket::Error::BadEvents class

adding POST and GET to ../hooks

adding BitBucket::Error::NoEvents class

improving accuracy of spec messages

adding #get and #edit for webhooks

1. refactoring webhooks_spec to fit inside ruler
2. included error handling when no events given

adding delete endpoint for webhooks

tidying up BitBucket::Repos::Webhooks class

adding blank value error

adding blank value error

adding method to validate presence of required fields in body

changing symbol to string

string keys and only validating string fields

validating presence of required keys and values for create and edit webhooks

moving code inside the 80c ruler

drying up mock params into let statements

removing uneccessary newline

Author: rashmi-rathi

.gitignore

@@ -14,3 +14,4 @@ features/settings.yml
 TAGS
 .tags_sorted_by_file
 coverage
+.rspec

.rspec

@@ -1 +1 @@
---color
+--color -fd

bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'bitbucket_rest_api'
+
+require 'pry'
+Pry.start

lib/bitbucket_rest_api/error.rb

@@ -30,6 +30,9 @@ def initialize(message)
   invalid_options
   required_params
   unknown_value
+  bad_events
+  no_events
+  blank_value
 ].each do |error|
   require "bitbucket_rest_api/error/#{error}"
 end

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

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

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

lib/bitbucket_rest_api/repos.rb

@@ -14,6 +14,7 @@ class Repos < API
                  :Forks       => 'forks',
                  :Commits =>'commits',
                  :Download=>'download',
+                 :Webhooks => 'webhooks',
                  :PullRequest    => 'pull_request'
 
     DEFAULT_REPO_OPTIONS = {

lib/bitbucket_rest_api/repos/webhooks.rb

@@ -0,0 +1,96 @@
+module BitBucket
+  class Repos::Webhooks < API
+    EVENTS =  [
+      'repo:push',
+      'repo:fork',
+      'repo:commit_comment_created',
+      'repo:commit_status_created',
+      'repo:commit_status_updated',
+      'issue:created',
+      'issue:updated',
+      'issue:comment_created',
+      'pullrequest:created',
+      'pullrequest:updated',
+      'pullrequest:approved',
+      'pullrequest:unapproved',
+      'pullrequest:fulfilled',
+      'pullrequest:rejected',
+      'pullrequest:comment_created',
+      'pullrequest:comment_updated',
+      'pullrequest:comment_deleted'
+    ]
+
+    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
+      assert_required_keys(%w[description url active events], params)
+      _validate_given_events(params)
+      assert_required_values_present(
+        params,
+        'description',
+        'url',
+        'active',
+        'events'
+      )
+
+      post_request("2.0/repositories/#{user_name}/#{repo_name}/hooks", params)
+    end
+
+    def list(user_name, repo_name)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      get_request("2.0/repositories/#{user_name}/#{repo_name}/hooks")
+    end
+
+    def get(user_name, repo_name, hook_uuid)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      get_request(
+        "2.0/repositories/#{user_name}/#{repo_name}/hooks/#{hook_uuid}"
+      )
+    end
+
+    def edit(user_name, repo_name, hook_uuid, params = {})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+      assert_required_keys(%w[description url active events], params)
+      _validate_given_events(params)
+      assert_required_values_present(
+        params,
+        'description',
+        'url',
+        'active',
+        'events'
+      )
+
+      put_request(
+        "2.0/repositories/#{user_name}/#{repo_name}/hooks/#{hook_uuid}",
+        params
+      )
+    end
+
+    def delete(user_name, repo_name, hook_uuid)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      delete_request(
+        "2.0/repositories/#{user_name}/#{repo_name}/hooks/#{hook_uuid}"
+      )
+    end
+
+    private
+    def _validate_given_events(params)
+      given_events = params['events']
+      raise BitBucket::Error::NoEvents if given_events.empty?
+      given_events.each do |k|
+        unless EVENTS.include?(k)
+          raise BitBucket::Error::BadEvents, k
+        end
+      end
+    end
+  end
+end

lib/bitbucket_rest_api/validations/required.rb

@@ -19,6 +19,26 @@ def assert_required_keys(required, provided)
         result
       end
 
+      # Validate that required values are not blank
+      # the *required are colon separated strings
+      # e.g. 'source:branch:name' tests value of params[:source][:branch][:name]
+      #
+      def assert_required_values_present(params, *required)
+        required.each do |encoded_string|
+          keys = parse_values(encoded_string)
+          value = keys.inject(params) { |params, key| params[key] }
+          if value.is_a?(String)
+            if value.empty?
+              raise BitBucket::Error::BlankValue.new(encoded_string)
+            end
+          end
+        end
+      end
+
+      def parse_values(string)
+        string.split(':')
+      end
+
     end # Required
   end # Validations
 end # BitBucket