gh_contrib 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae090cc95a0b2f79c232e8f54e419dfa3ae0ae73
-  data.tar.gz: 35919919f0b58ab5b5a411fc1edc354779d360bf
+  metadata.gz: 0e43359d39a497a4385b83845292c774fa452251
+  data.tar.gz: 02a26ec7cde1cc43ff37e1dbe3d3b48880bd6240
 SHA512:
-  metadata.gz: 7ebe8e4812c3f681c8ed5ec3dcba6bf052e9001c2a8f7d5fb4aea1821944ea4ba59da86a60d221627d9eee8c7089eb54448c1affeaa8bf3aad3bdfce3424f223
-  data.tar.gz: a5b0f293c6357a9377285baf886b79122fc6752cdc47f7ff98f59507b4bea6aba75435619f68871bc3cc79d2c1fe726362afaaf4fb9561cdeb01670a44fb0d91
+  metadata.gz: 9f8318e9e1d09022e7ca43b178b2237c4d61297cfedaa6ddcf7cef444214ce1ef781dc4d73452284cc0e99df1d2c540f033713c60ba48c4c40ff9dafe23acb8c
+  data.tar.gz: b784b1291b73fa8f1067bc5c2055bcdcc922443bb445b84bf7891560438a00bec702934962838e40cff9e6a715ca09132744e66e3f4150997fa33d41e2a9d19c

data/README.md

@@ -1 +1,53 @@
 # gh_contrib
+
+GitHub has a nice feature of [contributions](https://help.github.com/articles/viewing-contributions-on-your-profile-page/).
+But unfortunately they don't offer an official API.
+Now somehow we can get only from here (`https://github.com/users/<username>/contributions`). It returns HTML :cry:.
+This is just parsing HTML to JSON or returns as Ruby's object.
+
+## Usage
+
+### CLI
+
+```zsh
+$ gem install gh_contrib
+
+$ gh_contrib username
+
+$ echo 'GITHUB_USERNAME=username
+$ GITHUB_PASSWORD=password' > .env
+
+# or you can define on shell
+# export GITHUB_USERNAME=username
+# export GITHUB_PASSWORD=password
+
+$ gh_contrib username
+$ gh_contrib username -d month
+```
+
+### API
+
+```ruby
+require 'gh_contrib'
+
+agent = GhContrib::Agent.new
+puts agent.contributions 'username'
+
+agent.login 'username', 'password'
+
+puts agent.contributions 'username'
+puts agent.contributions_by_month 'username'
+```
+
+## Tips
+
+* Sum all the contributions with [jq](http://stedolan.github.io/jq/).
+
+```zsh
+$ gh_contrib banyan | jq 'reduce .[].count as $item (0; . + $item)'
+4698
+```
+
+## Limitations
+
+* You can't enable two factor authentication for this user if you want to get the data as logged in :cry:.

data/lib/gh_contrib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gh_contrib
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kohei Hasegawa