redd 0.7.8 → 0.7.9

data/lib/redd/objects/base.rb

@@ -1,39 +1,39 @@
-require "hashie"
-require "forwardable"
-
-module Redd
-  # A bunch of objects that can hold properties.
-  module Objects
-    # A base for all objects to inherit from.
-    class Base < Hashie::Hash
-      include Hashie::Extensions::MergeInitializer
-      include Hashie::Extensions::MethodReader
-      include Hashie::Extensions::MethodQuery
-      include Hashie::Extensions::DeepMerge
-
-      # The `delete` method is called `delete_path` because it conflicts with
-      # Hash#delete.
-      extend Forwardable
-      def_delegators :@client, :get, :post, :put, :delete_path
-
-      # @!attribute [r] client
-      # @return [Clients::Base] The client that used to make requests.
-      attr_reader :client
-
-      # @param [Clients::Base] client The client instance.
-      # @param [Hash] attributes A hash of attributes.
-      def initialize(client, attributes = {})
-        @client = client
-        super(attributes)
-      end
-
-      # Define an alias for a property.
-      # @param [Symbol] new_name The alias.
-      # @param [Symbol] old_name The existing property.
-      def self.alias_property(new_name, old_name)
-        define_method(new_name) { send(old_name) }
-        define_method(:"#{new_name}?") { send(old_name) }
-      end
-    end
-  end
-end
+require "hashie"
+require "forwardable"
+
+module Redd
+  # A bunch of objects that can hold properties.
+  module Objects
+    # A base for all objects to inherit from.
+    class Base < Hashie::Hash
+      include Hashie::Extensions::MergeInitializer
+      include Hashie::Extensions::MethodReader
+      include Hashie::Extensions::MethodQuery
+      include Hashie::Extensions::DeepMerge
+
+      # The `delete` method is called `delete_path` because it conflicts with
+      # Hash#delete.
+      extend Forwardable
+      def_delegators :@client, :get, :post, :put, :delete_path
+
+      # @!attribute [r] client
+      # @return [Clients::Base] The client that used to make requests.
+      attr_reader :client
+
+      # @param [Clients::Base] client The client instance.
+      # @param [Hash] attributes A hash of attributes.
+      def initialize(client, attributes = {})
+        @client = client
+        super(attributes)
+      end
+
+      # Define an alias for a property.
+      # @param [Symbol] new_name The alias.
+      # @param [Symbol] old_name The existing property.
+      def self.alias_property(new_name, old_name)
+        define_method(new_name) { send(old_name) }
+        define_method(:"#{new_name}?") { send(old_name) }
+      end
+    end
+  end
+end

data/lib/redd/objects/comment.rb

@@ -1,22 +1,22 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # A comment that can be made on a link.
-    class Comment < Thing
-      include Thing::Editable
-      include Thing::Inboxable
-      include Thing::Moderatable
-      include Thing::Refreshable
-      include Thing::Saveable
-      include Thing::Votable
-
-      alias_property :reports_count, :num_reports
-
-      # @return [Listing] The comment's replies.
-      def replies
-        @replies ||= (client.object_from_body(self[:replies]) || [])
-      end
-    end
-  end
-end
+require_relative "thing"
+
+module Redd
+  module Objects
+    # A comment that can be made on a link.
+    class Comment < Thing
+      include Thing::Editable
+      include Thing::Inboxable
+      include Thing::Moderatable
+      include Thing::Refreshable
+      include Thing::Saveable
+      include Thing::Votable
+
+      alias_property :reports_count, :num_reports
+
+      # @return [Listing] The comment's replies.
+      def replies
+        @replies ||= (client.object_from_body(self[:replies]) || [])
+      end
+    end
+  end
+end

data/lib/redd/objects/labeled_multi.rb

@@ -1,13 +1,13 @@
-module Redd
-  module Objects
-    # A comment that can be made on a link.
-    class LabeledMulti < Base
-      # @see Objects::Base
-      def initialize(client, attributes = {})
-        attr_dup = attributes.dup
-        attr_dup[:subreddits].map! { |sub| sub[:name] }
-        super(client, attr_dup)
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    # A comment that can be made on a link.
+    class LabeledMulti < Base
+      # @see Objects::Base
+      def initialize(client, attributes = {})
+        attr_dup = attributes.dup
+        attr_dup[:subreddits].map! { |sub| sub[:name] }
+        super(client, attr_dup)
+      end
+    end
+  end
+end

data/lib/redd/objects/listing.rb

@@ -1,29 +1,29 @@
-module Redd
-  module Objects
-    # A collection of reddit things.
-    # @see https://www.reddit.com/dev/api#listings
-    class Listing < Array
-      # @!attribute [r] before
-      # @return [String] The id of the object before the listing.
-      attr_reader :before
-
-      # @!attribute [r] after
-      # @return [String] The id of the object after the listing.
-      attr_reader :after
-
-      # @param [Clients::Base] client The client to expand the comments with.
-      # @param [{:before => String, :after => String,
-      #   :children => Array<Hash>}] attributes The data to initialize the
-      #   class with.
-      # @todo Only call Clients::Base#object_from_body when item is being
-      #   accessed.
-      def initialize(client, attributes)
-        @before = attributes[:before]
-        @after = attributes[:after]
-        attributes[:children].each do |child|
-          self << (client.object_from_body(child) || child)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    # A collection of reddit things.
+    # @see https://www.reddit.com/dev/api#listings
+    class Listing < Array
+      # @!attribute [r] before
+      # @return [String] The id of the object before the listing.
+      attr_reader :before
+
+      # @!attribute [r] after
+      # @return [String] The id of the object after the listing.
+      attr_reader :after
+
+      # @param [Clients::Base] client The client to expand the comments with.
+      # @param [{:before => String, :after => String,
+      #   :children => Array<Hash>}] attributes The data to initialize the
+      #   class with.
+      # @todo Only call Clients::Base#object_from_body when item is being
+      #   accessed.
+      def initialize(client, attributes)
+        @before = attributes[:before]
+        @after = attributes[:after]
+        attributes[:children].each do |child|
+          self << (client.object_from_body(child) || child)
+        end
+      end
+    end
+  end
+end

data/lib/redd/objects/more_comments.rb

@@ -1,10 +1,11 @@
-module Redd
-  module Objects
-    # The model for a morecomments object
-    class MoreComments < Array
-      def initialize(_, attributes)
-        super(attributes[:children])
-      end
-    end
-  end
-end
+module Redd
+  module Objects
+    # The model for a morecomments object
+    class MoreComments < Array
+      def initialize(_, attributes)
+        #Return an empty arrar if there are no children
+        super(attributes[:children]) if attributes[:children]
+      end
+    end
+  end
+end

data/lib/redd/objects/private_message.rb

@@ -1,28 +1,28 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # The model for private messages
-    class PrivateMessage < Thing
-      include Thing::Inboxable
-
-      alias_property :from, :author
-      alias_property :to, :dest
-
-      # Block the sender of the message from sending any more.
-      def block_sender!
-        post("/api/block", id: fullname)
-      end
-
-      # Mark the message as read.
-      def mark_as_read
-        post("/api/read_message", id: fullname)
-      end
-
-      # Mark the message as unread and add orangered to account.
-      def mark_as_unread
-        post("/api/unread_message", id: fullname)
-      end
-    end
-  end
-end
+require_relative "thing"
+
+module Redd
+  module Objects
+    # The model for private messages
+    class PrivateMessage < Thing
+      include Thing::Inboxable
+
+      alias_property :from, :author
+      alias_property :to, :dest
+
+      # Block the sender of the message from sending any more.
+      def block_sender!
+        post("/api/block", id: fullname)
+      end
+
+      # Mark the message as read.
+      def mark_as_read
+        post("/api/read_message", id: fullname)
+      end
+
+      # Mark the message as unread and add orangered to account.
+      def mark_as_unread
+        post("/api/unread_message", id: fullname)
+      end
+    end
+  end
+end

data/lib/redd/objects/submission.rb

@@ -1,139 +1,139 @@
-require_relative "thing"
-
-module Redd
-  module Objects
-    # A submission made in a subreddit.
-    class Submission < Thing
-      include Thing::Editable
-      include Thing::Hideable
-      include Thing::Moderatable
-      include Thing::Refreshable
-      include Thing::Saveable
-      include Thing::Votable
-
-      alias_property :nsfw?, :over_18
-      alias_property :self?, :is_self
-      alias_property :comments_count, :num_comments
-
-      # The shorter url for sharing.
-      def short_url
-        "http://redd.it/#{self[:id]}"
-      end
-
-      # Whether the comment was gilded.
-      def gilded?
-        self[:gilded] > 0
-      end
-
-      # Mark the thing as Not Suitable For Work.
-      def mark_as_nsfw
-        get("/api/marknsfw", id: fullname)
-        self[:over_18] = true
-      end
-
-      # No longer mark the thing as Not Suitable For Work.
-      def unmark_as_nsfw
-        get("/api/unmarknsfw", id: fullname)
-        self[:over_18] = false
-      end
-      alias_method :mark_as_safe, :unmark_as_nsfw
-
-      # Reply to the thing.
-      # @param text [String] The text to comment.
-      # @return [Objects::Comment] The reply.
-      def add_comment(text)
-        client.add_comment(self, text)
-      end
-
-      # Set the submission to "contest mode" (comments are randomly sorted)
-      def set_contest_mode
-        post("/api/set_contest_mode", id: fullname, state: true)
-      end
-
-      # Unset the "contest mode".
-      def unset_contest_mode
-        post("/api/set_contest_mode", id: fullname, state: false)
-      end
-
-      # Set the submission as the sticky post of the subreddit
-      def set_sticky
-        post("/api/set_subreddit_sticky", id: fullname, state: true)
-        self[:stickied] = true
-      end
-
-      # Unsticky the post from the subreddit
-      def unset_sticky
-        post("/api/set_subreddit_sticky", id: fullname, state: false)
-        self[:stickied] = false
-      end
-
-      # @return [Listing] The submission's comments.
-      # @todo Allow for various depths and contexts and what not. Maybe a
-      #   get_comment method?
-      def comments
-        refresh! unless @comments
-        @comments
-      end
-      alias_method :replies, :comments
-
-      # Refresh the submission AND its comments.
-      # @return [Submission] The updated submission.
-      def refresh!
-        body = get("/comments/#{id}.json").body
-        @comments = client.object_from_body(body[1])
-        deep_merge!(body[0])
-      end
-
-      # Take a MoreComments and return a listing of comments.
-      # @param [MoreComments] more The object to expand.
-      # @return [Listing] A listing of the expanded comments.
-      def expand_more(more)
-        response = client.get(
-          "/api/morechildren",
-          children: more.join(","),
-          link_id: fullname
-        )
-
-        client.object_from_body(
-          kind: "Listing",
-          data: {
-            before: "", after: "",
-            children: response.body[:json][:data][:things]
-          }
-        )
-      end
-
-      # Get the related articles.
-      # @param [Hash] params 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.
-      # @return [Objects::Listing<Objects::Thing>]
-      def get_related(**params)
-        related = get("/related/#{id}.json", params).body[1]
-        client.object_from_body(related)
-      end
-
-      # Get other articles with the same URL.
-      # @param [Hash] params 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.
-      # @return [Objects::Listing<Objects::Submission>]
-      def get_duplicates(**params)
-        duplicates = get("/duplicates/#{id}.json", params).body[1]
-        client.object_from_body(duplicates)
-      end
-    end
-  end
-end
+require_relative "thing"
+
+module Redd
+  module Objects
+    # A submission made in a subreddit.
+    class Submission < Thing
+      include Thing::Editable
+      include Thing::Hideable
+      include Thing::Moderatable
+      include Thing::Refreshable
+      include Thing::Saveable
+      include Thing::Votable
+
+      alias_property :nsfw?, :over_18
+      alias_property :self?, :is_self
+      alias_property :comments_count, :num_comments
+
+      # The shorter url for sharing.
+      def short_url
+        "http://redd.it/#{self[:id]}"
+      end
+
+      # Whether the comment was gilded.
+      def gilded?
+        self[:gilded] > 0
+      end
+
+      # Mark the thing as Not Suitable For Work.
+      def mark_as_nsfw
+        get("/api/marknsfw", id: fullname)
+        self[:over_18] = true
+      end
+
+      # No longer mark the thing as Not Suitable For Work.
+      def unmark_as_nsfw
+        get("/api/unmarknsfw", id: fullname)
+        self[:over_18] = false
+      end
+      alias_method :mark_as_safe, :unmark_as_nsfw
+
+      # Reply to the thing.
+      # @param text [String] The text to comment.
+      # @return [Objects::Comment] The reply.
+      def add_comment(text)
+        client.add_comment(self, text)
+      end
+
+      # Set the submission to "contest mode" (comments are randomly sorted)
+      def set_contest_mode
+        post("/api/set_contest_mode", id: fullname, state: true)
+      end
+
+      # Unset the "contest mode".
+      def unset_contest_mode
+        post("/api/set_contest_mode", id: fullname, state: false)
+      end
+
+      # Set the submission as the sticky post of the subreddit
+      def set_sticky
+        post("/api/set_subreddit_sticky", id: fullname, state: true)
+        self[:stickied] = true
+      end
+
+      # Unsticky the post from the subreddit
+      def unset_sticky
+        post("/api/set_subreddit_sticky", id: fullname, state: false)
+        self[:stickied] = false
+      end
+
+      # @return [Listing] The submission's comments.
+      # @todo Allow for various depths and contexts and what not. Maybe a
+      #   get_comment method?
+      def comments
+        refresh! unless @comments
+        @comments
+      end
+      alias_method :replies, :comments
+
+      # Refresh the submission AND its comments.
+      # @return [Submission] The updated submission.
+      def refresh!
+        body = get("/comments/#{id}.json").body
+        @comments = client.object_from_body(body[1])
+        deep_merge!(body[0])
+      end
+
+      # Take a MoreComments and return a listing of comments.
+      # @param [MoreComments] more The object to expand.
+      # @return [Listing] A listing of the expanded comments.
+      def expand_more(more)
+        response = client.get(
+          "/api/morechildren",
+          children: more.join(","),
+          link_id: fullname
+        )
+
+        client.object_from_body(
+          kind: "Listing",
+          data: {
+            before: "", after: "",
+            children: response.body[:json][:data][:things]
+          }
+        )
+      end
+
+      # Get the related articles.
+      # @param [Hash] params 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.
+      # @return [Objects::Listing<Objects::Thing>]
+      def get_related(**params)
+        related = get("/related/#{id}.json", params).body[1]
+        client.object_from_body(related)
+      end
+
+      # Get other articles with the same URL.
+      # @param [Hash] params 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.
+      # @return [Objects::Listing<Objects::Submission>]
+      def get_duplicates(**params)
+        duplicates = get("/duplicates/#{id}.json", params).body[1]
+        client.object_from_body(duplicates)
+      end
+    end
+  end
+end