github_streak_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ad582344ff768d248778902ac303eb9128d2500
+  data.tar.gz: b892b48f3a5c2bb49835843e7660eeffbed5b348
+SHA512:
+  metadata.gz: 777caa13d4a7825bee82c5f2942d7af0cbe91d01544e1273027008c415844f6eec6f4b1a4a75aca24c02b23a63314fb68035b696af80aac3ed032087a5f43c51
+  data.tar.gz: 3d338b36e18c921290ec0da6afa4c534c353865636edb2ddc6b2d69a5d2411aee2066a3c5692ec928359dc9a0fc94a26270c0c6708e721e546a17afc92a58c04

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/README.md

@@ -0,0 +1,40 @@
+# github_streak_check
+
+GitHub's user page (eg. https://github.com/yhara) shows 'Longest Streak',
+how many successive days the user is keep contributing. 
+
+This RubyGem provides a command to check if you have done today's
+contribution and optionally send an email if not.
+
+## Installation
+
+    $ gem i github_streak_check
+
+## Usage
+
+    $ github_streak_check GITHUB_USER_NAME
+
+Exit with status 0 if already did contribution, with 1 otherwise.
+
+### Sending alert mail
+
+    $ github_streak_check foo -m foo@example.com
+
+This will send an notification to the given mail address.
+github_streak_check uses [Pony](http://github.com/benprew/pony)'s default
+way to send email; use /usr/sbin/sendmail if exists, then try to send with SMTP on localhost.
+
+## Run test
+
+    $ bundle install
+    $ rspec
+
+## Limitations
+
+- Private repos are not supported
+- Commits to forked repo are not counted [unless it is merged to main repo](https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile), but github_streak_check returns OK for them, too
+- Fetches only recent 300 events, so it may fail if you make over 300 commits a day.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/github_streak_check

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'github_streak_check'
+require 'optparse'
+
+opts = {}
+option = OptionParser.new{|o|
+  o.banner = 'usage: github_streak_check USERNAME [options]'
+
+  o.on '-m', '--mail ADDRESS', 'Mail address to send notification(optional)' do |addr|
+    opts[:mail_to] = addr
+  end
+  o.on '-q', '--quiet', 'Supress message' do
+    $stdout = nil
+    $stderr = nil
+  end
+  o.on '-v', '--version', 'Show version' do
+    puts GithubStreakCheck::VERSION
+    exit
+  end
+  o.on '-h', '--help', 'Show this message' do
+    puts o
+    exit
+  end
+}
+rest = option.parse(ARGV)
+unless (opts[:username] = rest[0])
+  puts option
+  exit
+end
+
+GithubStreakCheck.new(opts).run

data/github_streak_check.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_streak_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "github_streak_check"
+  spec.version       = GithubStreakCheck::VERSION
+  spec.authors       = ["Yutaka HARA"]
+  spec.email         = ["yutaka.hara+github@gmail.com"]
+  spec.description   = %q{Checks if you already done today's commit}
+  spec.summary       = %q{Checks if you already done today's commit for GitHub's "Longest Streak" feature.}
+  spec.homepage      = "https://github.com/yhara/github_streak_check"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "pony", "~> 1.5.1"
+  spec.add_runtime_dependency "activesupport", "~> 4.0.1"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "fakeweb", "~> 1.3.0"
+  spec.add_development_dependency "timecop", "~> 0.6.3"
+end

data/lib/github_streak_check/version.rb

@@ -0,0 +1,3 @@
+class GithubStreakCheck
+  VERSION = "0.1.0"
+end

data/lib/github_streak_check.rb

@@ -0,0 +1,44 @@
+require "github_streak_check/version"
+require 'open-uri'
+require 'json'
+require 'active_support/time'
+require 'pony'
+
+class GithubStreakCheck
+  def initialize(opts)
+    @opts = opts
+  end
+
+  def run
+    if commited_today?
+      puts "Check OK: you've already done today(#{pst_today} PST)'s contribution."
+      exit 0
+    else
+      msg = "Check failed: You have not extended today(#{pst_today} PST)'s streak yet"
+      $stderr.puts msg
+      if (addr = @opts[:mail_to])
+        ret = Pony.mail(to: addr,
+                        from: addr,
+                        subject: "GithubStreakCheck",
+                        body: msg)
+        puts "Sent mail: #{ret.inspect}"
+      end
+      exit 1
+    end
+  end
+
+  def commited_today?
+    events = JSON.parse(open("https://api.github.com/users/#{@opts[:username]}/events?per_page=300").read)
+    return false if events.length == 0
+
+    return events.any?{|event|
+      Time.parse(event["created_at"]).to_date == pst_today
+    }
+  end
+
+  private
+
+  def pst_today
+    @pst_today ||= ActiveSupport::TimeZone["Pacific Time (US & Canada)"].today
+  end
+end

data/spec/github_streak_check_spec.rb

@@ -0,0 +1,73 @@
+require 'github_streak_check'
+require 'fakeweb'
+require 'timecop'
+
+FakeWeb.allow_net_connect = false
+
+describe GithubStreakCheck do
+  before do
+    @login = "taro"
+    @checker = GithubStreakCheck.new(username: @login) 
+  end
+
+  describe "#commited_today?" do
+    it "<no events> : false" do
+      FakeWeb.register_uri(:get,
+        "https://api.github.com/users/#{@login}/events?per_page=300",
+        body: "[]"
+      )
+      expect(@checker.commited_today?).to be_false
+    end
+
+    it "<yesterday's event> : false" do
+      FakeWeb.register_uri(:get,
+        "https://api.github.com/users/#{@login}/events?per_page=300",
+        body: '[{"created_at":"2013-11-04T10:47:16Z"}]'
+                         # == "2013-11-04T02:47:16-08:00"
+                       
+      )
+      Timecop.freeze(Time.parse("2013-11-05T07:00:00-08:00")) do
+        expect(@checker.commited_today?).to be_false
+      end
+    end
+
+    it "<today's event> : true" do
+      FakeWeb.register_uri(:get,
+        "https://api.github.com/users/#{@login}/events?per_page=300",
+        body: '[{"created_at":"2013-11-04T10:47:16Z"}]'
+                         # == "2013-11-04T02:47:16-08:00"
+                       
+      )
+      Timecop.freeze(Time.parse("2013-11-04T07:00:00-08:00")) do
+        expect(@checker.commited_today?).to be_true
+      end
+    end
+
+    it "<today's event> <tomorrow's event> : true" do
+      FakeWeb.register_uri(:get,
+        "https://api.github.com/users/#{@login}/events?per_page=300",
+        body: '[{"created_at":"2013-11-05T10:47:16Z"},' +
+                         # == "2013-11-05T02:47:16-08:00"
+               '{"created_at":"2013-11-04T10:47:16Z"}]'
+                         # == "2013-11-04T02:47:16-08:00"
+                       
+      )
+      Timecop.freeze(Time.parse("2013-11-04T07:00:00-08:00")) do
+        expect(@checker.commited_today?).to be_true
+      end
+    end
+
+    # Note: this happens when user is living in Tokyo, for example.
+    it "<tomorrow's event> : false" do
+      FakeWeb.register_uri(:get,
+        "https://api.github.com/users/#{@login}/events?per_page=300",
+        body: '[{"created_at":"2013-11-04T10:47:16Z"}]'
+                         # == "2013-11-04T02:47:16-08:00"
+                       
+      )
+      Timecop.freeze(Time.parse("2013-11-03T07:00:00-08:00")) do
+        expect(@checker.commited_today?).to be_false
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: github_streak_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yutaka HARA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: Checks if you already done today's commit
+email:
+- yutaka.hara+github@gmail.com
+executables:
+- github_streak_check
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/github_streak_check
+- github_streak_check.gemspec
+- lib/github_streak_check.rb
+- lib/github_streak_check/version.rb
+- spec/github_streak_check_spec.rb
+homepage: https://github.com/yhara/github_streak_check
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Checks if you already done today's commit for GitHub's "Longest Streak" feature.
+test_files:
+- spec/github_streak_check_spec.rb