Merge pull request #52 from codeclimate/jy-http-calls-return-useful-data

Services return the HTTP call's status

Author: noahd1

lib/cc/service.rb

@@ -87,7 +87,7 @@ def receive
         end
       end
 
-      nil
+      { ok: false, message: "No service handler found" }
     end
 
     private

lib/cc/service/http.rb

@@ -15,7 +15,23 @@ def default_http_options
     end
   end
 
-  def http_get(url = nil, params = nil, headers = nil)
+  def service_get(url = nil, body = nil, headers = nil, &block)
+    raw_get(url, body, headers, &block)
+  end
+
+  def service_post(url, body = nil, headers = nil, &block)
+    block ||= lambda{|*args| Hash.new }
+    response = raw_post(url, body, headers)
+    {
+      ok: response.success?,
+      params: body.as_json,
+      endpoint_url: url,
+      status: response.status,
+      message: "Success"
+    }.merge(block.call(response))
+  end
+
+  def raw_get(url = nil, params = nil, headers = nil)
     http.get do |req|
       req.url(url)                if url
       req.params.update(params)   if params
@@ -24,7 +40,7 @@ def http_get(url = nil, params = nil, headers = nil)
     end
   end
 
-  def http_post(url = nil, body = nil, headers = nil)
+  def raw_post(url = nil, body = nil, headers = nil)
     block = Proc.new if block_given?
     http_method :post, url, body, headers, &block
   end

lib/cc/service/invocation/with_error_handling.rb

@@ -8,24 +8,37 @@ def initialize(invocation, logger, prefix = nil)
 
     def call
       @invocation.call
-    rescue => ex
-      @logger.error(error_message(ex))
-
-      nil
+    rescue CC::Service::HTTPError => e
+      @logger.error(error_message(e))
+      {
+        ok: false,
+        params: e.params,
+        status: e.status,
+        endpoint_url: e.endpoint_url,
+        message: e.user_message || e.message,
+        log_message: error_message(e)
+      }
+    rescue => e
+      @logger.error(error_message(e))
+      {
+        ok: false,
+        message: e.message,
+        log_message: error_message(e)
+      }
     end
 
     private
 
-    def error_message(ex)
-      if ex.respond_to?(:response_body)
-        response_body = ". Response: <#{ex.response_body.inspect}>"
+    def error_message(e)
+      if e.respond_to?(:response_body)
+        response_body = ". Response: <#{e.response_body.inspect}>"
       else
         response_body = ""
       end
 
       message  = "Exception invoking service:"
       message << " [#{@prefix}]" if @prefix
-      message << " (#{ex.class}) #{ex.message}"
+      message << " (#{e.class}) #{e.message}"
       message << response_body
     end
   end

lib/cc/service/response_check.rb

@@ -1,10 +1,13 @@
 class CC::Service
   class HTTPError < StandardError
-    attr_reader :response_body, :status
+    attr_reader :response_body, :status, :params, :endpoint_url
+    attr_accessor :user_message
 
     def initialize(message, env)
       @response_body = env[:body]
       @status        = env[:status]
+      @params        = env[:params]
+      @endpoint_url  = env[:url]
 
       super(message)
     end

lib/cc/services/asana.rb

@@ -14,21 +14,24 @@ class Config < CC::Service::Config
     validates :workspace_id, presence: true
   end
 
+  ENDPOINT = "https://app.asana.com/api/1.0/tasks"
+
   self.title = "Asana"
   self.description = "Create tasks in Asana"
   self.issue_tracker = true
 
   def receive_test
     result = create_task("Test task from Code Climate")
-
-    {
-      ok: true,
-      message: "Ticked <a href='#{result[:url]}'>#{result[:id]}</a> created."
-    }
-  rescue => ex
-    { ok: false, message: ex.message }
+    result.merge(
+      message: "Ticket <a href='#{result[:url]}'>#{result[:id]}</a> created."
+    )
+  rescue CC::Service::HTTPError => ex
+    body = JSON.parse(ex.response_body)
+    ex.user_message = body["errors"].map{|e| e["message"] }.join(" ")
+    raise ex
   end
 
+
   def receive_quality
     title = "Refactor #{constant_name} from #{rating} on Code Climate"
 
@@ -45,6 +48,18 @@ def receive_vulnerability
 private
 
   def create_task(name)
+    params = generate_params(name)
+    authenticate_http
+    http.headers["Content-Type"] = "application/json"
+    service_post(ENDPOINT, params.to_json) do |response|
+      body = JSON.parse(response.body)
+      id = body['data']['id']
+      url = "https://app.asana.com/0/#{config.workspace_id}/#{id}"
+      { id: id, url: url }
+    end
+  end
+
+  def generate_params(name)
     params = {
       data: { workspace: config.workspace_id, name: name }
     }
@@ -58,18 +73,11 @@ def create_task(name)
       params[:data][:assignee] = config.assignee
     end
 
-    http.headers["Content-Type"] = "application/json"
-    http.basic_auth(config.api_key, "")
-
-    url = "https://app.asana.com/api/1.0/tasks"
-    res = http_post(url, params.to_json)
-
-    body = JSON.parse(res.body)
-
-    id = body['data']['id']
-    url = "https://app.asana.com/0/#{config.workspace_id}/#{id}"
+    params
+  end
 
-    { id: id, url: url }
+  def authenticate_http
+    http.basic_auth(config.api_key, "")
   end
 
 end

lib/cc/services/campfire.rb

@@ -15,11 +15,9 @@ class Config < CC::Service::Config
   self.description = "Send messages to a Campfire chat room"
 
   def receive_test
-    speak(formatter.format_test)
-
-    { ok: true, message: "Test message sent" }
-  rescue => ex
-    { ok: false, message: ex.message }
+    speak(formatter.format_test).merge(
+      message: "Test message sent"
+    )
   end
 
   def receive_coverage
@@ -42,10 +40,10 @@ def formatter
 
   def speak(line)
     http.headers['Content-Type']  = 'application/json'
-    body = { message: { body: line } }
+    params = { message: { body: line } }
 
     http.basic_auth(config.token, "X")
-    http_post(speak_uri, body.to_json)
+    service_post(speak_uri, params.to_json)
   end
 
   def speak_uri

lib/cc/services/flowdock.rb

@@ -13,11 +13,9 @@ class Config < CC::Service::Config
   self.description = "Send messages to a Flowdock inbox"
 
   def receive_test
-    notify("Test", repo_name, formatter.format_test)
-
-    { ok: true, message: "Test message sent" }
-  rescue => ex
-    { ok: false, message: ex.message }
+    notify("Test", repo_name, formatter.format_test).merge(
+      message: "Test message sent"
+    )
   end
 
   def receive_coverage
@@ -57,6 +55,7 @@ def notify(subject, project, content)
 
     url = "#{BASE_URL}/messages/team_inbox/#{config.api_token}"
     http.headers["User-Agent"] = "Code Climate"
-    http_post(url, params)
+
+    service_post(url, params)
   end
 end

lib/cc/services/github_issues.rb

@@ -21,13 +21,13 @@ class Config < CC::Service::Config
 
   def receive_test
     result = create_issue("Test ticket from Code Climate", "")
-
-    {
-      ok: true,
+    result.merge(
       message: "Issue <a href='#{result[:url]}'>##{result[:number]}</a> created."
-    }
-  rescue => ex
-    { ok: false, message: ex.message }
+    )
+  rescue CC::Service::HTTPError => e
+    body = JSON.parse(e.response_body)
+    e.user_message = body["message"]
+    raise e
   end
 
   def receive_quality
@@ -59,15 +59,14 @@ def create_issue(title, issue_body)
     http.headers["User-Agent"] = "Code Climate"
 
     url = "#{BASE_URL}/repos/#{config.project}/issues"
-    res = http_post(url, params.to_json)
-
-    body = JSON.parse(res.body)
-
-    {
-      id:     body["id"],
-      number: body["number"],
-      url:    body["html_url"]
-    }
+    service_post(url, params.to_json) do |response|
+      body = JSON.parse(response.body)
+      {
+        id: body["id"],
+        number: body["number"],
+        url: body["html_url"]
+      }
+    end
   end
 
 end