duolingo_personal_data 0.1.0

data/lib/duolingo_personal_data/friends_follow.rb

@@ -0,0 +1,47 @@
+module DuolingoPersonalData
+  class FriendsFollow
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    def num_following
+      @num_following ||= integer_value_from_property("num_following")
+    end
+
+    def num_followers
+      @num_followers ||= integer_value_from_property("num_followers")
+    end
+
+    def num_blocking
+      @num_blocking ||= integer_value_from_property("num_blocking")
+    end
+
+    def num_blockers
+      @num_blockers ||= integer_value_from_property("num_blockers")
+    end
+
+    def timestamp_generated
+      @timestamp_generated ||= timestamp_value_from_property("timestamp_generated")
+    end
+
+    private
+
+    def value_from_property(property_name)
+      table.first[property_name]
+    end
+
+    def integer_value_from_property(property_name)
+      value = value_from_property(property_name)
+      Integer(value)
+    end
+
+    def timestamp_value_from_property(property_name)
+      value = integer_value_from_property(property_name)
+      Time.at(value)
+    end
+
+    def table
+      @table ||= CSV.read(@csv_path, headers: true)
+    end
+  end
+end

data/lib/duolingo_personal_data/inventory.rb

@@ -0,0 +1,48 @@
+require "forwardable"
+
+module DuolingoPersonalData
+  InventoryItem = Struct.new(:item_type, :purchase_datetime, :active, :price_in_virtual_currency, :wager_day,
+                             :payment_processor, :product, :expected_expiration, keyword_init: true)
+
+  class Inventory
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    extend Forwardable
+    def_delegators :items, *(Array.instance_methods - [:object_id])
+
+    private
+
+    def items
+      @items ||= table.map do |row|
+        item = InventoryItem.new(item_type: row["item_type"],
+                                 purchase_datetime: parse_datetime(row["purchase_datetime"]), active: parse_boolean(row["active"]), payment_processor: row["payment_processor"], product: row["product"])
+        price = row["price_in_virtual_currency"]
+        item.price_in_virtual_currency = Integer(price) if price
+        day = row["wager_day"]
+        item.wager_day = Integer(day) if day
+        expiration = row["expected_expiration"]
+        item.expected_expiration = parse_datetime(expiration) if expiration
+        item
+      end
+    end
+
+    def parse_datetime(str)
+      Time.strptime(str, "%Y-%m-%d %T")
+    end
+
+    def parse_boolean(str)
+      case str
+      when "false" then false
+      when "true" then true
+      else
+        raise Error, "cannot parse #{str.inspect} as boolean"
+      end
+    end
+
+    def table
+      @table ||= CSV.read(@csv_path, headers: true)
+    end
+  end
+end

data/lib/duolingo_personal_data/languages.rb

@@ -0,0 +1,42 @@
+require "forwardable"
+require "csv"
+
+module DuolingoPersonalData
+  Language = Struct.new(:from_language, :points, :skill_learned, :total_lessons, :days_active, :last_active,
+                        :prior_proficiency, :subscribed, keyword_init: true)
+  class Languages
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    extend Forwardable
+    def_delegators :languages, *(Hash.instance_methods - [:object_id])
+
+    private
+
+    def languages
+      @languages ||= CSV.read(@csv_path, headers: true).map do |row|
+        language = Language.new(from_language: row["from_language"])
+        points = row["points"]
+        language.points = Integer(points) if points
+        skills = row["skills_learned"]
+        language.skill_learned = Integer(skills) if skills
+        lessons = row["total_lessons"]
+        language.total_lessons = Integer(lessons) if lessons
+        days = row["days_active"]
+        language.days_active = Integer(days) if days
+        active = row["last_active"]
+        language.last_active = parse_datetime(active) if active
+        proficiency = row["prior_proficiency"]
+        language.prior_proficiency = Integer(proficiency) if proficiency
+        subscribed = row["subscribed"]
+        language.subscribed = parse_datetime(subscribed) if subscribed
+        { row["learning_language"] => language }
+      end.reduce(&:merge)
+    end
+
+    def parse_datetime(str)
+      Time.strptime(str, "%Y-%m-%d %T")
+    end
+  end
+end

data/lib/duolingo_personal_data/leaderboards.rb

@@ -0,0 +1,24 @@
+require "csv"
+require "forwardable"
+
+module DuolingoPersonalData
+  LeaderboardsEntry = Struct.new(:timestamp, :tier, :score, keyword_init: true)
+
+  class Leaderboards
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    extend Forwardable
+    def_delegators :leaderboards_entries, *(Array.instance_methods - [:object_id])
+
+    private
+
+    def leaderboards_entries
+      @leaderboards_entries ||= CSV.read(@csv_path, headers: true).map do |row|
+        LeaderboardsEntry.new(timestamp: Time.strptime(row["timestamp"], "%FT%TZ"), tier: Integer(row["tier"]),
+                              score: Float(row["score"]))
+      end
+    end
+  end
+end

data/lib/duolingo_personal_data/notify_data.rb

@@ -0,0 +1,33 @@
+require "json"
+
+module DuolingoPersonalData
+  class NotifyData
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    def email
+      @email ||= value_from_property("email")
+    end
+
+    def device_ids
+      @device_ids ||= json_value_from_property("device_ids")
+    end
+
+    private
+
+    def value_from_property(property_name)
+      table.find { |row| row["property"] == property_name }["value"]
+    end
+
+    def json_value_from_property(property_name)
+      value = value_from_property(property_name)
+      value.gsub!("'", '"')
+      JSON.parse(value)
+    end
+
+    def table
+      @table ||= CSV.read(@csv_path, headers: true)
+    end
+  end
+end

data/lib/duolingo_personal_data/profile.rb

@@ -0,0 +1,67 @@
+require "csv"
+
+module DuolingoPersonalData
+  class Profile
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    def username
+      @username ||= value_from_property("username")
+    end
+
+    def email
+      @email ||= value_from_property("email")
+    end
+
+    def fullname
+      @fullname ||= value_from_property("fullname")
+    end
+
+    def joined_at
+      @joined_at ||= datetime_value_from_property("joined_at")
+    end
+
+    def ui_language
+      @ui_language ||= value_from_property("ui_language")
+    end
+
+    def learning_language
+      @learning_language ||= value_from_property("learning_language")
+    end
+
+    def lingots
+      @lingots ||= integer_value_from_property("lingots")
+    end
+
+    def daily_goal
+      @daily_goal ||= integer_value_from_property("daily_goal")
+    end
+
+    def timezone
+      @timezone ||= value_from_property("timezone")
+    end
+
+    def avatar_url
+      @avatar_url ||= value_from_property("avatar_url")
+    end
+
+    private
+
+    def value_from_property(property_name)
+      table.find { |row| row["name"] == property_name }["value"]
+    end
+
+    def integer_value_from_property(property_name)
+      Integer(value_from_property(property_name))
+    end
+
+    def datetime_value_from_property(property_name)
+      Time.strptime(value_from_property(property_name), "%F %T")
+    end
+
+    def table
+      @table ||= CSV.read(@csv_path, headers: true)
+    end
+  end
+end

data/lib/duolingo_personal_data/stories.rb

@@ -0,0 +1,29 @@
+module DuolingoPersonalData
+  class Stories
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    def user_id
+      @user_id ||= value_from_property("userId")
+    end
+
+    def date_of_first_visit_to_stories
+      @date_of_first_visit_to_stories ||= datetime_value_from_property("dateOfFirstVisitToStories")
+    end
+
+    private
+
+    def value_from_property(property_name)
+      table.first[property_name]
+    end
+
+    def datetime_value_from_property(property_name)
+      Time.strptime(value_from_property(property_name), "%F %T")
+    end
+
+    def table
+      @table ||= CSV.read(@csv_path, headers: true)
+    end
+  end
+end

data/lib/duolingo_personal_data/story_completions.rb

@@ -0,0 +1,23 @@
+require "forwardable"
+
+module DuolingoPersonalData
+  StoryCompletion = Struct.new(:user_id, :story_id, :score, :time, keyword_init: true)
+
+  class StoryCompletions
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    extend Forwardable
+    def_delegators :completions, *(Array.instance_methods - [:object_id])
+
+    private
+
+    def completions
+      @completions ||= CSV.read(@csv_path, headers: true).map do |row|
+        StoryCompletion.new(user_id: row["userId"], story_id: row["storyId"], score: Integer(row["score"]),
+                            time: Time.strptime(row["time"], "%F %T"))
+      end
+    end
+  end
+end

data/lib/duolingo_personal_data/teacher_privacy_settings.rb

@@ -0,0 +1,51 @@
+module DuolingoPersonalData
+  class TeacherPrivacySettings
+    def initialize(csv_path)
+      @csv_path = csv_path
+    end
+
+    def disable_clubs
+      @disable_clubs ||= boolean_value_from_property("disable_clubs")
+    end
+
+    def disable_discussions
+      @disable_discussions ||= boolean_value_from_property("disable_discussions")
+    end
+
+    def disable_events
+      @disable_events ||= boolean_value_from_property("disable_events")
+    end
+
+    def disable_stream
+      @disable_stream ||= boolean_value_from_property("disable_stream")
+    end
+
+    def disable_immersion
+      @disable_immersion ||= boolean_value_from_property("disable_immersion")
+    end
+
+    def disable_mature_words
+      @disable_mature_words ||= boolean_value_from_property("disable_mature_words")
+    end
+
+    private
+
+    def boolean_value_from_property(property_name)
+      value = value_from_property(property_name)
+      case value
+      when "False" then false
+      when "True" then true
+      else
+        raise Error, "cannot interpret #{value.inspect} as boolean"
+      end
+    end
+
+    def value_from_property(property_name)
+      table.first[property_name]
+    end
+
+    def table
+      @table ||= CSV.read(@csv_path, headers: true)
+    end
+  end
+end

data/lib/duolingo_personal_data/version.rb

@@ -0,0 +1,3 @@
+module DuolingoPersonalData
+  VERSION = "0.1.0".freeze
+end

data/lib/duolingo_personal_data.rb

@@ -0,0 +1,17 @@
+require_relative "duolingo_personal_data/version"
+require_relative "duolingo_personal_data/auth_data"
+require_relative "duolingo_personal_data/avatar_images"
+require_relative "duolingo_personal_data/blast_emails"
+require_relative "duolingo_personal_data/notify_data"
+require_relative "duolingo_personal_data/friends_follow"
+require_relative "duolingo_personal_data/inventory"
+require_relative "duolingo_personal_data/languages"
+require_relative "duolingo_personal_data/leaderboards"
+require_relative "duolingo_personal_data/profile"
+require_relative "duolingo_personal_data/stories"
+require_relative "duolingo_personal_data/story_completions"
+require_relative "duolingo_personal_data/teacher_privacy_settings"
+
+module DuolingoPersonalData
+  class Error < StandardError; end
+end

data/manifest.scm

@@ -0,0 +1,3 @@
+(use-modules (gnu packages ruby))
+
+(packages->manifest (list ruby-rubocop ruby))

data/sig/duolingo_personal_data.rbs

@@ -0,0 +1,272 @@
+# TypeProf 0.21.3
+
+# Classes
+module DuolingoPersonalData
+  VERSION: String
+
+  class AuthData
+    @csv_path: untyped
+    @user_account_name: String?
+    @table: Array[Array[String?]]
+    @email_address: String?
+    @last_update_timestamp: String?
+    @last_login_attempt_timestamp: String?
+    @last_authentication_key_refresh_timestamp: String?
+
+    def initialize: (untyped csv_path) -> void
+    def user_account_name: -> String?
+    def email_address: -> String?
+    def last_update_timestamp: -> String?
+    def last_login_attempt_timestamp: -> String?
+    def last_authentication_key_refresh_timestamp: -> String?
+
+    private
+    def value_from_property: (String property_name) -> String?
+    def table: -> Array[Array[String?]]
+  end
+
+  class AvatarImages
+    extend Forwardable
+    @csv_path: untyped
+    @urls: Array[URI::Generic]
+    @table: Array[Array[String?]]
+
+    def initialize: (untyped csv_path) -> void
+
+    private
+    def urls: -> Array[URI::Generic]
+    def table: -> Array[Array[String?]]
+  end
+
+  class BlastEmails
+    @csv_path: untyped
+    @email_address: String?
+    @table: Array[Array[String?]]
+    @ui_language: String?
+    @learning_language: String?
+    @enabled: bool
+    @announcement: bool
+    @creation_datetime: untyped
+    @last_session: untyped
+    @trial_user: bool
+    @country: String?
+    @client: String?
+    @schools_role: Integer
+
+    def initialize: (untyped csv_path) -> void
+    def email_address: -> String?
+    def ui_language: -> String?
+    def learning_language: -> String?
+    def enabled: -> bool
+    def announcement: -> bool
+    def creation_datetime: -> untyped
+    def last_session: -> untyped
+    def trial_user: -> bool
+    def country: -> String?
+    def client: -> String?
+    def schools_role: -> Integer
+
+    private
+    def value_from_property: (String property_name) -> String?
+    def boolean_value_from_property: (String property_name) -> bool
+    def time_value_from_property: (String property_name) -> untyped
+    def integer_value_from_property: (String property_name) -> Integer
+    def table: -> Array[Array[String?]]
+  end
+
+  class FriendsFollow
+    @csv_path: untyped
+    @num_following: Integer
+    @table: Array[Array[String?]]
+    @num_followers: Integer
+    @num_blocking: Integer
+    @num_blockers: Integer
+    @timestamp_generated: Time
+
+    def initialize: (untyped csv_path) -> void
+    def num_following: -> Integer
+    def num_followers: -> Integer
+    def num_blocking: -> Integer
+    def num_blockers: -> Integer
+    def timestamp_generated: -> Time
+
+    private
+    def value_from_property: (String property_name) -> String?
+    def integer_value_from_property: (String property_name) -> Integer
+    def timestamp_value_from_property: (String property_name) -> Time
+    def table: -> Array[Array[String?]]
+  end
+
+  class InventoryItem < Struct[untyped]
+    attr_accessor item_type(): String?
+    attr_accessor purchase_datetime(): untyped
+    attr_accessor active(): bool
+    attr_accessor price_in_virtual_currency(): Integer
+    attr_accessor wager_day(): Integer
+    attr_accessor payment_processor(): String?
+    attr_accessor product(): String?
+    attr_accessor expected_expiration(): untyped
+  end
+
+  class Inventory
+    extend Forwardable
+    @csv_path: untyped
+    @items: Array[InventoryItem]
+    @table: Array[Array[String?]]
+
+    def initialize: (untyped csv_path) -> void
+
+    private
+    def items: -> Array[InventoryItem]
+    def parse_datetime: (String? str) -> untyped
+    def parse_boolean: (String? str) -> bool
+    def table: -> Array[Array[String?]]
+  end
+
+  class Language < Struct[untyped]
+    attr_accessor from_language(): String?
+    attr_accessor points(): Integer
+    attr_accessor skill_learned(): Integer
+    attr_accessor total_lessons(): Integer
+    attr_accessor days_active(): Integer
+    attr_accessor last_active(): untyped
+    attr_accessor prior_proficiency(): Integer
+    attr_accessor subscribed(): untyped
+  end
+
+  class Languages
+    extend Forwardable
+    @csv_path: untyped
+    @languages: Hash[String?, Language]
+
+    def initialize: (untyped csv_path) -> void
+
+    private
+    def languages: -> Hash[String?, Language]
+    def parse_datetime: (String str) -> untyped
+  end
+
+  class LeaderboardsEntry < Struct[untyped]
+    attr_accessor timestamp(): untyped
+    attr_accessor tier(): Integer
+    attr_accessor score(): Float
+  end
+
+  class Leaderboards
+    extend Forwardable
+    @csv_path: untyped
+    @entries: Array[LeaderboardsEntry]
+
+    def initialize: (untyped csv_path) -> void
+
+    private
+    def entries: -> Array[LeaderboardsEntry]
+  end
+
+  class NotifyData
+    @csv_path: untyped
+    @email: String?
+    @table: Array[Array[String?]]
+    @device_ids: untyped
+
+    def initialize: (untyped csv_path) -> void
+    def email: -> String?
+    def device_ids: -> untyped
+
+    private
+    def value_from_property: (String property_name) -> String?
+    def json_value_from_property: (String property_name) -> untyped
+    def table: -> Array[Array[String?]]
+  end
+
+  class Profile
+    @csv_path: untyped
+    @username: String?
+    @table: Array[Array[String?]]
+    @email: String?
+    @fullname: String?
+    @joined_at: untyped
+    @ui_language: String?
+    @learning_language: String?
+    @lingots: Integer
+    @daily_goal: Integer
+    @timezone: String?
+    @avatar_url: String?
+
+    def initialize: (untyped csv_path) -> void
+    def username: -> String?
+    def email: -> String?
+    def fullname: -> String?
+    def joined_at: -> untyped
+    def ui_language: -> String?
+    def learning_language: -> String?
+    def lingots: -> Integer
+    def daily_goal: -> Integer
+    def timezone: -> String?
+    def avatar_url: -> String?
+
+    private
+    def value_from_property: (String property_name) -> String?
+    def integer_value_from_property: (String property_name) -> Integer
+    def datetime_value_from_property: (String property_name) -> untyped
+    def table: -> Array[Array[String?]]
+  end
+
+  class Stories
+    @csv_path: untyped
+    @user_id: String?
+    @table: Array[Array[String?]]
+    @date_of_first_visit_to_stories: untyped
+
+    def initialize: (untyped csv_path) -> void
+    def user_id: -> String?
+    def date_of_first_visit_to_stories: -> untyped
+
+    private
+    def value_from_property: (String property_name) -> String?
+    def datetime_value_from_property: (String property_name) -> untyped
+    def table: -> Array[Array[String?]]
+  end
+
+  class StoryCompletion < Struct[untyped]
+    attr_accessor user_id(): String?
+    attr_accessor story_id(): String?
+    attr_accessor score(): Integer
+    attr_accessor time(): untyped
+  end
+
+  class StoryCompletions
+    extend Forwardable
+    @csv_path: untyped
+    @completions: Array[StoryCompletion]
+
+    def initialize: (untyped csv_path) -> void
+
+    private
+    def completions: -> Array[StoryCompletion]
+  end
+
+  class TeacherPrivacySettings
+    @csv_path: untyped
+    @disable_clubs: bool
+    @table: Array[Array[String?]]
+    @disable_discussions: bool
+    @disable_events: bool
+    @disable_stream: bool
+    @disable_immersion: bool
+    @disable_mature_words: bool
+
+    def initialize: (untyped csv_path) -> void
+    def disable_clubs: -> bool
+    def disable_discussions: -> bool
+    def disable_events: -> bool
+    def disable_stream: -> bool
+    def disable_immersion: -> bool
+    def disable_mature_words: -> bool
+
+    private
+    def boolean_value_from_property: (String property_name) -> bool
+    def value_from_property: (String property_name) -> String?
+    def table: -> Array[Array[String?]]
+  end
+end