whenkani 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f7f0865d0d3596b94ea14a999d4c3a0a1ee16ce
+  data.tar.gz: 03adb254a2fbf46ebe991ae857ae4ac729263d95
+SHA512:
+  metadata.gz: 63f991b89ea064f9103e84422fe49caf54646b33395018fe2d48b591e6d364a30665cd6b70bff173e93ef528a6e15765c8156d7e365e798b56c97b4192d4782a
+  data.tar.gz: b491e9a3b154207eab6859514233ac812a90ed5036d22d7f7f70aeaf440936022c9dc6744241b93652d4903df4d2d0e429b71eeb7a10e041eb939da98744445c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,52 @@
+# Whenkani
+
+Tells you when you're ready to study at
+[WaniKani](https://www.wanikani.com/dashboard).
+
+## Installing
+
+```
+$ bundle gem install whenkani
+```
+
+## Usage
+
+First, you'll need your API key from your [Account
+page](https://www.wanikani.com/account)
+
+Set the API key via an environment variable (usually sourced in a profile):
+
+```
+$ WANIKANI_API_KEY=abcdef12345 whenkani
+```
+
+Set the API key as a command line argument:
+```
+$ whenkani abcdef12345
+```
+
+## Output
+
+### When you're ready to study
+
+When you have lessons or reviews to do, you'll see this output:
+
+```
+$ whenkani
+You're ready to study!
+https://www.wanikani.com/dashboard
+```
+
+`whenkani` will exit with code 0 if you're ready to study.
+
+### When you have no lessons or reviews
+
+When you don't have lessons yet, whenkani will tell you how long to wait:
+
+```
+$ whenkani
+You're not ready, come back in 4 minutes
+```
+
+`whenkani` will exit non-zero if you're not ready to study. This may be useful
+if you want to incorporate this gem into other automation scripts.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "whenkani"
+
+# 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 "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/exe/whenkani

@@ -0,0 +1,40 @@
+require "whenkani"
+
+api_key = ARGV[0] || ENV['WANIKANI_API_KEY']
+if api_key.nil? || api_key.empty?
+  raise <<~USAGE
+
+    No API key was provided. It's at the bottom fo your WaniKani Account page:
+      https://www.wanikani.com/account
+
+    usage (environment variable):
+      WANIKANI_API_KEY=abcdef12345 whenkani
+
+    usage (command line argument):
+      whenkani abcdef12345
+
+  USAGE
+end
+
+def human_time(seconds)
+  if seconds < 60
+    "#{seconds} seconds"
+  elsif seconds < (60 * 60)
+    "#{seconds / 60} minutes"
+  elsif seconds < (60 * 60 * 24)
+    "#{seconds / (60 * 60)} hours"
+  else
+    "#{seconds / (60 * 60 * 24)} days"
+  end
+end
+
+seconds = WhenKani.new(api_key).seconds_until_review
+
+if seconds > 0
+  puts "You're not ready, come back in #{human_time(seconds)}"
+  exit 42
+else
+  puts "You're ready to study!"
+  puts "https://www.wanikani.com/dashboard"
+  exit 0
+end

data/lib/whenkani.rb

@@ -0,0 +1,24 @@
+require "net/http"
+require "json"
+require "whenkani/version"
+
+class WhenKani
+  def initialize(api_key)
+    @api_key = api_key
+  end
+
+  def seconds_until_review
+    uri = URI("https://www.wanikani.com/api/user/#{@api_key}/study-queue")
+    response = JSON.parse(Net::HTTP.get(uri))
+    raise response["error"]["message"] if response.has_key?("error")
+    info = response["requested_information"]
+    seconds = info["next_review_date"] - Time.new.to_i
+    if info["reviews_available"] > 0 ||
+        info["lessons_available"] > 0 ||
+        seconds < 0
+      0
+    else
+      seconds
+    end
+  end
+end

data/lib/whenkani/version.rb

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

data/whenkani.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whenkani/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whenkani"
+  spec.version       = WhenKani::VERSION
+  spec.authors       = ["Justin Searls"]
+  spec.email         = ["searls@gmail.com"]
+
+  spec.summary       = %q{Tells you when you're ready to study WaniKani}
+  spec.description   = %q{Helps you know when you're ready to study WaniKani}
+  spec.homepage      = "https://github.com/searls/whenkani"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: whenkani
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justin Searls
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: pry
+  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'
+description: Helps you know when you're ready to study WaniKani
+email:
+- searls@gmail.com
+executables:
+- whenkani
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/whenkani
+- lib/whenkani.rb
+- lib/whenkani/version.rb
+- whenkani.gemspec
+homepage: https://github.com/searls/whenkani
+licenses: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Tells you when you're ready to study WaniKani
+test_files: []