redd 0.7.8 → 0.7.9

data/lib/redd/objects/thing.rb

@@ -1,26 +1,26 @@
-require_relative "base"
-
-module Redd
-  module Objects
-    # A reddit thing.
-    # @see http://www.reddit.com/dev/api#fullnames
-    class Thing < Base
-      # Load up all the possible mixins for the thing.
-      Dir[File.join(File.dirname(__FILE__), "thing", "*.rb")].each do |file|
-        require(file)
-      end
-
-      # Check for equality.
-      # @param other The other object.
-      # @return [Boolean]
-      def ==(other)
-        other.is_a?(Thing) && fullname == other.fullname
-      end
-
-      # @return [String] The fullname of the thing.
-      def fullname
-        self[:name] || "#{kind}_#{id}"
-      end
-    end
-  end
-end
+require_relative "base"
+
+module Redd
+  module Objects
+    # A reddit thing.
+    # @see http://www.reddit.com/dev/api#fullnames
+    class Thing < Base
+      # Load up all the possible mixins for the thing.
+      Dir[File.join(File.dirname(__FILE__), "thing", "*.rb")].each do |file|
+        require(file)
+      end
+
+      # Check for equality.
+      # @param other The other object.
+      # @return [Boolean]
+      def ==(other)
+        other.is_a?(Thing) && fullname == other.fullname
+      end
+
+      # @return [String] The fullname of the thing.
+      def fullname
+        self[:name] || "#{kind}_#{id}"
+      end
+    end
+  end
+end

data/lib/redd/objects/thing/editable.rb

@@ -1,22 +1,22 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be edited and deleted.
-      module Editable
-        # Edit a thing.
-        # @param text [String] The new text.
-        # @return [Thing] The edited thing.
-        def edit(text)
-          post("/api/editusertext", thing_id: fullname, text: text)
-          self[(self.is_a?(Submission) ? :selftext : :body)] = text
-          self
-        end
-
-        # Delete the thing
-        def delete!
-          post("/api/del", id: fullname)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    class Thing
+      # Things that can be edited and deleted.
+      module Editable
+        # Edit a thing.
+        # @param text [String] The new text.
+        # @return [Thing] The edited thing.
+        def edit(text)
+          post("/api/editusertext", thing_id: fullname, text: text)
+          self[(self.is_a?(Submission) ? :selftext : :body)] = text
+          self
+        end
+
+        # Delete the thing
+        def delete!
+          post("/api/del", id: fullname)
+        end
+      end
+    end
+  end
+end

data/lib/redd/objects/thing/hideable.rb

@@ -1,18 +1,18 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be hidden from the user.
-      module Hideable
-        # Hide a link from the user.
-        def hide
-          post("/api/hide", id: fullname)
-        end
-
-        # Unhide a previously hidden link.
-        def unhide
-          post("/api/unhide", id: fullname)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    class Thing
+      # Things that can be hidden from the user.
+      module Hideable
+        # Hide a link from the user.
+        def hide
+          post("/api/hide", id: fullname)
+        end
+
+        # Unhide a previously hidden link.
+        def unhide
+          post("/api/unhide", id: fullname)
+        end
+      end
+    end
+  end
+end

data/lib/redd/objects/thing/inboxable.rb

@@ -1,25 +1,25 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be sent to a user's inbox.
-      module Inboxable
-        # Mark this thing as read.
-        def mark_as_read
-          post("/api/read_message", id: fullname)
-        end
-
-        # Mark one or more messages as unread.
-        def mark_as_unread
-          post("/api/unread_message", id: fullname)
-        end
-
-        # Reply to the thing.
-        # @param text [String] The text to comment.
-        # @return [Objects::Comment, Objects::PrivateMessage] The reply.
-        def reply(text)
-          client.add_comment(self, text)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    class Thing
+      # Things that can be sent to a user's inbox.
+      module Inboxable
+        # Mark this thing as read.
+        def mark_as_read
+          post("/api/read_message", id: fullname)
+        end
+
+        # Mark one or more messages as unread.
+        def mark_as_unread
+          post("/api/unread_message", id: fullname)
+        end
+
+        # Reply to the thing.
+        # @param text [String] The text to comment.
+        # @return [Objects::Comment, Objects::PrivateMessage] The reply.
+        def reply(text)
+          client.add_comment(self, text)
+        end
+      end
+    end
+  end
+end

data/lib/redd/objects/thing/messageable.rb

@@ -1,34 +1,34 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be sent a message.
-      module Messageable
-        # Compose a message to a person or the moderators of a subreddit.
-        #
-        # @param [String] subject The subject of the message.
-        # @param [String] text The message text.
-        # @param [String] from_sr The subreddit to send the message on behalf
-        #   of or nil if from the user.
-        # @param [String] captcha A possible captcha result to send if one
-        #   is required.
-        # @param [String] identifier The identifier for the captcha if one
-        #   is required.
-        def send_message(
-          subject, text, from_sr = nil, captcha = nil, identifier = nil
-        )
-          params = {subject: subject, text: text}
-          params.merge!(captcha: captcha, iden: identifier) if captcha
-          params[:from_sr] = client.property(from_sr, :display_name) if from_sr
-          params[:to] =
-            if respond_to?(:display_name)
-              "/r/#{self[:display_name]}"
-            else
-              self[:name]
-            end
-
-          post("/api/compose", params)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    class Thing
+      # Things that can be sent a message.
+      module Messageable
+        # Compose a message to a person or the moderators of a subreddit.
+        #
+        # @param [String] subject The subject of the message.
+        # @param [String] text The message text.
+        # @param [String] from_sr The subreddit to send the message on behalf
+        #   of or nil if from the user.
+        # @param [String] captcha A possible captcha result to send if one
+        #   is required.
+        # @param [String] identifier The identifier for the captcha if one
+        #   is required.
+        def send_message(
+          subject, text, from_sr = nil, captcha = nil, identifier = nil
+        )
+          params = {subject: subject, text: text}
+          params.merge!(captcha: captcha, iden: identifier) if captcha
+          params[:from_sr] = client.property(from_sr, :display_name) if from_sr
+          params[:to] =
+            if respond_to?(:display_name)
+              "/r/#{self[:display_name]}"
+            else
+              self[:name]
+            end
+
+          post("/api/compose", params)
+        end
+      end
+    end
+  end
+end

data/lib/redd/objects/thing/moderatable.rb

@@ -1,43 +1,43 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that a moderator can manage.
-      module Moderatable
-        # Approve a submission.
-        def approve!
-          post("/api/approve", id: fullname)
-        end
-
-        # Remove a submission.
-        # @param [Boolean] spam Whether or not this item is removed due to it
-        #   being spam.
-        def remove!(spam = false)
-          post("/api/remove", id: fullname, spam: spam)
-        end
-
-        # Distinguish a link or comment with a sigil to show that it has
-        # been created by a moderator.
-        # @param [:yes, :no, :admin, :special] how How to distinguish the
-        #   thing.
-        def distinguish(how = :yes)
-          post("/api/distinguish", id: fullname, how: how)
-        end
-
-        # Remove the sigil that shows a thing was created by a moderator.
-        def undistinguish
-          distinguish(:no)
-        end
-
-        # Stop getting any moderator-related reports on the thing.
-        def ignore_reports
-          post("/api/ignore_reports", id: fullname)
-        end
-
-        # Start getting moderator-related reports on the thing again.
-        def unignore_reports
-          post("/api/unignore_reports", id: fullname)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    class Thing
+      # Things that a moderator can manage.
+      module Moderatable
+        # Approve a submission.
+        def approve!
+          post("/api/approve", id: fullname)
+        end
+
+        # Remove a submission.
+        # @param [Boolean] spam Whether or not this item is removed due to it
+        #   being spam.
+        def remove!(spam = false)
+          post("/api/remove", id: fullname, spam: spam)
+        end
+
+        # Distinguish a link or comment with a sigil to show that it has
+        # been created by a moderator.
+        # @param [:yes, :no, :admin, :special] how How to distinguish the
+        #   thing.
+        def distinguish(how = :yes)
+          post("/api/distinguish", id: fullname, how: how)
+        end
+
+        # Remove the sigil that shows a thing was created by a moderator.
+        def undistinguish
+          distinguish(:no)
+        end
+
+        # Stop getting any moderator-related reports on the thing.
+        def ignore_reports
+          post("/api/ignore_reports", id: fullname)
+        end
+
+        # Start getting moderator-related reports on the thing again.
+        def unignore_reports
+          post("/api/unignore_reports", id: fullname)
+        end
+      end
+    end
+  end
+end

data/lib/redd/objects/thing/refreshable.rb

@@ -1,14 +1,14 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be refreshed with the current data.
-      module Refreshable
-        # Refresh the thing.
-        def refresh!
-          body = get("/api/info", id: fullname).body[:data][:children][0]
-          deep_merge!(body[:data])
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    class Thing
+      # Things that can be refreshed with the current data.
+      module Refreshable
+        # Refresh the thing.
+        def refresh!
+          body = get("/api/info", id: fullname).body[:data][:children][0]
+          deep_merge!(body[:data])
+        end
+      end
+    end
+  end
+end

data/lib/redd/objects/thing/saveable.rb

@@ -1,21 +1,21 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be saved to a user's account.
-      module Saveable
-        # Save a link or comment (if gilded) to the user's account.
-        # @param [String] category A category to save to (if gilded).
-        def save(category = nil)
-          params = {id: fullname}
-          params.merge!(category: category) if category
-          post("/api/save", params)
-        end
-
-        # Remove the link or comment from the user's saved links.
-        def unsave
-          post("/api/unsave", id: fullname)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    class Thing
+      # Things that can be saved to a user's account.
+      module Saveable
+        # Save a link or comment (if gilded) to the user's account.
+        # @param [String] category A category to save to (if gilded).
+        def save(category = nil)
+          params = {id: fullname}
+          params.merge!(category: category) if category
+          post("/api/save", params)
+        end
+
+        # Remove the link or comment from the user's saved links.
+        def unsave
+          post("/api/unsave", id: fullname)
+        end
+      end
+    end
+  end
+end

data/lib/redd/objects/thing/votable.rb

@@ -1,33 +1,33 @@
-module Redd
-  module Objects
-    class Thing
-      # Things that can be voted upon.
-      module Votable
-        # Upvote the thing.
-        def upvote
-          vote(1)
-        end
-
-        # Downvote the thing.
-        def downvote
-          vote(-1)
-        end
-
-        # Remove your vote on the thing.
-        def clear_vote
-          vote(0)
-        end
-        alias_method :unvote, :clear_vote
-
-        private
-
-        # Send a vote.
-        # @param [-1, 0, 1] direction The direction to vote in.
-        def vote(direction)
-          post("/api/vote", id: fullname, dir: direction)
-          self[:ups] += direction
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    class Thing
+      # Things that can be voted upon.
+      module Votable
+        # Upvote the thing.
+        def upvote
+          vote(1)
+        end
+
+        # Downvote the thing.
+        def downvote
+          vote(-1)
+        end
+
+        # Remove your vote on the thing.
+        def clear_vote
+          vote(0)
+        end
+        alias_method :unvote, :clear_vote
+
+        private
+
+        # Send a vote.
+        # @param [-1, 0, 1] direction The direction to vote in.
+        def vote(direction)
+          post("/api/vote", id: fullname, dir: direction)
+          self[:ups] += direction
+        end
+      end
+    end
+  end
+end