redd 0.8.8 → 0.9.0.pre.1

data/lib/redd/models/trophy.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'model'
+
+module Redd
+  module Models
+    # A user trophy.
+    class Trophy < Model
+      # @!attribute [r] icon_70px
+      #   @return [String] the url for a 70x70 thumbnail icon
+      property :icon_70px, from: :icon_70
+
+      # @!attribute [r] icon_40px
+      #   @return [String] the url for a 40x40 thumbnail icon
+      property :icon_40px, from: :icon_40
+
+      # @!attribute [r] name
+      #   @return [String] the name of the trophy
+      property :name
+
+      # @!attribute [r] id
+      #   @return [String] the trophy id
+      property :id
+
+      # @!attribute [r] award_id
+      #   @return [String]
+      property :award_id
+
+      # @!attribute [r] description
+      #   @return [String] the trophy description
+      property :description
+    end
+  end
+end

data/lib/redd/models/user.rb

@@ -1,53 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'lazy_model'
+require_relative 'model'
 require_relative 'messageable'
 
 module Redd
   module Models
     # A reddit user.
-    class User < LazyModel
+    class User < Model
       include Messageable
 
-      # Create a User from their name.
-      # @param client [APIClient] the api client to initialize the object with
-      # @param id [String] the username
-      # @return [User]
-      def self.from_id(client, id)
-        new(client, name: id)
-      end
-
-      # Unblock a previously blocked user.
-      # @param me [User] (optional) the person doing the unblocking
-      def unblock(me: nil)
-        my_id = 't2_' + (me.is_a?(User) ? user.id : @client.get('/api/v1/me').body[:id])
-        # Talk about an unintuitive endpoint
-        @client.post('/api/unfriend', container: my_id, name: get_attribute(:name), type: 'enemy')
-      end
-
-      # Compose a message to the moderators of a subreddit.
-      #
-      # @param subject [String] the subject of the message
-      # @param text [String] the message text
-      # @param from [Subreddit, nil] the subreddit to send the message on behalf of
-      def send_message(subject:, text:, from: nil)
-        super(to: get_attribute(:name), subject: subject, text: text, from: from)
-      end
-
-      # Add the user as a friend.
-      # @param note [String] a note for the friend
-      def friend(note = nil)
-        name = get_attribute(:name)
-        body = JSON.generate(note ? { name: name, note: note } : { name: name })
-        @client.request(:put, "/api/v1/me/friends/#{name}", body: body)
-      end
-
-      # Unfriend the user.
-      def unfriend
-        name = get_attribute(:name)
-        @client.request(:delete, "/api/v1/me/friends/#{name}", raw: true, form: { id: name })
-      end
-
       # Get the appropriate listing.
       # @param type [:overview, :submitted, :comments, :liked, :disliked, :hidden, :saved, :gilded]
       #   the type of listing to request
@@ -65,7 +26,7 @@ module Redd
       # @return [Listing<Submission>]
       def listing(type, **params)
         params[:t] = params.delete(:time) if params.key?(:time)
-        @client.model(:get, "/user/#{get_attribute(:name)}/#{type}.json", params)
+        client.model(:get, "/user/#{read_attribute(:name)}/#{type}.json", params)
       end
 
       # @!method overview(**params)
@@ -78,20 +39,198 @@ module Redd
       # @!method gilded(**params)
       #
       # @see #listing
-      %i(overview submitted comments liked disliked hidden saved gilded).each do |type|
+      %i[overview submitted comments liked disliked hidden saved gilded].each do |type|
         define_method(type) { |**params| listing(type, **params) }
       end
 
+      # Compose a message to the moderators of a subreddit.
+      #
+      # @param subject [String] the subject of the message
+      # @param text [String] the message text
+      # @param from [Subreddit, nil] the subreddit to send the message on behalf of
+      def send_message(subject:, text:, from: nil)
+        super(to: read_attribute(:name), subject: subject, text: text, from: from)
+      end
+
+      # Block this user.
+      def block
+        client.post('/api/block_user', account_id: read_attribute(:id))
+      end
+
+      # @return [Array<Trophy>] this user's trophies
+      def trophies
+        client.get("/api/v1/user/#{read_attribute(:name)}/trophies")
+              .body[:data][:trophies]
+              .map { |t| client.unmarshal(t) }
+      end
+
+      # Unblock a previously blocked user.
+      # @param me [User] (optional) the person doing the unblocking
+      def unblock(me: nil)
+        my_id = 't2_' + (me.is_a?(User) ? user.id : client.get('/api/v1/me').body[:id])
+        # Talk about an unintuitive endpoint
+        client.post('/api/unfriend', container: my_id, name: read_attribute(:name), type: 'enemy')
+      end
+
+      # Add the user as a friend.
+      # @param note [String] a note for the friend
+      def friend(note = nil)
+        name = read_attribute(:name)
+        body = JSON.generate(note ? { name: name, note: note } : { name: name })
+        client.request(:put, "/api/v1/me/friends/#{name}", body: body)
+      end
+
+      # Unfriend the user.
+      def unfriend
+        name = read_attribute(:name)
+        client.request(:delete, "/api/v1/me/friends/#{name}", raw: true, form: { id: name })
+      end
+
       # Gift a redditor reddit gold.
       # @param months [Integer] the number of months of gold to gift
       def gift_gold(months: 1)
-        @client.post("/api/v1/gold/give/#{get_attribute(:name)}", months: months)
+        client.post("/api/v1/gold/give/#{read_attribute(:name)}", months: months)
       end
 
+      # @!attribute [r] name
+      #   @return [String] the user's username
+      property :name
+
+      # @!attribute [r] employee?
+      #   @return [Boolean] whether the user is a reddit employee
+      property :employee?, from: :is_employee
+
+      # @!attribute [r] features
+      #   @return [Hash] a hash of features
+      property :features
+
+      # @!attribute [r] friend?
+      #   @return [Boolean] whether the user is your friend
+      property :friend?, from: :is_friend
+
+      # @!attribute [r] no_profanity?
+      #   @return [Boolean] whether the user chooses to filter profanity
+      property :no_profanity?, from: :pref_no_profanity
+
+      # @!attribute [r] suspended?
+      #   @return [Boolean] whether the user is suspended
+      property :suspended?, from: :is_suspended
+
+      # @!attribute [r] geopopular
+      #   @return [String]
+      property :geopopular, from: :pref_geopopular
+
+      # @!attribute [r] subreddit
+      #   @return [Subreddit] the user's personal "subreddit"
+      property :subreddit, with: ->(name) { Subreddit.new(client, display_name: name) if name }
+
+      # @!attribute [r] sponsor?
+      #   @return [Boolean]
+      property :sponsor?, from: :is_sponsor
+
+      # @!attribute [r] gold_expiration
+      #   @return [Time, nil] the time when the user's gold expires
+      property :gold_expiration, with: ->(epoch) { Time.at(epoch) if epoch }
+
+      # @!attribute [r] id
+      #   @return [String] the user's base36 id
+      property :id
+
+      # @!attribute [r] profile_image
+      #   @return [String] a link to the user's profile image
+      property :profile_image, from: :profile_img
+
+      # @!attribute [r] over_18?
+      #   @return [Boolean] whether the user's profile is considered over 18.
+      property :over_18?, from: :profile_over_18
+
+      # @!attribute [r] suspension_expiration
+      #   @return [Time, nil] the time when the user's suspension expires
+      property :suspension_expiration, from: :suspension_expiration_utc,
+                                       with: ->(epoch) { Time.at(epoch) if epoch }
+
+      # @!attribute [r] verified?
+      #   @return [Boolean] whether the user is verified (?)
+      property :verified?, from: :verified
+
+      # @!attribute [r] new_modmail_exists?
+      #   @return [Boolean] whether the user has mail in the new modmail
+      property :new_modmail_exists?, from: :new_modmail_exists
+
+      # @!attribute [r] over_18?
+      #   @return [Boolean] whether the user has indicated they're over 18
+      property :over_18?, from: :over_18
+
+      # @!attribute [r] gold?
+      #   @return [Boolean] whether the user currently has gold
+      property :gold?, from: :is_gold
+
+      # @!attribute [r] mod?
+      #   @return [Boolean] whether the user is a moderator
+      property :mod?, from: :is_mod
+
+      # @!attribute [r] has_verified_email?
+      #   @return [Boolean] whether the user's email has been verified
+      property :has_verified_email?, from: :has_verified_email
+
+      # @!attribute [r] has_mod_mail?
+      #   @return [Boolean] whether the user has old-style mod mail
+      property :has_mod_mail?, from: :has_mod_mail
+
+      # @!attribute [r] hidden_from_robots?
+      #   @return [Boolean] whether the user chose to hide from Google
+      property :hidden_from_robots?, from: :hide_from_robots
+
+      # @!attribute [r] link_karma
+      #   @return [Integer] the user's link karma
+      property :link_karma
+
+      # @!attribute [r] inbox_count
+      #   @return [Integer] the number of messages in the user's inbox
+      property :inbox_count
+
+      # @!attribute [r] show_top_karma_subreddits?
+      #   @return [Boolean] whether top karma subreddits are shown on the user's page
+      property :show_top_karma_subreddits?, from: :pref_top_karma_subreddits
+
+      # @!attribute [r] has_mail?
+      #   @return [Boolean] whether the user has new messages
+      property :has_mail?, from: :has_mail
+
+      # @!attribute [r] show_snoovatar?
+      #   @return [Boolean] whether the user's snoovatar is shown
+      property :show_snoovatar?, from: :pref_show_snoovatar
+
+      # @!attribute [r] created_at
+      #   @return [Time] the time the user signed up
+      property :created_at, from: :created_utc, with: ->(epoch) { Time.at(epoch) }
+
+      # @!attribute [r] gold_creddits
+      #   @return [Integer] the number of gold creddits the user has
+      property :gold_creddits
+
+      # @!attribute [r] in_beta?
+      #   @return [Boolean] whether the user is in beta
+      property :in_beta?, from: :in_beta
+
+      # @!attribute [r] comment_karma
+      #   @return [Integer] the user's comment karma
+      property :comment_karma
+
+      # @!attribute [r] has_subscribed?
+      #   @return [Boolean]
+      property :has_subscribed?, from: :has_subscribed
+
       private
 
-      def default_loader
-        @client.get("/user/#{@attributes.fetch(:name)}/about").body[:data]
+      def lazer_reload
+        # return load_from_fullname if self[:id] && !self[:name]
+        fully_loaded!
+        client.get("/user/#{read_attribute(:name)}/about").body[:data]
+      end
+
+      def load_from_fullname
+        client.get('/api/user_data_by_account_ids', ids: read_attribute(:id)).body.values.first
       end
     end
   end

data/lib/redd/models/wiki_page.rb

@@ -1,34 +1,55 @@
 # frozen_string_literal: true
 
-require_relative 'lazy_model'
+require_relative 'model'
 
 module Redd
   module Models
     # A reddit user.
-    class WikiPage < LazyModel
+    class WikiPage < Model
       # Edit the wiki page.
       # @param content [String] the new wiki page contents
       # @param reason [String, nil] an optional reason for editing the page
       def edit(content, reason: nil)
-        params = { page: @attributes.fetch(:title), content: content }
+        params = { page: read_attribute(:title), content: content }
         params[:reason] = reason if reason
-        @client.post("/r/#{@attributes.fetch(:subreddit).display_name}/api/wiki/edit", params)
+        client.post("/r/#{read_attribute(:subreddit).display_name}/api/wiki/edit", params)
       end
 
-      private
+      # @!attribute [r] title
+      #   @return [String] the page title
+      property :title, :required
 
-      def default_loader
-        title = @attributes.fetch(:title)
-        if @attributes.key?(:subreddit)
-          sr_name = @attributes[:subreddit].display_name
-          return @client.get("/r/#{sr_name}/wiki/#{title}").body[:data]
-        end
-        @client.get("/wiki/#{title}").body[:data]
-      end
+      # @!attribute [r] subreddit
+      #   @return [Subreddit] the wiki page's (optional) subreddit
+      property :subreddit, :nil
+
+      # @!attribute [r] may_revise?
+      #   @return [Boolean] not sure, whether you're allowed to edit the page?
+      property :may_revise?, from: :may_revise
+
+      # @!attribute [r] revision_date
+      #   @return [Time] the time of the last revision
+      property :revision_date, with: ->(t) { Time.at(t) }
+
+      # @!attribute [r] content_md
+      #   @return [String] the markdown version of the content
+      property :content_md
+
+      # @!attribute [r] content_html
+      #   @return [String] the html version of the content
+      property :content_html
+
+      # @!attribute [r] revision_by
+      #   @return [User] the user who made the last revision
+      property :revision_by, with: ->(res) { User.new(client, res[:data]) }
+
+      private
 
-      def after_initialize
-        return unless @attributes[:revision_by]
-        @attributes[:revision_by] = @client.unmarshal(@attributes[:revision_by])
+      def lazer_reload
+        fully_loaded!
+        path = "/wiki/#{read_attribute(:title)}"
+        path = "/r/#{read_attribute(:subreddit).display_name}#{path}" if self[:subreddit]
+        client.get(path).body[:data]
       end
     end
   end

data/lib/redd/utilities/error_handler.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../error'
+require_relative '../errors'
 
 module Redd
   module Utilities
@@ -11,15 +11,15 @@ module Redd
       INSUFFICIENT_SCOPE = 'insufficient_scope'
 
       HTTP_ERRORS = {
-        400 => Redd::BadRequest,
-        403 => Redd::Forbidden,
-        404 => Redd::NotFound,
-        429 => Redd::TooManyRequests,
-        500 => Redd::ServerError,
-        502 => Redd::ServerError,
-        503 => Redd::ServerError,
-        504 => Redd::ServerError
-      }.freeze
+        400 => Errors::BadRequest,
+        403 => Errors::Forbidden,
+        404 => Errors::NotFound,
+        429 => Errors::TooManyRequests,
+        500 => Errors::ServerError,
+        502 => Errors::ServerError,
+        503 => Errors::ServerError,
+        504 => Errors::ServerError
+      }
 
       def check_error(res, raw:)
         # Check for status code-based errors first and return it if we found one.
@@ -38,14 +38,14 @@ module Redd
       def invalid_access_error(res)
         return nil unless res.code == 401 && res.headers[AUTH_HEADER] &&
                           res.headers[AUTH_HEADER].include?(INVALID_TOKEN)
-        InvalidAccess.new(res)
+        Errors::InvalidAccess.new(res)
       end
 
       # Deal with an error caused by not having enough the correct scope
       def insufficient_scope_error(res)
         return nil unless res.code == 403 && res.headers[AUTH_HEADER] &&
                           res.headers[AUTH_HEADER].include?(INSUFFICIENT_SCOPE)
-        InsufficientScope.new(res)
+        Errors::InsufficientScope.new(res)
       end
 
       # Deal with an error signalled by the HTTP response code.
@@ -57,7 +57,7 @@ module Redd
       def api_error(res)
         return nil unless res.body.is_a?(Hash) && res.body[:json] && res.body[:json][:errors] &&
                           !res.body[:json][:errors].empty?
-        APIError.new(res)
+        Errors::APIError.new(res)
       end
     end
   end

data/lib/redd/utilities/unmarshaller.rb

@@ -7,17 +7,19 @@ module Redd
       # Contains the mapping from 'kind' strings to classes.
       # TODO: UserList type!
       MAPPING = {
+        'Listing'      => Models::Listing,
         't1'           => Models::Comment,
         't2'           => Models::User,
         't3'           => Models::Submission,
         't4'           => Models::PrivateMessage,
         't5'           => Models::Subreddit,
+        't6'           => Models::Trophy,
         'more'         => Models::MoreComments,
         'wikipage'     => Models::WikiPage,
-        'modaction'    => Models::Subreddit::ModAction,
+        'modaction'    => Models::ModAction,
         'LabeledMulti' => Models::Multireddit,
-        'LiveUpdate'   => Models::LiveThread::LiveUpdate
-      }.freeze
+        'LiveUpdate'   => Models::LiveUpdate
+      }
 
       def initialize(client)
         @client = client
@@ -25,7 +27,7 @@ module Redd
 
       def unmarshal(res)
         # I'm loving the hell out of this pattern.
-        model = js_listing(res) || js_model(res) || api_listing(res) || api_model(res)
+        model = js_listing(res) || js_model(res) || api_model(res)
         raise "cannot unmarshal: #{res.inspect}" if model.nil?
         model
       end
@@ -43,7 +45,7 @@ module Redd
       def js_model(res)
         # FIXME: deprecate this? this shouldn't be happening in the API, so this is better handled
         #   in the respective classes.
-        Models::BasicModel.new(@client, res[:json][:data]) if res[:json] && res[:json][:data]
+        Models::Model.new(@client, res[:json][:data]) if res[:json] && res[:json][:data]
       end
 
       # Unmarshal API-provided listings.