codeclimate-services 0.6.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a54f744a90038f57b0394f3fd4d98be62ab52ffa
-  data.tar.gz: dc870ec854172e950e2cb7eb9ebfd932f073236a
+  metadata.gz: 284a96fe4285fcc34d367b9dd24abdf4cb51b43a
+  data.tar.gz: e60dd3be41f2ed70a13602b260a4f7364c7b9656
 SHA512:
-  metadata.gz: c7e8ee7f277ff54a9e9d77dbfc0268b1b5cc4bced5512594ce75d0448f6a98c501039a3f02cc00d0a1bf448f233c9fb08bc2363336414fe001283987313c3171
-  data.tar.gz: 2e2c7ac2be8a98a00977860623b5523de21f1078a21368e673ca6bc32943bbbb5dde377037063160e09692576e94a9a396ee776a5ff5486e4eb05d7eea96454f
+  metadata.gz: 7e33711b3282b2870de63ef36e7fe520ebe7276949c44fd33f020a84eb30fb0afa4dfeec7113d939b6921f7d96e1ca2cbf26d0aa1e7b4830ae8f137c5bd91ab1
+  data.tar.gz: 44d1e4c810e0392b32ba9aadb6cd79bf963bb67d227607340ca1620728e7c47c4e8fcd30be328e9177d57d23cf705a6e8f1b7ec530a43556eccd167a36e99842

data/lib/cc/services/github_pull_requests.rb

@@ -8,9 +8,6 @@ class CC::Service::GitHubPullRequests < CC::Service
     attribute :update_status, Axiom::Types::Boolean,
       label: "Update status?",
       description: "Update the pull request status after analyzing?"
-    attribute :add_comment, Axiom::Types::Boolean,
-      label: "Add a comment?",
-      description: "Comment on the pull request after analyzing?"
     attribute :base_url, Axiom::Types::String,
       label: "Github API Base URL",
       description: "Base URL for the Github API",
@@ -26,22 +23,14 @@ class CC::Service::GitHubPullRequests < CC::Service
   self.title = "GitHub Pull Requests"
   self.description = "Update pull requests on GitHub"
 
-  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>.'
-
   # 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 update_status? && add_comment?
-      receive_test_status
-      receive_test_comment
-    elsif update_status?
+    if update_status?
       receive_test_status
-    elsif add_comment?
-      receive_test_comment
     else
       simple_failure("Nothing happened")
     end
@@ -62,10 +51,6 @@ class CC::Service::GitHubPullRequests < CC::Service
 
 private
 
-  def add_comment?
-    [true, "1"].include?(config.add_comment)
-  end
-
   def update_status?
     [true, "1"].include?(config.update_status)
   end
@@ -83,12 +68,10 @@ private
   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
 
@@ -122,26 +105,6 @@ private
     end
   end
 
-  def add_comment
-    if 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 = {}
@@ -160,24 +123,6 @@ private
     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}"
@@ -192,10 +137,6 @@ private
     "#{config.base_url}/repos/#{github_slug}/statuses/#{commit_sha}"
   end
 
-  def comments_url
-    "#{config.base_url}/repos/#{github_slug}/issues/#{number}/comments"
-  end
-
   def user_url
     "#{config.base_url}/user"
   end

data/lib/cc/services/version.rb

@@ -1,5 +1,5 @@
 module CC
   module Services
-    VERSION = "0.6.2"
+    VERSION = "1.0.0"
   end
 end

data/pull_request_test.rb

@@ -31,7 +31,6 @@ 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

data/service_test.rb

@@ -11,7 +11,7 @@
 # Example:
 #
 #   $ SLACK_WEBHOOK_URL="http://..." bundle exec ruby service_test.rb
-#   $ GITHUBPULLREQUESTS_UPDATE_STATUS=false GITHUBPULLREQUESTS_ADD_COMMENT=true GITHUBPULLREQUESTS_OAUTH_TOKEN=06083a4a060d358ca709939b1f00645777661c44 bundle exec ruby service_test.rb
+#   $ GITHUBPULLREQUESTS_UPDATE_STATUS=false GITHUBPULLREQUESTS_OAUTH_TOKEN=06083a4a060d358ca709939b1f00645777661c44 bundle exec ruby service_test.rb
 #
 # Other Environment variables used:
 #

data/test/github_pull_requests_test.rb

@@ -73,7 +73,7 @@ class TestGitHubPullRequests < CC::Service::TestCase
     })
   end
 
-    def test_pull_request_status_error_message_provided
+  def test_pull_request_status_error_message_provided
     expect_status_update("pbrisbin/foo", "abc123", {
       "state"       => "error",
       "description" => "descriptive message",
@@ -131,107 +131,26 @@ class TestGitHubPullRequests < CC::Service::TestCase
     })
   end
 
-
-  def test_no_comment_for_skips_regardless_of_add_comment_config
-    # With no POST expectation, test will fail if request is made.
-
-    receive_pull_request({ add_comment: true }, {
-      github_slug: "pbrisbin/foo",
-      commit_sha:  "abc123",
-      state:       "skipped",
-    })
-  end
-
   def test_pull_request_status_test_success
     @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [422, {}, ""] }
 
     assert receive_test({ update_status: true }, { github_slug: "pbrisbin/foo" })[:ok], "Expected test of pull request to be true"
   end
 
-  def test_pull_request_status_test_failure
-    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [401, {}, ""] }
-
-    assert_raises(CC::Service::HTTPError) do
-      receive_test({ update_status: true }, { github_slug: "pbrisbin/foo" })
-    end
-  end
-
-  def test_pull_request_comment_test_success
-    @stubs.get("/user") { |env| [200, { "x-oauth-scopes" => "gist, user, repo" }, ""] }
-
-    assert receive_test({ add_comment: true })[:ok], "Expected test of pull request to be true"
-  end
-
-  def test_pull_request_comment_test_failure_insufficient_permissions
-    @stubs.get("/user") { |env| [200, { "x-oauth-scopes" => "gist, user" }, ""] }
-
-    assert !receive_test({ add_comment: true })[:ok], "Expected failed test of pull request"
-  end
-
-  def test_pull_request_comment_test_failure_bad_token
-    @stubs.get("/user") { |env| [401, {}, ""] }
+  def test_pull_request_status_test_doesnt_blow_up_when_unused_keys_present_in_config
+    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [422, {}, ""] }
 
-    assert !receive_test({ add_comment: true })[:ok], "Expected failed test of pull request"
+    assert receive_test({ update_status: true, add_comment: true, wild_flamingo: true }, { github_slug: "pbrisbin/foo" })[:ok], "Expected test of pull request to be true"
   end
 
-  def test_pull_request_failure_on_status_requesting_both
+  def test_pull_request_status_test_failure
     @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [401, {}, ""] }
 
     assert_raises(CC::Service::HTTPError) do
-      receive_test({ update_status: true, add_comment: true }, { github_slug: "pbrisbin/foo" })
+      receive_test({ update_status: true }, { github_slug: "pbrisbin/foo" })
     end
   end
 
-  def test_pull_request_failure_on_comment_requesting_both
-    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [422, {}, ""] }
-    @stubs.get("/user") { |env| [401, { "x-oauth-scopes" => "gist, user, repo" }, ""] }
-
-    assert_false receive_test({ update_status: true, add_comment: true }, { github_slug: "pbrisbin/foo" })[:ok]
-  end
-
-  def test_pull_request_success_both
-    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") { |env| [422, {}, ""] }
-    @stubs.get("/user") { |env| [200, { "x-oauth-scopes" => "gist, user, repo" }, ""] }
-
-    assert receive_test({ update_status: true, add_comment: true }, { github_slug: "pbrisbin/foo" })[:ok], "Expected test of pull request to be true"
-  end
-
-  def test_pull_request_comment
-    stub_existing_comments("pbrisbin/foo", 1, %w[Hey Yo])
-
-    expect_comment("pbrisbin/foo", 1, %r{href="http://example.com">analyzed})
-
-    receive_pull_request({ add_comment: true }, {
-      github_slug: "pbrisbin/foo",
-      number:      1,
-      state:       "success",
-      compare_url: "http://example.com",
-      issue_comparison_counts: {
-        "fixed" => 2,
-        "new"   => 1,
-      }
-    })
-  end
-
-  def test_pull_request_comment_already_present
-    stub_existing_comments("pbrisbin/foo", 1, [
-      '<b>Code Climate</b> has <a href="">analyzed this pull request</a>'
-    ])
-
-    # With no POST expectation, test will fail if request is made.
-
-    response = receive_pull_request({
-      add_comment: true,
-      update_status: false
-    }, {
-      github_slug: "pbrisbin/foo",
-      number:      1,
-      state:       "success",
-    })
-
-    assert_equal({ ok: true, message: "Comment already present" }, response)
-  end
-
   def test_pull_request_unknown_state
     response = receive_pull_request({}, { state: "unknown" })
 
@@ -245,12 +164,12 @@ class TestGitHubPullRequests < CC::Service::TestCase
   end
 
   def test_different_base_url
-    @stubs.get("/user") do |env|
-      assert env[:url].to_s == "http://example.com/user"
-      [200, { "x-oauth-scopes" => "gist, user, repo" }, ""]
+    @stubs.post("/repos/pbrisbin/foo/statuses/#{"0" * 40}") do |env|
+      assert env[:url].to_s == "http://example.com/repos/pbrisbin/foo/statuses/#{"0" * 40}"
+      [422, { "x-oauth-scopes" => "gist, user, repo" }, ""]
     end
 
-    assert receive_test({ add_comment: true, base_url: "http://example.com" })[:ok], "Expected test of pull request to be true"
+    assert receive_test({ update_status: true, base_url: "http://example.com" }, { github_slug: "pbrisbin/foo" })[:ok], "Expected test of pull request to be true"
   end
 
   def test_default_context
@@ -280,15 +199,15 @@ class TestGitHubPullRequests < CC::Service::TestCase
   end
 
   def test_config_coerce_bool_true
-    c = CC::Service::GitHubPullRequests::Config.new(oauth_token: "a1b2c3", add_comment: "1")
+    c = CC::Service::GitHubPullRequests::Config.new(oauth_token: "a1b2c3", update_status: "1")
     assert c.valid?
-    assert_equal true, c.add_comment
+    assert_equal true, c.update_status
   end
 
   def test_config_coerce_bool_false
-    c = CC::Service::GitHubPullRequests::Config.new(oauth_token: "a1b2c3", add_comment: "0")
+    c = CC::Service::GitHubPullRequests::Config.new(oauth_token: "a1b2c3", update_status: "0")
     assert c.valid?
-    assert_equal false, c.add_comment
+    assert_equal false, c.update_status
   end
 
 private
@@ -306,22 +225,6 @@ private
     end
   end
 
-  def stub_existing_comments(repo, number, bodies)
-    body = bodies.map { |b| { body: b } }.to_json
-
-    @stubs.get("repos/#{repo}/issues/#{number}/comments") { [200, {}, body] }
-  end
-
-  def expect_comment(repo, number, content)
-    @stubs.post "repos/#{repo}/issues/#{number}/comments" do |env|
-      body = JSON.parse(env[:body])
-      assert_equal "token 123", env[:request_headers]["Authorization"]
-      assert content === body["body"],
-        "Unexpected comment body. #{content.inspect} !== #{body["body"].inspect}"
-      [200, {}, '{"id": 2}']
-    end
-  end
-
   def receive_pull_request(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: 0.6.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Bryan Helmkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday