wanikani 1.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 47162b1fe2e86d5d805dae4c0e248c0f562ee8ba
-  data.tar.gz: ce663341e1e1a9f753a04d629eb3062c08335406
+SHA256:
+  metadata.gz: a313e7eca6981bd4ba6baf4f2dd0360a5e013bfde51a1bfc8d7f77184afee9ff
+  data.tar.gz: 2e13e29b6b19234142639720afa85578c7f036ba64e958c16102fbcde9c10990
 SHA512:
-  metadata.gz: 76585b1c58d2148d2ad6ace39e9be05e7f7f348e33d5ee73893a95c06496e679043e7df77567ff094d9f8c8c900d92257d766559c72ccc62904eae621790581e
-  data.tar.gz: 0d6ff0ef83595072ea0010594a3656a6022980d56fae0627ae9ec205349036cea08bf9ebbc00d427a1851e9572f5f4bf11fcaca6a1623f16ee281cddd84710dd
+  metadata.gz: 9bdbca8d53bed166a13720ba58e14564788d6a3c5e868d7e3469209940ac904c88b576514a860ac8926357f069523ed1da87ff86dff405de64f50684d29a080f
+  data.tar.gz: 1dceaa8c18c3eeb7cdf4e92fdb5b629b40ddd78627b648c8d8f9585fe6786ed109e26904483fbf9ec0781fabd10bd4f419a2fac39609610456aeaf9890db0185

data/lib/wanikani.rb

@@ -1,69 +1,40 @@
 # -*- 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'
-require 'wanikani/critical_items'
-require 'wanikani/exceptions'
+require 'wanikani/client'
+require 'wanikani/response'
+require 'wanikani/configuration'
+require 'wanikani/models/shared'
+require 'wanikani/models/assignment'
+require 'wanikani/models/level_progression'
+require 'wanikani/models/reset'
+require 'wanikani/models/review'
+require 'wanikani/models/review_statistic'
+require 'wanikani/models/spaced_repetition_system'
+require 'wanikani/models/study_material'
+require 'wanikani/models/subject'
+require 'wanikani/models/summary'
+require 'wanikani/models/user'
+require 'wanikani/models/voice_actor'
 
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
 module Wanikani
-  API_ENDPOINT = "https://www.wanikani.com/api"
-  DEFAULT_API_VERSION = "v1.4"
-  VALID_API_VERSIONS = %w(v1 v1.1 v1.2 v1.3 v1.4)
+  DEFAULT_API_REVISION = '20170710'
+  VALID_API_REVISIONS = %w(20170710)
 
-  def self.api_key=(api_key)
-    @api_key = api_key
-  end
+  class InvalidKey < Exception; end
+  class Exception < Exception; end
 
-  def self.api_key
-    @api_key
-  end
+  DEFAULT_CONFIG = {
+    api_revision: DEFAULT_API_REVISION
+  }
 
-  def self.api_version=(api_version)
-    raise ArgumentError, "API version should be one of the following: #{VALID_API_VERSIONS.join(', ')}." unless VALID_API_VERSIONS.include?(api_version) || api_version.nil?
-    @api_version = api_version
+  def self.configure
+    yield @config ||= Wanikani::Configuration.new(DEFAULT_CONFIG)
   end
 
-  def self.api_version
-    @api_version ||= DEFAULT_API_VERSION
-  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_version}/user/#{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
-
-  def self.valid_api_key?(api_key = nil)
-    api_key ||= Wanikani.api_key
-    return false if api_key.nil? || api_key.empty?
-
-    response = RestClient.get("#{Wanikani::API_ENDPOINT}/#{Wanikani.api_version}/user/#{api_key}/user-information/")
-    !MultiJson.load(response).has_key?("error")
-  end
-
-  private
-
-  def self.raise_exception(message)
-    raise Wanikani::Exception, "There was an error fetching the data from Wanikani (#{message})"
+  # global settings
+  def self.config
+    @config ||= Wanikani::Configuration.new(DEFAULT_CONFIG)
   end
 end

data/lib/wanikani/client.rb

@@ -0,0 +1,114 @@
+# -*- encoding : utf-8 -*-
+require 'faraday'
+require 'faraday_middleware'
+
+module Wanikani
+  class Client
+    API_ENDPOINT = "https://api.wanikani.com"
+
+    attr_accessor :api_key, :api_revision
+
+    # Initialize a client which will be used to communicate with WaniKani.
+    #
+    # @param options [Hash] the API key (required) and API version (optional)
+    #   used to communicate with the WaniKani API.
+    # @return [Wanikani::Client] an instance of Wanikani::Client.
+    def initialize(options = {})
+      raise ArgumentError, "You must specify a WaniKani API key before querying the API." if options[:api_key].nil? || options[:api_key].empty?
+      raise ArgumentError, "API revision should be one of the following: #{Wanikani::VALID_API_REVISIONS.join(', ')}." unless Wanikani::VALID_API_REVISIONS.include?(options[:api_revision]) || options[:api_revision].nil?
+
+      @api_key = options[:api_key]
+      @api_revision = options[:api_revision] ||= Wanikani::DEFAULT_API_REVISION
+
+    end
+
+    # Verifies if the client's API key is valid by checking WaniKani's API.
+    #
+    # @param api_key [String] the API key to validate in WaniKani.
+    # @return [Boolean] whether the API key is valid.
+    def valid_api_key?(api_key = nil)
+      api_key ||= @api_key
+      return false if api_key.empty?
+
+      res = client.get("/v2/user/")
+
+      return false if !res.success? || res.body.has_key?("error")
+      return true
+    end
+
+    # Verifies if the specified API key is valid by checking WaniKani's API.
+    #
+    # @param api_key [String] the API key to validate in WaniKani.
+    # @return [Boolean] whether the API key is valid.
+    def self.valid_api_key?(api_key = nil)
+      raise ArgumentError, "You must specify a WaniKani API key before querying the API." if api_key.nil? || api_key.empty?
+
+      @client = Wanikani::Client.new(api_key: api_key)
+      return @client.valid_api_key?
+    end
+
+    # API endpoint at WaniKani
+    #
+    # @return [String] URL of endpoint
+    def api_endpoint
+      API_ENDPOINT
+    end
+
+    # Contacts the WaniKani API and returns the data specified.
+    #
+    # @param resource [String] the resource to access.
+    # @param parameters [Hash] optional arguments for the specified resource.
+    # @return [Hash] the parsed API response.
+    def get(resource, parameters = nil)
+      raise ArgumentError, "You must define a resource to query WaniKani" if resource.nil? || resource.empty?
+
+      begin
+        res = client.get("/v2/#{resource}", parameters)
+
+        if !res.success? || res.body.has_key?("error")
+          raise_exception(res)
+        else
+          return res.body
+        end
+      rescue => error
+        raise Exception, "There was an error: #{error.message}"
+      end
+    end
+
+    private
+
+    # Sets up the HTTP client for communicating with the WaniKani API.
+    #
+    # @return [Faraday::Connection] the HTTP client to communicate with the
+    #   WaniKani API.
+    def client
+      Faraday.new(url: api_endpoint, :headers => headers) do |conn|
+        conn.response :json, :content_type => /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def headers
+      {
+        'Content-Type' => 'application/json',
+        'Wanikani-Revision' => api_revision,
+        'Authorization' => "Bearer #{api_key}"
+}
+    end
+
+
+    # Handles exceptions according to the API response.
+    #
+    # @param response [Hash] the parsed API response from WaniKani's API.
+    def raise_exception(response)
+      raise Wanikani::InvalidKey, "The API key used for this request is invalid." and return if response.status == 401
+
+      message = if response.body.is_a?(Hash) and response.body.has_key?("error")
+                  response.body["error"]
+                else
+                  "Status code: #{response.status}"
+                end
+      raise Wanikani::Exception, "There was an error fetching the data from WaniKani (#{message})"
+    end
+  end
+end

data/lib/wanikani/configuration.rb

@@ -0,0 +1,16 @@
+module Wanikani
+  class Configuration
+    attr_accessor :api_revision, :api_key
+
+    def initialize(configuration)
+      @api_revision = configuration.fetch(:api_revision)
+    end
+
+    def to_hash
+      {
+        api_revision: api_revision,
+        api_key: api_key
+      }
+    end
+  end
+end

data/lib/wanikani/models/assignment.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module Assignment
+    extend Wanikani::Shared
+
+    PERMITTED_PARAMS = %w[available_after available_before burned hidden ids immediately_available_for_lessons immediately_available_for_review in_review levels passed srs_stages started subject_ids subject_types unlocked updated_after page_after_id page_before_id].freeze
+
+    def self.permitted_params
+      PERMITTED_PARAMS
+    end
+
+    def self.find_all
+      find_by
+    end
+
+    def self.find_by(parameters = {})
+      respond(client.get('assignments', filter(parameters)))
+    end
+
+    def self.find(id)
+      respond(client.get("assignments/#{id}"))
+    end
+  end
+end

data/lib/wanikani/models/level_progression.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module LevelProgression
+    extend Wanikani::Shared
+
+    PERMITTED_PARAMS = %w[ids updated_after page_after_id page_before_id].freeze
+
+    def self.find_all
+      find_by
+    end
+
+    def self.find_by(parameters = {})
+      respond(client.get('level_progressions',
+                         filter(parameters)))
+    end
+
+    def self.find(id)
+      respond(client.get("level_progressions/#{id}"))
+    end
+
+    def self.permitted_params
+      PERMITTED_PARAMS
+    end
+  end
+end

data/lib/wanikani/models/reset.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module Reset
+    extend Wanikani::Shared
+
+    PERMITTED_PARAMS = %w[ids assignment_ids subject_ids updated_after page_after_id page_before_id].freeze
+
+    def self.find_by(parameters = {})
+      respond(client.get('resets', parameters))
+    end
+
+    def self.find(id)
+      respond(client.get("resets/#{id}"))
+    end
+
+    def self.permitted_params
+      PERMITTED_PARAMS
+    end
+  end
+end

data/lib/wanikani/models/review.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module Review
+    extend Wanikani::Shared
+
+    PERMITTED_PARAMS = %w[ids assignment_ids subject_ids updated_after page_after_id page_before_id].freeze
+
+    def self.find_all
+      find_by
+    end
+
+    def self.find_by(parameters = {})
+      respond(client.get('reviews', parameters))
+    end
+
+    def self.find(id)
+      respond(client.get("reviews/#{id}"))
+    end
+
+    def self.permitted_params
+      PERMITTED_PARAMS
+    end
+  end
+end

data/lib/wanikani/models/review_statistic.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module ReviewStatistic
+    extend Wanikani::Shared
+
+    PERMITTED_PARAMS = %w[ids hidden percentages_greater_than percentages_less_than subject_ids subject_types updated_after page_after_id page_before_id].freeze
+
+    def self.find_all
+      find_by
+    end
+
+    def self.find_by(parameters = {})
+      respond(client.get('review_statistics', parameters))
+    end
+
+    def self.find(id)
+      respond(client.get("review_statistics/#{id}"))
+    end
+
+    def self.permitted_params
+      PERMITTED_PARAMS
+    end
+  end
+end

data/lib/wanikani/models/shared.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module Shared
+    def respond(json)
+      Response.new(json)
+    end
+
+    def permitted_params
+      raise NotImplementedError
+    end
+
+    def filter(parameters)
+      parameters.keep_if { |key, value| permitted_params.include?(key.to_s) }
+    end
+
+    def client
+      @client ||= ::Wanikani::Client.new(::Wanikani.config.to_hash)
+    end
+  end
+end

data/lib/wanikani/models/spaced_repetition_system.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module SpacedRepetitionSystem
+    extend Wanikani::Shared
+
+    PERMITTED_PARAMS = %w[ids updated_after].freeze
+
+    def self.find_all
+      find_by
+    end
+
+    def self.find_by(parameters = {})
+      respond(client.get('spaced_repetition_systems',
+                         filter(parameters)))
+    end
+
+    def self.find(id)
+      respond(client.get("spaced_repetition_systems/#{id}"))
+    end
+
+    def self.permitted_params
+      PERMITTED_PARAMS
+    end
+  end
+end

data/lib/wanikani/models/study_material.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module StudyMaterial
+    extend Wanikani::Shared
+
+    PERMITTED_PARAMS = %w[ids hidden subject_ids subject_types updated_after page_after_id page_before_id].freeze
+
+    def self.find_all
+      find_by
+    end
+
+    def self.find_by(parameters = {})
+      respond(client.get('study_materials', parameters))
+    end
+
+    def self.find(id)
+      respond(client.get("study_materials/#{id}"))
+    end
+
+    def self.permitted_params
+      PERMITTED_PARAMS
+    end
+  end
+end

data/lib/wanikani/models/subject.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module Subject
+    extend Wanikani::Shared
+
+    PERMITTED_PARAMS = %w[ids types slugs levels hidden updated_after page_after_id page_before_id].freeze
+
+    def self.find_all
+      find_by
+    end
+
+    def self.find_by(parameters = {})
+      respond(client.get('subjects', parameters))
+    end
+
+    def self.find(id)
+      respond(client.get("subjects/#{id}"))
+    end
+
+    def self.permitted_params
+      PERMITTED_PARAMS
+    end
+  end
+end

data/lib/wanikani/models/summary.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module Summary
+    extend Wanikani::Shared
+
+    def self.fetch
+      respond(client.get('summary'))
+    end
+  end
+end

data/lib/wanikani/models/user.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module User
+    extend Wanikani::Shared
+
+    def self.fetch
+      respond(client.get('user'))
+    end
+  end
+end

data/lib/wanikani/models/voice_actor.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  module VoiceActor
+    extend Wanikani::Shared
+
+    PERMITTED_PARAMS = %w[ids updated_after page_after_id page_before_id].freeze
+
+    def self.find_all
+      find_by
+    end
+
+    def self.find_by(parameters = {})
+      respond(client.get('voice_actors', parameters))
+    end
+
+    def self.find(id)
+      respond(client.get("voice_actors/#{id}"))
+    end
+
+    def self.permitted_params
+      PERMITTED_PARAMS
+    end
+  end
+end

data/lib/wanikani/response.rb

@@ -0,0 +1,34 @@
+# -*- encoding : utf-8 -*-
+module Wanikani
+  class Response
+    attr_reader :response_data
+
+    def initialize(response_data)
+      @response_data = response_data
+    end
+
+    def data
+      response_data['data']
+    end
+
+    def id
+      response_data['id']
+    end
+
+    def object
+      response_data['object']
+    end
+
+    def data_updated_at
+      response_data['data_updated_at']
+    end
+
+    def per_page
+      response_data['pages']['per_page']
+    end
+
+    def total_count
+      response_data['total_count']
+    end
+  end
+end

data/lib/wanikani/version.rb

@@ -1,3 +1,3 @@
 module Wanikani
-  VERSION = '1.3'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: wanikani
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: 3.0.0
 platform: ruby
 authors:
 - Dennis Martinez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-27 00:00:00.000000000 Z
+date: 2020-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.0'
 description: Use WaniKani's (https://www.wanikani.com/) API in your Ruby applications
 email: dennis@dennmart.com
 executables: []
@@ -73,19 +73,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/wanikani.rb
-- lib/wanikani/critical_items.rb
-- lib/wanikani/exceptions.rb
-- lib/wanikani/level.rb
-- lib/wanikani/recent_unlocks.rb
-- lib/wanikani/srs.rb
-- lib/wanikani/study_queue.rb
-- lib/wanikani/user.rb
+- lib/wanikani/client.rb
+- lib/wanikani/configuration.rb
+- lib/wanikani/models/assignment.rb
+- lib/wanikani/models/level_progression.rb
+- lib/wanikani/models/reset.rb
+- lib/wanikani/models/review.rb
+- lib/wanikani/models/review_statistic.rb
+- lib/wanikani/models/shared.rb
+- lib/wanikani/models/spaced_repetition_system.rb
+- lib/wanikani/models/study_material.rb
+- lib/wanikani/models/subject.rb
+- lib/wanikani/models/summary.rb
+- lib/wanikani/models/user.rb
+- lib/wanikani/models/voice_actor.rb
+- lib/wanikani/response.rb
 - lib/wanikani/version.rb
 homepage: https://github.com/dennmart/wanikani-gem
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |2
+      Version 3.0 of the wanikani gem introduces many breaking changes in support of Wanikani API 2.0.
+      Please view the README for more information: https://github.com/dennmart/wanikani-gem
 rdoc_options: []
 require_paths:
 - lib
@@ -93,15 +103,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Add Japanese Kanji learning goodness to your Ruby projects!

data/lib/wanikani/critical_items.rb

@@ -1,23 +0,0 @@
-# -*- encoding : utf-8 -*-
-module Wanikani
-  class CriticalItems
-    # Gets the user's current items under 'Critical Items'.
-    #
-    # @param [Integer] percentage maximum percentage
-    # @return [Array] Returns hashes of critical items and their related information.
-    def self.critical(percentage = 75)
-      raise ArgumentError, "Percentage must be an Integer between 0 and 100" if !percentage.between?(0, 100)
-      api_response = Wanikani.api_response("critical-items", percentage)
-      return api_response["requested_information"]
-    end
-
-    # Gets the full response of the Critical Items List API call.
-    #
-    # @param [Integer] percentage maximum percentage
-    # @return [Hash] Full response from the Critical Items List API call.
-    def self.full_response(percentage = 75)
-      raise ArgumentError, "Percentage must be an Integer between 0 and 100" if !percentage.between?(0, 100)
-      return Wanikani.api_response("critical-items", percentage)
-    end
-  end
-end

data/lib/wanikani/exceptions.rb

@@ -1,3 +0,0 @@
-module Wanikani
-  class Exception < Exception; end
-end

data/lib/wanikani/level.rb

@@ -1,38 +0,0 @@
-# -*- 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")
-      current_level = { "current_level" => api_response["user_information"]["level"] }
-      return api_response["requested_information"].merge(current_level)
-    end
-
-    # Gets the full response of the Level Progression API call.
-    #
-    # @return [Hash] Full response from the Level Progression API call.
-    def self.full_response
-      return Wanikani.api_response("level-progression")
-    end
-
-    private
-
-    def self.method_missing(name, *args)
-      super unless [:radicals, :kanji, :vocabulary].include?(name)
-
-      levels = args.push
-      levels = levels.join(',') if levels.is_a?(Array)
-      api_response = Wanikani.api_response(name.to_s, levels)
-
-      # The vocabulary API call without specifying levels returns a Hash instead
-      # of an Array, so this is a hacky way of dealing with it.
-      if api_response["requested_information"].is_a?(Hash)
-        return api_response["requested_information"]["general"]
-      else
-        return api_response["requested_information"]
-      end
-    end
-  end
-end

data/lib/wanikani/recent_unlocks.rb

@@ -1,32 +0,0 @@
-# -*- 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 full response of the Recents Unlocks List API call.
-    #
-    # @param [Integer] limit the total number of items returned.
-    # @return [Hash] Full response from the Recent Unlocks List API call.
-    def self.full_response(limit = 10)
-      return Wanikani.api_response("recent-unlocks", limit)
-    end
-
-    private
-
-    def self.method_missing(name, *args)
-      super unless [:radicals, :vocabulary, :kanji].include?(name)
-
-      limit = args.shift || 10
-      type = name == :radicals ? name.to_s.chop! : name.to_s
-      unlock_list = self.list(limit)
-      return unlock_list.select { |unlock| unlock["type"] == type }
-    end
-  end
-end

data/lib/wanikani/srs.rb

@@ -1,46 +0,0 @@
-# -*- 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
-
-    # Gets all items for a specific SRS level.
-    #
-    # @param [String] item_type the SRS level for the items returned.
-    # @return [Array] Returns all the items matching the specified SRS for each level for the user.
-    def self.items_by_type(item_type)
-      raise ArgumentError, "Please use a valid SRS type." if !ITEM_TYPES.include?(item_type) || item_type == "all"
-
-      items_by_type = []
-      %w(radicals kanji vocabulary).each do |type|
-        items = Wanikani::Level.send(type)
-        items.reject! { |item| item["user_specific"].nil? || item["user_specific"]["srs"] != item_type }.map! do |item|
-          item.merge!("type" => (type == 'radicals' ? 'radical' : type))
-        end
-        items_by_type << items
-      end
-
-      items_by_type.flatten
-    end
-
-    # Gets the full response of the SRS Distribution API call.
-    #
-    # @return [Hash] Full response from the SRS Distribution API call.
-    def self.full_response
-      return Wanikani.api_response("srs-distribution")
-    end
-  end
-end

data/lib/wanikani/study_queue.rb

@@ -1,33 +0,0 @@
-# -*- 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
-
-    # Gets the full response of the Study Queue API call.
-    #
-    # @return [Hash] Full response from the Study Queue API call.
-    def self.full_response
-      return Wanikani.api_response("study-queue")
-    end
-  end
-end

data/lib/wanikani/user.rb

@@ -1,53 +0,0 @@
-# -*- 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
-
-    # Checks if the user is currently in vacation mode.
-    #
-    # @return [Boolean] true if vacation_date contains a timestamp, false if
-    #   vacation_date is null.
-    def self.on_vacation?
-      api_response = Wanikani.api_response("user-information")
-      vacation_date = api_response["user_information"]["vacation_date"]
-      return !vacation_date.nil?
-    end
-
-    # Returns the Gravatar image URL using the Gravatar hash from the user's information.
-    #
-    # @param options [Hash] Optional settings for the gravatar URL.
-    # @return [String] The Gravatar URL, with the optional size parameter, nil if
-    #   the user information contains no Gravatar hash.
-    def self.gravatar_url(options = {})
-      raise ArgumentError, "The size parameter must be an integer" if options[:size] && !options[:size].is_a?(Integer)
-      api_response = Wanikani.api_response("user-information")
-      hash = api_response["user_information"]["gravatar"]
-
-      return nil if hash.nil?
-      return build_gravatar_url(hash, options)
-    end
-
-    # Gets the full response of the User Information API call.
-    #
-    # @return [Hash] Full response from the User Information API call.
-    def self.full_response
-      return Wanikani.api_response("user-information")
-    end
-
-    private
-
-    def self.build_gravatar_url(hash, options)
-      params = "d=mm" # Use 'Mystery Man' image if no image found.
-      params += "&size=#{options[:size]}" if options[:size]
-
-      return "https://secure.gravatar.com/avatar/#{hash}?#{params}" if options[:secure]
-      return "http://www.gravatar.com/avatar/#{hash}?#{params}"
-    end
-  end
-end