NeonRAW 0.1.6 → 0.1.7

data/lib/NeonRAW/objects/comment.rb

@@ -33,8 +33,8 @@ module NeonRAW
     #   @note This attribute only exists if the comment is fetched from outside
     #     the thread it was posted in (so like user pages,
     #     /r/subreddit/comments, that type of stuff).
-    # @!attribute [r] link_id
-    #   @return [String] Returns the id of the link that this comment is in.
+    # @!attribute [r] link_name
+    #   @return [String] Returns the name of the link that this comment is in.
     # @!attribute [r] link_title
     #   @return [String] Returns the title of the parent link.
     #   @note This attribute only exists if the comment is fetched from outside
@@ -48,8 +48,8 @@ module NeonRAW
     # @!attribute [r] num_reports
     #   @return [Integer, nil] Returns the number of times the comment has been
     #     reported or nil if it hasn't or you aren't a moderator.
-    # @!attribute [r] parent_id
-    #   @return [String] Returns the ID of either the link or the comment that
+    # @!attribute [r] parent_name
+    #   @return [String] Returns the name of either the link or the comment that
     #     this comment is a reply to.
     # @!attribute [r] saved?
     #   @return [Boolean] Returns whether or not you saved the comment.
@@ -81,9 +81,12 @@ module NeonRAW
       def initialize(client, data)
         @client = client
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
           instance_variable_set(:"@#{key}", value)
-          next if key == :created || key == :created_utc || key == :replies
+          next if %i[created created_utc replies].include?(key)
           self.class.send(:attr_reader, key)
         end
         class << self
@@ -92,6 +95,8 @@ module NeonRAW
           alias_method :saved?, :saved
           alias_method :score_hidden?, :score_hidden
           alias_method :archived?, :archived
+          alias_method :link_name, :link_id
+          alias_method :parent_name, :parent_id
         end
       end
 
@@ -144,6 +149,15 @@ module NeonRAW
         end
         comments
       end
+
+      # Creates the comment's permalink.
+      # @!method permalink
+      # @return [String] Returns the comment's permalink.
+      def permalink
+        submission_id = link_id[3..-1] # trims the t3_ from the fullname
+        # the // is intentional
+        "https://www.reddit.com/r/#{subreddit}/comments/#{submission_id}//#{id}"
+      end
     end
   end
 end

data/lib/NeonRAW/objects/inboxcomment.rb

@@ -40,9 +40,12 @@ module NeonRAW
       def initialize(client, data)
         @client = client
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
           instance_variable_set(:"@#{key}", value)
-          next if key == :created || key == :created_utc
+          next if %i[created created_utc].include?(key)
           self.class.send(:attr_reader, key)
         end
         class << self

data/lib/NeonRAW/objects/me.rb

@@ -1,7 +1,7 @@
 require_relative 'user'
 require_relative 'trophy'
 require_relative 'multireddit'
-# rubocop:disable Metrics/AbcSize, Metrics/ClassLength
+# rubocop:disable Metrics/AbcSize, Metrics/MethodLength
 # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
 module NeonRAW
@@ -34,10 +34,15 @@ module NeonRAW
       # @param data [Hash] The object data.
       def initialize(client, data)
         @client = client
+        data[:username] = data.delete(:name) # this is for consistency
+        data[:name] = 't2_' + data[:id]
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
           instance_variable_set(:"@#{key}", value)
-          next if key == :created || key == :created_utc
+          next if %i[created created_utc].include?(key)
           self.class.send(:attr_reader, key)
         end
         class << self
@@ -70,7 +75,7 @@ module NeonRAW
       # @option params :limit [1..1000] The number of listing items to fetch.
       # @option params :show [String] Literally the string 'all'.
       # @return [NeonRAW::Objects::Listing] Returns a listing with all your PMs.
-      %w(messages inbox unread sent).each do |type|
+      %w[messages inbox unread sent].each do |type|
         define_method :"#{type}" do |params = { limit: 25 }|
           @client.send(:build_listing, "/message/#{type}", params)
         end
@@ -88,7 +93,7 @@ module NeonRAW
       # @return [NeonRAW::Objects::Listing] Returns a listing with all your
       #   modmails.
       def modmail(params = { limit: 25 })
-        @client.send(:build_listing, '/message/moderator.json', params)
+        @client.send(:build_listing, '/message/moderator', params)
       end
 
       # Fetches your subreddits.
@@ -104,7 +109,7 @@ module NeonRAW
       # @option params :show [String] Literally the string 'all'.
       # @return [NeonRAW::Objects::Listing] Returns a listing with all your
       #   subreddits.
-      %w(subscribed contributed moderated).each do |type|
+      %w[subscribed contributed moderated].each do |type|
         define_method :"#{type}" do |params = { limit: 25 }|
           type = 'subscriber' if type == 'subscribed'
           type = 'contributor' if type == 'contributed'
@@ -144,12 +149,8 @@ module NeonRAW
       # @!method trophies
       # @return [Array<NeonRAW::Objects::Trophy>] Returns a list of trophies.
       def trophies
-        data_arr = []
         data = @client.request_data('/api/v1/me/trophies', :get)[:data]
-        data[:trophies].each do |trophy|
-          data_arr << Trophy.new(trophy[:data])
-        end
-        data_arr
+        data[:trophies].map { |trophy| Trophy.new(trophy[:data]) }
       end
 
       # Fetches your friends.
@@ -163,12 +164,8 @@ module NeonRAW
       # @return [Array<Hash<Float, String, String>>] Returns the list of your
       #   friends.
       def friends(params = { limit: 25 })
-        data_arr = []
         data = @client.request_data('/prefs/friends', :get, params)
-        data[0][:data][:children].each do |friend|
-          data_arr << friend
-        end
-        data_arr
+        data[0][:data][:children].map { |friend| friend }
       end
 
       # Fetches your blocked users.
@@ -182,12 +179,8 @@ module NeonRAW
       # @return [Array<Hash<Float, String, String>>] Returns the list of your
       #   blocked users.
       def blocked(params = { limit: 25 })
-        data_arr = []
         data = @client.request_data('/prefs/blocked', :get, params)
-        data[:data][:children].each do |blocked|
-          data_arr << blocked
-        end
-        data_arr
+        data[:data][:children].map { |blocked| blocked }
       end
 
       # Mark all your messages as "read."
@@ -201,19 +194,15 @@ module NeonRAW
       # @return [Array<NeonRAW::Objects::MultiReddit>] Returns a list of
       #   multireddits.
       def multireddits
-        data_arr = []
         params = { expand_srs: false }
         data = @client.request_data('/api/multi/mine', :get, params)
-        data.each do |multireddit|
-          data_arr << MultiReddit.new(@client, multireddit[:data])
-        end
-        data_arr
+        data.map { |multireddit| MultiReddit.new(@client, multireddit[:data]) }
       end
 
       # Goes through and edits then deletes your post history. Defaults to
       # 2 weeks.
       # @!method purge(queue, params = {})
-      # @param queue [String] The queue you want to get your posts from
+      # @param queue [Symbol] The queue you want to get your posts from
       #   [overview, submitted, comments, upvoted, downvoted, hidden, saved,
       #   giled]
       # @param params [Hash] The additional parameters.
@@ -240,9 +229,9 @@ module NeonRAW
           next if item.created < params[:age]
           next unless whitelist.include?(item.subreddit) || whitelist[0] == '*'
           if item.is_a?(Submission)
-            item.edit! params[:edit] if item.selfpost? && !item.archived?
+            item.edit! params[:edit] if item.selfpost?
           else
-            item.edit! params[:edit] unless item.archived?
+            item.edit! params[:edit]
           end
           item.delete!
         end

data/lib/NeonRAW/objects/modlogaction.rb

@@ -41,6 +41,9 @@ module NeonRAW
       def initialize(client, data)
         @client = client
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
           instance_variable_set(:"@#{key}", value)
           next if key == :created_utc

data/lib/NeonRAW/objects/modloguser.rb

@@ -17,6 +17,9 @@ module NeonRAW
       def initialize(client, data)
         @client = client
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
           instance_variable_set(:"@#{key}", value)
           next if key == :date

data/lib/NeonRAW/objects/morecomments.rb

@@ -7,6 +7,9 @@ module NeonRAW
       def initialize(client, data)
         @client = client
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
           instance_variable_set(:"@#{key}", value)
           self.class.send(:attr_reader, key)
@@ -20,21 +23,21 @@ module NeonRAW
         true
       end
 
+      # Returns whether or not the object is a Comment object.
+      # @!method comment?
+      # @return [Boolean] Returns false.
+      def comment?
+        false
+      end
+
       # Expands the MoreComments object.
-      # @!method expand(subreddit)
-      # @param subreddit [String] The name of the subreddit where the
-      #   MoreComments object resides.
-      # @return [Array] Returns a list of the comments that were expanded.
-      def expand(subreddit)
-        comments = []
+      # @!method expand
+      # @return [NeonRAW::Objects::Listing] Returns a listing with all of the
+      #   comments that were expanded.
+      def expand
         return [] if children.nil?
-        params = { id: children.map { |the_id| 't1_' + the_id }.join(',') }
         # /api/morechildren is buggy shit. This is better.
-        data = @client.request_data("/r/#{subreddit}/api/info", :get, params)
-        data[:data][:children].each do |comment|
-          comments << Comment.new(@client, comment[:data])
-        end
-        comments
+        @client.info(name: children.map { |the_id| 't1_' + the_id }.join(','))
       end
     end
   end

data/lib/NeonRAW/objects/multireddit.rb

@@ -46,9 +46,12 @@ module NeonRAW
       def initialize(client, data)
         @client = client
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
           instance_variable_set(:"@#{key}", value)
-          next if key == :created || key == :created_utc || key == :subreddits
+          next if %i[created created_utc subreddits].include?(key)
           self.class.send(:attr_reader, key)
         end
         class << self

data/lib/NeonRAW/objects/popular.rb

@@ -0,0 +1,57 @@
+module NeonRAW
+  module Objects
+    # The object for /r/popular.
+    class Popular
+      # @!method initialize(client)
+      # @param client [NeonRAW::Clients::Web/Installed/Script] The client
+      #   object.
+      def initialize(client)
+        @client = client
+      end
+
+      # @!group Listings
+      # Fetches a listing from /r/popular.
+      # @!method hot(params = { limit: 25 })
+      # @!method rising(params = { limit: 25 })
+      # @!method top(params = { limit: 25 })
+      # @!method old(params = { limit: 25 })
+      # @!method new(params = { limit: 25 })
+      # @!method controversial(params = { limit: 25 })
+      # @!method comments(param = { limit: 25 })
+      # @param params [Hash] The parameters for the request.
+      # @option params :t [String] Time for relevant sorting [hour, day, week,
+      #   month, year, all]
+      # @option params :after [String] The name of the next data block.
+      # @option params :before [String] The name of the previous data block.
+      # @option params :count [Integer] The number of items already in the
+      #   listing.
+      # @option params :limit [1..1000] The number of items to fetch.
+      # @option params :show [String] Literally the string 'all'.
+      # @return [NeonRAW::Objects::Listing] Returns the listing object.
+      %w[hot rising top old new controversial comments].each do |type|
+        define_method :"#{type}" do |params = { limit: 25 }|
+          path = "/r/popular/#{type}"
+          @client.send(:build_listing, path, params)
+        end
+      end
+
+      # Streams content from /r/popular.
+      # @!method stream(queue, params = { limit: 25 })
+      # @param queue [Symbol] The queue to get data from [hot, top, new,
+      #   controversial, gilded, comments]
+      # @param params [Hash] The parameters for the request.
+      # @option params :t [String] Time for relevant sorting [hour, day, week,
+      #   month, year, all]
+      # @option params :after [String] The name of the next data block.
+      # @option params :before [String] The name of the previous data block.
+      # @option params :count [Integer] The number of items already in the
+      #   listing.
+      # @option params :limit [1..1000] The number of items to fetch.
+      # @option params :show [String] Literally the string 'all'.
+      # @return [Enumerator] Returns an enumerator for the streamed data.
+      def stream(queue, params = { limit: 25 })
+        @client.send(:stream, "/r/popular/#{queue}", params)
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/privatemessage.rb

@@ -36,9 +36,12 @@ module NeonRAW
       def initialize(client, data)
         @client = client
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
           instance_variable_set(:"@#{key}", value)
-          next if key == :created || key == :created_utc || key == :replies
+          next if %i[created created_utc replies].include?(key)
           self.class.send(:attr_reader, key)
         end
         class << self
@@ -69,7 +72,7 @@ module NeonRAW
       # Toggle the read status of a message.
       # @!method mark_as_read!
       # @!method mark_as_unread!
-      %w(read unread).each do |type|
+      %w[read unread].each do |type|
         define_method :"mark_as_#{type}!" do
           params = { id: name }
           @client.request_data("/api/#{type}_message", :post, params)
@@ -79,7 +82,7 @@ module NeonRAW
       # Set whether to mute a user in modmail or not.
       # @!method mute!
       # @!method unmute!
-      %w(mute unmute).each do |type|
+      %w[mute unmute].each do |type|
         define_method :"#{type}!" do
           params = { id: name }
           @client.request_data("/api/#{type}_message_author", :post, params)

data/lib/NeonRAW/objects/rule.rb

@@ -23,6 +23,9 @@ module NeonRAW
       def initialize(client, data)
         @client = client
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
           instance_variable_set(:"@#{key}", value)
           next if key == :created_utc

data/lib/NeonRAW/objects/submission.rb

@@ -1,6 +1,10 @@
 require_relative 'thing'
 require_relative 'comment'
 require_relative 'morecomments'
+require_relative 'listing'
+require_relative 'submission'
+
+# rubocop:disable Metrics/MethodLength, Metrics/ClassLength
 
 module NeonRAW
   module Objects
@@ -84,9 +88,16 @@ module NeonRAW
       def initialize(client, data)
         @client = client
         data.each do |key, value|
+          # for consistency, empty strings/arrays/hashes are set to nil
+          # because most of the keys returned by Reddit are nil when they
+          # don't have a value, besides a few
           value = nil if ['', [], {}].include?(value)
-          instance_variable_set(:"@#{key}", value)
-          next if key == :created || key == :created_utc
+          if key == :permalink
+            instance_variable_set(:"@#{key}", 'https://www.reddit.com' + value)
+          else
+            instance_variable_set(:"@#{key}", value)
+          end
+          next if %i[created created_utc].include?(key)
           self.class.send(:attr_reader, key)
         end
         class << self
@@ -134,7 +145,7 @@ module NeonRAW
       # @return [Array] Returns an array full of Comments and MoreComments
       #   objects.
       def comments
-        data = @client.request_data("/comments/#{id}/.json", :get)
+        data = @client.request_data("/comments/#{id}", :get)
         data_arr = []
         data[1][:data][:children].each do |comment|
           if comment[:kind] == 't1'
@@ -146,6 +157,34 @@ module NeonRAW
         data_arr
       end
 
+      # Fetches duplicates for the submission.
+      # @!method duplicates(params = { limit: 25 })
+      # @param params [Hash] Optional parameters.
+      # @option :after [String] The fullname of the next data block.
+      # @option :before [String] The fullname of the previous data block.
+      # @option :count [Integer] The number of posts already in the listing.
+      # @option :limit [1..1000] The number of listing items to fetch.
+      # @option :show [String] Literally the string 'all'.
+      # @return [NeonRAW::Objects::Listing] Returns the listing with all the
+      #   duplicate submissions.
+      def duplicates(params = { limit: 25 })
+        params[:sr_detail] = false
+        data_arr = []
+        until data_arr.length == params[:limit]
+          data = @client.request_data("/duplicates/#{id}", :get, params)
+          params[:after] = data[1][:data][:after]
+          params[:before] = data[1][:data][:before]
+          data[1][:data][:children].each do |submission|
+            data_arr << Submission.new(@client, submission[:data])
+            break if data_arr.length == params[:limit]
+          end
+          break if params[:after].nil?
+        end
+        listing = Listing.new(params[:after], params[:before])
+        data_arr.each { |submission| listing << submission }
+        listing
+      end
+
       # Set submission visibility.
       # @!method hide
       # @!method unhide
@@ -154,7 +193,7 @@ module NeonRAW
       # Set whether or not users can comment on the submission.
       # @!method lock
       # @!method unlock
-      %w(hide unhide lock unlock).each do |type|
+      %w[hide unhide lock unlock].each do |type|
         define_method :"#{type}" do
           params = { id: name }
           @client.request_data("/api/#{type}", :post, params)
@@ -164,7 +203,7 @@ module NeonRAW
       # Set the submission's NSFW status.'
       # @!method mark_nsfw
       # @!method unmark_nsfw
-      %w(mark unmark).each do |type|
+      %w[mark unmark].each do |type|
         define_method :"#{type}_nsfw" do
           params = { id: name }
           @client.request_data("/api/#{type}nsfw", :post, params)