codeclimate-services 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62974a5f010b848b43edd501e04b3fd7e7efcc81
-  data.tar.gz: 6bf203a29ac168df6c9e420c47b180b9bca13660
+  metadata.gz: 3a4f61a5b3f784878457cd8e81bfe7982eae48d4
+  data.tar.gz: 5af929445d6091a1c6694eecd0a5f2d4985c8382
 SHA512:
-  metadata.gz: 2a0eb59655aff194805a6ec28ffb5275d2f038585cdbb0df9cd3e927808e6ea67fa61603fcbd46bdd66aa7e1617e3cf8d6a18f6ecd532465a06a1dc824fcd21c
-  data.tar.gz: cfb76a9402d0ee2edb54378b2a4735b8f01586b37739281cd507b9e6844289ecb19a6fe378bae4241553f2f4f1de42b7b2b0dd218d9a42b79adc136ac6536d6b
+  metadata.gz: 3cf81df8fcfe3d364fc4024e2b89529177c5d5e6206b74ce8545168c78c6f3d7424ddeb56d7785f682790f6912a3fe8093764b54fa66f021bd1ed76b8363713b
+  data.tar.gz: efd09827e835d99ed4210525bba7bc764441925670477c7726002e9b02e8d45cbae2f9a9d1aa50589bdfd9e156aed314d97600e5f29699846a4b28d5ed740be6

data/README.md

@@ -95,6 +95,22 @@ Event-specific attributes:
 }
 ```
 
+### Pull Request Coverage
+
+Event name: `pull_request_coverage`
+
+Event-specific attributes:
+
+```javascript
+{
+  "state": String, // "pending", "success", or "failure"
+  "github_slug": String, // user/repo
+  "number": String,
+  "commit_sha": String,
+  "covered_percent_delta": Float,
+}
+```
+
 ## Other Events
 
 The following are not fully implemented yet.

data/lib/cc/presenters/pull_requests_presenter.rb

@@ -10,6 +10,8 @@ module CC
           @fixed_count = issue_comparison_counts["fixed"]
           @new_count = issue_comparison_counts["new"]
         end
+
+        @covered_percent = payload["covered_percent"]
       end
 
       def error_message
@@ -24,6 +26,10 @@ module CC
         "Code Climate has skipped analysis of this commit."
       end
 
+      def coverage_success_message
+        "Test coverage for this commit: #{@covered_percent}%"
+      end
+
       def success_message
         if both_issue_counts_zero?
           "Code Climate didn't find any new or fixed issues."

data/lib/cc/service.rb

@@ -30,7 +30,17 @@ module CC
 
     attr_reader :event, :config, :payload
 
-    ALL_EVENTS = %w[test unit coverage quality vulnerability snapshot pull_request issue]
+    ALL_EVENTS = %w[
+      coverage
+      issue
+      pull_request
+      pull_request_coverage
+      quality
+      snapshot
+      test
+      unit
+      vulnerability
+    ].freeze
 
     # Tracks the defined services.
     def self.services

data/lib/cc/services/github_pull_requests.rb

@@ -6,9 +6,13 @@ class CC::Service::GitHubPullRequests < CC::Service
       label: "OAuth Token",
       description: "A personal OAuth token with permissions for the repo."
     attribute :update_status, Axiom::Types::Boolean,
-      label: "Update status?",
+      label: "Update analysis status?",
       description: "Update the pull request status after analyzing?",
       default: true
+    attribute :update_coverage_status, Axiom::Types::Boolean,
+      label: "Update coverage status?",
+      description: "Update the pull request status with test coverage reports?",
+      default: false
     attribute :base_url, Axiom::Types::String,
       label: "Github API Base URL",
       description: "Base URL for the Github API",
@@ -38,13 +42,30 @@ class CC::Service::GitHubPullRequests < CC::Service
   end
 
   def receive_pull_request
-    setup_http
-    state = @payload["state"]
+    if update_status?
+      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
+    end
 
-    if %w[pending success failure skipped error].include?(state)
-      send("update_status_#{state}")
-    else
-      @response = simple_failure("Unknown state")
+    response
+  end
+
+  def receive_pull_request_coverage
+    if update_coverage_status?
+      setup_http
+      state = @payload["state"]
+
+      if state == "success"
+        update_coverage_status_success
+      else
+        @response = simple_failure("Unknown state")
+      end
     end
 
     response
@@ -53,7 +74,15 @@ class CC::Service::GitHubPullRequests < CC::Service
 private
 
   def update_status?
-    [true, "1"].include?(config.update_status)
+    effective_boolean?(config.update_status)
+  end
+
+  def update_coverage_status?
+    effective_boolean?(config.update_coverage_status)
+  end
+
+  def effective_boolean?(value)
+    [true, "1"].include?(value)
   end
 
   def simple_failure(message)
@@ -72,6 +101,10 @@ private
     update_status("success", presenter.success_message)
   end
 
+  def update_coverage_status_success
+    update_status("success", presenter.coverage_success_message, "#{config.context}/coverage")
+  end
+
   def update_status_failure
     update_status("failure", presenter.success_message)
   end
@@ -94,16 +127,14 @@ private
     )
   end
 
-  def update_status(state, description)
-    if update_status?
-      params = {
-        state:       state,
-        description: description,
-        target_url:  @payload["details_url"],
-        context:     config.context,
-      }
-      @response = service_post(status_url, params.to_json)
-    end
+  def update_status(state, description, context = config.context)
+    params = {
+      state:       state,
+      description: description,
+      target_url:  @payload["details_url"],
+      context:     context,
+    }
+    @response = service_post(status_url, params.to_json)
   end
 
   def receive_test_status

data/lib/cc/services/version.rb

@@ -1,5 +1,5 @@
 module CC
   module Services
-    VERSION = "1.2.0"
+    VERSION = "1.3.0"
   end
 end

data/test/github_pull_requests_test.rb

@@ -100,6 +100,20 @@ class TestGitHubPullRequests < CC::Service::TestCase
     })
   end
 
+  def test_pull_request_coverage_status_success
+    expect_status_update("pbrisbin/foo", "abc123", {
+      "state"       => "success",
+      "description" => "Test coverage for this commit: 87%",
+    })
+
+    receive_pull_request_coverage({ update_coverage_status: true }, {
+      github_slug:     "pbrisbin/foo",
+      commit_sha:      "abc123",
+      state:           "success",
+      covered_percent: 87
+    })
+  end
+
   def test_no_status_update_for_skips_when_update_status_config_is_falsey
     # With no POST expectation, test will fail if request is made.
 
@@ -233,6 +247,14 @@ private
     )
   end
 
+  def receive_pull_request_coverage(config, event_data)
+    receive(
+      CC::Service::GitHubPullRequests,
+      { oauth_token: "123" }.merge(config),
+      { name: "pull_request_coverage", issue_comparison_counts: {'fixed' => 1, 'new' => 2} }.merge(event_data)
+    )
+  end
+
   def receive_test(config, event_data = {})
     receive(
       CC::Service::GitHubPullRequests,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate-services
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Bryan Helmkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -237,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Service classes for Code Climate