wanikani 0.0.2

data/lib/wanikani.rb

@@ -0,0 +1,45 @@
+# -*- encoding : utf-8 -*-
+require 'rest_client'
+require 'multi_json'
+
+require 'wanikani/user'
+require 'wanikani/study_queue'
+require 'wanikani/level'
+require 'wanikani/srs'
+require 'wanikani/recent_unlocks'
+
+module Wanikani
+  API_ENDPOINT = "http://www.wanikani.com/api/user"
+
+  def self.api_key=(api_key)
+    @api_key = api_key
+  end
+
+  def self.api_key
+    @api_key
+  end
+
+  def self.api_response(resource, optional_arg = nil)
+    raise ArgumentError, "You must define a resource to query Wanikani" if resource.nil? || resource.empty?
+    raise ArgumentError, "You must set your Wanikani API key before querying the API" if Wanikani.api_key.nil? || Wanikani.api_key.empty?
+
+    begin
+      response = RestClient.get("#{Wanikani::API_ENDPOINT}/#{Wanikani.api_key}/#{resource}/#{optional_arg}")
+      parsed_response = MultiJson.load(response)
+      
+      if parsed_response.has_key?("error")
+        self.raise_exception(parsed_response["error"]["message"])
+      else
+        return parsed_response
+      end
+    rescue => error
+      self.raise_exception(error.message)
+    end
+  end
+
+  private
+
+  def self.raise_exception(message)
+    raise Exception, "There was an error fetching the data from Wanikani (#{message})"
+  end
+end

data/lib/wanikani/level.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  class Level
+    # Gets the user's current level progression (radicals and Kanji).
+    #
+    # @return [Hash] Progress and total of radicals and Kanji for the user's current level.
+    def self.progression
+      api_response = Wanikani.api_response("level-progression")
+      return api_response["requested_information"]
+    end
+  end
+end

data/lib/wanikani/recent_unlocks.rb

@@ -0,0 +1,40 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  class RecentUnlocks
+    # Gets the recent unlocked items (radicals, Kanji and vocabulary).
+    #
+    # @param [Integer] limit the total number of items returned.
+    # @return [Array] Returns hashes of unlocked items and related information.
+    def self.list(limit = 10)
+      api_response = Wanikani.api_response("recent-unlocks", limit)
+      return api_response["requested_information"]
+    end
+
+    # Gets the recent unlocked radicals.
+    #
+    # @param [Integer] limit the total number of items returned.
+    # @return [Array] Returns hashes of unlocked radicals and related information.
+    def self.radicals(limit = 10)
+      unlock_list = self.list(limit)
+      return unlock_list.select { |unlock| unlock["type"] == "radical" }
+    end
+
+    # Gets the recent unlocked vocabulary.
+    #
+    # @param [Integer] limit the total number of items returned.
+    # @return [Array] Returns hashes of unlocked vocabulary and related information.
+    def self.vocabulary(limit = 10)
+      unlock_list = self.list(limit)
+      return unlock_list.select { |unlock| unlock["type"] == "vocabulary" }
+    end
+
+    # Gets the recent unlocked Kanji.
+    #
+    # @param [Integer] limit the total number of items returned.
+    # @return [Array] Returns hashes of unlocked Kanji and related information.
+    def self.kanji(limit = 10)
+      unlock_list = self.list(limit)
+      return unlock_list.select { |unlock| unlock["type"] == "kanji" }
+    end
+  end
+end

data/lib/wanikani/srs.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  class SRS
+    ITEM_TYPES = %w(apprentice guru master enlighten burned all)
+
+    # Gets the counts for each SRS level and item types.
+    #
+    # @param [String] item_type the SRS level that will be returned.
+    # @return [Hash] Returns the SRS information for each level for the user.
+    def self.distribution(item_type = "all")
+      raise ArgumentError, "Please use a valid SRS type (or none for all types)" if !ITEM_TYPES.include?(item_type)
+
+      api_response = Wanikani.api_response("srs-distribution")
+      srs_distribution = api_response["requested_information"]
+
+      return srs_distribution if item_type == "all"
+      return srs_distribution[item_type]
+    end
+  end
+end

data/lib/wanikani/study_queue.rb

@@ -0,0 +1,26 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  class StudyQueue
+    # Get the number of lessons and reviews that are currently in the user's queue.
+    #
+    # @return [Hash] Returns the number of lessons and reviews pending, along with upcoming review information.
+    def self.queue
+      api_response = Wanikani.api_response("study-queue")
+      return api_response["requested_information"]
+    end
+
+    # Check if there are lessons available.
+    #
+    # @return [Boolean] Returns true if there's at least one lesson available, or false if there are none.
+    def self.lessons_available?
+      return !self.queue["lessons_available"].zero?
+    end
+
+    # Check if there are reviews available.
+    #
+    # @return [Boolean] Returns true if there's at least one review available, or false if there are none.
+    def self.reviews_available?
+      return !self.queue["reviews_available"].zero?
+    end
+  end
+end

data/lib/wanikani/user.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  class User
+    # Gets the user information from WaniKani.
+    #
+    # @return [Hash] The user information for the WaniKani account by from the API key.
+    def self.information
+      api_response = Wanikani.api_response("user-information")
+      return api_response["user_information"]
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: wanikani
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors:
+- Dennis Martinez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  name: rest-client
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  name: multi_json
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  name: rspec
+- !ruby/object:Gem::Dependency
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  name: fakeweb
+description: Use WaniKani's (http://www.wanikani.com/) API in your Ruby applications
+email: dennis@dennmart.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/wanikani/study_queue.rb
+- lib/wanikani/recent_unlocks.rb
+- lib/wanikani/srs.rb
+- lib/wanikani/user.rb
+- lib/wanikani/level.rb
+- lib/wanikani.rb
+homepage: http://github.com/dennmart/wanikani-gem
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Add Japanese Kanji learning goodness to your Ruby projects!
+test_files: []
+has_rdoc: