renshuu 0.1.0 → 1.0.0

data/lib/renshuu/models/presence.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for term presence.
+  class Presence < Model
+    ##
+    # Model class for schedule presence.
+    class Schedule < Model
+      ##
+      # @!attribute [r] sched_id
+      #   @return [String]
+      attribute :sched_id, Types::String
+      alias schedule_id sched_id
+      ##
+      # @!attribute [r] name
+      #   @return [String]
+      attribute :name, Types::String
+      ##
+      # @!attribute [r] has_word
+      #   @return [Boolean]
+      attribute :has_word, Types::Params::Bool
+      alias has_word? has_word
+
+      ##
+      # Retrieves the schedule associated with this presence item.
+      #
+      # @return [Renshuu::Schedule]
+      #
+      # @see Renshuu::Schedule.get
+      def schedule
+        Renshuu::Schedule.get(schedule_id)
+      end
+    end
+    ##
+    # @!attribute [r] scheds
+    #   @return [Array<Schedule>]
+    attribute(:scheds, Types::Array.of(Schedule).default { [] })
+    alias schedules scheds
+
+    ##
+    # Model class for list presence.
+    class List < Model
+      ##
+      # @!attribute [r] list_id
+      #   @return [String]
+      attribute :list_id, Types::String
+      ##
+      # @!attribute [r] name
+      #   @return [String]
+      attribute :name, Types::String
+      ##
+      # @!attribute [r] set_name
+      #   @return [String, nil]
+      attribute? :set_name, Types::String
+      ##
+      # @!attribute [r] has_word
+      #   @return [Boolean]
+      attribute :has_word, Types::Params::Bool
+    end
+    ##
+    # @!attribute [r] lists
+    #   @return [Array<List>]
+    attribute(:lists, Types::Array.of(List).default { [] })
+  end
+end

data/lib/renshuu/models/profile.rb

@@ -12,5 +12,163 @@ module Renshuu
       body = Renshuu.client.query(:get, 'v1/profile')
       new(body)
     end
+
+    ##
+    # @!attribute [r] id
+    #   @return [String]
+    attribute :id, Types::String
+    ##
+    # @!attribute [r] real_name
+    #   @return [String]
+    attribute :real_name, Types::String
+    ##
+    # @!attribute [r] adventure_level
+    #   @return [String]
+    attribute :adventure_level, Types::String
+    ##
+    # @!attribute [r] user_length
+    #   @return [String]
+    attribute :user_length, Types::String
+    ##
+    # @!attribute [r] kao
+    #   @return [URI]
+    attribute :kao, Types::URI
+
+    ##
+    # Model class for user study counts.
+    class StudyCount < Model
+      ##
+      # @!attribute [r] today_all
+      #   @return [Integer]
+      attribute :today_all, Types::Integer
+      ##
+      # @!attribute [r] today_grammar
+      #   @return [Integer]
+      attribute :today_grammar, Types::Integer
+      ##
+      # @!attribute [r] today_vocab
+      #   @return [Integer]
+      attribute :today_vocab, Types::Integer
+      ##
+      # @!attribute [r] today_kanji
+      #   @return [Integer]
+      attribute :today_kanji, Types::Integer
+      ##
+      # @!attribute [r] today_sent
+      #   @return [Integer]
+      attribute :today_sent, Types::Integer
+      ##
+      # @!attribute [r] today_aconj
+      #   @return [Integer]
+      attribute :today_aconj, Types::Integer
+      ##
+      # @!attribute [r] today_conj
+      #   @return [Integer]
+      attribute :today_conj, Types::Integer
+      ##
+      # @!attribute [r] total
+      #   @return [Integer]
+      attribute :total, Types::Integer
+      ##
+      # @!attribute [r] total_vocab
+      #   @return [Integer]
+      attribute :total_vocab, Types::Integer
+      ##
+      # @!attribute [r] total_kanji
+      #   @return [Integer]
+      attribute :total_kanji, Types::Integer
+      ##
+      # @!attribute [r] total_grammar
+      #   @return [Integer]
+      attribute :total_grammar, Types::Integer
+      ##
+      # @!attribute [r] total_sent
+      #   @return [Integer]
+      attribute :total_sent, Types::Integer
+    end
+    ##
+    # @!attribute [r] studied
+    #   @return [StudyCount]
+    attribute :studied, StudyCount
+    alias study_count studied
+
+    ##
+    # Model class for profile JLPT progress.
+    class Progress < Model
+      ##
+      # @!attribute [r] n1
+      #   @return [Integer]
+      attribute :n1, Types::Integer
+      ##
+      # @!attribute [r] n2
+      #   @return [Integer]
+      attribute :n2, Types::Integer
+      ##
+      # @!attribute [r] n3
+      #   @return [Integer]
+      attribute :n3, Types::Integer
+      ##
+      # @!attribute [r] n4
+      #   @return [Integer]
+      attribute :n4, Types::Integer
+      ##
+      # @!attribute [r] n5
+      #   @return [Integer]
+      attribute :n5, Types::Integer
+    end
+    ##
+    # @!attribute [r] level_progress_percs
+    #   @return [Hash{String => Progress}]
+    attribute :level_progress_percs, Types::Hash.map(Types::String, Progress)
+
+    ##
+    # Model class for profile study streaks.
+    class Streak < Model
+      ##
+      # @!attribute [r] correct_in_a_row
+      #   @return [Integer]
+      attribute :correct_in_a_row, Types::Integer
+      ##
+      # @!attribute [r] correct_in_a_row_alltime
+      #   @return [Integer]
+      attribute :correct_in_a_row_alltime, Types::Integer
+      ##
+      # @!attribute [r] days_studied_in_a_row
+      #   @return [Integer]
+      attribute :days_studied_in_a_row, Types::Integer
+      ##
+      # @!attribute [r] days_studied_in_a_row_alltime
+      #   @return [Integer]
+      attribute :days_studied_in_a_row_alltime, Types::Integer
+    end
+    ##
+    # @!attribute [r] streaks
+    #   @return [Hash{String => Streak}]
+    attribute :streaks, Types::Hash.map(Types::String, Streak)
+
+    ##
+    # Model class for profile API usage.
+    class APIUsage < Model
+      ##
+      # @!attribute [r] calls_today
+      #   @return [Integer]
+      attribute :calls_today, Types::Integer
+      ##
+      # @!attribute [r] daily_allowance
+      #   @return [Integer]
+      attribute :daily_allowance, Types::Integer
+
+      ##
+      # Number of API calls remaining in today's quota.
+      #
+      # @return [Integer]
+      def remaining_today
+        daily_allowance - calls_today
+      end
+    end
+    ##
+    # @!attribute [r] api_usage
+    #   @return [APIUsage]
+    attribute :api_usage, APIUsage
   end
 end

data/lib/renshuu/models/schedule.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for schedules.
+  #
+  # @see https://api.renshuu.org/docs/#/Schedules
+  class Schedule < Model
+    ##
+    # Mapping between schedule booktypes and model classes.
+    #
+    # @see #term_class
+    BOOKTYPES = {
+      'kanji' => Kanji, 'vocab' => Word, 'grammar' => Grammar,
+      'sent' => Sentence
+    }.freeze
+
+    ##
+    # Lists all schedules of the current user.
+    #
+    # @return [Array<Schedule>]
+    #
+    # @see https://api.renshuu.org/docs/#/Schedules/get_schedule
+    def self.list
+      body = Renshuu.client.query(:get, 'v1/schedule')
+
+      body.fetch(:schedules).map { new(_1) }
+    end
+
+    ##
+    # Retrieves a specific schedule from the API.
+    #
+    # @param [String, Integer] id
+    # @return [Schedule]
+    #
+    # @see https://api.renshuu.org/docs/#/Schedules/get_schedule__id_
+    def self.get(id)
+      body = Renshuu.client.query(:get, "v1/schedule/#{id}")
+
+      body.fetch(:schedules).first.then { new(_1) }
+    end
+
+    ##
+    # @!attribute [r] id
+    #   @return [String]
+    attribute :id, Types::String
+    ##
+    # @!attribute [r] name
+    #   @return [String]
+    attribute :name, Types::String
+    ##
+    # @!attribute [r] booktype
+    #   @return [String]
+    attribute :booktype, Types::String
+    ##
+    # @!attribute [r] is_frozen
+    #   @return [Boolean]
+    attribute :is_frozen, Types::Params::Bool
+
+    ##
+    # Model class for schedules today counts.
+    class TodayCount < Model
+      transform_keys do |key|
+        key == :new ? :new_terms : key
+      end
+
+      ##
+      # @!attribute [r] review
+      #   @return [Integer]
+      attribute :review, Types::Integer
+      ##
+      # @!attribute [r] new_terms
+      #   @note +new+ is a reserved keyword, so we have to circumvent that.
+      #   @return [Integer]
+      attribute :new_terms, Types::Integer
+    end
+    ##
+    # @!attribute [r] today
+    #   rn [TodayCount]
+    attribute :today, TodayCount
+
+    ##
+    # Model class for schedule upcoming counts.
+    class UpcomingCount < Model
+      ##
+      # @!attribute [r] days_in_future
+      #   @return [Integer]
+      attribute :days_in_future, Types::Integer
+      ##
+      # @!attribute [r] terms_to_review
+      #   @return [Integer]
+      attribute :terms_to_review, Types::Integer
+    end
+    ##
+    # @!attribute [r] upcoming
+    #   @return [Array<UpcomingCount>]
+    attribute :upcoming, Types::Array.of(UpcomingCount)
+
+    ##
+    # Model class for schedule term counts.
+    class TermCount < Model
+      ##
+      # @!attribute [r] total_count
+      #   @return [Integer]
+      attribute :total_count, Types::Integer
+      ##
+      # @!attribute [r] studied_count
+      #   @return [Integer]
+      attribute :studied_count, Types::Integer
+      ##
+      # @!attribute [r] unstudied_count
+      #   @return [Integer]
+      attribute :unstudied_count, Types::Integer
+      ##
+      # @!attribute [r] hidden_count
+      #   @return [Integer]
+      attribute :hidden_count, Types::Integer
+    end
+    ##
+    # @!attribute [r] terms
+    #   @return [TermCount]
+    attribute :terms, TermCount
+
+    ##
+    # Model class for schedule new term counts.
+    class NewTermCount < Model
+      ##
+      # @!attribute [r] today_count
+      #   @return [Integer]
+      attribute :today_count, Types::Integer
+      ##
+      # @!attribute [r] rolling_week_count
+      #   @return [Integer]
+      attribute :rolling_week_count, Types::Integer
+    end
+    ##
+    # @!attribute [r] new_terms
+    #   @return [NewTermCount]
+    attribute :new_terms, NewTermCount
+
+    ##
+    # Retrieves the terms contained in the schedule.
+    #
+    # @param [Integer, nil] page
+    # @param [Symbol, nil] group One of +:all+, +:blocked+, +:studied+,
+    #   +:notyetstudied+, +:cannot_study+, +:review_today+, +:mastery_1+,
+    #   +:mastery_2+, +:mastery_3+, +:mastery_4+, +:mastery_5+, +:mastery_6+,
+    #   +:mastery_7+, +:mastery_8+ or +:mastery_9+.
+    #
+    # @return [Array<Kanji,Word,Grammar,Sentence>] Depending on the type of
+    #   schedule
+    def contents(page: nil, group: nil)
+      params =  { pg: page, group: }.compact
+      body = Renshuu.client.query(:get, "v1/schedule/#{id}/list", params:)
+
+      body.dig(:contents, :terms).map { term_class.new(_1) }
+    end
+
+    ##
+    # Adds the given item to the schedule.
+    #
+    # @param [Schedulable] item
+    #
+    # @return [Void]
+    # @raise [ArgumentError] If the type of the item does not match the
+    #   schedule's type
+    #
+    # @see Schedulable#add_to_schedule
+    def add(item)
+      unless item.is_a?(term_class)
+        raise ArgumentError, "Expected a `#{term_class}`, got a `#{item.class}`"
+      end
+
+      item.add_to_schedule(self)
+    end
+
+    ##
+    # Removes the given item from the schedule.
+    #
+    # @param [Schedulable] item
+    #
+    # @return [Void]
+    # @raise [ArgumentError] If the type of the item does not match the
+    #   schedule's type
+    #
+    # @see Schedulable#remove_from_schedule
+    def remove(item)
+      unless item.is_a?(term_class)
+        raise ArgumentError, "Expected a `#{term_class}`, got a `#{item.class}`"
+      end
+
+      item.remove_from_schedule(self)
+    end
+
+    ##
+    # Model class to use for this schedule's terms.
+    #
+    # @return [Class]
+    # @raise [KeyError]
+    #
+    # @see ::BOOKTYPES
+    def term_class
+      @term_class ||= BOOKTYPES.fetch(booktype) do |key|
+        raise KeyError, "Unkown schedule type `#{key}`"
+      end
+    end
+  end
+end

data/lib/renshuu/models/sentence.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for sentences.
+  #
+  # @see https://api.renshuu.org/docs/#/Sentence
+  class Sentence < Model
+    ##
+    # Searches sentences in Renshuu's dictionary.
+    #
+    # @param [String] value
+    #
+    # @return [Array<Sentence>]
+    #
+    # @see https://api.renshuu.org/docs/#/Sentence/get_reibun_search
+    def self.search(value)
+      Renshuu.client.query(:get, 'v1/reibun/search', params: { value: })
+        .fetch(:reibuns).map { new(_1) }
+    end
+
+    ##
+    # Retrieves sentences from Renshuu's dictionary for a specific word.
+    #
+    # @param [Word, Integer] word
+    #
+    # @return [Array<Sentence>]
+    #
+    # @see https://api.renshuu.org/docs/#/Sentence/get_reibun_search__word_id_
+    def self.word_search(word)
+      identifier = case word
+      when Integer then word
+      else word.id
+      end
+      Renshuu.client.query(:get, "v1/reibun/search/#{identifier}")
+        .fetch(:reibuns).map { new(_1) }
+    end
+
+    ##
+    # @!attribute [r] id
+    #   @return [String]
+    attribute :id, Types::String
+    ##
+    # @!attribute [r] japanese
+    #   @return [String]
+    attribute :japanese, Types::String
+    ##
+    # @!attribute [r] hiragana
+    #   @return [String, nil]
+    attribute? :hiragana, Types::String
+    ##
+    # @!attribute [r] meaning
+    #   @return [Hash{String => String}]
+    attribute :meaning, Types::Hash.map(Types::String, Types::String)
+  end
+end

data/lib/renshuu/models/types.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Module for type values.
+  module Types
+    include Dry.Types(default: :coercible)
+
+    ##
+    # Dry type for dates.
+    Date = Constructor(::Date) do |date|
+      case date
+      when ::Date then date
+      when 'Not yet' then nil
+      when 'Now' then ::Date.today
+      else ::Date.parse(date)
+      end
+    end
+
+    ##
+    # Dry type for URIs.
+    URI = Constructor(URI) do |uri|
+      ::URI.parse(uri)
+    end
+  end
+end

data/lib/renshuu/models/user_data.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for user data.
+  class UserData < Model
+    ##
+    # @!attribute [r] correct_count
+    #   @return [Integer]
+    attribute :correct_count, Types::Integer
+    ##
+    # @!attribute [r] missed_count
+    #   @return [Integer]
+    attribute :missed_count, Types::Integer
+    ##
+    # @!attribute [r] mastery_avg_perc
+    #   @return [Integer]
+    attribute :mastery_avg_perc, Types::Integer.fallback(0)
+
+    ##
+    # Model class for user data study vectors.
+    class StudyVector < Model
+      ##
+      # @!attribute [r] name
+      #   @return [String]
+      attribute :name, Types::String
+      ##
+      # @!attribute [r] correct_count
+      #   @return [Integer]
+      attribute :correct_count, Types::Integer
+      ##
+      # @!attribute [r] missed_count
+      #   @return [Integer]
+      attribute :missed_count, Types::Integer
+      ##
+      # @!attribute [r] mastery_perc
+      #   @return [Integer]
+      attribute :mastery_perc, Types::Integer
+      ##
+      # @!attribute [r] last_quizzed
+      #   @return [Date]
+      attribute :last_quizzed, Types::Date
+      ##
+      # @!attribute [r] next_quiz
+      #   @return [Date]
+      attribute :next_quiz, Types::Date
+    end
+    ##
+    # @!attribute [r] study_vectors
+    #   @return [Hash{String => StudyVector}]
+    attribute? :study_vectors, Types::Hash.map(Types::String, StudyVector)
+  end
+end

data/lib/renshuu/models/word.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for words and vocabulary.
+  #
+  # @see https://api.renshuu.org/docs/#/Vocabulary
+  class Word < Model
+    include Schedulable
+    include Listable
+
+    ##
+    # Searches the Renshuu vocabulary dictionary.
+    #
+    # @param [String] value
+    #
+    # @return [Array<Word>]
+    def self.search(value)
+      body = Renshuu.client.query(:get, 'v1/word/search', params: { value: })
+
+      body.fetch(:words).map { new(_1) }
+    end
+
+    ##
+    # Retrieves a word from the dictionary by its identifier.
+    #
+    # @param [Integer] id
+    #
+    # @return [Word]
+    def self.get(id)
+      body = Renshuu.client.query(:get, "v1/word/#{id}")
+
+      body.fetch(:words).first.then { new(_1) }
+    end
+
+    ##
+    # @!attribute [r] id
+    #   @return [String]
+    attribute :id, Types::String
+    ##
+    # @!attribute [r] kanji_full
+    #   @return [String]
+    attribute :kanji_full, Types::String
+    ##
+    # @!attribute [r] hiragana_full
+    #   @return [String]
+    attribute :hiragana_full, Types::String
+    ##
+    # @!attribute [r] pic
+    #   @return [Array<URI>]
+    attribute(:pic, Types::Array.of(Types::URI).default { [] })
+    alias pictures pic
+    ##
+    # @!attribute [r] markers
+    #   @return [Array<String>]
+    attribute(:markers, Types::Array.of(Types::String).default { [] })
+    ##
+    # @!attribute [r] pitch
+    #   @return [Array<String>]
+    attribute :pitch, Types::Array.of(Types::String)
+    ##
+    # @!attribute [r] typeofspeech
+    #   @return [String]
+    attribute :typeofspeech, Types::String
+    alias type_of_speech typeofspeech
+    ##
+    # @!attribute [r] def
+    #   @return [Array<String>]
+    attribute :def, Types::Array.of(Types::String)
+
+    ##
+    # @!attribute [r] user_data
+    #   @return [UserData, nil]
+    attribute? :user_data, UserData
+    ##
+    # @!attribute [r] presence
+    #   @return [Presence, nil]
+    attribute? :presence, Presence
+
+    ##
+    # Retrieves sentences using this word from the dictionary.
+    #
+    # @return [Array<Sentence>]
+    #
+    # @see Sentence.word_search
+    def sentences
+      Sentence.word_search(self)
+    end
+  end
+end

data/lib/renshuu/models.rb

@@ -3,9 +3,25 @@
 module Renshuu # rubocop:disable Style/Documentation
 end
 
+# Types
+require_relative 'models/types'
+
+# Mixins
+require_relative 'models/mixins/listable'
+require_relative 'models/mixins/schedulable'
+
 # Base class
 require_relative 'models/model'
 
-# Other models
+# Other models (respect blank lines for dependency order)
+require_relative 'models/presence'
+require_relative 'models/user_data'
+
+require_relative 'models/grammar'
 require_relative 'models/kanji'
 require_relative 'models/profile'
+require_relative 'models/sentence'
+require_relative 'models/word'
+
+require_relative 'models/list'
+require_relative 'models/schedule'

data/lib/renshuu/version.rb

@@ -3,5 +3,5 @@
 module Renshuu
   ##
   # Semantic version number of the library.
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/renshuu.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # External requires
+require 'dry-struct'
 require 'httpx'
-require 'recursive-open-struct'
 require 'uri'
 
 # Pre-module requires