wkcheck 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e071a3e6a1aa9c5a94e5cff33e1a46f1e9946b3
+  data.tar.gz: 91678d915c78a7381c672cbb51798abd46ea6add
+SHA512:
+  metadata.gz: d56c3205e7362729510d085aa7ea92307c96502dbfa3b8ceac2e562707623aff98b4b09a5baea6647937bb0882d6cdd5b792703b5285c262d66461ca2329af2d
+  data.tar.gz: 0437d3b35635beb805c40dde5e1f5e1521ec7008cfe58cae24a095f870cf23e72f438c90ca90d4359675918f64d917804883554b1617d395db4ba06979825e50

data/README.md

@@ -0,0 +1,46 @@
+[![Build Status](https://travis-ci.org/dennmart/wkcheck.png)](https://travis-ci.org/dennmart/wkcheck)
+
+**wkcheck** is a command-line tool to access information from your [WaniKani](http://www.wanikani.com/) account.
+
+## Installation
+```
+$ gem install wanikani
+```
+
+## API Key
+
+Before using wkcheck, you need to set up the WaniKani API key from your account. You need to use the `--api-key` flag to save your API Key for future use. This only needs to be done once. A file will be created in `~/.wkcheck.yml` with your API Key. The key can be found in your [account settings](http://www.wanikani.com/account).
+
+```
+$ wkcheck --api-key=YOUR_WANIKANI_API_KEY
+```
+
+## Usage
+
+Once the API Key is saved, simply run `wkcheck` to see how many lessons and reviews you have pending in WaniKani.
+
+```
+$ wkcheck
+You have no lessons pending.
+You have 93 reviews pending.
+```
+
+If you don't have any lessons or reviews pending, you'll be able to see when your next review will come up.
+
+```
+$ wkcheck
+You have no lessons or reviews now! You'll have some more on Sunday, May 10 at 8:45 AM.
+```
+
+## Contributing
+
+I'll be super-happy if you guys help giving back! If you want to do some hacking on wkcheck for your needs, this is a good guideline to get started:
+
+* Fork the repo on GitHub
+* Create a branch on your clone that will contain your changes
+* Hack away on your branch
+* Add tests in the `/features` or `/test` directory relating to your changes
+* Make sure all tests still pass (`rake test_all`)
+* If you're adding new functionality, make sure to update `README.md`
+* Push the branch to GitHub
+* Send me a pull request for your branch

data/bin/wkcheck

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+require 'slop'
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+require 'wkcheck'
+
+opts = Slop.parse(help: true) do
+  banner "Usage: wkcheck [options]"
+
+  on "api-key=", "Saves your WaniKani API Key to #{WKCheck::CONFIG_FILE}"
+
+  on "v", "version", "Show version number and quit" do
+    puts "wkcheck #{WKCheck::VERSION}"
+    exit
+  end
+end
+
+unless opts["api-key"].nil? || opts["api-key"].empty?
+  File.open(WKCheck::CONFIG_FILE, 'w') { |f| f.write({ api_key: opts["api-key"] }.to_yaml) } unless opts["api-key"].nil?
+  puts "WaniKani API Key saved to #{WKCheck::CONFIG_FILE}!"
+  exit
+end
+
+api_key = if File.exists?(WKCheck::CONFIG_FILE)
+            config = YAML.load_file(WKCheck::CONFIG_FILE)
+            config[:api_key]
+          end
+
+if api_key.nil? || api_key.empty?
+  puts "You must first save your WaniKani API Key using the --api-key flag."
+  exit 1
+end
+
+Wanikani.api_key = api_key
+
+puts WKCheck::Study.available_stats

data/lib/wkcheck.rb

@@ -0,0 +1,24 @@
+require 'wanikani'
+
+module WKCheck
+  VERSION = "0.0.2"
+  CONFIG_FILE = "#{Dir.home}/.wkcheck.yml"
+
+  class Study
+    def self.available_stats
+      queue = Wanikani::StudyQueue.queue
+      lessons = queue["lessons_available"]
+      reviews = queue["reviews_available"]
+      next_review_date = Time.at(queue["next_review_date"]).utc.strftime("%A, %B %-d at %-l:%M %p")
+
+      if lessons.zero? && reviews.zero?
+        message = "You have no lessons or reviews now! You'll have some more on #{next_review_date}."
+      else
+        message = "You have #{lessons.zero? ? "no" : lessons } lessons pending."
+        message += "\nYou have #{reviews.zero? ? "no" : reviews } reviews pending."
+      end
+
+      message
+    end
+  end
+end

data/wkcheck.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name          = "wkcheck"
+  s.version       = "0.0.2"
+  s.date          = "2013-05-12"
+  s.summary       = "Check your WaniKani stats from the command line"
+  s.description   = "Check your pending lessons and reviews of your WaniKani account (http://www.wanikani.com/) from the command line"
+  s.authors       = ["Dennis Martinez"]
+  s.email         = "dennis@dennmart.com"
+  s.homepage      = "http://github.com/dennmart/wkcheck"
+  s.executables   = ["wkcheck"]
+  s.require_paths = ["lib"]
+  s.files         = %w[
+    README.md
+    bin/wkcheck
+    wkcheck.gemspec
+    lib/wkcheck.rb
+  ]
+
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_runtime_dependency "wanikani", "~> 0.0.3"
+  s.add_runtime_dependency "slop", "~> 3.4.4"
+
+  s.add_development_dependency "aruba", "~> 0.5.2"
+  s.add_development_dependency "mocha", "~> 0.13.3"
+  s.add_development_dependency "rake", "~> 10.0.4"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: wkcheck
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dennis Martinez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wanikani
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+description: Check your pending lessons and reviews of your WaniKani account (http://www.wanikani.com/)
+  from the command line
+email: dennis@dennmart.com
+executables:
+- wkcheck
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/wkcheck
+- wkcheck.gemspec
+- lib/wkcheck.rb
+homepage: http://github.com/dennmart/wkcheck
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+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: Check your WaniKani stats from the command line
+test_files: []