Module: Wanikani::StudyQueue

Included in:
Client
Defined in:
lib/wanikani/study_queue.rb

Instance Method Summary collapse

Instance Method Details

#full_study_queue_response ⇒ Hash

Gets the full response of the Study Queue API call.

Returns:

  • (Hash) —

    full response from the Study Queue API call.



29
30
31
 
# File 'lib/wanikani/study_queue.rb', line 29

def full_study_queue_response
  return api_response("study-queue")
end

#lessons_available? ⇒ Boolean

Check if there are lessons available.

Returns:

  • (Boolean) —

    true if there’s at least one lesson available, or false if there are none.



15
16
17
 
# File 'lib/wanikani/study_queue.rb', line 15

def lessons_available?
  return !study_queue["lessons_available"].zero?
end

#reviews_available? ⇒ Boolean

Check if there are reviews available.

Returns:

  • (Boolean) —

    true if there’s at least one review available, or false if there are none.



22
23
24
 
# File 'lib/wanikani/study_queue.rb', line 22

def reviews_available?
  return !study_queue["reviews_available"].zero?
end

#study_queue ⇒ Hash

Get the number of lessons and reviews that are currently in the user’s queue.

Returns:

  • (Hash) —

    the number of lessons and reviews pending, along with upcoming review information.



7
8
9
10
 
# File 'lib/wanikani/study_queue.rb', line 7

def study_queue
  response = api_response("study-queue")
  return response["requested_information"]
end