contribution-checker 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19182ad1d31baf01f0dc6d78e7d3ba7d3f992bcb
-  data.tar.gz: a8f6d7d814d0637a965c93b43a98fe12465fecbe
+  metadata.gz: 861b8fcdc7200e4a0c0f2ac9a177a7cb5299e41d
+  data.tar.gz: 95cf9de9a6eb0f53e0060fa4740917d193349c96
 SHA512:
-  metadata.gz: ecbddc0756b18773bb5be5ef195f2b96251b30bddd1b8c20b1291749a057a29fa23b9079bc0be43e0123974f2c552caec18432af88681f46a2a17be7fdbf3aee
-  data.tar.gz: dcb17c150028c981d7939ecc53e9f8f1fc8c60512766387577f00aab4b53593b2f8f7486b668d33f5de3c6bb518348c67e8c3c8e99846c3ca237e9a60825b48a
+  metadata.gz: 92c9763dac3837ac574e7df2c3f9c3075d04f2934c437401f84dfe53c63c8ef597241d1ca47f0a5735e370df9a1bd5659ff82986fcdb892e9ef59b32b37814b0
+  data.tar.gz: 3115ca43d29d6a7b5ceb05db9c738a510a5529608df448d10858c9ad0c5c5df32135ef59a1c19be735950931d6f43cf7a385fb035c9bc6fb36415bf12eada2a6

data/README.md

@@ -5,14 +5,15 @@ People :heart: GitHub Contributions. However, it's not always simple to tell why
 ## Usage
 
 ```ruby
+require "contribution-checker"
+
 checker = ContributionChecker::Checker.new \
   :access_token => "<Your 40 char GitHub API token>",
   :commit_url   => "https://github.com/user/repo/commit/sha"
-)
 
 checker.check
 => {
-  :counted_as_contribution => true,
+  :contribution => true,
   :and_criteria => {
     :commit_in_valid_branch      => true,
     :commit_in_last_year         => true,

data/contribution-checker.gemspec

@@ -9,8 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["James Dennes"]
   spec.email         = ["jdennes@gmail.com"]
   spec.summary       = %q{Check whether a commit is counted as a contribution.}
-  spec.description   = %q{Check whether a GitHub commit is counted as a \
-    contribution for a specific GitHub user.}
+  spec.description   = %q{Check whether a GitHub commit is counted as a contribution for a specific GitHub user.}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/lib/contribution-checker.rb

@@ -1,2 +1,3 @@
 require "contribution-checker/version"
+require "contribution-checker/error"
 require "contribution-checker/checker"

data/lib/contribution-checker/checker.rb

@@ -31,7 +31,7 @@ module ContributionChecker
     #
     # @return [Hash] The return value takes the following form:
     # {
-    #   :counted_as_contribution => true,
+    #   :contribution => true,
     #   :and_criteria => {
     #     :commit_in_valid_branch      => true,
     #     :commit_in_last_year         => true,
@@ -46,12 +46,14 @@ module ContributionChecker
     #   }
     # }
     def check
-      parts = URI.parse(@commit_url).path.split("/")
-      @nwo = "#{parts[1]}/#{parts[2]}"
-      @sha = parts[4]
-      @user = @client.user
+      @nwo, @sha = parse_commit_url @commit_url
+      begin
+        @commit = @client.commit @nwo, @sha
+      rescue Octokit::NotFound
+        raise ContributionChecker::InvalidCommitUrlError
+      end
       @repo = @client.repository @nwo
-      @commit = @client.commit @nwo, @sha
+      @user = @client.user
 
       @commit_in_valid_branch = commit_in_valid_branch?
       @commit_in_last_year = commit_in_last_year?
@@ -79,6 +81,20 @@ module ContributionChecker
       }
     end
 
+    # Parses the commit URL provided.
+    #
+    # @return [Array] URL parts: nwo, sha
+    def parse_commit_url(url)
+      begin
+        parts = URI.parse(@commit_url).path.split("/")
+        nwo = "#{parts[1]}/#{parts[2]}"
+        sha = parts[4]
+        return nwo, sha
+      rescue
+        raise ContributionChecker::InvalidCommitUrlError
+      end
+    end
+
     # Checks whether the commit is in a valid branch. A valid branch is defined
     # as either the default branch of the repository, or the gh-pages branch.
     #

data/lib/contribution-checker/error.rb

@@ -0,0 +1,10 @@
+module ContributionChecker
+
+  # Error class to help us rescue from invalid commit URL input.
+  class InvalidCommitUrlError < StandardError
+    def initialize
+      super "Invalid commit URL provided"
+    end
+  end
+
+end

data/lib/contribution-checker/version.rb

@@ -1,3 +1,3 @@
 module ContributionChecker
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contribution-checker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James Dennes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-07 00:00:00.000000000 Z
+date: 2014-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -52,9 +52,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: |-
-  Check whether a GitHub commit is counted as a \
-      contribution for a specific GitHub user.
+description: Check whether a GitHub commit is counted as a contribution for a specific
+  GitHub user.
 email:
 - jdennes@gmail.com
 executables: []
@@ -69,6 +68,7 @@ files:
 - contribution-checker.gemspec
 - lib/contribution-checker.rb
 - lib/contribution-checker/checker.rb
+- lib/contribution-checker/error.rb
 - lib/contribution-checker/version.rb
 homepage: ''
 licenses: