NeonRAW 0.1.1

data/lib/NeonRAW/objects/all.rb

@@ -0,0 +1,36 @@
+module NeonRAW
+  module Objects
+    # The object for /r/all.
+    class All
+      def initialize(client)
+        @client = client
+      end
+
+      # @!group Listings
+      # Fetches a listing from /r/all.
+      # @!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/all/#{type}/.json"
+          @client.send(:build_listing, path, params)
+        end
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/comment.rb

@@ -0,0 +1,128 @@
+require_relative 'thing'
+
+module NeonRAW
+  module Objects
+    # The comment object.
+    # @!attribute [r] approved_by
+    #   @return [String, nil] Returns which mod approved the comment or nil if
+    #     none did or you aren't a moderator of that subreddit.
+    # @!attribute [r] archived?
+    #   @return [Boolean] Returns whether or not the comment is archived.
+    # @!attribute [r] author
+    #   @return [String] Returns the author of the comment.
+    # @!attribute [r] author_flair_css_class
+    #   @return [String, nil] Returns the author's flair CSS class or nil if
+    #     there is none.
+    # @!attribute [r] author_flair_text
+    #   @return [String, nil] Returns the author's flair text or nil if there
+    #     is none.
+    # @!attribute [r] removed_by
+    #   @return [String, nil] Returns which mod removed the comment or nil if
+    #     none did or you aren't a moderator of that subreddit.
+    # @!attribute [r] body
+    #   @return [String, nil] Returns the text body of the comment or nil if
+    #     there isn't one.
+    # @!attribute [r] body_html
+    #   @return [String, nil] Returns the text body of the comment with HTML or
+    #     nil if there isn't one.
+    # @!attribute [r] gold_count
+    #   @return [Integer] Returns the amount of gold a comment has been given.
+    # @!attribute [r] link_author
+    #   @return [String] Returns the author of the submission link that the
+    #     comment was made in response to.
+    #   @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_title
+    #   @return [String] Returns the title of the parent link.
+    #   @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_url
+    #   @return [String] Returns the URL of the parent link.
+    #   @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] 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
+    #     this comment is a reply to.
+    # @!attribute [r] saved?
+    #   @return [Boolean] Returns whether or not you saved the comment.
+    # @!attribute [r] score
+    #   @return [Integer] Returns the karma score of the comment.
+    # @!attribute [r] score_hidden?
+    #   @return [Boolean] Returns whether or not the karma score of the comment
+    #     is hidden.
+    # @!attribute [r] subreddit
+    #   @return [String] Returns the subreddit the comment was posted to.
+    # @!attribute [r] subreddit_id
+    #   @return [String] Returns the ID of the subreddit where the comment was
+    #     posted to.
+    class Comment < Thing
+      include Thing::Createable
+      include Thing::Editable
+      include Thing::Gildable
+      include Thing::Inboxable
+      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 comment 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 || key == :replies
+          self.class.send(:attr_reader, key)
+        end
+        class << self
+          alias_method :removed_by, :banned_by
+          alias_method :gold_count, :gilded
+          alias_method :saved?, :saved
+          alias_method :score_hidden?, :score_hidden
+          alias_method :archived?, :archived
+        end
+      end
+
+      # Checks whether or not the comment has replies to it.
+      # @!method replies?
+      # @return [Boolean] Returns whether or not the comment has replies to it.
+      def replies?
+        if @replies.nil?
+          false
+        else
+          true
+        end
+      end
+
+      # Gets the replies made to the comment.
+      # @!method replies
+      # @return [Array<NeonRAW::Objects::Comment,
+      #   NeonRAW::Objects::MoreComments>, nil] Returns either a list of the
+      #   Comments/MoreComments or nil if there were no replies.
+      def replies
+        return nil if @replies.nil?
+        comments = []
+        @replies[:data][:children].each do |reply|
+          if reply[:kind] == 't1'
+            comments << Comment.new(@client, reply[:data])
+          elsif reply[:kind] == 'more'
+            comments << MoreComments.new(@client, reply[:data])
+          end
+        end
+        comments
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/inboxcomment.rb

@@ -0,0 +1,54 @@
+require_relative 'thing'
+
+module NeonRAW
+  module Objects
+    # The inboxed comment object.
+    # @!attribute [r] body
+    #   @return [String, nil] Returns the text body of the comment or nil if
+    #     there is none.
+    # @!attribute [r] link_title
+    #   @return [String] Returns the title of the submission where the comment
+    #     was posted.
+    # @!attribute [r] dest
+    #   @return [String] Returns whom the InboxComment was sent to.
+    # @!attribute [r] author
+    #   @return [String] Returns the author of the comment.
+    # @!attribute [r] body_html
+    #   @return [String, nil] Returns the text body of the comment with HTML or
+    #     nil if there is none.
+    # @!attribute [r] subreddit
+    #   @return [String] Returns the subreddit where the comment was posted.
+    # @!attribute [r] parent_id
+    #   @return [String] Returns the fullname of the comment's parent object.
+    # @!attribute [r] context
+    #   @return [String] Returns a link to the comment with context provided.
+    # @!attribute [r] new?
+    #   @return [Boolean] Returns whether the comment is new or not.
+    # @!attribute [r] subject
+    #   @return [String] Returns the subject of the comment (post/comment
+    #     reply).
+    class InboxComment < Thing
+      include Thing::Createable
+      include Thing::Inboxable
+      include Thing::Moderateable
+      include Thing::Repliable
+      include Thing::Votable
+
+      # @!method initialize(client, data)
+      # @param client [NeonRAW::Clients::Web/Installed/Script] The client.
+      # @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 :new?, :new
+        end
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/listing.rb

@@ -0,0 +1,12 @@
+module NeonRAW
+  module Objects
+    # The listing object.
+    class Listing < Array
+      attr_reader :after, :before
+      def initialize(after, before)
+        @after = after
+        @before = before
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/me.rb

@@ -0,0 +1,268 @@
+require_relative 'user'
+require_relative 'trophy'
+require_relative 'multireddit'
+# rubocop:disable Metrics/AbcSize, Metrics/ClassLength
+# rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+module NeonRAW
+  # Objects module.
+  module Objects
+    # The me object.
+    # @!attribute [r] employee?
+    #   @return [Boolean] Returns whether or not you're a Reddit
+    #     employee.
+    # @!attribute [r] mail?
+    #   @return [Boolean] Returns whether or not you've got mail.
+    # @!attribute [r] suspended?
+    #   @return [Boolean] Returns whether or not your account is
+    #     suspended.
+    # @!attribute [r] modmail?
+    #   @return [Boolean] Returns whether or not you've got modmail.
+    # @!attribute [r] beta?
+    #   @return [Boolean] Returns whether or not you're opted into
+    #     beta testing.
+    # @!attribute [r] over_18?
+    #   @return [Boolean] Returns whether or not you can view adult
+    #     content.
+    # @!attribute [r] inbox_count
+    #   @return [Integer] Returns the number of unread messages
+    #     in your inbox.
+    class Me < User
+      # @!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 :employee?, :is_employee
+          alias_method :mail?, :has_mail
+          alias_method :hide_from_robots?, :hide_from_robots
+          alias_method :suspended?, :is_suspended
+          alias_method :modmail?, :has_mod_mail
+          alias_method :beta?, :in_beta
+          alias_method :over_18?, :over_18
+          alias_method :gold?, :is_gold
+          alias_method :moderator?, :is_mod
+          alias_method :verified_email?, :has_verified_email
+        end
+      end
+
+      # @!group Listings
+      # Fetches your private messages.
+      # @!method messages(params = { limit: 25 })
+      # @!method inbox(params = { limit: 25 })
+      # @!method unread(params = { limit: 25 })
+      # @!method sent(params = { limit: 25 })
+      # @param params [Hash] Optional parameters.
+      # @option params :mark [Boolean] Whether or not to remove the orangered
+      #   from your inbox.
+      # @option params :after [String] Fullname of the next data block.
+      # @option params :before [String] Fullname 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 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|
+        define_method :"#{type}" do |params = { limit: 25 }|
+          @client.send(:build_listing, "/message/#{type}", params)
+        end
+      end
+
+      # Fetches your modmail.
+      # @!method modmail(params = { limit: 25 })
+      # @param params [Hash] The parameters.
+      # @option params :after [String] Fullname of the next data block.
+      # @option params :before [String] Fullname 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 listing items to fetch.
+      # @option params :show [String] Literally the string 'all'.
+      # @return [NeonRAW::Objects::Listing] Returns a listing with all your
+      #   modmails.
+      def modmail(params = { limit: 25 })
+        @client.send(:build_listing, '/message/moderator.json', params)
+      end
+
+      # Fetches your subreddits.
+      # @!method subscribed(params = { limit: 25 })
+      # @!method contributed(params = { limit: 25 })
+      # @!method moderated(params = { limit: 25 })
+      # @param params [Hash] The parameters.
+      # @option params :after [String] Fullname of the next data block.
+      # @option params :before [String] Fullname 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 listing items to fetch.
+      # @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|
+        define_method :"#{type}" do |params = { limit: 25 }|
+          type = 'subscriber' if type == 'subscribed'
+          type = 'contributor' if type == 'contributed'
+          type = 'moderator' if type == 'moderated'
+          @client.send(:build_listing, "/subreddits/mine/#{type}", params)
+        end
+      end
+      # @!endgroup
+
+      # Fetches your karma breakdown.
+      # @!method karma_breakdown
+      # @return [Array<Hash<String, Integer, Integer>>] Returns a list with your
+      #   karma distribution in it.
+      def karma_breakdown
+        @client.request_data('/api/v1/me/karma', :get)[:data]
+      end
+
+      # Fetches your preferences.
+      # @!method prefs
+      # @return [Hash] Returns your account preferences.
+      def prefs
+        @client.request_data('/api/v1/me/prefs', :get)
+      end
+
+      # Edits your preferences.
+      # @!method edit_prefs(data)
+      # @param data [JSON] Your preferences data. Read Reddit's API docs for
+      #   how to format the data.
+      # @see https://www.reddit.com/dev/api#PATCH_api_v1_me_prefs
+      # @todo Figure out why this is raising BadRequest exceptions when I try
+      #   to use it.
+      def edit_prefs(data)
+        @client.request_data('/api/v1/me/prefs', :patch, {}, content: data)
+      end
+
+      # Fetches your trophies.
+      # @!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
+      end
+
+      # Fetches your friends.
+      # @!method friends(params = { limit: 25 })
+      # @param params [Hash] The parameters for the request.
+      # @option params :after [String] The fullname of a thing.
+      # @option params :before [String] The fullname of a thing.
+      # @option params :count [Integer] The number of items fetch already.
+      # @option params :limit [1..100] The number of items to fetch.
+      # @option params :show [String] Literally the string 'all'.
+      # @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
+      end
+
+      # Fetches your blocked users.
+      # @!method blocked(params = { limit: 25 })
+      # @param params [Hash] The parameters for the request.
+      # @option params :after [String] The fullname of a thing.
+      # @option params :before [String] The fullname of a thing.
+      # @option params :count [Integer] The number of items fetch already.
+      # @option params :limit [1..100] The number of items to fetch.
+      # @option params :show [String] Literally the string 'all'.
+      # @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
+      end
+
+      # Mark all your messages as "read."
+      # @!method read_all_messages!
+      def read_all_messages!
+        @client.request_nonjson('/api/read_all_messages', :post)
+      end
+
+      # Fetches your multireddits.
+      # @!method multireddits
+      # @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
+      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
+      #   [overview, submitted, comments, upvoted, downvoted, hidden, saved,
+      #   giled]
+      # @param params [Hash] The additional parameters.
+      # @option params :edit [String] The text to edit your posts with.
+      # @option params :blacklist [Array<String>] Subreddits to avoid purging
+      #   from.
+      # @option params :whitelist [Array<String>] Subreddits to purge.
+      # @option params :sort [String] The sort of the data (defaults to new)
+      #   [new, hot, top, controversial].
+      # @option params :hours [Integer] The number of hours to go back from.
+      # @option params :days [Integer] The number of days to go back from.
+      # @option params :weeks [Integer] The number of weeks to go back from.
+      # @option params :months [Integer] The number of months to go back from.
+      # @option params :years [Integer] The number of years to go back from.
+      def purge(queue, params = {})
+        params[:edit] = '.' if params[:edit].nil?
+        params[:blacklist] = [] if params[:blacklist].nil?
+        params[:whitelist] = ['*'] if params[:whitelist].nil?
+        whitelist = params[:whitelist]
+        params[:age] = max_age(params)
+        items = send(:"#{queue}", sort: params[:sort] || 'new', limit: 1000)
+        items.each do |item|
+          next if params[:blacklist].include?(item.subreddit)
+          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?
+          else
+            item.edit! params[:edit] unless item.archived?
+          end
+          item.delete!
+        end
+      end
+
+      # Fetches the max age of things to be purged.
+      # @!method max_age(params)
+      # @param params [Hash] The hours/days/weeks/months/years to go back from.
+      def max_age(params)
+        start = Time.now
+        age = start
+        age -= 3600 * params[:hours] unless params[:hours].nil?
+        age -= 86_400 * params[:days] unless params[:days].nil?
+        age -= 604_800 * params[:weeks] unless params[:weeks].nil?
+        age -= 2_419_200 * params[:months] unless params[:months].nil?
+        age -= 29_030_400 * params[:years] unless params[:years].nil?
+        age -= (604_800 * 2) if age == start # defaults to 2 weeks
+        age
+      end
+      private :max_age
+    end
+  end
+end

data/lib/NeonRAW/objects/modlogaction.rb

@@ -0,0 +1,59 @@
+require_relative 'thing'
+
+module NeonRAW
+  module Objects
+    # The modlogaction object.
+    # @!attribute [r] description
+    #   @return [String, nil] Returns the description or nil if there is none.
+    # @!attribute [r] target_body
+    #   @return [String, nil] Returns the text body of the target object or nil
+    #     if there is none.
+    # @!attribute [r] mod_id36
+    #   @return [String] Returns the ID of the mod who did the action.
+    # @!attribute [r] subreddit
+    #   @return [String] Returns the subreddit where the action occured.
+    # @!attribute [r] target_title
+    #   @return [String, nil] Returns the title of the target object or nil if
+    #     there is none.
+    # @!attribute [r] target_permalink
+    #   @return [String, nil] Returns the permalink of the target object or nil
+    #     if there is none.
+    # @!attribute [r] details
+    #   @return [String] Returns the details of the action.
+    # @!attribute [r] action
+    #   @return [String] Returns the type of action.
+    # @!attribute [r] target_author
+    #   @return [String, nil] Returns the author of the target object or nil if
+    #     there is none.
+    # @!attribute [r] target_fullname
+    #   @return [String, nil] Returns the fullname of the target object or nil
+    #     if there is none.
+    # @!attribute [r] sr_id36
+    #   @return [String] Returns the ID of the subreddit where the action
+    #     occured.
+    # @!attribute [r] mod
+    #   @return [String] Returns the mod who did the action.
+    # @!attribute [r] id
+    #   @return [String] Returns the ID of the modlog action.
+    class ModLogAction
+      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_utc
+          self.class.send(:attr_reader, key)
+        end
+      end
+
+      # Gets when the mod log action was done.
+      # @!method created
+      # @return [Time] Returns the date/time when the mod log action was done.
+      def created
+        Time.at(@created_utc).localtime
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/modloguser.rb

@@ -0,0 +1,35 @@
+require_relative 'thing'
+
+module NeonRAW
+  module Objects
+    # The modloguser object.
+    # @!attribute [r] note
+    #   @return [String, nil] Returns the reason for the banning or nil if there
+    #     is none. This attribute is only available for the banned and
+    #     wikibanned methods.
+    # @!attribute [r] mod_permissions
+    #   @return [Array<String>] Returns the mod permissions for the user. This
+    #     attribute is only available for the moderators method.
+    class ModLogUser < Thing
+      # @!method initialize(client, data)
+      # @param client [NeonRAW::Clients::Web/Installed/Script] The client.
+      # @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 == :date
+          self.class.send(:attr_reader, key)
+        end
+      end
+
+      # Gets the date of when the user was added to the list.
+      # @!method date
+      # @return [Time] Returns when the user was added to the list.
+      def date
+        Time.at(@date)
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/morecomments.rb

@@ -0,0 +1,33 @@
+require_relative 'comment'
+
+module NeonRAW
+  module Objects
+    # The MoreComments object.
+    class MoreComments
+      def initialize(client, data)
+        @client = client
+        data.each do |key, value|
+          value = nil if ['', [], {}].include?(value)
+          instance_variable_set(:"@#{key}", value)
+          self.class.send(:attr_reader, key)
+        end
+      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 = []
+        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
+      end
+    end
+  end
+end