NeonRAW 0.1.1

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

@@ -0,0 +1,98 @@
+module NeonRAW
+  module Objects
+    class Thing
+      # Methods for moderators.
+      # @!attribute [r] mod_reports
+      #   @return [Array<String>, nil] Returns the mod reports or nil if there
+      #     are none.
+      # @!attribute [r] user_reports
+      #   @return [Array<String>, nil] Returns the user reports or nil if there
+      #     are none.
+      module Moderateable
+        # Approve a comment or submission.
+        # @!method approve!
+        def approve!
+          params = { id: name }
+          @client.request_data('/api/approve', :post, params)
+          refresh!
+        end
+
+        # Checks whether or not the thing was distinguished by a privileged
+        # user.
+        # @!method distinguished?
+        # @return [Boolean] Returns whether or not the comment was
+        #   distinguished.
+        def distinguished?
+          if @distinguished.nil?
+            false
+          else
+            true
+          end
+        end
+
+        # Distinguish a submission/comment.
+        # @!method distinguish(type)
+        # @param type [String] The type of distinguish you want to do [yes, no,
+        #   admin, special].
+        # @!group Moderators
+        def distinguish(type)
+          params = { api_type: 'json', how: type, id: name }
+          @client.request_data('/api/distinguish', :post, params)
+          refresh!
+        end
+
+        # Checks who distinguished the thing.
+        # @!method distinguished_by
+        # @return [String, nil] Returns who distinguished the comment or nil if
+        #   the comment isn't distinguished [moderator, admin, special].
+        def distinguished_by
+          @distinguished
+        end
+
+        # Checks whether or not the thing is stickied.
+        # @!method stickied?
+        # @return [Boolean] Returns whether or not the thing is stickied.
+        def stickied?
+          @stickied
+        end
+
+        # Report a thing to the subreddit's moderators or admins if the thing
+        # is a private message.
+        # @!method report(reason)
+        # @param reason [String] The reason for the report (100 characters
+        #   maximum).
+        def report(reason)
+          params = { api_type: 'json', reason: reason, thing_id: name }
+          @client.request_data('/api/report', :post, params)
+        end
+
+        # Set whether to ignore reports on the thing or not.
+        # @!method ignore_reports!
+        # @!method unignore_reports!
+        %w(ignore unignore).each do |type|
+          define_method :"#{type}_reports!" do
+            params = { id: name }
+            @client.request_data("/api/#{type}_reports", :post, params)
+            refresh!
+          end
+        end
+
+        # Remove a comment/link/modmail message.
+        # @!method remove!
+        def remove!
+          params = { id: name, spam: false }
+          @client.request_data('/api/remove', :post, params)
+          refresh!
+        end
+
+        # Spamfilter a comment/link/modmail message.
+        # @!method spam!
+        def spam!
+          params = { id: name, spam: true }
+          @client.request_data('/api/remove', :post, params)
+          refresh!
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module NeonRAW
+  module Objects
+    class Thing
+      # Methods for things that can be refreshed.
+      module Refreshable
+        # Refreshes the data of a comment/submission/subreddit object.
+        # @!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[:data][:children][0][:data].each do |key, value|
+            value = nil if ['', [], {}].include?(value)
+            instance_variable_set(:"@#{key}", value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module NeonRAW
+  module Objects
+    class Thing
+      # Methods for things that can be replied to.
+      module Repliable
+        # Leaves a comment/PM reply to the thing.
+        # @!method reply(text)
+        # @param text [String] The text body of the comment.
+        # @return [NeonRAW::Objects::Comment/PrivateMessage] Returns the object.
+        def reply(text)
+          params = { api_type: 'json', text: text, thing_id: name }
+          data = @client.request_data('/api/comment', :post, params)
+          object_data = data[:json][:data][:things][0][:data]
+          if data[:kind] == 't1'
+            Comment.new(@client, object_data)
+          elsif data[:kind] == 't4'
+            PrivateMessage.new(@client, object_data)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module NeonRAW
+  module Objects
+    class Thing
+      # Methods for things that can be saved.
+      module Saveable
+        # Saves the thing.
+        # @!method save(opts = {})
+        # @param opts [Hash] Stores optional parameters.
+        # @option opts :category [String] The category you want to save to
+        #   (Reddit Gold Feature).
+        def save(opts = {})
+          params = { id: name }
+          params[:category] = opts[:category] if opts[:category]
+          @client.request_data('/api/save', :post, params)
+        end
+
+        # Unsaves the thing.
+        # @!method unsave
+        def unsave
+          params = { id: name }
+          @client.request_data('/api/unsave', :post, params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module NeonRAW
+  module Objects
+    class Thing
+      # Methods for objects that you can cast votes on.
+      # @!attribute [r] ups
+      #   @return [Integer] Returns the number of upvotes the thing has.
+      # @!attribute [r] downs
+      #   @return [Integer] Returns the number of downvotes the thing has.
+      module Votable
+        # Checks whether you voted on the thing.
+        # @!method voted?
+        # @return [Boolean] Returns whether or not you voted on the thing.
+        def voted?
+          if @likes.nil?
+            false
+          else
+            true
+          end
+        end
+
+        # Checks whether or not you upvoted the thing.
+        # @!method upvoted?
+        # @return [Boolean] Returns whether or not you upvoted the thing.
+        def upvoted?
+          if @likes == true
+            true
+          else
+            false
+          end
+        end
+
+        # Checks whether or not you downvoted the thing.
+        # @!method downvoted?
+        # @return [Boolean] Returns whether or not you downvoted the thing.
+        def downvoted?
+          if @likes == false
+            true
+          else
+            false
+          end
+        end
+
+        # Contains the values for each type of vote.
+        # @!method votes
+        # @return [Hash] Returns a hash containing the vote values.
+        def votes
+          {
+            upvote: 1,
+            clear_vote: 0,
+            downvote: -1
+          }
+        end
+
+        # Cast a vote on an object.
+        # @!method upvote
+        # @!method clear_vote
+        # @!method downvote
+        %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)
+            refresh!
+          end
+        end
+        private :votes
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/thing.rb

@@ -0,0 +1,24 @@
+require_relative 'thing/votable'
+require_relative 'thing/editable'
+require_relative 'thing/moderateable'
+require_relative 'thing/gildable'
+require_relative 'thing/createable'
+require_relative 'thing/saveable'
+require_relative 'thing/refreshable'
+require_relative 'thing/inboxable'
+require_relative 'thing/repliable'
+
+module NeonRAW
+  module Objects
+    # Exists to hold methods that work in all objects.
+    # @!attribute [r] id
+    #   @return [String] The id of the thing.
+    # @!attribute [r] name
+    #   @return [String] The fullname of the thing.
+    class Thing
+      class << self
+        public :define_method
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/trophy.rb

@@ -0,0 +1,25 @@
+require_relative 'thing'
+
+module NeonRAW
+  module Objects
+    # The trophy object.
+    # @!attribute [r] icon_70
+    #   @return [String] Returns a link to the icon file.
+    # @!attribute [r] description
+    #   @return [String, nil] Returns the description or nil if there is none.
+    # @!attribute [r] url
+    #   @return [String, nil] Returns the URL or nil if there is none.
+    # @!attribute [r] icon_40
+    #   @return [String] Returns a link to the icon file.
+    # @!attribute [r] award_id
+    #   @return [String] Returns the award ID.
+    class Trophy < Thing
+      def initialize(data)
+        data.each do |key, value|
+          instance_variable_set(:"@#{key}", value)
+          self.class.send(:attr_reader, key)
+        end
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/user.rb

@@ -0,0 +1,147 @@
+require_relative 'thing'
+require_relative 'trophy'
+
+module NeonRAW
+  module Objects
+    # The user object.
+    # @!attribute [r] friend?
+    #   @return [Boolean] Returns whether or not the user is a friend.
+    # @!attribute [r] gold?
+    #   @return [Boolean] Returns whether or not the user has gold.
+    # @!attribute [r] moderator?
+    #   @return [Boolean] Returns whether or not the user is a
+    #     moderator.
+    # @!attribute [r] verified_email?
+    #   @return [Boolean] Returns whether or not the user has a
+    #     verified email.
+    # @!attribute [r] hide_from_robots?
+    #   @return [Boolean] Returns whether or not the user doesn't
+    #     want web crawlers indexing their profile page.
+    # @!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.
+    class User < Thing
+      include Thing::Createable
+      include Thing::Refreshable
+
+      # @!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 :friend?, :is_friend
+          alias_method :gold?, :is_gold
+          alias_method :moderator?, :is_mod
+          alias_method :verified_email?, :has_verified_email
+          alias_method :hide_from_robots?, :hide_from_robots
+        end
+      end
+
+      # @!group Listings
+      # Fetches a listing from a user.
+      # @!method overview(params = { limit: 25 })
+      # @!method comments(params = { limit: 25 })
+      # @!method submitted(params = { limit: 25 })
+      # @!method gilded(params = { limit: 25 })
+      # @!method upvoted(params = { limit: 25 })
+      # @!method downvoted(params = { limit: 25 })
+      # @!method hidden(params = { limit: 25 })
+      # @!method saved(params = { limit: 25 })
+      # @param params [Hash] The parameters for the request.
+      # @option params :show [String] Show a listing type [overview, comments,
+      #   submitted, gilded, upvoted, downvoted, hidden, saved]
+      # @option params :sort [String] The sorting algorithm [hot, new, top,
+      #   controversial]
+      # @option params :t [String] The time for the relevance sort [hour, day,
+      #   week, month, year, all]
+      # @option params :username [String] The username of an existing user.
+      # @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 listing items to fetch.
+      # @return [NeonRAW::Objects::Listing] Returns the listing object.
+      %w(overview comments submitted gilded upvoted downvoted
+         hidden saved).each do |type|
+        define_method :"#{type}" do |params = { limit: 25 }|
+          path = "/user/#{name}/#{type}/.json"
+          @client.send(:build_listing, path, params)
+        end
+      end
+      # @!endgroup
+
+      # Give gold to a user.
+      # @!method give_gold(months)
+      # @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)
+        refresh!
+      end
+
+      # Send a PM to a user.
+      # @!method message(subject, text, opts = {})
+      # @param subject [String] The subject of the message (100 characters
+      #   maximum).
+      # @param text [String] The text body of the message.
+      # @param opts [Hash] Optional parameters.
+      # @option opts :from_subreddit [String] The subreddit to send the message
+      #   from.
+      def message(subject, text, opts = {})
+        params = { api_type: 'json', from_sr: opts[:from_subreddit], text: text,
+                   subject: subject, to: name }
+        @client.request_data('/api/compose', :post, params)
+      end
+
+      # Fetches the user's 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/user/#{name}", :get, params)
+        data.each do |multireddit|
+          data_arr << MultiReddit.new(@client, multireddit[:data])
+        end
+        data_arr
+      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)
+      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)
+      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"
+        data = @client.request_data(path, :get)[:data]
+        data[:trophies].each do |trophy|
+          data_arr << Trophy.new(trophy[:data])
+        end
+        data_arr
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/wikipage.rb

@@ -0,0 +1,176 @@
+require_relative 'wikipagerevision'
+require_relative 'listing'
+
+module NeonRAW
+  module Objects
+    # The wikipage object.
+    # @!attribute [r] revisable?
+    #   @return [Boolean] Returns whether or not you can revise the wiki page.
+    # @!attribute [r] content_html
+    #   @return [String, nil] Returns the content of the wiki page with HTML or
+    #     nil if there is none.
+    # @!attribute [r] content
+    #   @return [String, nil] Returns the content of the wiki page or nil if
+    #     there is none.
+    # @!attribute [r] name
+    #   @return [String] Returns the name of the wiki page.
+    # @!attribute [r] subreddit
+    #   @return [String] Returns the subreddit of the wiki page.
+    class WikiPage
+      class << self
+        public :define_method
+      end
+
+      # @!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 == :revision_date || key == :revision_by
+          self.class.send(:attr_reader, key)
+        end
+        class << self
+          alias_method :revisable?, :may_revise
+          alias_method :content, :content_md
+        end
+      end
+
+      # The user who made the last revision to the wiki page.
+      # @!method revised_by
+      # @return [String] Returns the username of the user.
+      def revised_by
+        @revision_by[:data][:name]
+      end
+
+      # The date of the last revision to the wiki page.
+      # @!method revision_date
+      # @return [Time] Returns the date.
+      def revision_date
+        Time.at(@revision_date)
+      end
+
+      # @!group Listings
+      # Gets the revisions made to the wiki page.
+      # @!method revisions(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 the list of revisions.
+      def revisions(params = { limit: 25 })
+        data_arr = []
+        path = "/r/#{subreddit}/wiki/revisions/#{name}"
+        until data_arr.length == params[:limit]
+          data = @client.request_data(path, :get, params)
+          params[:after] = data[:data][:after]
+          params[:before] = data[:data][:before]
+          data[:data][:children].each do |item|
+            item[:subreddit] = subreddit
+            data_arr << WikiPageRevision.new(@client, item)
+            break if data_arr.length == params[:limit]
+          end
+          break if params[:after].nil?
+        end
+        listing = Objects::Listing.new(params[:after], params[:before])
+        data_arr.each { |revision| listing << revision }
+        listing
+      end
+
+      # Fetches submissions about the wiki page.
+      # @!method discussions(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 the
+      #   submissions.
+      def discussions(params = { limit: 25 })
+        params[:page] = name
+        path = "/r/#{subreddit}/wiki/discussions/#{name}"
+        @client.send(:build_listing, path, params)
+      end
+      # @!endgroup
+
+      # Change the wiki contributors.
+      # @!method add_editor(username)
+      # @!method remove_editor(username)
+      # @param username [String] The username of the user.
+      %w(add remove).each do |type|
+        define_method :"#{type}_editor" do |username|
+          params = { page: name, username: username }
+          type = 'del' if type == 'remove'
+          params[:act] = type
+          path = "/r/#{subreddit}/api/wiki/alloweditor/#{type}"
+          @client.request_data(path, :post, params)
+        end
+      end
+
+      # Edit the wiki page.
+      # @!method edit!(text, opts = {})
+      # @param text [String] The content for the page.
+      # @param opts [Hash] Optional parameters.
+      # @option opts :reason [String] The reason for the edit (256 characters
+      #   maximum).
+      def edit!(text, opts = {})
+        params = { reason: opts[:reason], content: text, page: name }
+        path = "/r/#{subreddit}/api/wiki/edit"
+        @client.request_data(path, :post, params)
+        data = @client.request_data("/r/#{subreddit}/wiki/#{name}", :get)
+        data[:data].each do |key, value|
+          value = nil if ['', [], {}].include?(value)
+          instance_variable_set(:"@#{key}", value)
+        end
+      end
+
+      # Reverts the wiki page to this revision.
+      # @!method revert!(revision)
+      # @param revision [NeonRAW::Objects::WikiPageRevision] The revision you
+      #   want to revert back to.
+      def revert!(revision)
+        params = { page: name, revision: revision.id }
+        path = "/r/#{subreddit}/api/wiki/revert"
+        @client.request_data(path, :post, params)
+        path = "/r/#{subreddit}/wiki/#{name}"
+        data = @client.request_data(path, :get, page: name)
+        data[:data].each do |key, value|
+          instance_variable_set(:"@#{key}", value)
+        end
+      end
+
+      # Fetches the settings for the wiki.
+      # @!method settings
+      # @return [Hash<Integer, Array<String>, Boolean>] Returns the wiki
+      #   page's settings.
+      def settings
+        path = "/r/#{subreddit}/wiki/settings/#{name}"
+        @client.request_data(path, :get, page: name)[:data]
+      end
+
+      # Edits the settings of the wiki.
+      # @!method edit_settings(data)
+      # @param data [Hash] The parameters.
+      # @option data :listed [Boolean] Whether or not the wiki page will be
+      #   listed on the list of wiki pages.
+      # @option data :permlevel [String] Set the permission level needed to
+      #   edit the wiki [use_subreddit_settings, approved_only, mods_only].
+      def edit_settings(data)
+        permlevel = { 'use_subreddit_settings' => 0, 'approved_only' => 1,
+                      'mods_only' => 2 }
+        params = { page: name, permlevel: permlevel[data[:permlevel]],
+                   listed: data[:listed] }
+        params[:page] = name
+        path = "/r/#{subreddit}/wiki/settings/#{name}"
+        @client.request_data(path, :post, params)[:data]
+      end
+    end
+  end
+end

data/lib/NeonRAW/objects/wikipagerevision.rb

@@ -0,0 +1,45 @@
+module NeonRAW
+  module Objects
+    # The wiki page revision object.
+    # @!attribute [r] reason
+    #   @return [String, nil] Returns the reason for the revision.
+    # @!attribute [r] page
+    #   @return [String] Returns the name of the wiki page.
+    # @!attribute [r] id
+    #   @return [String] Returns the ID of the revision.
+    class WikiPageRevision
+      # @!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 == :timestamp || key == :author
+          self.class.send(:attr_reader, key)
+        end
+      end
+
+      # @!attribute [r] author
+      #   @return [String] Returns the user who made the revision.
+      def author
+        @author[:data][:name]
+      end
+
+      # The time and date when the revision was created.
+      # @!method created
+      # @return [Time] Returns when the revision was made.
+      def created
+        Time.at(@timestamp)
+      end
+
+      # The time and date when the revision was created in UTC.
+      # @!method created_utc
+      # @return [Time] Returns when the revision was made in UTC.
+      def created_utc
+        Time.at(@timestamp).utc
+      end
+    end
+  end
+end

data/lib/NeonRAW/version.rb

@@ -0,0 +1,3 @@
+module NeonRAW
+  VERSION = '0.1.1'.freeze
+end