contribution-checker 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c129f3407bbeb442ecd2002f9fadbca15dff589
-  data.tar.gz: 57559b50a1ea7bb8c15aa4358dc3ec3c8f3e2171
+  metadata.gz: c2e0818376e281959857ad59fcf196dbe5a107d2
+  data.tar.gz: f822111b754aa62875a4cbfdddb108af1736929d
 SHA512:
-  metadata.gz: b3ef530dc6204ae16ff3334b495602351a3caa33102a22a34e8b2bca3b9f2f02a447b0411e83bfbacb874c617b257b03a61ee4188351e40981688801c50b4db2
-  data.tar.gz: d2bcc6cf147512af14a7bf8ad1ac470b1f6e2c4ac4082a180a56c6f918ab0296f9efdcc7ed323152c12d000097773f0dbb20f02ffd063b2b9403d5cb86ed0d45
+  metadata.gz: 00594f72065361343a7121e7563f6908031de2685bb0f9bfa03ee0dd810320d8c70578362815ab9eb42707d063e0e21b695fd775746516577c50e3a67152a324
+  data.tar.gz: 953c874712e16d57886dfa59983d429ac8ead173850d5d1a75922f24f36b908ca728febc4f0e2be373887f16aba73e46389e60cbe8970bb8a37f8f2464e0c89f

data/README.md

@@ -23,10 +23,11 @@ checker.check
     :default_branch              => "master"
   },
   :or_criteria => {
-    :user_has_starred_repo   => false,
-    :user_can_push_to_repo   => false,
-    :user_is_repo_org_member => true,
-    :user_has_fork_of_repo   => false
+    :user_has_starred_repo               => false,
+    :user_can_push_to_repo               => false,
+    :user_is_repo_org_member             => true,
+    :user_has_fork_of_repo               => false,
+    :user_has_opened_issue_or_pr_in_repo => false
   }
 }
 ```
@@ -35,10 +36,13 @@ You might also like to try out the [Contribution Checker][app] app built on top
 
 ![checker](https://cloud.githubusercontent.com/assets/65057/3352063/2a90d4b4-fa31-11e3-8733-c52d5df05bad.png)
 
+The source for the app is in [jdennes/contribution-checker-app][contribution-checker-app].
+
 Created by [@izuzak][izuzak] and [@jdennes][jdennes] at the [Hamburg Hackathon][hamburg-hackathon], June 2014.
 
 [contributions]: https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile
 [app]: http://contribution-checker.herokuapp.com/
+[contribution-checker-app]: https://github.com/jdennes/contribution-checker-app
 [izuzak]: https://github.com/izuzak
 [jdennes]: https://github.com/jdennes
 [hamburg-hackathon]: http://hamburg-hackathon.de/hackathon/

data/lib/contribution-checker/checker.rb

@@ -41,16 +41,19 @@ module ContributionChecker
     #     :default_branch              => "master"
     #   },
     #   :or_criteria => {
-    #     :user_has_starred_repo   => false,
-    #     :user_can_push_to_repo   => false,
-    #     :user_is_repo_org_member => true,
-    #     :user_has_fork_of_repo   => false
+    #     :user_has_starred_repo               => false,
+    #     :user_can_push_to_repo               => false,
+    #     :user_is_repo_org_member             => true,
+    #     :user_has_fork_of_repo               => false,
+    #     :user_has_opened_issue_or_pr_in_repo => false
     #   }
     # }
     def check
       @nwo, @sha = parse_commit_url @commit_url
       begin
         @commit = @client.commit @nwo, @sha
+      rescue ArgumentError
+        raise ContributionChecker::InvalidCommitUrlError
       rescue Octokit::NotFound
         raise ContributionChecker::InvalidCommitUrlError
       rescue Octokit::Unauthorized
@@ -67,6 +70,7 @@ module ContributionChecker
       @user_can_push_to_repo = user_can_push_to_repo?
       @user_is_repo_org_member = user_is_repo_org_member?
       @user_has_fork_of_repo = user_has_fork_of_repo?
+      @user_has_opened_issue_or_pr_in_repo = user_has_opened_issue_or_pr_in_repo?
 
       {
         :contribution => and_criteria_met? && or_criteria_met?,
@@ -79,10 +83,11 @@ module ContributionChecker
           :default_branch              => @repo[:default_branch],
         },
         :or_criteria => {
-          :user_has_starred_repo   => @user_has_starred_repo,
-          :user_can_push_to_repo   => @user_can_push_to_repo,
-          :user_is_repo_org_member => @user_is_repo_org_member,
-          :user_has_fork_of_repo   => @user_has_fork_of_repo,
+          :user_has_starred_repo               => @user_has_starred_repo,
+          :user_can_push_to_repo               => @user_can_push_to_repo,
+          :user_is_repo_org_member             => @user_is_repo_org_member,
+          :user_has_fork_of_repo               => @user_has_fork_of_repo,
+          :user_has_opened_issue_or_pr_in_repo => @user_has_opened_issue_or_pr_in_repo,
         }
       }
     end
@@ -232,6 +237,16 @@ module ContributionChecker
       false
     end
 
+    # Checks whether the authenticated user has opened an issue or pull request
+    # in the repository in which the commit exists.
+    #
+    # @return [Boolean]
+    def user_has_opened_issue_or_pr_in_repo?
+      issues_and_prs = @client.list_issues @nwo,
+        :creator => @user[:login], :state => "all"
+      issues_and_prs.any?
+    end
+
     # Checks whether the "and" criteria for counting a commit as a contribution
     # are correctly met.
     #
@@ -251,7 +266,8 @@ module ContributionChecker
       @user_has_starred_repo ||
       @user_can_push_to_repo ||
       @user_is_repo_org_member ||
-      @user_has_fork_of_repo
+      @user_has_fork_of_repo ||
+      @user_has_opened_issue_or_pr_in_repo
     end
   end
 end

data/lib/contribution-checker/version.rb

@@ -1,3 +1,3 @@
 module ContributionChecker
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/spec/contribution-checker/checker_spec.rb

@@ -31,6 +31,22 @@ describe ContributionChecker::Checker do
       end
     end
 
+    context "when a repository URL is provided which isn't a commit URL" do
+      let(:checker) { checker = ContributionChecker::Checker.new \
+        :access_token => "your token",
+        :commit_url   => "https://github.com/github/linguist/blahblah"
+      }
+
+      before do
+        stub_request(:get, "https://api.github.com/repos/github/linguist/commits/").to_return(
+        :status  => 404, :body => "")
+      end
+
+      it "raises an error" do
+        expect { checker.check }.to raise_error ContributionChecker::InvalidCommitUrlError
+      end
+    end
+
     context "when an invalid access token is provided" do
       let(:checker) { checker = ContributionChecker::Checker.new \
         :access_token => "invalid access token",
@@ -66,7 +82,9 @@ describe ContributionChecker::Checker do
           to_return(json_response("emails.json"))
         stub_get("/user/starred?per_page=100").
           to_return(json_response("starred.json"))
-      end
+        stub_get("/repos/jdennes/contribution-checker/issues?creator=jdennes&per_page=100&state=all").
+          to_return(json_response("issues_and_prs.json"))
+        end
 
       it "returns the check result" do
         result = checker.check
@@ -85,6 +103,7 @@ describe ContributionChecker::Checker do
         expect(result[:or_criteria][:user_can_push_to_repo]).to eq(true)
         expect(result[:or_criteria][:user_is_repo_org_member]).to eq(false)
         expect(result[:or_criteria][:user_has_fork_of_repo]).to eq(false)
+        expect(result[:or_criteria][:user_has_opened_issue_or_pr_in_repo]).to eq(true)
       end
     end
 
@@ -109,7 +128,9 @@ describe ContributionChecker::Checker do
           to_return(json_response("emails.json"))
         stub_get("/user/starred?per_page=100").
           to_return(json_response("starred.json"))
-      end
+        stub_get("/repos/jdennes/contribution-checker/issues?creator=jdennes&per_page=100&state=all").
+          to_return(json_response("issues_and_prs.json"))
+        end
 
       it "returns the check result" do
         result = checker.check
@@ -128,6 +149,7 @@ describe ContributionChecker::Checker do
         expect(result[:or_criteria][:user_can_push_to_repo]).to eq(true)
         expect(result[:or_criteria][:user_is_repo_org_member]).to eq(false)
         expect(result[:or_criteria][:user_has_fork_of_repo]).to eq(false)
+        expect(result[:or_criteria][:user_has_opened_issue_or_pr_in_repo]).to eq(true)
       end
     end
 
@@ -152,7 +174,9 @@ describe ContributionChecker::Checker do
           to_return(json_response("emails.json"))
         stub_get("/user/starred?per_page=100").
           to_return(json_response("starred.json"))
-      end
+        stub_get("/repos/jdennes/contribution-checker/issues?creator=jdennes&per_page=100&state=all").
+          to_return(json_response("issues_and_prs.json"))
+        end
 
       it "returns the check result" do
         result = checker.check
@@ -171,6 +195,7 @@ describe ContributionChecker::Checker do
         expect(result[:or_criteria][:user_can_push_to_repo]).to eq(true)
         expect(result[:or_criteria][:user_is_repo_org_member]).to eq(false)
         expect(result[:or_criteria][:user_has_fork_of_repo]).to eq(false)
+        expect(result[:or_criteria][:user_has_opened_issue_or_pr_in_repo]).to eq(true)
       end
     end
 
@@ -195,7 +220,9 @@ describe ContributionChecker::Checker do
           to_return(json_response("emails.json"))
         stub_get("/user/starred?per_page=100").
           to_return(json_response("starred.json"))
-      end
+        stub_get("/repos/jdennes/contribution-checker/issues?creator=jdennes&per_page=100&state=all").
+          to_return(json_response("issues_and_prs.json"))
+        end
 
       it "returns the check result" do
         result = checker.check
@@ -214,6 +241,7 @@ describe ContributionChecker::Checker do
         expect(result[:or_criteria][:user_can_push_to_repo]).to eq(true)
         expect(result[:or_criteria][:user_is_repo_org_member]).to eq(false)
         expect(result[:or_criteria][:user_has_fork_of_repo]).to eq(false)
+        expect(result[:or_criteria][:user_has_opened_issue_or_pr_in_repo]).to eq(true)
       end
     end
 
@@ -239,7 +267,9 @@ describe ContributionChecker::Checker do
           to_return(json_response("starred.json"))
         stub_get("/orgs/github/members/jdennes").
           to_return(:status => 204)
-      end
+        stub_get("/repos/jdennes/contribution-checker/issues?creator=jdennes&per_page=100&state=all").
+          to_return(json_response("issues_and_prs.json"))
+        end
 
       it "returns the check result" do
         result = checker.check
@@ -258,6 +288,7 @@ describe ContributionChecker::Checker do
         expect(result[:or_criteria][:user_can_push_to_repo]).to eq(true)
         expect(result[:or_criteria][:user_is_repo_org_member]).to eq(true)
         expect(result[:or_criteria][:user_has_fork_of_repo]).to eq(false)
+        expect(result[:or_criteria][:user_has_opened_issue_or_pr_in_repo]).to eq(true)
       end
     end
 
@@ -282,7 +313,9 @@ describe ContributionChecker::Checker do
           to_return(json_response("starred.json"))
         stub_get("/repos/jdennes/contribution-checker/forks?per_page=100").
           to_return(json_response("repo_forks.json"))
-      end
+        stub_get("/repos/jdennes/contribution-checker/issues?creator=jdennes&per_page=100&state=all").
+          to_return(json_response("issues_and_prs.json"))
+        end
 
       it "returns the check result" do
         result = checker.check
@@ -301,6 +334,7 @@ describe ContributionChecker::Checker do
         expect(result[:or_criteria][:user_can_push_to_repo]).to eq(true)
         expect(result[:or_criteria][:user_is_repo_org_member]).to eq(false)
         expect(result[:or_criteria][:user_has_fork_of_repo]).to eq(true)
+        expect(result[:or_criteria][:user_has_opened_issue_or_pr_in_repo]).to eq(true)
       end
     end
 
@@ -325,7 +359,9 @@ describe ContributionChecker::Checker do
           to_return(json_response("starred.json"))
         stub_get("/repos/jdennes/contribution-checker").
           to_return(json_response("potential_fork.json"))
-      end
+        stub_get("/repos/someone/contribution-checker/issues?creator=jdennes&per_page=100&state=all").
+          to_return(json_response("issues_and_prs.json"))
+        end
 
       it "returns the check result" do
         result = checker.check
@@ -344,6 +380,7 @@ describe ContributionChecker::Checker do
         expect(result[:or_criteria][:user_can_push_to_repo]).to eq(true)
         expect(result[:or_criteria][:user_is_repo_org_member]).to eq(false)
         expect(result[:or_criteria][:user_has_fork_of_repo]).to eq(true)
+        expect(result[:or_criteria][:user_has_opened_issue_or_pr_in_repo]).to eq(true)
       end
     end
 
@@ -372,7 +409,9 @@ describe ContributionChecker::Checker do
           to_return(json_response("user_repos.json"))
         stub_get("/repos/jdennes/myfork").
           to_return(json_response("user_fork.json"))
-      end
+        stub_get("/repos/someone/contribution-checker/issues?creator=jdennes&per_page=100&state=all").
+          to_return(json_response("issues_and_prs.json"))
+        end
 
       it "returns the check result" do
         result = checker.check
@@ -391,6 +430,7 @@ describe ContributionChecker::Checker do
         expect(result[:or_criteria][:user_can_push_to_repo]).to eq(true)
         expect(result[:or_criteria][:user_is_repo_org_member]).to eq(false)
         expect(result[:or_criteria][:user_has_fork_of_repo]).to eq(true)
+        expect(result[:or_criteria][:user_has_opened_issue_or_pr_in_repo]).to eq(true)
       end
     end
 
@@ -419,7 +459,9 @@ describe ContributionChecker::Checker do
           to_return(json_response("user_repos.json"))
         stub_get("/repos/jdennes/myfork").
           to_return(json_response("user_fork_not_matching.json"))
-      end
+        stub_get("/repos/someone/contribution-checker/issues?creator=jdennes&per_page=100&state=all").
+          to_return(json_response("issues_and_prs.json"))
+        end
 
       it "returns the check result" do
         result = checker.check
@@ -438,6 +480,7 @@ describe ContributionChecker::Checker do
         expect(result[:or_criteria][:user_can_push_to_repo]).to eq(true)
         expect(result[:or_criteria][:user_is_repo_org_member]).to eq(false)
         expect(result[:or_criteria][:user_has_fork_of_repo]).to eq(false)
+        expect(result[:or_criteria][:user_has_opened_issue_or_pr_in_repo]).to eq(true)
       end
     end
 

data/spec/fixtures/issues_and_prs.json

@@ -0,0 +1,137 @@
+[
+  {
+    "url": "https://api.github.com/repos/jdennes/contribution-checker/issues/11",
+    "labels_url": "https://api.github.com/repos/jdennes/contribution-checker/issues/11/labels{/name}",
+    "comments_url": "https://api.github.com/repos/jdennes/contribution-checker/issues/11/comments",
+    "events_url": "https://api.github.com/repos/jdennes/contribution-checker/issues/11/events",
+    "html_url": "https://github.com/jdennes/contribution-checker/pull/11",
+    "id": 58511832,
+    "number": 11,
+    "title": "[WIP] Add missing criterion",
+    "user": {
+      "login": "jdennes",
+      "id": 65057,
+      "avatar_url": "https://avatars.githubusercontent.com/u/65057?v=3",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/jdennes",
+      "html_url": "https://github.com/jdennes",
+      "followers_url": "https://api.github.com/users/jdennes/followers",
+      "following_url": "https://api.github.com/users/jdennes/following{/other_user}",
+      "gists_url": "https://api.github.com/users/jdennes/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/jdennes/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/jdennes/subscriptions",
+      "organizations_url": "https://api.github.com/users/jdennes/orgs",
+      "repos_url": "https://api.github.com/users/jdennes/repos",
+      "events_url": "https://api.github.com/users/jdennes/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/jdennes/received_events",
+      "type": "User",
+      "site_admin": true
+    },
+    "labels": [
+
+    ],
+    "state": "open",
+    "locked": false,
+    "assignee": null,
+    "milestone": null,
+    "comments": 4,
+    "created_at": "2015-02-22T18:09:15Z",
+    "updated_at": "2015-02-22T18:56:04Z",
+    "closed_at": null,
+    "pull_request": {
+      "url": "https://api.github.com/repos/jdennes/contribution-checker/pulls/11",
+      "html_url": "https://github.com/jdennes/contribution-checker/pull/11",
+      "diff_url": "https://github.com/jdennes/contribution-checker/pull/11.diff",
+      "patch_url": "https://github.com/jdennes/contribution-checker/pull/11.patch"
+    },
+    "body": "Not ready to merge. Work in progress to add the following \"or\" criterion:\r\n\r\n> \"You have opened a pull request or issue in the repository.\"\r\n\r\nNot yet implemented. Probably going to try to use the Search API to search for either issues or PRs created by the user in the specified repository (hopefully that should work in a single call).\r\n\r\nAims to fix #9.\r\n\r\n/cc @izuzak "
+  },
+  {
+    "url": "https://api.github.com/repos/jdennes/contribution-checker/issues/10",
+    "labels_url": "https://api.github.com/repos/jdennes/contribution-checker/issues/10/labels{/name}",
+    "comments_url": "https://api.github.com/repos/jdennes/contribution-checker/issues/10/comments",
+    "events_url": "https://api.github.com/repos/jdennes/contribution-checker/issues/10/events",
+    "html_url": "https://github.com/jdennes/contribution-checker/pull/10",
+    "id": 58508412,
+    "number": 10,
+    "title": "Cater for change in Octokit behaviour",
+    "user": {
+      "login": "jdennes",
+      "id": 65057,
+      "avatar_url": "https://avatars.githubusercontent.com/u/65057?v=3",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/jdennes",
+      "html_url": "https://github.com/jdennes",
+      "followers_url": "https://api.github.com/users/jdennes/followers",
+      "following_url": "https://api.github.com/users/jdennes/following{/other_user}",
+      "gists_url": "https://api.github.com/users/jdennes/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/jdennes/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/jdennes/subscriptions",
+      "organizations_url": "https://api.github.com/users/jdennes/orgs",
+      "repos_url": "https://api.github.com/users/jdennes/repos",
+      "events_url": "https://api.github.com/users/jdennes/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/jdennes/received_events",
+      "type": "User",
+      "site_admin": true
+    },
+    "labels": [
+
+    ],
+    "state": "closed",
+    "locked": false,
+    "assignee": null,
+    "milestone": null,
+    "comments": 3,
+    "created_at": "2015-02-22T16:30:55Z",
+    "updated_at": "2015-02-22T16:48:59Z",
+    "closed_at": "2015-02-22T16:48:59Z",
+    "pull_request": {
+      "url": "https://api.github.com/repos/jdennes/contribution-checker/pulls/10",
+      "html_url": "https://github.com/jdennes/contribution-checker/pull/10",
+      "diff_url": "https://github.com/jdennes/contribution-checker/pull/10.diff",
+      "patch_url": "https://github.com/jdennes/contribution-checker/pull/10.patch"
+    },
+    "body": "While working on a new branch, I noticed this test failing because of a change in Octokit's exception handling behaviour:\r\n\r\nhttps://travis-ci.org/jdennes/contribution-checker/builds/51730061#L135\r\n\r\nThis fixes that."
+  },
+  {
+    "url": "https://api.github.com/repos/jdennes/contribution-checker/issues/9",
+    "labels_url": "https://api.github.com/repos/jdennes/contribution-checker/issues/9/labels{/name}",
+    "comments_url": "https://api.github.com/repos/jdennes/contribution-checker/issues/9/comments",
+    "events_url": "https://api.github.com/repos/jdennes/contribution-checker/issues/9/events",
+    "html_url": "https://github.com/jdennes/contribution-checker/issues/9",
+    "id": 58394546,
+    "number": 9,
+    "title": "Add missing criterion",
+    "user": {
+      "login": "jdennes",
+      "id": 65057,
+      "avatar_url": "https://avatars.githubusercontent.com/u/65057?v=3",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/jdennes",
+      "html_url": "https://github.com/jdennes",
+      "followers_url": "https://api.github.com/users/jdennes/followers",
+      "following_url": "https://api.github.com/users/jdennes/following{/other_user}",
+      "gists_url": "https://api.github.com/users/jdennes/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/jdennes/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/jdennes/subscriptions",
+      "organizations_url": "https://api.github.com/users/jdennes/orgs",
+      "repos_url": "https://api.github.com/users/jdennes/repos",
+      "events_url": "https://api.github.com/users/jdennes/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/jdennes/received_events",
+      "type": "User",
+      "site_admin": true
+    },
+    "labels": [
+
+    ],
+    "state": "open",
+    "locked": false,
+    "assignee": null,
+    "milestone": null,
+    "comments": 0,
+    "created_at": "2015-02-20T18:52:27Z",
+    "updated_at": "2015-02-20T18:52:27Z",
+    "closed_at": null,
+    "body": "The following [documented](https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile/#commits) criterion is missing from the `or_criteria` in the check results:\r\n\r\n> \"You have opened a pull request or issue in the repository.\""
+  }
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contribution-checker
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - James Dennes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-13 00:00:00.000000000 Z
+date: 2015-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -132,6 +132,7 @@ files:
 - spec/fixtures/default_compare_ahead.json
 - spec/fixtures/emails.json
 - spec/fixtures/gh-pages_compare.json
+- spec/fixtures/issues_and_prs.json
 - spec/fixtures/org_owned_repo.json
 - spec/fixtures/potential_fork.json
 - spec/fixtures/repo.json
@@ -164,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Check whether a commit is counted as a contribution.
@@ -175,6 +176,7 @@ test_files:
 - spec/fixtures/default_compare_ahead.json
 - spec/fixtures/emails.json
 - spec/fixtures/gh-pages_compare.json
+- spec/fixtures/issues_and_prs.json
 - spec/fixtures/org_owned_repo.json
 - spec/fixtures/potential_fork.json
 - spec/fixtures/repo.json