NeonRAW 0.1.1

data/lib/NeonRAW/objects/multireddit.rb

@@ -0,0 +1,134 @@
+require_relative 'thing'
+
+module NeonRAW
+  module Objects
+    # The multireddit object.
+    # @!attribute [r] editable?
+    #   @return [Boolean] Returns whether or not you can edit the multireddit.
+    # @!attribute [r] display_name
+    #   @return [String] Returns the display name of the multireddit.
+    # @!attribute [r] name
+    #   @return [String] Returns the name of the multireddit.
+    # @!attribute [r] description_html
+    #   @return [String, nil] Returns the description of the multireddit with
+    #     HTML or nil if there is none.
+    # @!attribute [r] copied_from
+    #   @return [String, nil] Returns where the multireddit was copied from or
+    #     nil if it wasn't copied.
+    # @!attribute [r] icon_url
+    #   @return [String, nil] Returns the icon URL of the multireddit or nil if
+    #     there is none.
+    # @!attribute [r] key_color
+    #   @return [String, nil] Returns the color of the key or nil if there is
+    #     none.
+    # @!attribute [r] visibility
+    #   @return [String] Returns the visibility status of the multireddit
+    #     [public, private, hidden].
+    # @!attribute [r] icon_name
+    #   @return [String, nil] Returns the name of the icon or nil if there is
+    #     none ['art and design', 'ask', 'books', 'business', 'cars',
+    #     'comics', 'cute animals', 'diy', 'entertainment', 'food and drink',
+    #     'funny', 'games', 'grooming', 'health', 'life advice', 'military',
+    #     'models pinup', 'music', 'news', 'philosophy', 'pictures and gifs',
+    #     'science', 'shopping', 'sports', 'style', 'tech', 'travel',
+    #     'unusual stories', 'video', '', 'None'].
+    # @!attribute [r] weighting_scheme
+    #   @return [String] Returns the weighting scheme for the multireddit
+    #     [classic, fresh].
+    # @!attribute [r] path
+    #   @return [String] Returns the path to the multireddit.
+    # @!attribute [r] description
+    #   @return [String, nil] Returns the description of the multireddit or nil
+    #     if there is none.
+    class MultiReddit < Thing
+      include Thing::Createable
+
+      def initialize(client, data)
+        @client = client
+        data.each do |key, value|
+          value = nil if ['', [], {}].include?(value)
+          instance_variable_set(:"@#{key}", value)
+          next if key == :created || key == :created_utc || key == :subreddits
+          self.class.send(:attr_reader, key)
+        end
+        class << self
+          alias_method :editable?, :can_edit
+          alias_method :description, :description_md
+        end
+      end
+
+      # Fetches a list of subreddits in the multireddit.
+      # @!method subreddits
+      # @return [Array<String>] Returns a list of subreddit display_names.
+      def subreddits
+        subreddits = @subreddits || []
+        subreddits.map { |subreddit| subreddit[:name] }
+      end
+
+      # Copy the multireddit.
+      # @!method copy(opts = {})
+      # @param opts [Hash] Optional parameters.
+      # @option opts :name [String] The new name of the multireddit. Defaults to
+      #   the name of the original copy.
+      # @return [NeonRAW::Objects::MultiReddit] Returns the new object.
+      def copy(opts = {})
+        params = { display_name: display_name, from: path,
+                   to: "/user/#{@client.me.name}/m/" }
+        params[:to] += opts[:name] || display_name
+        data = @client.request_data('/api/multi/copy', :post, params)
+        MultiReddit.new(@client, data[:data])
+      end
+
+      # Renames the multireddit.
+      # @!method rename!(new_name)
+      # @param new_name [String] The new name for the multireddit.
+      # @return [NeonRAW::objects::MultiReddit] Returns the multireddit object.
+      def rename!(new_name)
+        params = { display_name: new_name, from: path,
+                   to: "/user/#{@client.me.name}/m/#{new_name}" }
+        data = @client.request_data('/api/multi/rename', :post, params)
+        MultiReddit.new(@client, data[:data])
+      end
+
+      # Deletes the multireddit.
+      # @!method delete!
+      def delete!
+        @client.request_nonjson("/api/multi/#{path}", :delete)
+      end
+
+      # Edit the multireddit.
+      # @!method edit(data)
+      # @param data [JSON] The data for the multireddit.
+      # @see https://www.reddit.com/dev/api#PUT_api_multi_{multipath}
+      def edit(data)
+        params = { model: data, multipath: path, expand_srs: false }
+        data = @client.request_data("/api/multi/#{path}", :put, params)
+        data[:data].each do |key, value|
+          value = nil if ['', [], {}].include?(value)
+          instance_variable_set(:"@#{key}", value)
+        end
+      end
+
+      # Adds a subreddit to the multireddit.
+      # @!method add_subreddit(subreddit)
+      # @param subreddit [String] The name of the subreddit to add.
+      def add_subreddit(subreddit)
+        params = { model: { 'name' => subreddit }.to_json, multipath: path,
+                   srname: subreddit }
+        api_path = "/api/multi/#{path}/r/#{subreddit}"
+        @client.request_data(api_path, :put, params)
+        @subreddits << { name: subreddit }
+      end
+
+      # Remove a subreddit from the multireddit.
+      # @!method remove_subreddit(subreddit)
+      # @param subreddit [String] The name of the subreddit to remove.
+      def remove_subreddit(subreddit)
+        params = { multipath: path, srname: subreddit }
+        api_path = "/api/multi/#{path}/r/#{subreddit}"
+        @client.request_nonjson(api_path, :delete, params)
+        @subreddits.delete(name: subreddit)
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/privatemessage.rb

@@ -0,0 +1,90 @@
+require_relative 'thing'
+
+module NeonRAW
+  module Objects
+    # The private message object.
+    # @!attribute [r] author
+    #   @return [String] Returns the author of the private message.
+    # @!attribute [r] body
+    #   @return [String, nil] Returns the PM text body or nil if there is none.
+    # @!attribute [r] was_comment?
+    #   @return [Boolean] Returns whether or not the object was a comment first.
+    # @!attribute [r] first_message
+    #   @return [String, nil] Returns the first message ID or nil if there was
+    #     none.
+    # @!attribute [r] dest
+    #   @return [String] Returns the user whom the PM was sent to.
+    # @!attribute [r] body_html
+    #   @return [String, nil] Returns the text body with HTML or nil if there
+    #     is none.
+    # @!attribute [r] subreddit
+    #   @return [String, nil] Returns the subreddit it was sent from or nil if
+    #     it wasn't a comment.
+    # @!attribute [r] context
+    #   @return [String, nil] Returns the comment permalink with context or nil
+    #     if it wasn't a comment.
+    # @!attribute [r] new?
+    #   @return [Boolean] Returns whether or not the message is unread.
+    # @!attribute [r] subject
+    #   @return [String] Returns the subject of the PM.
+    class PrivateMessage < Thing
+      include Thing::Createable
+      include Thing::Inboxable
+      include Thing::Moderateable
+      include Thing::Repliable
+
+      def initialize(client, data)
+        @client = client
+        data.each do |key, value|
+          value = nil if ['', [], {}].include?(value)
+          instance_variable_set(:"@#{key}", value)
+          next if key == :created || key == :created_utc || key == :replies
+          self.class.send(:attr_reader, key)
+        end
+        class << self
+          alias_method :was_comment?, :was_comment
+        end
+      end
+
+      # Creates a list of replies to a private message.
+      # @!method replies
+      # @return [Array<NeonRAW::Objects::PrivateMessage>] Returns a list of
+      #   replies.
+      def replies
+        return nil if @replies.nil?
+        messages = []
+        @replies[:data][:children].each do |reply|
+          messages << PrivateMessage.new(@client, reply[:data])
+        end
+        messages
+      end
+
+      # Block a user.
+      # @!method block!
+      def block!
+        params = { id: name }
+        @client.request_data('/api/block', :post, params)
+      end
+
+      # Toggle the read status of a message.
+      # @!method mark_as_read!
+      # @!method mark_as_unread!
+      %w(read unread).each do |type|
+        define_method :"mark_as_#{type}!" do
+          params = { id: name }
+          @client.request_data("/api/#{type}_message", :post, params)
+        end
+      end
+
+      # Set whether to mute a user in modmail or not.
+      # @!method mute!
+      # @!method unmute!
+      %w(mute unmute).each do |type|
+        define_method :"#{type}!" do
+          params = { id: name }
+          @client.request_data("/api/#{type}_message_author", :post, params)
+        end
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/rule.rb

@@ -0,0 +1,41 @@
+require_relative 'thing'
+
+module NeonRAW
+  module Objects
+    # The subreddit rule object.
+    # @!attribute [r] kind
+    #   @return [String] Returns the kind of rule.
+    # @!attribute [r] description
+    #   @return [String] Returns the description of the rule.
+    # @!attribute [r] short_name
+    #   @return [String] Returns the name of the rule.
+    # @!attribute [r] priority
+    #   @return [Integer] Returns the priority of the rule.
+    # @!attribute [r] description_html
+    #   @return [String] Returns the description of the rule with HTML.
+    class Rule < Thing
+      include Thing::Createable
+
+      # @!method initialize(client, data)
+      # @param client [NeonRAW::Clients::Web/Installed/Script] The client
+      #   object.
+      # @param data [Hash] The object data.
+      def initialize(client, data)
+        @client = client
+        data.each do |key, value|
+          value = nil if ['', [], {}].include?(value)
+          instance_variable_set(:"@#{key}", value)
+          next if key == :created_utc
+          self.class.send(:attr_reader, key)
+        end
+      end
+
+      # Says when the rule was created.
+      # @!method created
+      # @return [Time] Returns when the rule was created.
+      def created
+        Time.at(@created_utc).localtime
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/submission.rb

@@ -0,0 +1,221 @@
+require_relative 'thing'
+require_relative 'comment'
+require_relative 'morecomments'
+
+module NeonRAW
+  module Objects
+    # The submission object.
+    # @!attribute [r] archived?
+    #   @return [Boolean] Returns whether or not the submission is archived.
+    # @!attribute [r] author
+    #   @return [String] Returns the author of the submission.
+    # @!attribute [r] author_flair_css_class
+    #   @return [String, nil] Returns the CSS class of the submitter's flair or
+    #     nil if there is none.
+    # @!attribute [r] author_flair_text
+    #   @return [String, nil] Returns the flair's text of the submitter's flair
+    #     or nil if there is none.
+    # @!attribute [r] clicked?
+    #   @return [Boolean] Returns whether or not the submission has been
+    #     "clicked".
+    # @!attribute [r] domain
+    #   @return [String] Returns the domain of the submitted item.
+    # @!attribute [r] hidden?
+    #   @return [Boolean] Returns whether or not you hid the submission.
+    # @!attribute [r] selfpost?
+    #   @return [Boolean] Returns whether or not the submission is a selfpost.
+    # @!attribute [r] link_flair_css_class
+    #   @return [String, nil] Returns the CSS class for the submission's link
+    #     flair or nil if there is none.
+    # @!attribute [r] link_flair_text
+    #   @return [String, nil] Returns the Link flair's text or nil if there is
+    #     none.
+    # @!attribute [r] locked?
+    #   @return [Boolean] Returns whether or not the submission is locked.
+    # @!attribute [r] media
+    #   @return [Hash, nil] Returns an object containing information about a
+    #     video and its origins or nil if there is none.
+    # @!attribute [r] media_embed
+    #   @return [Hash, nil] Returns an object containing technical embed
+    #     information or nil if there is none.
+    # @!attribute [r] num_comments
+    #   @return [Integer] Returns the number of comments in the submission.
+    # @!attribute [r] nsfw?
+    #   @return [Boolean] Returns whether or not the post is flagged as NSFW.
+    # @!attribute [r] permalink
+    #   @return [String] Returns the permalink of the submission.
+    # @!attribute [r] saved?
+    #   @return [Boolean] Returns whether or not you saved the submission.
+    # @!attribute [r] score
+    #   @return [Integer] Returns the submission's karma score.
+    # @!attribute [r] selftext
+    #   @return [String, nil] Returns the text of selfposts or nil if there is
+    #     none.
+    # @!attribute [r] selftext_html
+    #   @return [String, nil] Returns the text of selfposts with HTML or nil if
+    #     there is none.
+    # @!attribute [r] subreddit
+    #   @return [String] Returns the subreddit the submission was posted to.
+    # @!attribute [r] subreddit_id
+    #   @return [String] Returns the ID of the subreddit where the submission
+    #     was posted to.
+    # @!attribute [r] thumbnail
+    #   @return [String, nil] Returns the URL to the thumbnail of the post or
+    #     nil if there is none.
+    # @!attribute [r] title
+    #   @return [String] Returns the title of the submission.
+    # @!attribute [r] url
+    #   @return [String] Either the URL submitted (link post) or the
+    #     submission's permalink (selfpost).
+    class Submission < Thing
+      include Thing::Createable
+      include Thing::Editable
+      include Thing::Gildable
+      include Thing::Moderateable
+      include Thing::Refreshable
+      include Thing::Repliable
+      include Thing::Saveable
+      include Thing::Votable
+
+      # @!method initialize(client, data)
+      # @param client [NeonRAW::Clients::Web/Installed/Script] The client
+      #   object.
+      # @param data [Hash] The object data.
+      def initialize(client, data)
+        @client = client
+        data.each do |key, value|
+          value = nil if ['', [], {}].include?(value)
+          instance_variable_set(:"@#{key}", value)
+          next if key == :created || key == :created_utc
+          self.class.send(:attr_reader, key)
+        end
+        class << self
+          alias_method :clicked?, :clicked
+          alias_method :hidden?, :hidden
+          alias_method :selfpost?, :is_self
+          alias_method :locked?, :locked
+          alias_method :nsfw?, :over_18
+          alias_method :saved?, :saved
+          alias_method :archived?, :archived
+          alias_method :add_comment, :reply
+        end
+      end
+
+      # Checks whether or not the submission is a link post.
+      # @!method linkpost?
+      # @return [Boolean] Returns whether or not the submission is a link post.
+      def linkpost?
+        !@is_self
+      end
+
+      # Checks whether or not the submission has flair.
+      # @!method flair?
+      # @return [Boolean] Returns whether or not the submission has flair.
+      def flair?
+        !@link_flair_text.nil? || !@link_flair_css_class.nil?
+      end
+
+      # Fetches the comments for a submission.
+      # @!method comments
+      # @return [Array] Returns an array full of Comments and MoreComments
+      #   objects.
+      def comments
+        data = @client.request_data(permalink + '.json', :get)
+        data_arr = []
+        data[1][:data][:children].each do |comment|
+          if comment[:kind] == 't1'
+            data_arr << Comment.new(@client, comment[:data])
+          elsif comment[:kind] == 'more'
+            data_arr << MoreComments.new(@client, comment[:data])
+          end
+        end
+        data_arr
+      end
+
+      # Flattens comment trees into a single array.
+      # @!method flatten_comments(comments)
+      # @param comments [Array] A list of comments to be checked for replies to
+      #   flatten.
+      # @return [Array] Returns a list of the flattened comments.
+      def flatten_comments(comments)
+        flattened = []
+        stack = comments.dup
+
+        until stack.empty?
+          comment = stack.shift
+          if comment.is_a?(Comment)
+            replies = comment.replies
+            stack = replies + stack unless replies.nil?
+          end
+          flattened << comment
+        end
+        flattened
+      end
+
+      # Set submission visibility.
+      # @!method hide
+      # @!method unhide
+      # @note See lock/unlock for source code.
+
+      # Set whether or not users can comment on the submission.
+      # @!method lock
+      # @!method unlock
+      %w(hide unhide lock unlock).each do |type|
+        define_method :"#{type}" do
+          params = { id: name }
+          @client.request_data("/api/#{type}", :post, params)
+        end
+      end
+
+      # Set the submission's NSFW status.'
+      # @!method mark_nsfw
+      # @!method unmark_nsfw
+      %w(mark unmark).each do |type|
+        define_method :"#{type}_nsfw" do
+          params = { id: name }
+          @client.request_data("/api/#{type}nsfw", :post, params)
+        end
+      end
+
+      # Toggle getting inbox replies from the submission.
+      # @!method inbox_replies(enable)
+      # @param enable [Boolean] Turns it on or off.
+      def inbox_replies(enable)
+        params = { id: name, state: enable }
+        @client.request_data('/api/sendreplies', :post, params)
+      end
+
+      # Set contest mode on or off.
+      # @!method contest_mode(enable)
+      # @param enable [Boolean] Turns it on or off.
+      def contest_mode(enable)
+        params = { api_type: 'json', id: name, state: enable }
+        @client.request_data('/api/set_contest_mode', :post, params)
+      end
+
+      # Sets the suggested sort for a submission.
+      # @!method suggested_sort(sort)
+      # @param sort [Symbol] The sort to set [confidence, top, new,
+      #   controversial, old, random, qa]
+      def suggested_sort(sort)
+        params = { api_type: 'json', id: name, sort: sort }
+        @client.request_data('/api/set_suggested_sort', :post, params)
+      end
+
+      # Sticky a submission/comment.
+      # @!method sticky(enable)
+      # @param enable [Boolean] Stickies/unstickies the thing.
+      def sticky(enable)
+        params = { api_type: 'json', id: name, state: enable }
+        @client.request_data('/api/set_subreddit_sticky', :post, params)
+      end
+
+      # The submission's shortlink.
+      # @!method shortlink
+      # @return [String] Returns the submission's shortlink.
+      def shortlink
+        "https://redd.it/#{id}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,169 @@
+require_relative '../thing'
+# rubocop:disable Style/AccessorMethodName, Metrics/LineLength
+
+module NeonRAW
+  module Objects
+    class Subreddit < Thing
+      # Methods for flairs.
+      module Flair
+        # Clears flair templates.
+        # @!method clear_flair_templates(flair_type)
+        # @param flair_type [String] The type of flair [user, link].
+        def clear_flair_templates(flair_type)
+          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)
+        end
+
+        # Deletes a user's flair.
+        # @!method delete_flair(username)
+        # @param username [String] The username of the user whose flair will be
+        #   deleted.
+        def delete_flair(username)
+          params = { api_type: 'json', name: username }
+          path = "/r/#{display_name}/api/deleteflair"
+          @client.request_data(path, :post, params)
+        end
+
+        # Delete a flair template.
+        # @!method delete_flair_template(template_id)
+        # @param template_id [String] The template's ID.
+        def delete_flair_template(template_id)
+          params = { api_type: 'json', flair_template_id: template_id }
+          path = "/r/#{display_name}/api/deleteflairtemplate"
+          @client.request_data(path, :post, params)
+        end
+
+        # Sets the flair on either a link or a user.
+        # @!method set_flair(thing, text, opts = {})
+        # @param thing [NeonRAW::Objects::User/Me/Submission] The thing to flair.
+        # @param text [String] The flair text (64 characters max).
+        # @param opts [Hash] Optional parameters.
+        # @option opts css_class [String] The CSS class of the flair.
+        def set_flair(thing, text, opts = {})
+          params = { api_type: 'json', text: text, css_class: opts[:css_class] }
+          if thing.is_a?(Objects::User) || thing.is_a?(Objects::Me)
+            params[:name] = thing.name
+          elsif thing.is_a?(Objects::Submission)
+            params[:link] = thing.name
+          end
+          path = "/r/#{display_name}/api/flair"
+          @client.request_data(path, :post, params)
+        end
+
+        # Configure the subreddit's flairs.
+        # @!method flair_config(enabled, position, self_assign_enabled, link_flair_position, self_link_flair_assign)
+        # @param enabled [Boolean] Enable/disable flair.
+        # @param position [Symbol] Flair position [left, right].
+        # @param self_assign_enabled [Boolean] Allow/disallow users to set their
+        #   own flair.
+        # @param link_flair_position [Symbol] Link flair position ['', left,
+        #   right].
+        # @param self_link_flair_assign [Boolean] Allow/disallow users to set
+        #   their own link flair.
+        def flair_config(enabled, position, self_assign_enabled,
+                         link_flair_position, self_link_flair_assign)
+          params = {}
+          params[:api_type] = 'json'
+          params[:flair_enabled] = enabled
+          params[:flair_position] = position
+          params[:flair_self_assign_enabled] = self_assign_enabled
+          params[:link_flair_position] = link_flair_position
+          params[:link_flair_self_assign_enabled] = self_link_flair_assign
+          path = "/r/#{display_name}/api/flairconfig"
+          @client.request_data(path, :post, params)
+        end
+
+        # 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".
+        # @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.
+        def set_many_flairs(flair_data)
+          params = { flair_csv: flair_data }
+          path = "/r/#{display_name}/api/flaircsv"
+          @client.request_data(path, :post, params)
+        end
+
+        # Fetches a list of flairs.
+        # @!method flairlist(params = { limit: 25 })
+        # @param params [Hash] The parameters.
+        # @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 list.
+        # @option params :limit [1..1000] The number of items to fetch.
+        # @option params :name [String] The username of the user whose flair you
+        #   want.
+        # @option params :show [String] Literally the string 'all'.
+        # @return [Hash<Array<Hash>>] Returns a list of the flairs.
+        def flairlist(params = { limit: 25 })
+          path = "/r/#{display_name}/api/flairlist"
+          @client.request_data(path, :get, params)
+        end
+
+        # Gets information about a user's flair options.
+        # @!method flair(thing)
+        # @param thing [NeonRAW::Objects::Submission/User/Me] The thing to get the
+        #   flairs of.
+        # @return [Hash] Returns the flair data for the thing.
+        def flair(thing)
+          params = {}
+          if thing.is_a?(Objects::User) || thing.is_a?(Objects::Me)
+            params[:name] = thing.name
+          elsif thing.is_a?(Objects::Submission)
+            params[:link] = thing.name
+          end
+          path = "/r/#{display_name}/api/flairselector"
+          @client.request_data(path, :post, params)
+        end
+
+        # Creates a flair template.
+        # @!method flair_template(type, text, css_class, editable, template_id)
+        # @param type [String] The template type [user, link].
+        # @param text [String] The flair text (64 characters maximum).
+        # @param css_class [String] The flair's CSS class.
+        # @param editable [Boolean] Whether or not the user can edit the flair
+        #   text.
+        def flair_template(type, text, css_class, editable)
+          flairs = { 'user' => 'USER_FLAIR', 'link' => 'LINK_FLAIR' }
+          params = { api_type: 'json', css_class: css_class,
+                     flair_type: flairs[type], text: text,
+                     text_editable: editable }
+          path = "/r/#{display_name}/api/flairtemplate"
+          @client.request_data(path, :post, params)
+        end
+
+        # Select a flair.
+        # @!method select_flair(thing, text, template_id)
+        # @param thing [NeonRAW::Objects::Submission/User/Me] The thing whose flair
+        #   will be selected.
+        # @param text [String] The flair text (64 characters maximum).
+        # @param template_id [String] The flair template ID.
+        def select_flair(thing, text, template_id)
+          params = { api_type: 'json', text: text,
+                     flair_template_id: template_id }
+          params[:api_type] = 'json'
+          if thing.is_a?(Objects::User) || thing.is_a?(Objects::Me)
+            params[:name] = thing.name
+          elsif thing.is_a?(Objects::Submission)
+            params[:link] = thing.name
+          end
+          path = "/r/#{display_name}/api/selectflair"
+          @client.request_data(path, :post, params)
+        end
+
+        # Let's you enable/disable the setting of flair.
+        # @!method enable_set_flair(can_set_flair)
+        # @param can_set_flair [Boolean] Whether or not you can set flair.
+        def enable_set_flair(can_set_flair)
+          params = { api_type: 'json', flair_enabled: can_set_flair }
+          path = "/r/#{display_name}/api/setflairenabled"
+          @client.request_data(path, :post, params)
+        end
+      end
+    end
+  end
+end