codeclimate-services 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09c50b131c87eef76cf123ce50096e9be93e38a0
-  data.tar.gz: bd7f6de0a9958fa0b7cd0e391ba48e1bb9fea7b4
+  metadata.gz: fd43be14f3a358c801335f30ab99aa3e72e65362
+  data.tar.gz: fa21aa050c37330b29af67477d078f5b4aa262c9
 SHA512:
-  metadata.gz: 52dd437c1e971a66cd1f4d2d68aa19e94c78d518bf72776d181eae8964103483ef1719859c91be038416291bc009a095dc3d55ee52cbc6f3c24dcbdf6504682d
-  data.tar.gz: d30b3ded92c7ef1dce8f40d41dded29e5f14b3813164110ebdff15fb87a66e8044a47e1aa40cd46901937e4ac805a09a7124b02d120dddeddcd7e65b841062a7
+  metadata.gz: 48410aea9beb76e44066ed178a98a54f58d6cbe308d58fdbbf11b7d8aa4e5c5a1d0d0722661eac46bb7bcade9594f3ce840b3b4fb6341f68be419376182f010e
+  data.tar.gz: 281c5a7829bac3d55eff0c2884a6f9d31eaa801abde6f2fa4c8246277735cc884d89941a526e27debf3c82b4b72c853b34d131abeb8817743f911bc00c7c6720

data/lib/cc/presenters/{github_pull_requests_presenter.rb → pull_requests_presenter.rb}

@@ -1,6 +1,6 @@
 module CC
   class Service
-    class GitHubPullRequestsPresenter
+    class PullRequestsPresenter
       include ActiveSupport::NumberHelper
 
       def initialize(payload)
@@ -12,6 +12,18 @@ module CC
         end
       end
 
+      def error_message
+        "Code Climate encountered an error attempting to analyze this pull request."
+      end
+
+      def pending_message
+        "Code Climate is analyzing this code."
+      end
+
+      def skipped_message
+        "Code Climate has skipped analysis of this commit."
+      end
+
       def success_message
         if both_issue_counts_zero?
           "Code Climate didn't find any new or fixed issues."

data/lib/cc/services/github_pull_requests.rb

@@ -1,10 +1,10 @@
-require "cc/presenters/github_pull_requests_presenter"
+require "cc/presenters/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."
+      description: "A personal OAuth token with permissions for the repo."
     attribute :update_status, Boolean,
       label: "Update status?",
       description: "Update the pull request status after analyzing?"
@@ -24,9 +24,6 @@ class CC::Service::GitHubPullRequests < CC::Service
 
   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
@@ -70,10 +67,7 @@ private
   end
 
   def update_status_skipped
-    update_status(
-      "success",
-      "Code Climate has skipped analysis of this commit."
-    )
+    update_status("success", presenter.skipped_message)
   end
 
   def update_status_success
@@ -87,18 +81,21 @@ private
   end
 
   def presenter
-    CC::Service::GitHubPullRequestsPresenter.new(@payload)
+    CC::Service::PullRequestsPresenter.new(@payload)
   end
 
   def update_status_error
     update_status(
       "error",
-      @payload["message"] || DEFAULT_ERROR
+      @payload["message"] || presenter.error_message
     )
   end
 
   def update_status_pending
-    update_status("pending", "Code Climate is analyzing this code.")
+    update_status(
+      "pending",
+      @payload["message"] || presenter.pending_message
+    )
   end
 
   def update_status(state, description)

data/lib/cc/services/stash_pull_requests.rb

@@ -0,0 +1,98 @@
+require "base64"
+require "cc/presenters/pull_requests_presenter"
+
+class CC::Service::StashPullRequests < CC::Service
+  class Config < CC::Service::Config
+    attribute :domain, String,
+      description: "Your Stash host domain (e.g. yourstash.com:PORT, please exclude https://)"
+    attribute :username, String
+    attribute :password, Password
+
+    validates :domain, presence: true
+    validates :username, presence: true
+    validates :password, presence: true
+  end
+
+  self.title = "Stash Pull Requests"
+  self.description = "Update pull requests on Stash"
+
+  STASH_STATES = {
+    "error" => "FAILED",
+    "failure" => "FAILED",
+    "pending" => "INPROGRESS",
+    "skipped" => "SUCCESSFUL",
+    "success" => "SUCCESSFUL",
+  }.freeze
+
+  def receive_test
+    setup_http
+
+    service_get(test_url)
+
+    { ok: true, message: "Test succeeded" }
+  rescue HTTPError => e
+    { ok: false, message: e.message }
+  end
+
+  def receive_pull_request
+    setup_http
+
+    params = {
+      description: description,
+      key: "Code Climate",
+      name: "Code Climate",
+      state: state,
+      url:  @payload["details_url"],
+    }
+    service_post(url, params.to_json)
+  end
+
+  private
+
+  def test_url
+    "http://#{config.domain}/rest/api/1.0/users"
+  end
+
+  def url
+    "http://#{config.domain}/rest/build-status/1.0/commits/#{commit_sha}"
+  end
+
+  def commit_sha
+    @payload.fetch("commit_sha")
+  end
+
+  def description
+    return @payload["message"] if @payload["message"]
+
+    case @payload["state"]
+    when "pending"
+      presenter.pending_message
+    when "success", "failure"
+      presenter.success_message
+    when "skipped"
+      presenter.skipped_message
+    when "error"
+      presenter.error_message
+    end
+  end
+
+  def state
+    STASH_STATES[@payload["state"]]
+  end
+
+  def setup_http
+    http.headers["Content-Type"]  = "application/json"
+    http.headers["Authorization"] = "Basic #{auth_token}"
+    http.headers["User-Agent"]    = "Code Climate"
+  end
+
+  # Following Basic Auth headers here:
+  # https://developer.atlassian.com/stash/docs/latest/how-tos/example-basic-authentication.html
+  def auth_token
+    Base64.encode64("#{config.username}:#{config.password}")
+  end
+
+  def presenter
+    CC::Service::PullRequestsPresenter.new(@payload)
+  end
+end

data/lib/cc/services/version.rb

@@ -1,5 +1,5 @@
 module CC
   module Services
-    VERSION = "0.4.1"
+    VERSION = "0.5.0"
   end
 end

data/test/github_pull_requests_test.rb

@@ -62,7 +62,7 @@ class TestGitHubPullRequests < CC::Service::TestCase
   def test_pull_request_status_error
     expect_status_update("pbrisbin/foo", "abc123", {
       "state"       => "error",
-      "description" => CC::Service::GitHubPullRequests::DEFAULT_ERROR,
+      "description" => "Code Climate encountered an error attempting to analyze this pull request.",
     })
 
     receive_pull_request({ update_status: true }, {

data/test/presenters/{github_pull_requests_presenter_test.rb → pull_requests_presenter_test.rb}

@@ -1,7 +1,7 @@
 require "helper"
-require "cc/presenters/github_pull_requests_presenter"
+require "cc/presenters/pull_requests_presenter"
 
-class TestGitHubPullRequestsPresenter < CC::Service::TestCase
+class TestPullRequestsPresenter < CC::Service::TestCase
   def test_message_singular
     assert_equal(
       "Code Climate found 1 new issue and 1 fixed issue.",
@@ -44,6 +44,6 @@ private
   end
 
   def build_presenter(issue_counts)
-    CC::Service::GitHubPullRequestsPresenter.new(build_payload(issue_counts))
+    CC::Service::PullRequestsPresenter.new(build_payload(issue_counts))
   end
 end

data/test/stash_pull_requests_test.rb

@@ -0,0 +1,146 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestStashPullRequests < CC::Service::TestCase
+  def test_receive_test
+    @stubs.get "/rest/api/1.0/users" do
+      [200, {}, "{ 'values': [] }"]
+    end
+
+    response = receive_test
+
+    assert_equal({ ok: true, message: "Test succeeded" }, response)
+  end
+
+  def test_failed_receive_test
+    @stubs.get "/rest/api/1.0/users" do
+      [401, {}, ""]
+    end
+
+    response = receive_test
+
+    assert_equal({ ok: false, message: "API request unsuccessful (401)" }, response)
+  end
+
+  def test_pull_request_status_pending
+    expect_status_update("abc123", {
+      "state" => "INPROGRESS",
+      "description" => /is analyzing/,
+    })
+
+    receive_pull_request(
+      commit_sha: "abc123",
+      state: "pending",
+    )
+  end
+
+  def test_pull_request_status_success_detailed
+    expect_status_update("abc123", {
+      "state"       => "SUCCESSFUL",
+      "description" => "Code Climate found 2 new issues and 1 fixed issue.",
+    })
+
+    receive_pull_request(
+      commit_sha: "abc123",
+      state: "success",
+    )
+  end
+
+  def test_pull_request_status_failure
+    expect_status_update("abc123", {
+      "state"       => "FAILED",
+      "description" => "Code Climate found 2 new issues and 1 fixed issue.",
+    })
+
+    receive_pull_request(
+      commit_sha: "abc123",
+      state: "failure"
+    )
+  end
+
+  def test_pull_request_status_error
+    expect_status_update("abc123", {
+      "state" => "FAILED",
+      "description" => "Code Climate encountered an error attempting to analyze this pull request."
+    })
+
+    receive_pull_request(
+      commit_sha: "abc123",
+      state: "error"
+    )
+  end
+
+  def test_pull_request_status_error_message_provided
+    message = "Everything broke."
+
+    expect_status_update("abc123", {
+      "state" => "FAILED",
+      "description" => message
+    })
+
+    receive_pull_request(
+      commit_sha: "abc123",
+      message: message,
+      state: "error"
+    )
+  end
+
+  def test_pull_request_status_skipped
+    expect_status_update("abc123", {
+      "state" => "SUCCESSFUL",
+      "description" => "Code Climate has skipped analysis of this commit."
+    })
+
+    receive_pull_request(
+      commit_sha: "abc123",
+      state: "skipped",
+    )
+  end
+
+  def test_failed_receive_pull_request
+    commit_sha = "abc123"
+
+    @stubs.post("/rest/build-status/1.0/commits/#{commit_sha}") do
+      [401, {}, ""]
+    end
+
+    assert_raises(CC::Service::HTTPError) do
+      receive_pull_request(
+        commit_sha: "abc123",
+        state: "success",
+      )
+    end
+  end
+
+  private
+
+  def expect_status_update(commit_sha, params)
+    @stubs.post("/rest/build-status/1.0/commits/#{commit_sha}") do |env|
+      body = JSON.parse(env[:body])
+
+      params.each do |k, v|
+        assert v === body[k],
+          "Unexpected value for #{k}. #{v.inspect} !== #{body[k].inspect}"
+      end
+    end
+  end
+
+  def default_config
+    { domain: "example.com", username: "zaphod", password: "g4rgl3bl4st3r" }
+  end
+
+  def receive_pull_request(event_data, config = {})
+    receive(
+      CC::Service::StashPullRequests,
+      default_config.merge(config),
+      { name: "pull_request", issue_comparison_counts: {'fixed' => 1, 'new' => 2} }.merge(event_data)
+    )
+  end
+
+  def receive_test(config = {}, event_data = {})
+    receive(
+      CC::Service::StashPullRequests,
+      default_config.merge(config),
+      { name: "test" }.merge(event_data)
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate-services
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Bryan Helmkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -167,7 +167,7 @@ files:
 - lib/cc/helpers/issue_helper.rb
 - lib/cc/helpers/quality_helper.rb
 - lib/cc/helpers/vulnerability_helper.rb
-- lib/cc/presenters/github_pull_requests_presenter.rb
+- lib/cc/presenters/pull_requests_presenter.rb
 - lib/cc/service.rb
 - lib/cc/service/config.rb
 - lib/cc/service/formatter.rb
@@ -191,6 +191,7 @@ files:
 - lib/cc/services/lighthouse.rb
 - lib/cc/services/pivotal_tracker.rb
 - lib/cc/services/slack.rb
+- lib/cc/services/stash_pull_requests.rb
 - lib/cc/services/version.rb
 - pull_request_test.rb
 - service_test.rb
@@ -210,9 +211,10 @@ files:
 - test/jira_test.rb
 - test/lighthouse_test.rb
 - test/pivotal_tracker_test.rb
-- test/presenters/github_pull_requests_presenter_test.rb
+- test/presenters/pull_requests_presenter_test.rb
 - test/service_test.rb
 - test/slack_test.rb
+- test/stash_pull_requests_test.rb
 - test/support/fake_logger.rb
 - test/with_metrics_test.rb
 homepage: ''
@@ -235,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Service classes for Code Climate
@@ -256,8 +258,9 @@ test_files:
 - test/jira_test.rb
 - test/lighthouse_test.rb
 - test/pivotal_tracker_test.rb
-- test/presenters/github_pull_requests_presenter_test.rb
+- test/presenters/pull_requests_presenter_test.rb
 - test/service_test.rb
 - test/slack_test.rb
+- test/stash_pull_requests_test.rb
 - test/support/fake_logger.rb
 - test/with_metrics_test.rb