redd 0.8.1 → 0.8.2

data/lib/redd/models/postable.rb

@@ -21,7 +21,7 @@ module Redd
       # Save a link or comment to the user's account.
       # @param category [String] a category to save to
       def save(category = nil)
-        params = { id: fullname }
+        params = { id: get_attribute(:name) }
         params[:category] = category if category
         @client.post('/api/save', params)
       end
@@ -33,12 +33,12 @@ module Redd
 
       # Hide a link from the user.
       def hide
-        @client.post('/api/hide', id: get_attribute(:fullname))
+        @client.post('/api/hide', id: get_attribute(:name))
       end
 
       # Unhide a previously hidden link.
       def unhide
-        @client.post('/api/unhide', id: get_attribute(:fullname))
+        @client.post('/api/unhide', id: get_attribute(:name))
       end
 
       # Upvote the model.

data/lib/redd/models/private_message.rb

@@ -11,19 +11,28 @@ module Redd
       include Inboxable
       include Replyable
 
-      # Make a Message from its id.
-      # @option hash [String] :id the post's id (e.g. abc123)
-      # @return [Submission]
-      def self.from_response(client, hash)
-        # FIXME: This returns the entire conversation, not the specific message. Possible to search,
-        #   because depth of replies is just one.
-        super
-      end
-
       # Delete the message from the user's inbox.
       def delete
         @client.post('/api/del_msg', id: get_attribute(:name))
       end
+
+      # Mute the author of the message.
+      def mute_author
+        @client.post('/api/mute_message_author', id: get_attribute(:name))
+      end
+
+      # Unmute the author of the message.
+      def unmute_author
+        @client.post('/api/unmute_message_author', id: get_attribute(:name))
+      end
+
+      private
+
+      def default_loader
+        # FIXME: This returns the entire conversation, not the specific message. Possible to search,
+        #   because depth of replies is just one.
+        {}
+      end
     end
   end
 end

data/lib/redd/models/searchable.rb

@@ -20,7 +20,7 @@ module Redd
       # @option params [String] :restrict_to restrict by subreddit (prefer {Subreddit#search})
       # @return [Listing<Comment, Submission>] the search results
       def search(query, **params)
-        params[:q] = query if query
+        params[:q] = query
         params[:t] = params.delete(:time) if params.key?(:time)
         if params[:restrict_to]
           subreddit = params.delete(:restrict_to)

data/lib/redd/models/session.rb

@@ -94,20 +94,49 @@ module Redd
         @client.post('/api/read_all_messages')
       end
 
+      # @return [Hash] the user's preferences
+      def my_preferences
+        @client.get('/api/v1/me/prefs').body
+      end
+
+      # Edit the user's preferences.
+      # @param new_prefs [Hash] the changed preferences
+      # @return [Hash] the new preferences
+      # @see #my_preferences
+      def edit_preferences(new_prefs = {})
+        @client.request(
+          :patch, '/api/v1/me/prefs',
+          headers: { 'Content-Type' => 'application/json' },
+          body: JSON.generate(new_prefs)
+        ).body
+      end
+
       # @return [Array<User>] the logged-in user's friends
       def friends
         @client.get('/api/v1/me/friends').body[:data][:children].map do |h|
-          User.from_response(@client, name: h[:name], id: h[:id].sub('t2_', ''), since: h[:date])
+          User.new(@client, name: h[:name], id: h[:id].sub('t2_', ''), since: h[:date])
         end
       end
 
       # @return [Array<User>] users blocked by the logged-in user
       def blocked
         @client.get('/prefs/blocked').body[:data][:children].map do |h|
-          User.from_response(@client, name: h[:name], id: h[:id].sub('t2_', ''), since: h[:date])
+          User.new(@client, name: h[:name], id: h[:id].sub('t2_', ''), since: h[:date])
+        end
+      end
+
+      # @return [Array<User>] users blocked by the logged-in user
+      def trusted
+        @client.get('/prefs/trusted').body[:data][:children].map do |h|
+          User.new(@client, name: h[:name], id: h[:id].sub('t2_', ''), since: h[:date])
         end
       end
 
+      # @return [Array<String>] a list of categories the user's items are saved in
+      def saved_categories
+        @client.get('/api/saved_categories').body
+      end
+
       # Return a listing of the user's subreddits.
       #
       # @param type ['subscriber', 'contributor', 'moderator'] the type of subreddits

data/lib/redd/models/submission.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'lazy_model'
+require_relative 'gildable'
 require_relative 'moderatable'
 require_relative 'postable'
 require_relative 'replyable'
@@ -12,25 +13,17 @@ module Redd
   module Models
     # A text or link post.
     class Submission < LazyModel
+      include Gildable
       include Moderatable
       include Postable
       include Replyable
 
-      coerce_attribute :author, User
-      coerce_attribute :subreddit, Subreddit
-
-      # Make a Submission from its id.
-      # @option hash [String] :id the post's id (e.g. abc123)
+      # Create a Subreddit from its fullname.
+      # @param client [APIClient] the api client to initialize the object with
+      # @param id [String] the fullname
       # @return [Submission]
-      def self.from_response(client, hash)
-        link_id = hash.fetch(:id)
-        new(client, hash) do |c|
-          # `data` is a pair (2-element array):
-          #   - data[0] is a one-item listing containing the submission
-          #   - data[1] is listing of comments
-          data = c.get("/comments/#{link_id}").body
-          data[0][:data][:children][0][:data].merge(comments: c.unmarshal(data[1]))
-        end
+      def self.from_id(client, id)
+        new(client, name: id)
       end
 
       # Get all submissions for the same url.
@@ -98,6 +91,25 @@ module Redd
       def unlock
         @client.post('/api/unlock', id: get_attribute(:name))
       end
+
+      private
+
+      def default_loader
+        # Ensure we have the link's id.
+        id = @attributes[:id] ? @attributes[:id] : @attributes.fetch(:name).sub('t3_', '')
+        response = @client.get("/comments/#{id}").body
+        # `response` is a pair (2-element array):
+        #   - response[0] is a one-item listing containing the submission
+        #   - response[1] is listing of comments
+        response[0][:data][:children][0][:data].merge(comments: @client.unmarshal(response[1]))
+      end
+
+      def after_initialize
+        if @attributes[:subreddit]
+          @attributes[:subreddit] = Subreddit.from_id(@client, @attributes[:subreddit])
+        end
+        @attributes[:author] = User.from_id(@client, @attributes[:author]) if @attributes[:author]
+      end
     end
   end
 end

data/lib/redd/models/subreddit.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'basic_model'
 require_relative 'lazy_model'
 require_relative 'messageable'
 require_relative 'searchable'
@@ -12,14 +13,6 @@ module Redd
       include Messageable
       include Searchable
 
-      # A list of keys that are required by #modify_settings.
-      SETTINGS_KEYS = %i(allow_images allow_top collapse_deleted_comments comment_score_hide_mins
-                         description exclude_banned_modqueue header-title hide_ads lang link_type
-                         over_18 public_description public_traffic show_media show_media_preview
-                         spam_comments spam_links spam_selfposts spoilers_enabled submit_link_label
-                         submit_text submit_text_label suggested_comment_sort theme_sr
-                         theme_sr_update title type wiki_edit_age wiki_edit_karma wikimode).freeze
-
       # A mapping from keys returned by #settings to keys required by #modify_settings
       SETTINGS_MAP = {
         subreddit_type: :type,
@@ -29,20 +22,16 @@ module Redd
         header_hover_text: :'header-title'
       }.freeze
 
-      # Make a Subreddit from its name.
-      # @option hash [String] :display_name the subreddit's name
-      # @return [Subreddit]
-      def self.from_response(client, hash)
-        name = hash.fetch(:display_name)
-        new(client, hash) { |c| c.get("/r/#{name}/about").body[:data] }
-      end
+      # Represents a moderator action, part of a moderation log.
+      # @see Subreddit#log
+      class ModAction < BasicModel; end
 
       # Create a Subreddit from its name.
       # @param client [APIClient] the api client to initialize the object with
       # @param id [String] the subreddit name
       # @return [Subreddit]
       def self.from_id(client, id)
-        from_response(client, display_name: id)
+        new(client, display_name: id)
       end
 
       # @return [Array<String>] the subreddit's wiki pages
@@ -54,7 +43,7 @@ module Redd
       # @param title [String] the page's title
       # @return [WikiPage]
       def wiki_page(title)
-        WikiPage.from_response(@client, title: title, subreddit: self)
+        WikiPage.new(@client, title: title, subreddit: self)
       end
 
       # Search a subreddit.
@@ -198,7 +187,7 @@ module Redd
         params[:kind] = url ? 'link' : 'self'
         params[:url]  = url  if url
         params[:text] = text if text
-        Submission.from_response(@client, @client.post('/api/submit', params).body[:json][:data])
+        Submission.new(@client, @client.post('/api/submit', params).body[:json][:data])
       end
 
       # Compose a message to the moderators of a subreddit.
@@ -293,10 +282,117 @@ module Redd
         @client.post('/api/site_admin', full_params)
       end
 
+      # Get the moderation log.
+      # @param params [Hash] a list of params to send with the request
+      # @option params [String] :after return results after the given fullname
+      # @option params [String] :before return results before the given fullname
+      # @option params [Integer] :count the number of items already seen in the listing
+      # @option params [1..100] :limit the maximum number of things to return
+      # @option params [String] :type filter events to a specific type
+      #
+      # @return [Listing<ModAction>]
+      def mod_log(**params)
+        @client.model(:get, "/r/#{get_attribute(:display_name)}/about/log", params)
+      end
+
+      # Invite a user to moderate this subreddit.
+      # @param user [User] the user to invite
+      # @param permissions [String] the permission string to invite the user with
+      def invite_moderator(user, permissions: '+all')
+        add_relationship(type: 'moderator_invite', name: user.name, permissions: permissions)
+      end
+
+      # Take back a moderator request.
+      # @param user [User] the requested user
+      def uninvite_moderator(user)
+        remove_relationship(type: 'moderator_invite', name: user.name)
+      end
+
+      # Accept an invite to become a moderator of this subreddit.
+      def accept_moderator_invite
+        @client.post("/r/#{get_attribute(:display_name)}/api/accept_moderator_invite")
+      end
+
+      # Dethrone a moderator.
+      # @param user [User] the user to remove
+      def remove_moderator(user)
+        remove_relationship(type: 'moderator', name: user.name)
+      end
+
+      # Leave from being a moderator on a subreddit.
+      def leave_moderator
+        @client.post('/api/leavemoderator', id: get_attribute(:name))
+      end
+
+      # Add a contributor to the subreddit.
+      # @param user [User] the user to add
+      def add_contributor(user)
+        add_relationship(type: 'contributor', name: user.name)
+      end
+
+      # Remove a contributor from the subreddit.
+      # @param user [User] the user to remove
+      def remove_contributor(user)
+        remove_relationship(type: 'contributor', name: user.name)
+      end
+
+      # Leave from being a contributor on a subreddit.
+      def leave_contributor
+        @client.post('/api/leavecontributor', id: get_attribute(:name))
+      end
+
+      # Ban a user from a subreddit.
+      # @param user [User] the user to ban
+      # @param params [Hash] additional options to supply with the request
+      # @option params [String] :ban_reason the reason for the ban
+      # @option params [String] :ban_message a message sent to the banned user
+      # @option params [String] :note a note that only moderators can see
+      # @option params [Integer] :duration the number of days to ban the user (if temporary)
+      def ban(user, **params)
+        add_relationship(type: 'banned', name: user.name, **params)
+      end
+
+      # Remove a ban on a user.
+      # @param user [User] the user to unban
+      def unban(user)
+        remove_relationship(type: 'banned', name: user.name)
+      end
+
+      # Allow a user to contribute to the wiki.
+      # @param user [User] the user to add
+      def add_wiki_contributor(user)
+        add_relationship(type: 'wikicontributor', name: user.name)
+      end
+
+      # No longer allow a user to contribute to the wiki.
+      # @param user [User] the user to remove
+      def remove_wiki_contributor(user)
+        remove_relationship(type: 'wikicontributor', name: user.name)
+      end
+
+      # Ban a user from contributing to the wiki.
+      # @param user [User] the user to ban
+      # @param params [Hash] additional options to supply with the request
+      # @option params [String] :ban_reason the reason for the ban (not sure this matters)
+      # @option params [String] :note a note that only moderators can see
+      # @option params [Integer] :duration the number of days to ban the user (if temporary)
+      def ban_wiki_contributor(user, **params)
+        add_relationship(type: 'wikibanned', name: user.name, **params)
+      end
+
+      # No longer ban a user from contributing to the wiki.
+      # @param user [User] the user to unban
+      def unban_wiki_contributor(user)
+        remove_relationship(type: 'wikibanned', name: user.name)
+      end
+
       private
 
+      def default_loader
+        @client.get("/r/#{@attributes.fetch(:display_name)}/about").body[:data]
+      end
+
       def add_relationship(**params)
-        # FIXME: add public methods
         @client.post("/r/#{get_attribute(:display_name)}/api/friend", params)
       end
 

data/lib/redd/models/user.rb

@@ -9,20 +9,20 @@ module Redd
     class User < LazyModel
       include Messageable
 
-      # Make a User from their name.
-      # @option hash [String] :name the user's name
-      # @return [User]
-      def self.from_response(client, hash)
-        name = hash.fetch(:name)
-        new(client, hash) { |c| c.get("/user/#{name}/about").body[:data] }
-      end
-
       # 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)
-        from_response(client, name: 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.
@@ -81,6 +81,18 @@ module Redd
       %i(overview submitted comments liked disliked hidden saved gilded).each do |type|
         define_method(type) { |**params| listing(type, **params) }
       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)
+      end
+
+      private
+
+      def default_loader
+        @client.get("/user/#{@attributes.fetch(:name)}/about").body[:data]
+      end
     end
   end
 end

data/lib/redd/models/wiki_page.rb

@@ -6,18 +6,15 @@ module Redd
   module Models
     # A reddit user.
     class WikiPage < LazyModel
-      # Make a Wikipage from its title and subreddit.
-      # @option hash [String] :title the page's title
-      # @option hash [Subreddit] :subreddit the page's subreddit
-      # @return [WikiPage]
-      def self.from_response(client, hash)
-        title = hash.fetch(:title)
-        if hash.key?(:subreddit)
-          sr_name = hash[:subreddit].display_name
-          new(client, hash) { |c| c.get("/r/#{sr_name}/wiki/#{title}").body[:data] }
-        else
-          new(client, hash) { |c| c.get("/wiki/#{title}").body[:data] }
+      private
+
+      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
     end
   end