codeclimate-services 0.3.0

data/lib/cc/services/github_pull_requests.rb

@@ -0,0 +1,210 @@
+require "cc/presenters/github_pull_requests_presenter"
+
+class CC::Service::GitHubPullRequests < CC::Service
+  class Config < CC::Service::Config
+    attribute :oauth_token, String,
+      label: "OAuth Token",
+      description: "A personal OAuth token with permissions for the repo. The owner of the token will be the author of the pull request comment."
+    attribute :update_status, Boolean,
+      label: "Update status?",
+      description: "Update the pull request status after analyzing?"
+    attribute :add_comment, Boolean,
+      label: "Add a comment?",
+      description: "Comment on the pull request after analyzing?"
+
+    validates :oauth_token, presence: true
+  end
+
+  self.title = "GitHub Pull Requests"
+  self.description = "Update pull requests on GitHub"
+
+  BASE_URL = "https://api.github.com"
+  BODY_REGEX = %r{<b>Code Climate</b> has <a href=".*">analyzed this pull request</a>}
+  COMMENT_BODY = '<img src="https://codeclimate.com/favicon.png" width="20" height="20" />&nbsp;<b>Code Climate</b> has <a href="%s">analyzed this pull request</a>.'
+  MESSAGES = [
+    DEFAULT_ERROR = "Code Climate encountered an error attempting to analyze this pull request",
+  ]
+
+  # Just make sure we can access GH using the configured token. Without
+  # additional information (github-slug, PR number, etc) we can't test much
+  # else.
+  def receive_test
+    setup_http
+
+    if config.update_status && config.add_comment
+      receive_test_status
+      receive_test_comment
+    elsif config.update_status
+      receive_test_status
+    elsif config.add_comment
+      receive_test_comment
+    else
+      simple_failure("Nothing happened")
+    end
+  end
+
+  def receive_pull_request
+    setup_http
+    state = @payload["state"]
+
+    if %w[pending success failure skipped error].include?(state)
+      send("update_status_#{state}")
+    else
+      @response = simple_failure("Unknown state")
+    end
+
+    response
+  end
+
+private
+
+  def simple_failure(message)
+    { ok: false, message: message }
+  end
+
+  def response
+    @response || simple_failure("Nothing happened")
+  end
+
+  def update_status_skipped
+    update_status(
+      "success",
+      "Code Climate has skipped analysis of this commit."
+    )
+  end
+
+  def update_status_success
+    add_comment
+    update_status("success", presenter.success_message)
+  end
+
+  def update_status_failure
+    add_comment
+    update_status("failure", presenter.success_message)
+  end
+
+  def presenter
+    CC::Service::GitHubPullRequestsPresenter.new(@payload)
+  end
+
+  def update_status_error
+    update_status(
+      "error",
+      @payload["message"] || DEFAULT_ERROR
+    )
+  end
+
+  def update_status_pending
+    update_status("pending", "Code Climate is analyzing this code.")
+  end
+
+  def update_status(state, description)
+    if config.update_status
+      params = {
+        state:       state,
+        description: description,
+        target_url:  @payload["details_url"],
+        context:     "codeclimate"
+      }
+      if state == "error"
+        params.delete(:target_url)
+      end
+      @response = service_post(status_url, params.to_json)
+    end
+  end
+
+  def add_comment
+    if config.add_comment
+      if !comment_present?
+        body = {
+          body: COMMENT_BODY % @payload["compare_url"]
+        }.to_json
+
+        @response = service_post(comments_url, body) do |response|
+          doc = JSON.parse(response.body)
+          { id: doc["id"] }
+        end
+      else
+        @response = {
+          ok: true,
+          message: "Comment already present"
+        }
+      end
+    end
+  end
+
+  def receive_test_status
+    url = base_status_url("0" * 40)
+    params = {}
+    raw_post(url, params.to_json)
+  rescue CC::Service::HTTPError => e
+    if e.status == 422
+      {
+        ok: true,
+        params: params.as_json,
+        status: e.status,
+        endpoint_url: url,
+        message: "OAuth token is valid"
+      }
+    else
+      raise
+    end
+  end
+
+  def receive_test_comment
+    response = service_get(user_url)
+    if response_includes_repo_scope?(response)
+      { ok: true, message: "OAuth token is valid" }
+    else
+      { ok: false, message: "OAuth token requires 'repo' scope to post comments." }
+    end
+  rescue => ex
+    { ok: false, message: ex.message }
+  end
+
+  def comment_present?
+    response = service_get(comments_url)
+    comments = JSON.parse(response.body)
+
+    comments.any? { |comment| comment["body"] =~ BODY_REGEX }
+  end
+
+  def setup_http
+    http.headers["Content-Type"]  = "application/json"
+    http.headers["Authorization"] = "token #{config.oauth_token}"
+    http.headers["User-Agent"]    = "Code Climate"
+  end
+
+  def status_url
+    base_status_url(commit_sha)
+  end
+
+  def base_status_url(commit_sha)
+    "#{BASE_URL}/repos/#{github_slug}/statuses/#{commit_sha}"
+  end
+
+  def comments_url
+    "#{BASE_URL}/repos/#{github_slug}/issues/#{number}/comments"
+  end
+
+  def user_url
+    "#{BASE_URL}/user"
+  end
+
+  def github_slug
+    @payload.fetch("github_slug")
+  end
+
+  def commit_sha
+    @payload.fetch("commit_sha")
+  end
+
+  def number
+    @payload.fetch("number")
+  end
+
+  def response_includes_repo_scope?(response)
+    response.headers['x-oauth-scopes'] && response.headers['x-oauth-scopes'].split(/\s*,\s*/).include?("repo")
+  end
+
+end

data/lib/cc/services/hipchat.rb

@@ -0,0 +1,57 @@
+class CC::Service::HipChat < CC::Service
+  class Config < CC::Service::Config
+    attribute :auth_token, String,
+      description: "Your HipChat API auth token"
+
+    attribute :room_id, String,
+      description: "The ID or name of the HipChat chat room to send notifications to"
+
+    attribute :notify, Boolean, default: false,
+      description: "Should we trigger a notification for people in the room?"
+
+    validates :auth_token, presence: true
+    validates :room_id, presence: true
+  end
+
+  BASE_URL = "https://api.hipchat.com/v1"
+
+  self.description = "Send messages to a HipChat chat room"
+
+  def receive_test
+    speak(formatter.format_test, "green").merge(
+      message: "Test message sent"
+    )
+  end
+
+  def receive_coverage
+    speak(formatter.format_coverage, color)
+  end
+
+  def receive_quality
+    speak(formatter.format_quality, color)
+  end
+
+  def receive_vulnerability
+    speak(formatter.format_vulnerability, "red")
+  end
+
+  private
+
+  def formatter
+    CC::Formatters::LinkedFormatter.new(self, prefix: nil, link_style: :html)
+  end
+
+  def speak(message, color)
+    url = "#{BASE_URL}/rooms/message"
+    params = {
+      from:       "Code Climate",
+      message:    message,
+      auth_token: config.auth_token,
+      room_id:    config.room_id,
+      notify:     !!config.notify,
+      color:      color
+    }
+    service_post(url, params)
+  end
+
+end

data/lib/cc/services/jira.rb

@@ -0,0 +1,93 @@
+require 'base64'
+
+class CC::Service::Jira < CC::Service
+  class Config < CC::Service::Config
+    attribute :domain, String,
+      description: "Your JIRA host domain (e.g. yourjira.com:PORT, please exclude https://)"
+
+    attribute :username, String,
+      description: "Must exactly match the 'username' that appears on your JIRA profile page."
+
+    attribute :password, Password,
+      label: "JIRA password",
+      description: "Your JIRA password"
+
+    attribute :project_id, String,
+      description: "Your JIRA project ID number (located in your JIRA admin panel). Project must support 'task' issue types and contain only the default required fields."
+
+    attribute :labels, String,
+      description: "Which labels to add to issues, comma delimited"
+
+    validates :domain, presence: true
+    validates :username, presence: true
+    validates :password, presence: true
+    validates :project_id, presence: true
+  end
+
+  self.title = "JIRA"
+  self.description = "Create tickets in JIRA"
+  self.issue_tracker = true
+
+  def receive_test
+    result = create_ticket("Test ticket from Code Climate", "")
+    result.merge(
+      message: "Ticket <a href='#{result[:url]}'>#{result[:id]}</a> created."
+    )
+  end
+
+  def receive_quality
+    title = "Refactor #{constant_name} from #{rating} on Code Climate"
+
+    create_ticket(title, details_url)
+  end
+
+  def receive_issue
+    title = %{Fix "#{issue["check_name"]}" issue in #{constant_name}}
+
+    body = [issue["description"], details_url].join("\n\n")
+
+    create_ticket(title, body)
+  end
+
+  def receive_vulnerability
+    formatter = CC::Formatters::TicketFormatter.new(self)
+
+    create_ticket(
+      formatter.format_vulnerability_title,
+      formatter.format_vulnerability_body
+    )
+  end
+
+private
+
+  def create_ticket(title, ticket_body)
+    params = {
+      fields:
+        {
+          project: { id: config.project_id },
+          summary: title,
+          description: ticket_body,
+          issuetype: { name: "Task" }
+        }
+    }
+
+    if config.labels.present?
+      params[:fields][:labels] = config.labels.split(",")
+    end
+
+    http.headers["Content-Type"] = "application/json"
+    http.basic_auth(config.username, config.password)
+
+    url = "https://#{config.domain}/rest/api/2/issue/"
+
+    service_post(url, params.to_json) do |response|
+      body = JSON.parse(response.body)
+      {
+        id: body["id"],
+        key: body["key"],
+        url: body["self"]
+      }
+    end
+  end
+
+end

data/lib/cc/services/lighthouse.rb

@@ -0,0 +1,79 @@
+class CC::Service::Lighthouse < CC::Service
+  class Config < CC::Service::Config
+    attribute :subdomain, String,
+      description: "Your Lighthouse subdomain"
+
+    attribute :api_token, String,
+      label: "API Token",
+      description: "Your Lighthouse API Key (http://help.lighthouseapp.com/kb/api/how-do-i-get-an-api-token)"
+
+    attribute :project_id, String,
+      description: "Your Lighthouse project ID. You can find this from the URL to your Lighthouse project."
+
+    attribute :tags, String,
+      description: "Which tags to add to tickets, comma delimited"
+
+    validates :subdomain, presence: true
+    validates :api_token, presence: true
+    validates :project_id, presence: true
+  end
+
+  self.title = "Lighthouse"
+  self.description = "Create tickets in Lighthouse"
+  self.issue_tracker = true
+
+  def receive_test
+    result = create_ticket("Test ticket from Code Climate", "")
+    result.merge(
+      message: "Ticket <a href='#{result[:url]}'>#{result[:id]}</a> created."
+    )
+  end
+
+  def receive_quality
+    title = "Refactor #{constant_name} from #{rating} on Code Climate"
+
+    create_ticket(title, details_url)
+  end
+
+  def receive_issue
+    title = %{Fix "#{issue["check_name"]}" issue in #{constant_name}}
+
+    body = [issue["description"], details_url].join("\n\n")
+
+    create_ticket(title, body)
+  end
+
+  def receive_vulnerability
+    formatter = CC::Formatters::TicketFormatter.new(self)
+
+    create_ticket(
+      formatter.format_vulnerability_title,
+      formatter.format_vulnerability_body
+    )
+  end
+
+private
+
+  def create_ticket(title, ticket_body)
+    params = { ticket: { title: title, body: ticket_body } }
+
+    if config.tags.present?
+      params[:ticket][:tags] = config.tags.strip
+    end
+
+    http.headers["X-LighthouseToken"] = config.api_token
+    http.headers["Content-Type"] = "application/json"
+
+    base_url = "https://#{config.subdomain}.lighthouseapp.com"
+    url = "#{base_url}/projects/#{config.project_id}/tickets.json"
+
+    service_post(url, params.to_json) do |response|
+      body = JSON.parse(response.body)
+      {
+        id: body["ticket"]["number"],
+        url: body["ticket"]["url"],
+      }
+    end
+  end
+
+end

data/lib/cc/services/pivotal_tracker.rb

@@ -0,0 +1,78 @@
+class CC::Service::PivotalTracker < CC::Service
+  class Config < CC::Service::Config
+    attribute :api_token, String,
+      description: "Your Pivotal Tracker API Token, from your profile page"
+
+    attribute :project_id, String,
+      description: "Your Pivotal Tracker project ID"
+
+    attribute :labels, String,
+      label: "Labels (comma separated)",
+      description: "Comma separated list of labels to apply to the story"
+
+    validates :api_token, presence: true
+    validates :project_id, presence: true
+  end
+
+  self.title = "Pivotal Tracker"
+  self.description = "Create stories on Pivotal Tracker"
+  self.issue_tracker = true
+
+  BASE_URL = "https://www.pivotaltracker.com/services/v3"
+
+  def receive_test
+    result = create_story("Test ticket from Code Climate", "")
+    result.merge(
+      message: "Ticket <a href='#{result[:url]}'>#{result[:id]}</a> created."
+    )
+  end
+
+  def receive_quality
+    name = "Refactor #{constant_name} from #{rating} on Code Climate"
+
+    create_story(name, details_url)
+  end
+
+  def receive_issue
+    title = %{Fix "#{issue["check_name"]}" issue in #{constant_name}}
+
+    body = [issue["description"], details_url].join("\n\n")
+
+    create_story(title, body)
+  end
+
+  def receive_vulnerability
+    formatter = CC::Formatters::TicketFormatter.new(self)
+
+    create_story(
+      formatter.format_vulnerability_title,
+      formatter.format_vulnerability_body
+    )
+  end
+
+private
+
+  def create_story(name, description)
+    params = {
+      "story[name]"        => name,
+      "story[story_type]"  => "chore",
+      "story[description]" => description,
+    }
+
+    if config.labels.present?
+      params["story[labels]"] = config.labels.strip
+    end
+
+    http.headers["X-TrackerToken"] = config.api_token
+    url = "#{BASE_URL}/projects/#{config.project_id}/stories"
+
+    service_post(url, params) do |response|
+      body = Nokogiri::XML(response.body)
+      {
+        id: (body / "story/id").text,
+        url: (body / "story/url").text
+      }
+    end
+  end
+
+end

data/lib/cc/services/slack.rb

@@ -0,0 +1,124 @@
+ # encoding: UTF-8
+
+class CC::Service::Slack < CC::Service
+  include CC::Service::QualityHelper
+
+  class Config < CC::Service::Config
+    attribute :webhook_url, String,
+      label: "Webhook URL",
+      description: "The Slack webhook URL you would like message posted to"
+
+    attribute :channel, String,
+      description: "The channel to send to (optional). Enter # before the channel name."
+  end
+
+  self.description = "Send messages to a Slack channel"
+
+  def receive_test
+    # payloads for test receivers include the weekly quality report.
+    send_snapshot_to_slack(CC::Formatters::SnapshotFormatter::Sample.new(payload))
+    speak(formatter.format_test).merge(
+      message: "Test message sent"
+    )
+  end
+
+  def receive_snapshot
+    send_snapshot_to_slack(CC::Formatters::SnapshotFormatter::Base.new(payload))
+  end
+
+  def receive_coverage
+    speak(formatter.format_coverage, hex_color)
+  end
+
+  def receive_vulnerability
+    speak(formatter.format_vulnerability)
+  end
+
+  private
+
+  def formatter
+    CC::Formatters::LinkedFormatter.new(self, prefix: nil, link_style: :wiki)
+  end
+
+  def speak(message, color = nil)
+    params = { attachments: [{
+      color: color,
+      fallback: message,
+      fields: [{ value: message }],
+      mrkdwn_in: ["fields", "fallback"]
+    }]}
+
+    if config.channel
+      params[:channel] = config.channel
+    end
+
+    http.headers['Content-Type']  = 'application/json'
+    url = config.webhook_url
+
+    service_post(url, params.to_json) do |response|
+      {
+        ok: response.body == "ok",
+        message: response.body
+      }
+    end
+  end
+
+  def send_snapshot_to_slack(snapshot)
+    if snapshot.alert_constants_payload
+      @response = speak(alerts_message(snapshot.alert_constants_payload), RED_HEX)
+    end
+
+    if snapshot.improved_constants_payload
+      @response = speak(improvements_message(snapshot.improved_constants_payload), GREEN_HEX)
+    end
+
+    @response || { ok: false, ignored: true, message: "No changes in snapshot" }
+  end
+
+  def alerts_message(constants_payload)
+    constants = constants_payload["constants"]
+    message = ["Quality alert triggered for *#{repo_name}* (<#{compare_url}|Compare>)\n"]
+
+    constants[0..2].each do |constant|
+      object_identifier = constant_basename(constant["name"])
+
+      if constant["from"]
+        from_rating = constant["from"]["rating"]
+        to_rating   = constant["to"]["rating"]
+
+        message << "• _#{object_identifier}_ just declined from #{with_article(from_rating, :bold)} to #{with_article(to_rating, :bold)}"
+      else
+        rating = constant["to"]["rating"]
+
+        message << "• _#{object_identifier}_ was just created and is #{with_article(rating, :bold)}"
+      end
+    end
+
+    if constants.size > 3
+      remaining = constants.size - 3
+      message << "\nAnd <#{details_url}|#{remaining} other #{"change".pluralize(remaining)}>"
+    end
+
+    message.join("\n")
+  end
+
+  def improvements_message(constants_payload)
+    constants = constants_payload["constants"]
+    message = ["Quality improvements in *#{repo_name}* (<#{compare_url}|Compare>)\n"]
+
+    constants[0..2].each do |constant|
+      object_identifier = constant_basename(constant["name"])
+      from_rating = constant["from"]["rating"]
+      to_rating   = constant["to"]["rating"]
+
+      message << "• _#{object_identifier}_ just improved from #{with_article(from_rating, :bold)} to #{with_article(to_rating, :bold)}"
+    end
+
+    if constants.size > 3
+      remaining = constants.size - 3
+      message << "\nAnd <#{details_url}|#{remaining} other #{"improvement".pluralize(remaining)}>"
+    end
+
+    message.join("\n")
+  end
+end

data/lib/cc/services/version.rb

@@ -0,0 +1,5 @@
+module CC
+  module Services
+    VERSION = "0.3.0"
+  end
+end

data/lib/cc/services.rb

@@ -0,0 +1,9 @@
+require "cc/services/version"
+
+require "faraday"
+require "nokogiri"
+require "virtus"
+require "active_model"
+require "active_support/core_ext"
+
+require File.expand_path('../service', __FILE__)

data/pull_request_test.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+#
+# Ad-hoc script for updating a pull request using our service.
+#
+# Usage:
+#
+#   $ OAUTH_TOKEN="..." bundle exec ruby pull_request_test.rb
+#
+#     OAUTH_TOKEN: Personal GitHub access token
+#
+#         GitHub >
+#         Account settings >
+#         Applications >
+#         Personal access tokens >
+#         Generate new token
+#
+###
+require 'cc/services'
+CC::Service.load_services
+
+class WithResponseLogging
+  def initialize(invocation)
+    @invocation = invocation
+  end
+
+  def call
+    @invocation.call.tap { |r| p r }
+  end
+end
+
+service = CC::Service::GitHubPullRequests.new({
+  oauth_token:   ENV.fetch("OAUTH_TOKEN"),
+  update_status: true,
+  add_comment:   true,
+}, {
+  name:        "pull_request",
+  # https://github.com/codeclimate/nillson/pull/33
+  state:       "success",
+  github_slug: "codeclimate/nillson",
+  issue_comparison_counts: {"new" => 0, "fixed" => 0},
+  number:      33,
+  commit_sha:  "986ec903b8420f4e8c8d696d8950f7bd0667ff0c"
+})
+
+CC::Service::Invocation.new(service) do |i|
+  i.wrap(WithResponseLogging)
+end