codeclimate-services 0.3.0

data/config/load.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require File.expand_path("../../lib/cc/services", __FILE__)

data/lib/axiom/types/password.rb

@@ -0,0 +1,7 @@
+class Axiom::Types::Password < Axiom::Types::String
+  def self.infer(object)
+    if object == Axiom::Types::Password
+      self
+    end
+  end
+end

data/lib/cc/formatters/linked_formatter.rb

@@ -0,0 +1,60 @@
+module CC
+  module Formatters
+    class LinkedFormatter < CC::Service::Formatter
+      def format_test
+        message = message_prefix
+        message << "This is a test of the #{service_title} service hook"
+      end
+
+      def format_coverage
+        message = message_prefix
+        message << "#{format_link(details_url, "Test coverage")}"
+        message << " has #{changed} to #{covered_percent}% (#{delta})"
+
+        if compare_url
+          message << " (#{format_link(compare_url, "Compare")})"
+        end
+
+        message
+      end
+
+      def format_quality
+        message = message_prefix
+        message << "#{format_link(details_url, constant_name)}"
+        message << " has #{changed} from #{previous_rating} to #{rating}"
+
+        if compare_url
+          message << " (#{format_link(compare_url, "Compare")})"
+        end
+
+        message
+      end
+
+      def format_vulnerability
+        message = message_prefix
+
+        if multiple?
+          message << "#{vulnerabilities.size} new"
+          message << " #{format_link(details_url, warning_type)}"
+          message << " issues found"
+        else
+          message << "New #{format_link(details_url, warning_type)}"
+          message << " issue found"
+          message << location_info
+        end
+
+        message
+      end
+
+      private
+
+      def format_link(url, text)
+        case options[:link_style]
+        when :html then "<a href=\"#{url}\">#{text}</a>"
+        when :wiki then "<#{url}|#{text}>"
+        else text
+        end
+      end
+    end
+  end
+end

data/lib/cc/formatters/plain_formatter.rb

@@ -0,0 +1,36 @@
+module CC
+  module Formatters
+    class PlainFormatter < CC::Service::Formatter
+      def format_test
+        message = message_prefix
+        message << "This is a test of the #{service_title} service hook"
+      end
+
+      def format_coverage
+        message = message_prefix
+        message << "#{emoji} Test coverage has #{changed}"
+        message << " to #{covered_percent}% (#{delta})."
+        message << " (#{details_url})"
+      end
+
+      def format_quality
+        message = message_prefix
+        message << "#{emoji} #{constant_name} has #{changed}"
+        message << " from #{previous_rating} to #{rating}."
+        message << " (#{details_url})"
+      end
+
+      def format_vulnerability
+        message = message_prefix
+
+        if multiple?
+          message << "#{vulnerabilities.size} new #{warning_type} issues found"
+        else
+          message << "New #{warning_type} issue found" << location_info
+        end
+
+        message << ". Details: #{details_url}"
+      end
+    end
+  end
+end

data/lib/cc/formatters/snapshot_formatter.rb

@@ -0,0 +1,101 @@
+module CC::Formatters
+  module SnapshotFormatter
+    # Simple Comparator for rating letters.
+    class Rating
+      include Comparable
+
+      def initialize(letter)
+        @letter = letter
+      end
+
+      def <=>(other)
+        other.to_s <=> to_s
+      end
+
+      def hash
+        @letter.hash
+      end
+
+      def eql?(other)
+        to_s == other.to_s
+      end
+
+      def inspect
+        "<Rating:#{to_s}>"
+      end
+
+      def to_s
+        @letter.to_s
+      end
+    end
+
+    C = Rating.new("C")
+    D = Rating.new("D")
+
+    # SnapshotFormatter::Base takes the quality information from the payload and divides it
+    # between alerts and improvements.
+    #
+    # The information in the payload must be a comparison in time between two quality reports, aka snapshot.
+    # This information is in the payload when the service receive a `receive_snapshot` and also
+    # when it receives a `receive_test`. In this latest case, the comparison is between today and seven days ago.
+    class Base
+      attr_reader :alert_constants_payload, :improved_constants_payload, :details_url, :compare_url
+
+      def initialize(payload)
+        new_constants = Array(payload["new_constants"])
+        changed_constants = Array(payload["changed_constants"])
+
+        alert_constants = new_constants.select(&new_constants_selector)
+        alert_constants += changed_constants.select(&decreased_constants_selector)
+
+        improved_constants = changed_constants.select(&improved_constants_selector)
+
+        data = {
+          "from" => { "commit_sha" => payload["previous_commit_sha"] },
+          "to"   => { "commit_sha" => payload["commit_sha"] }
+        }
+
+        @alert_constants_payload    = data.merge("constants" => alert_constants) if alert_constants.any?
+        @improved_constants_payload = data.merge("constants" => improved_constants) if improved_constants.any?
+      end
+
+    private
+
+      def new_constants_selector
+        Proc.new { |constant| to_rating(constant) < C }
+      end
+
+      def decreased_constants_selector
+        Proc.new { |constant| from_rating(constant) > D && to_rating(constant) < C }
+      end
+
+      def improved_constants_selector
+        Proc.new { |constant| from_rating(constant) < C && to_rating(constant) > from_rating(constant) }
+      end
+
+      def to_rating(constant)
+        Rating.new(constant["to"]["rating"])
+      end
+
+      def from_rating(constant)
+        Rating.new(constant["from"]["rating"])
+      end
+    end
+
+    # Override the base snapshot formatter for be more lax grouping information.
+    # This is useful to show more information for testing the service.
+    class Sample < Base
+      def new_constants_selector
+        Proc.new { |_| true }
+      end
+
+      def decreased_constants_selector
+        Proc.new { |constant| to_rating(constant) < from_rating(constant) }
+      end
+
+      def improved_constants_selector
+        Proc.new { |constant| to_rating(constant) > from_rating(constant) }
+      end
+    end
+  end
+end

data/lib/cc/formatters/ticket_formatter.rb

@@ -0,0 +1,27 @@
+module CC
+  module Formatters
+    class TicketFormatter < CC::Service::Formatter
+
+      def format_vulnerability_title
+        if multiple?
+          "#{vulnerabilities.size} new #{warning_type} issues found"
+        else
+          "New #{warning_type} issue found" << location_info
+        end
+      end
+
+      def format_vulnerability_body
+        if multiple?
+          "#{vulnerabilities.size} new #{warning_type} issues were found by Code Climate"
+        else
+          message = "A #{warning_type} vulnerability was found by Code Climate"
+          message << location_info
+        end
+
+        message << ".\n\n"
+        message << details_url
+      end
+
+    end
+  end
+end

data/lib/cc/helpers/coverage_helper.rb

@@ -0,0 +1,25 @@
+module CC::Service::CoverageHelper
+  def improved?
+    covered_percent_delta > 0
+  end
+
+  def delta
+    if improved?
+      "+#{covered_percent_delta.round(1)}%"
+    else
+      "#{covered_percent_delta.round(1)}%"
+    end
+  end
+
+  def covered_percent
+    payload.fetch("covered_percent", 0).round(1)
+  end
+
+  def previous_covered_percent
+    payload.fetch("previous_covered_percent", 0).round(1)
+  end
+
+  def covered_percent_delta
+    payload.fetch("covered_percent_delta", 0) # pre-rounded
+  end
+end

data/lib/cc/helpers/issue_helper.rb

@@ -0,0 +1,9 @@
+module CC::Service::IssueHelper
+  def constant_name
+    payload["constant_name"]
+  end
+
+  def issue
+    payload["issue"]
+  end
+end

data/lib/cc/helpers/quality_helper.rb

@@ -0,0 +1,44 @@
+module CC::Service::QualityHelper
+  def improved?
+    remediation_cost < previous_remediation_cost
+  end
+
+  def constant_name
+    payload["constant_name"]
+  end
+
+  def rating
+    with_article(payload["rating"])
+  end
+
+  def previous_rating
+    with_article(payload["previous_rating"])
+  end
+
+  def remediation_cost
+    payload.fetch("remediation_cost", 0)
+  end
+
+  def previous_remediation_cost
+    payload.fetch("previous_remediation_cost", 0)
+  end
+
+  def with_article(letter, bold = false)
+    letter ||= '?'
+
+    text = bold ? "*#{letter}*" : letter
+    if %w( A F ).include?(letter.to_s)
+      "an #{text}"
+    else
+      "a #{text}"
+    end
+  end
+
+  def constant_basename(name)
+    if name.include?(".")
+      File.basename(name)
+    else
+      name
+    end
+  end
+end

data/lib/cc/helpers/vulnerability_helper.rb

@@ -0,0 +1,31 @@
+module CC::Service::VulnerabilityHelper
+
+  def vulnerability
+    vulnerabilities.first || {}
+  end
+
+  def vulnerabilities
+    payload.fetch("vulnerabilities", [])
+  end
+
+  def multiple?
+    vulnerabilities.size > 1
+  end
+
+  def location_info
+    if vulnerability["location"]
+      " in #{vulnerability["location"]}"
+    else
+      ""
+    end
+  end
+
+  def warning_type
+    if multiple?
+      payload["warning_type"]
+    else
+      vulnerability["warning_type"]
+    end
+  end
+
+end

data/lib/cc/presenters/github_pull_requests_presenter.rb

@@ -0,0 +1,54 @@
+module CC
+  class Service
+    class GitHubPullRequestsPresenter
+      include ActiveSupport::NumberHelper
+
+      def initialize(payload)
+        issue_comparison_counts = payload["issue_comparison_counts"]
+
+        if issue_comparison_counts
+          @fixed_count = issue_comparison_counts["fixed"]
+          @new_count = issue_comparison_counts["new"]
+        end
+      end
+
+      def success_message
+        if both_issue_counts_zero?
+          "Code Climate didn't find any new or fixed issues."
+        else
+          "Code Climate found #{formatted_issue_counts}."
+        end
+      end
+
+    private
+
+      def both_issue_counts_zero?
+        issue_counts.all?(&:zero?)
+      end
+
+      def formatted_fixed_issues
+        if @fixed_count > 0
+          "#{number_to_delimited(@fixed_count)} fixed #{"issue".pluralize(@fixed_count)}"
+        else
+          nil
+        end
+      end
+
+      def formatted_new_issues
+        if @new_count > 0
+          "#{number_to_delimited(@new_count)} new #{"issue".pluralize(@new_count)}"
+        else
+          nil
+        end
+      end
+
+      def formatted_issue_counts
+        [formatted_new_issues, formatted_fixed_issues].compact.to_sentence
+      end
+
+      def issue_counts
+        [@new_count, @fixed_count]
+      end
+    end
+  end
+end

data/lib/cc/service/config.rb

@@ -0,0 +1,4 @@
+class CC::Service::Config
+  include Virtus.model
+  include ActiveModel::Validations
+end

data/lib/cc/service/formatter.rb

@@ -0,0 +1,34 @@
+require 'delegate'
+
+class CC::Service::Formatter < SimpleDelegator
+  attr_reader :options
+
+  def initialize(service, options = {})
+    super(service)
+
+    @options = {
+      prefix: "[Code Climate]",
+      prefix_with_repo: true
+    }.merge(options)
+  end
+
+  private
+
+  def service_title
+    __getobj__.class.title
+  end
+
+  def message_prefix
+    prefix = options.fetch(:prefix, "").to_s
+
+    if options[:prefix_with_repo]
+      prefix << "[#{repo_name}]"
+    end
+
+    if !prefix.empty?
+      prefix << " "
+    end
+
+    prefix
+  end
+end

data/lib/cc/service/helper.rb

@@ -0,0 +1,54 @@
+module CC::Service::Helper
+  GREEN_HEX = "#38ae6f"
+  RED_HEX   = "#ed2f00"
+
+  def repo_name
+    payload["repo_name"]
+  end
+
+  def details_url
+    payload["details_url"]
+  end
+
+  def compare_url
+    payload["compare_url"]
+  end
+
+  def emoji
+    if improved?
+      ":sunny:"
+    else
+      ":umbrella:"
+    end
+  end
+
+  def color
+    if improved?
+      "green"
+    else
+      "red"
+    end
+  end
+
+  def hex_color
+    if improved?
+      GREEN_HEX
+    else
+      RED_HEX
+    end
+  end
+
+  def changed
+    if improved?
+      "improved"
+    else
+      "declined"
+    end
+  end
+
+  def improved?
+    raise NotImplementedError,
+      "Event-specific helpers must define #{__method__}"
+  end
+
+end

data/lib/cc/service/http.rb

@@ -0,0 +1,87 @@
+require "active_support/concern"
+require "cc/service/response_check"
+
+module CC::Service::HTTP
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def default_http_options
+      @@default_http_options ||= {
+        adapter: :net_http,
+        request: { timeout: 10, open_timeout: 5 },
+        ssl:     { verify_depth: 5 },
+        headers: {}
+      }
+    end
+  end
+
+  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
+      req.headers.update(headers) if headers
+      yield req if block_given?
+    end
+  end
+
+  def raw_post(url = nil, body = nil, headers = nil)
+    block = Proc.new if block_given?
+    http_method :post, url, body, headers, &block
+  end
+
+  def http_method(method, url = nil, body = nil, headers = nil)
+    block = Proc.new if block_given?
+
+    http.send(method) do |req|
+      req.url(url)                if url
+      req.headers.update(headers) if headers
+      req.body = body             if body
+      block.call req if block
+    end
+  end
+
+  def http(options = {})
+    @http ||= begin
+      config = self.class.default_http_options
+      config.each do |key, sub_options|
+        next if key == :adapter
+        sub_hash = options[key] ||= {}
+        sub_options.each do |sub_key, sub_value|
+          sub_hash[sub_key] ||= sub_value
+        end
+      end
+      options[:ssl][:ca_file] ||= ca_file
+
+      Faraday.new(options) do |b|
+        b.use(CC::Service::ResponseCheck)
+        b.request(:url_encoded)
+        b.adapter(*Array(options[:adapter] || config[:adapter]))
+      end
+    end
+  end
+
+  # Gets the path to the SSL Certificate Authority certs.  These were taken
+  # from: http://curl.haxx.se/ca/cacert.pem
+  #
+  # Returns a String path.
+  def ca_file
+    @ca_file ||= ENV.fetch("CODECLIMATE_CA_FILE", File.expand_path('../../../../config/cacert.pem', __FILE__))
+  end
+
+end

data/lib/cc/service/invocation/invocation_chain.rb

@@ -0,0 +1,15 @@
+class CC::Service::Invocation
+  class InvocationChain
+    def initialize(&block)
+      @invocation = block
+    end
+
+    def wrap(klass, *args)
+      @invocation = klass.new(@invocation, *args)
+    end
+
+    def call
+      @invocation.call
+    end
+  end
+end

data/lib/cc/service/invocation/with_error_handling.rb

@@ -0,0 +1,45 @@
+class CC::Service::Invocation
+  class WithErrorHandling
+    def initialize(invocation, logger, prefix = nil)
+      @invocation = invocation
+      @logger = logger
+      @prefix = prefix
+    end
+
+    def call
+      @invocation.call
+    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(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 << " (#{e.class}) #{e.message}"
+      message << response_body
+    end
+  end
+end

data/lib/cc/service/invocation/with_metrics.rb

@@ -0,0 +1,37 @@
+class CC::Service::Invocation
+  class WithMetrics
+    def initialize(invocation, statsd, prefix = nil)
+      @invocation = invocation
+      @statsd = statsd
+      @prefix = prefix
+    end
+
+    def call
+      start_time = Time.now
+
+      result = @invocation.call
+      @statsd.increment(success_key)
+
+      result
+    rescue => ex
+      @statsd.increment(error_key(ex))
+      raise ex
+    ensure
+      duration = ((Time.now - start_time) * 1_000).round
+      @statsd.timing(timing_key, duration)
+    end
+
+    def success_key
+      ["services.invocations", @prefix].compact.join('.')
+    end
+
+    def timing_key
+      ["services.timing", @prefix].compact.join('.')
+    end
+
+    def error_key(ex)
+      error_string = ex.class.name.underscore.gsub("/", "-")
+      ["services.errors", @prefix, error_string].compact.join('.')
+    end
+  end
+end