NeonRAW 0.1.6 → 0.1.7

data/lib/NeonRAW/objects/subreddit.rb

@@ -124,9 +124,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
@@ -151,19 +154,15 @@ module NeonRAW
       # @!method rules
       # @return [Array<NeonRAW::Objects::Rule>] Returns a list of the rules.
       def rules
-        data_arr = []
-        data = @client.request_data("/r/#{display_name}/about/rules.json", :get)
-        data[:rules].each do |rule|
-          data_arr << Rule.new(@client, rule)
-        end
-        data_arr
+        data = @client.request_data("/r/#{display_name}/about/rules", :get)
+        data[:rules].map { |rule| Rule.new(@client, rule) }
       end
 
       # Fetches the subreddit's stylesheet.
       # @!method stylesheet
       # @return [Hash<Array, String, String>] Returns the stylesheet data.
       def stylesheet
-        path = "/r/#{display_name}/about/stylesheet.json"
+        path = "/r/#{display_name}/about/stylesheet"
         @client.request_data(path, :get)[:data]
       end
 
@@ -186,9 +185,9 @@ module NeonRAW
       # @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|
+      %w[hot rising top old new controversial comments].each do |type|
         define_method :"#{type}" do |params = { limit: 25 }|
-          path = "/r/#{display_name}/#{type}/.json"
+          path = "/r/#{display_name}/#{type}"
           @client.send(:build_listing, path, params)
         end
       end

data/lib/NeonRAW/objects/subreddit/flair.rb

@@ -8,9 +8,9 @@ module NeonRAW
       module Flair
         # Clears flair templates.
         # @!method clear_flair_templates(flair_type)
-        # @param flair_type [String] The type of flair [user, link].
+        # @param flair_type [Symbol] The type of flair [user, link].
         def clear_flair_templates(flair_type)
-          flairs = { 'user' => 'USER_FLAIR', 'link' => 'LINK_FLAIR' }
+          flairs = { user: 'USER_FLAIR', link: 'LINK_FLAIR' }
           params = { api_type: 'json', flair_type: flairs[flair_type] }
           path = "/r/#{display_name}/api/clearflairtemplates"
           @client.request_data(path, :post, params)
@@ -77,11 +77,14 @@ module NeonRAW
 
         # Sets flairs for multiple users.
         # @!method set_many_flairs(flair_data)
-        # @param flair_data [String] The flair data in CSV format. Format as such:
-        #   "User,flair text,CSS class\\nUser 2,flair text, CSS class".
+        # @param flair_data [String] The flair data in CSV format.
         # @note This API can take up to 100 lines before it starts ignoring
         #   things. If the flair text and CSS class are both empty strings then
         #   it will clear the user's flair.
+        # @example How to set mulitple user flairs.
+        #   client = NeonRAW.script(...)
+        #   flairs = "User,flair text,CSS class\nUser 2,flair text,CSS class"
+        #   client.subreddit(...).set_many_flairs flairs
         def set_many_flairs(flair_data)
           params = { flair_csv: flair_data }
           path = "/r/#{display_name}/api/flaircsv"

data/lib/NeonRAW/objects/subreddit/moderation.rb

@@ -32,7 +32,7 @@ module NeonRAW
         # @return [NeonRAW::Objects::Listing] Returns a listing of the modlog
         #   actions.
         def modlog(params = { limit: 25 })
-          path = "/r/#{display_name}/about/log.json"
+          path = "/r/#{display_name}/about/log"
           @client.send(:build_listing, path, params)
         end
 
@@ -69,10 +69,10 @@ module NeonRAW
         # @option params :show [String] Literally the string 'all'.
         # @return [NeonRAW::Objects::Listing] Returns a listing with all the
         #   things.
-        %w(reported spam modqueue unmoderated edited).each do |type|
+        %w[reported spam modqueue unmoderated edited].each do |type|
           define_method :"#{type}" do |params = { limit: 25 }|
             type = 'reports' if type == 'reported'
-            path = "/r/#{display_name}/about/#{type}.json"
+            path = "/r/#{display_name}/about/#{type}"
             @client.send(:build_listing, path, params)
           end
         end
@@ -93,8 +93,8 @@ module NeonRAW
         # @option params :show [String] Literally the string 'all'.
         # @option params :user [String] The name of the user to fetch.
         # @return [NeonRAW::Objects::Listing] Returns a listing of the users.
-        %w(banned muted wikibanned
-           contributors wikicontributors moderators).each do |type|
+        %w[banned muted wikibanned
+           contributors wikicontributors moderators].each do |type|
              define_method :"#{type}" do |params = { limit: 25 }|
                data_arr = []
                path = "/r/#{display_name}/about/#{type}"
@@ -127,7 +127,7 @@ module NeonRAW
         # Ditch your privileged status in the subreddit.
         # @!method leave_contributor!
         # @!method leave_moderator!
-        %w(contributor moderator).each do |type|
+        %w[contributor moderator].each do |type|
           define_method :"leave_#{type}!" do
             params = { id: name }
             @client.request_data("/api/leave#{type}", :post, params)
@@ -155,7 +155,7 @@ module NeonRAW
         # @!method remove_banner!
         # @!method remove_header!
         # @!method remove_icon!
-        %w(banner header icon).each do |type|
+        %w[banner header icon].each do |type|
           define_method :"remove_#{type}!" do
             params = { api_type: 'json' }
             path = "/r/#{display_name}/api/delete_sr_#{type}"
@@ -191,7 +191,7 @@ module NeonRAW
         # @!method settings
         # @return [Hash] Returns the subreddit's settings.
         def settings
-          path = "/r/#{display_name}/about/edit.json"
+          path = "/r/#{display_name}/about/edit"
           @client.request_data(path, :get)[:data]
         end
       end

data/lib/NeonRAW/objects/subreddit/utilities.rb

@@ -3,29 +3,6 @@ module NeonRAW
     class Subreddit
       # Utilities for subreddits.
       module Utilities
-        # Get info on a link/comment/subreddit.
-        # @!method info(params = {})
-        # @param params [Hash] The parameters.
-        # @option params :name [String] The fullname of the thing.
-        # @option params :url [String] The URL of the thing.
-        # @return [NeonRAW::Objects::Comment/Submission/Subreddit] Returns the
-        #   object.
-        # @see https://www.reddit.com/dev/api#fullnames
-        def info(params = {})
-          params[:id] = params[:name]
-          params.delete(:name)
-          path = "/r/#{display_name}/api/info"
-          data = @client.request_data(path, :get, params)
-          case data[:data][:children][0][:kind]
-          when 't1'
-            Comment.new(@client, data[:data][:children][0][:data])
-          when 't3'
-            Submission.new(@client, data[:data][:children][0][:data])
-          when 't5'
-            Subreddit.new(@client, data[:data][:children][0][:data])
-          end
-        end
-
         # Submit a thread to the subreddit.
         # @!method submit(title, params = {})
         # @param title [String] The title of the submission (300
@@ -34,15 +11,16 @@ module NeonRAW
         # @option params :text [String] The text of the submission (selfpost).
         # @option params :url [String] The URL of the submission (link post).
         # @return [NeonRAW::Objects::Submission] Returns the submission object.
+        # @note This method uses 2 API requests, as it calls #info since the
+        #   JSON returned doesn't give you the submission data.
         def submit(title, params = {})
           params[:kind] = 'self' if params[:text]
           params[:kind] = 'link' if params[:url]
+          params[:api_type] = 'json'
           params[:sr] = display_name
           params[:title] = title
           response = @client.request_data('/api/submit', :post, params)
-          # Seriously though, fucking convoluted data structures.
-          submission_id = response[:jquery].last[3].first.split('/')[6]
-          info(name: 't3_' + submission_id)
+          @client.info(name: response[:json][:data][:name]).first
         end
 
         # Gets recommended subreddits for the subreddit.
@@ -61,7 +39,7 @@ module NeonRAW
         # Toggle your subscription to the subreddit.
         # @!method subscribe!
         # @!method unsubscribe!
-        %w(subscribe unsubscribe).each do |type|
+        %w[subscribe unsubscribe].each do |type|
           define_method :"#{type}!" do
             params = { sr: name }
             params[:action] = 'sub' if type == 'subscribe'
@@ -70,6 +48,45 @@ module NeonRAW
             refresh!
           end
         end
+
+        # Streams content from subreddits.
+        # @!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'.
+        # @yield [NeonRAW::Objects::Comment/Submission] Yields listing items.
+        # @return [Enumerator] Returns an enumerator for the streamed data.
+        # @example Simple comment stream.
+        #   client = NeonRAW.script(...)
+        #   comments = client.subreddit(...).stream :comments
+        #   comments.each do |comment|
+        #     comment.reply 'world' if comment.body =~ /hello/i
+        #   end
+        def stream(queue, params = { limit: 25 })
+          @client.send(:stream, "/r/#{display_name}/#{queue}", params)
+        end
+
+        # Returns data on the moderators of the subreddit.
+        # @!method moderators
+        # @return [Array<Hash<String, String, Array<String>, Float, String,
+        #  String>>] Returns data on the moderators.
+        def moderators
+          path = "/r/#{display_name}/about/moderators"
+          data = @client.request_data(path, :get)[:data][:children]
+          data.each do |user|
+            user[:username] = user.delete(:name)
+            user[:name] = user.delete(:id) # this is for consistency
+          end
+          data
+        end
       end
     end
   end

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

@@ -6,7 +6,7 @@ module NeonRAW
         # Changes the read status of a PM.
         # @!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)

data/lib/NeonRAW/objects/thing/moderateable.rb

@@ -31,12 +31,15 @@ module NeonRAW
         end
 
         # Distinguish a submission/comment.
-        # @!method distinguish(type)
+        # @!method distinguish!(type, params = { sticky: nil })
         # @param type [String] The type of distinguish you want to do [yes, no,
         #   admin, special].
+        # @param params [Hash<Symbol>] Optional parameters.
+        # @option params :sticky [Boolean] Whether or not you want the post
+        #   stickied (top level mod comments only!)
         # @!group Moderators
-        def distinguish(type)
-          params = { api_type: 'json', how: type, id: name }
+        def distinguish!(type, params = { sticky: nil })
+          params.merge!(api_type: 'json', how: type, id: name)
           @client.request_data('/api/distinguish', :post, params)
           refresh!
         end
@@ -69,7 +72,7 @@ module NeonRAW
         # Set whether to ignore reports on the thing or not.
         # @!method ignore_reports!
         # @!method unignore_reports!
-        %w(ignore unignore).each do |type|
+        %w[ignore unignore].each do |type|
           define_method :"#{type}_reports!" do
             params = { id: name }
             @client.request_data("/api/#{type}_reports", :post, params)

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

@@ -7,9 +7,7 @@ module NeonRAW
         # @!method refresh!
         def refresh!
           params = { id: name }
-          path = "/r/#{display_name}/api/info" if /t5_/ =~ name
-          path = "/r/#{subreddit}/api/info" unless /t5_/ =~ name
-          data = @client.request_data(path, :get, params)
+          data = @client.request_data('/api/info', :get, params)
           data[:data][:children][0][:data].each do |key, value|
             value = nil if ['', [], {}].include?(value)
             instance_variable_set(:"@#{key}", value)

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

@@ -55,7 +55,7 @@ module NeonRAW
         # @!method upvote
         # @!method clear_vote
         # @!method downvote
-        %i(upvote clear_vote downvote).each do |type|
+        %i[upvote clear_vote downvote].each do |type|
           define_method type do
             params = { dir: votes[type], id: name }
             @client.request_data('/api/vote', :post, params)

data/lib/NeonRAW/objects/user.rb

@@ -17,10 +17,16 @@ module NeonRAW
     # @!attribute [r] hide_from_robots?
     #   @return [Boolean] Returns whether or not the user doesn't
     #     want web crawlers indexing their profile page.
+    # @!attribute [r] suspended?
+    #   @return [Boolean] Returns whether or not the user is suspended.
     # @!attribute [r] link_karma
     #   @return [Integer] Returns the link karma of the user.
     # @!attribute [r] comment_karma
     #   @return [Integer] Returns the comment karma of the user.
+    # @!attribute [r] name
+    #   @return [String] Returns the fullname of the user.
+    # @!attribute [r] username
+    #   @return [String] Returns the username of the user.
     class User < Thing
       include Thing::Createable
       include Thing::Refreshable
@@ -31,10 +37,17 @@ module NeonRAW
       # @param data [Hash] The object data.
       def initialize(client, data)
         @client = client
+        # is_suspended only gets included when the user is actually suspended
+        data[:is_suspended] = false unless data.key?(:is_suspended)
+        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
@@ -43,6 +56,7 @@ module NeonRAW
           alias_method :moderator?, :is_mod
           alias_method :verified_email?, :has_verified_email
           alias_method :hide_from_robots?, :hide_from_robots
+          alias_method :suspended?, :is_suspended
         end
       end
 
@@ -70,13 +84,38 @@ module NeonRAW
       #   listing.
       # @option params :limit [1..1000] The number of listing items to fetch.
       # @return [NeonRAW::Objects::Listing] Returns the listing object.
-      %w(overview comments submitted gilded upvoted downvoted
-         hidden saved).each do |type|
+      %w[overview comments submitted gilded upvoted downvoted
+         hidden saved].each do |type|
         define_method :"#{type}" do |params = { limit: 25 }|
-          path = "/user/#{name}/#{type}/.json"
+          path = "/user/#{username}/#{type}"
           @client.send(:build_listing, path, params)
         end
       end
+
+      # Streams content from users.
+      # @!method stream(queue, params = { limit: 25 })
+      # @param queue [Symbol] The queue to get data from [overview, comments,
+      #   submitted, gilded, upvoted, downvoted, hidden, saved]
+      # @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'.
+      # @yield [NeonRAW::Objects::Comment/Submission] Yields the listing items.
+      # @return [Enumerator] Returns an enumerator for the streamed data.
+      # @example Simple comment stream.
+      #   client = NeonRAW.script(...)
+      #   comments = client.subreddit(...).stream :comments
+      #   comments.each do |comment|
+      #     comment.reply 'world' if comment.body =~ /hello/i
+      #   end
+      def stream(queue, params = { limit: 25 })
+        @client.send(:stream, "/user/#{username}/#{queue}", params)
+      end
       # @!endgroup
 
       # Give gold to a user.
@@ -84,7 +123,7 @@ module NeonRAW
       # @param months [1..36] The number of months worth of gold to give.
       def give_gold(months)
         params = { months: months }
-        @client.request_data("/api/v1/gold/give/#{name}", :post, params)
+        @client.request_data("/api/v1/gold/give/#{username}", :post, params)
         refresh!
       end
 
@@ -107,40 +146,33 @@ 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/user/#{name}", :get, params)
-        data.each do |multireddit|
-          data_arr << MultiReddit.new(@client, multireddit[:data])
-        end
-        data_arr
+        data = @client.request_data("/api/multi/user/#{username}", :get, params)
+        data.map { |multireddit| MultiReddit.new(@client, multireddit[:data]) }
       end
 
       # Add the user to your friends list.
       # @!method friend
       def friend
         body = { 'name' => name }.to_json
-        @client.request_data("/api/v1/me/friends/#{name}", :put, {}, body)
+        @client.request_data("/api/v1/me/friends/#{username}", :put, {}, body)
       end
 
       # Remove the user from your friends list.
       # @!method unfriend
       def unfriend
         params = { id: name }
-        @client.request_nonjson("/api/v1/me/friends/#{name}", :delete, params)
+        path = "/api/v1/me/friends/#{username}"
+        @client.request_nonjson(path, :delete, params)
       end
 
       # Fetches the user's trophies.
       # @!method trophies
       # @return [Array<NeonRAW::Objects::Trophy>] Returns a list of trophies.
       def trophies
-        data_arr = []
-        path = "/api/v1/user/#{name}/trophies"
+        path = "/api/v1/user/#{username}/trophies"
         data = @client.request_data(path, :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
     end
   end

data/lib/NeonRAW/objects/wikipage.rb

@@ -27,9 +27,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 == :revision_date || key == :revision_by
+          next if %i[revision_date revision_by].include?(key)
           self.class.send(:attr_reader, key)
         end
         class << self
@@ -104,7 +107,7 @@ module NeonRAW
       # @!method add_editor(username)
       # @!method remove_editor(username)
       # @param username [String] The username of the user.
-      %w(add remove).each do |type|
+      %w[add remove].each do |type|
         define_method :"#{type}_editor" do |username|
           params = { page: name, username: username }
           type = 'del' if type == 'remove'