github_contributions_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1380017f03381e51c2b16db583cab90befe49ec
+  data.tar.gz: 4b277d21d9b671ee8b39cb36db876b47c17fb0e2
+SHA512:
+  metadata.gz: 7e1f352d1c638fa4fd877de82d89b7a41d4f5b5209066f5443c8603be610482fac02a208902c3fd9e07bd3d146ab7291aa9bc1038b91675e560f0cbd7c515619
+  data.tar.gz: 9f86c1dfa3bc87fc07519604cf9d2d4a4e1e3aa20fcc24680455d7f0596ba0ff086ced922648ea7bf1022b78f5441d96bf2a192bb2081f36d8a2cdd2a330895e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.11.2

data/.yardopts

@@ -0,0 +1 @@
+--markup-provider=redcarpet --markup=markdown

data/CREDITS.md

@@ -0,0 +1,6 @@
+# Credits, Notes, and Reference
+
+  + https://githubcontributions.io/
+  + https://github.com/tenex/github-contributions
+  + https://jsonformatter.curiousconcept.com/
+  + http://data-creative.info/process-documentation/2015/07/03/how-to-make-a-ruby-gem.html

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github_contributions_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 MJ Rossetti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# GitHub Contributions API - Ruby
+
+A ruby interface to the [GitHub Contributions Archive](https://githubcontributions.io) API. Get information about GitHub users and events, including all repositories a user has contributed to. No authentication required.
+
+## Installation
+
+Add this line to your application's Gemfile before running `bundle install`:
+
+```ruby
+gem 'github_contributions_api'
+```
+
+Or install it yourself as:
+
+    $ gem install github_contributions_api
+
+## Usage
+
+### GitHub User
+
+Get GitHub user information, including all repositories contributed to.
+
+```` sh
+user = GithubContributionsApi.user("octocat")
+
+#=> {
+#  "username":"octocat",
+#  "repos":[
+#    "OpenELEC/OpenELEC.tv",
+#    "octocat/Hello-World",
+#    "octocat/Spoon-Knife",
+#    "octocat/ThisIsATest",
+#    "octocat/git-alliance",
+#    "octocat/git-consortium",
+#    "octocat/octocat.github.io"
+#  ],
+#  "eventCount":28
+#}
+````
+
+### GitHub Events
+
+Get events information for a given GitHub user. By default, this returns the first page of available results.
+
+```` sh
+events = GithubContributionsApi.user_events("octocat")
+
+#=> {
+#  "events":[
+#    {
+#      "_event_id":"3342744700",
+#      "_id":"564c28d972c4347a4234f081",
+#      "_repo_lower":"octocat/octocat.github.io",
+#      "_user_lower":"octocat",
+#      "before":"e2daa5755ee24217f39a10dc6b94988c19e0f109",
+#      "commit_count":1,
+#      "created_at":"2015-11-14T22:22:37+00:00",
+#      "distinct_commit_count":1,
+#      "head":"3a9796cf19902af0f7e677391b340f1ae4128433",
+#      "ref":"refs/heads/master",
+#      "repo":"octocat/octocat.github.io",
+#      "type":"PushEvent",
+#      "user":"octocat"
+#    },
+#    ...
+#    {
+#      "_id":"564de6ba72c4347a42a05b05",
+#      "_org_lower":"",
+#      "_repo_lower":"octocat/thisisatest",
+#      "_user_lower":"octocat",
+#      "created_at":"2012-03-12T21:14:01+00:00",
+#      "org":"",
+#      "repo":"octocat/ThisIsATest",
+#      "type":"PublicEvent",
+#      "user":"octocat"
+#    }
+#  ],
+#  "start":0,
+#  "end":28,
+#  "currentPage":1,
+#  "size":28
+#}
+````
+
+Optionally traverse pagination for users who have more than one page of events.
+
+```` sh
+events = GithubContributionsApi.user_events("s2t2", :page => 2)
+````
+
+## Development
+
+```` sh
+git clone git@github.com:data-creative/github-contributions-api-ruby.git
+cd github-contributions-api-ruby.git/
+````
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/data-creative/github-contributions-api-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "github_contributions_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/github_contributions_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_contributions_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_contributions_api"
+  spec.version       = GithubContributionsApi::VERSION
+  spec.authors       = ["MJ Rossetti"]
+  spec.email         = ["datacreativellc@gmail.com"]
+
+  spec.summary       = %q{A ruby interface to the GitHub Contributions Archive API (https://githubcontributions.io). Get information about GitHub users and events, including all repositories a user has contributed to. No authentication required.}
+  spec.description   = %q{A ruby interface to the GitHub Contributions Archive API (https://githubcontributions.io). Get information about GitHub users and events, including all repositories a user has contributed to. No authentication required.}
+  spec.homepage      = "https://github.com/data-creative/github-contributions-api-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "github-markup"
+  spec.add_dependency "httparty", "~> 0.13"
+end

data/lib/github_contributions_api.rb

@@ -0,0 +1,34 @@
+require "github_contributions_api/version"
+require 'json'
+require "httparty"
+
+# A ruby interface to the GitHub Contributions Archive API (https://githubcontributions.io). To the author's knowlege, this API is undocumented.
+module GithubContributionsApi
+  # The prexix for all GitHub Contributions API endpoints.
+  URL_BASE = "https://githubcontributions.io/api"
+
+  # Get information about a given github user.
+  # @param [String] github_username The username of the github user.
+  # @example GithubContributionsApi.user("octocat")
+  # @return [Hash]
+  def self.user(github_username)
+    request_url = "#{URL_BASE}/user/#{github_username}"
+    response = HTTParty.get(request_url)
+    JSON.parse(response.body)
+  end
+
+  # Get events for a given github user.
+  # @param [String] github_username The username of the github user.
+  # @param [Hash] options
+  # @option options [Integer] :page (1) The requested page number.
+  # @example GithubContributionsApi.user_events("octocat")
+  # @example GithubContributionsApi.user_events("octocat", :page => 1)
+  # @example GithubContributionsApi.user_events("s2t2", :page => 2)
+  # @return [Hash]
+  def self.user_events(github_username, options = {})
+    page_number = options[:page] || 1
+    request_url = "#{URL_BASE}/user/#{github_username}/events/#{page_number}"
+    response = HTTParty.get(request_url)
+    JSON.parse(response.body)
+  end
+end

data/lib/github_contributions_api/version.rb

@@ -0,0 +1,4 @@
+module GithubContributionsApi
+  # The current version of this library. Follows semantic versioning (http://semver.org/).
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: github_contributions_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- MJ Rossetti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: A ruby interface to the GitHub Contributions Archive API (https://githubcontributions.io).
+  Get information about GitHub users and events, including all repositories a user
+  has contributed to. No authentication required.
+email:
+- datacreativellc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CREDITS.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- github_contributions_api.gemspec
+- lib/github_contributions_api.rb
+- lib/github_contributions_api/version.rb
+homepage: https://github.com/data-creative/github-contributions-api-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A ruby interface to the GitHub Contributions Archive API (https://githubcontributions.io).
+  Get information about GitHub users and events, including all repositories a user
+  has contributed to. No authentication required.
+test_files: []
+has_rdoc: