NeonRAW 0.1.1

data/examples/flairbot.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+require 'NeonRAW'
+
+# Creates and authenticates the client.
+# @!method login(config)
+# @param config [Hash] The data loaded from settings.yaml.
+# @return [NeonRAW::Clients::Script] Returns the client.
+def login(config)
+  reddit_exception_handling do
+    client = NeonRAW.script(config['username'], config['password'],
+                            config['client_id'], config['secret'],
+                            user_agent: 'Flairbot by /u/SirNeon')
+    return client
+  end
+end
+
+# Flairs submissions based on keywords in their title.
+# @!method flair_shit(client, subreddit)
+# @param client [NeonRAW::Clients::Script] The client.
+# @param subreddit [String] The subreddit to scan.
+def flair_shit(client, subreddit)
+  reddit_exception_handling do
+    subreddit = client.subreddit subreddit
+    submissions = subreddit.new limit: 100
+    submissions.each do |submission|
+      next if submission.flair?
+      case submission.title
+      when /\[meta\]/i then subreddit.set_flair submission, 'Meta',
+                                                css_class: 'meta'
+      when /test/i then subreddit.set_flair submission, 'Test'
+      end
+    end
+    break
+  end
+end
+
+# Handles Reddit exceptions.
+# @!method reddit_exception_handling
+# @param block [&block] The block to execute.
+def reddit_exception_handling
+  include NeonRAW::Errors
+  loop do
+    begin
+      yield
+    rescue InvalidCredentials, InvalidOAuth2Credentials => error
+      abort(error.message)
+    rescue CouldntReachServer, ServiceUnavailable
+      sleep(5)
+      redo
+    end
+  end
+end
+
+def main
+  config = YAML.load_file('settings.yaml')
+  client = login(config)
+  flair_shit client, client.me.name
+end
+
+main

data/examples/publicmodlogger.rb

@@ -0,0 +1,79 @@
+require 'yaml'
+require 'NeonRAW'
+
+# Creates and authenticates the client.
+# @!method login(config)
+# @param config [Hash] The data loaded from the settings.yaml file.
+# @return [NeonRAW::Clients::Script] Returns the client.
+def login(config)
+  reddit_exception_handling do
+    client = NeonRAW.script(config['username'], config['password'],
+                            config['client_id'], config['secret'],
+                            user_agent: 'Public mod logger by /u/SirNeon')
+    return client
+  end
+end
+
+# Fetches the modlog.
+# @!method get_modlog(client, subreddit)
+# @param client [NeonRAW::Clients::Script] The client.
+# @param subreddit [String] The subreddit to fetch the modlog from.
+# @return [NeonRAW::Objects::Listing] Returns the modlog actions.
+def get_modlog(client, subreddit)
+  reddit_exception_handling do
+    subreddit = client.subreddit subreddit
+    modlog = subreddit.modlog limit: 100
+    return modlog.reverse
+  end
+end
+
+# Submits the modlog data to Reddit.
+# @!method submit_actions(client, subreddit, modlog)
+# @param client [NeonRAW::Clients::Script] The client.
+# @param subreddit [String] The subreddit to submit the data to.
+# @param modlog [NeonRAW::Objects::Listing] The modlog actions.
+def submit_actions(client, subreddit, modlog)
+  reddit_exception_handling do
+    subreddit = client.subreddit subreddit
+    modlog.each do |entry|
+      title = entry.id
+      text = "Mod: #{entry.mod}\n\n"
+      text += "Action: #{entry.action}\n\n"
+      text += "Description: #{entry.description}\n\n" if entry.description
+      text += "Created: #{entry.created}\n\n"
+      text += "Target Author: #{entry.target_author}\n\n" if entry.target_author
+      if entry.target_permalink
+        text += "Target Permalink: #{entry.target_permalink}\n\n"
+      end
+      submission = subreddit.submit title, text: text
+      subreddit.set_flair submission, entry.action
+    end
+    break
+  end
+end
+
+# Handles Reddit exceptions.
+# @!method reddit_exception_handling
+# @param block [&block] The block to be executed.
+def reddit_exception_handling
+  include NeonRAW::Errors
+  loop do
+    begin
+      yield
+    rescue InvalidCredentials, InvalidOAuth2Credentials => error
+      abort(error.message)
+    rescue CouldntReachServers, ServiceUnavailable
+      sleep(5)
+      redo
+    end
+  end
+end
+
+def main
+  config = YAML.load_file('settings.yaml')
+  client = login(config)
+  modlog = get_modlog(client, 'NeonRAW')
+  submit_actions(client, 'NeonRAW', modlog)
+end
+
+main

data/examples/settings.yaml

@@ -0,0 +1,4 @@
+username: username
+password: password
+client_id: client_id
+secret: secret

data/examples/userhistoryscraper.rb

@@ -0,0 +1,108 @@
+require 'yaml'
+require 'NeonRAW'
+
+# Creates and authenticates the client.
+# @!method login(config)
+# @param config [Hash] The data loaded from the settings.yaml file.
+# @return [NeonRAW::Clients::Script] Returns the client.
+def login(config)
+  reddit_exception_handling do
+    client = NeonRAW.script(config['username'], config['password'],
+                            config['client_id'], config['secret'],
+                            user_agent: 'User history scraper by /u/SirNeon')
+    return client
+  end
+end
+
+# Fetches the posts of the user.
+# @!method get_posts(client, user, quantity)
+# @param client [NeonRAW::Clients::Script] The client.
+# @param user [String] The username of the user.
+# @param quantity [1..1000] The number of posts to fetch.
+# @return [NeonRAW::Objects::Listing] Returns the posts.
+def get_posts(client, user, quantity)
+  reddit_exception_handling do
+    posts = client.user(user).overview limit: quantity
+    return posts
+  end
+end
+
+# Tallies the number of posts/karma per subreddit.
+# @!method tally_data(posts)
+# @param posts [NeonRAW::Objects::Listing] The posts.
+# @return [Hash<Integer, Integer>] Returns the tallied data.
+def tally_data(posts)
+  stats = {}
+  posts.each do |post|
+    subreddit = post.subreddit
+    stats[subreddit] = { posts: 0, karma: 0 } if stats[subreddit].nil?
+    stats[subreddit][:posts] += 1
+    stats[subreddit][:karma] += post.score
+  end
+  stats
+end
+
+# Sorts the data.
+# @!method sort_data(data, by)
+# @param data [Hash] The data.
+# @param by [Symbol] The thing to sort by [posts, karma].
+# @return [Hash<Integer, Integer>] Returns the sorted data.
+def sort_data(data, by)
+  # Sort the data highest amount of posts/karma to least amount.
+  data.sort_by { |_subreddit, tallies| tallies[by] }.reverse.to_h
+end
+
+# Builds a table from the sorted data.
+# @!method build_table(data)
+# @param data [Hash] The data.
+# @return [String] Returns the table.
+def build_table(data)
+  text = "|subreddit|posts|karma|\n|:---|:---:|:---:|\n"
+  data.each do |subreddit, tallies|
+    text += "|#{subreddit}|#{tallies[:posts]}|#{tallies[:karma]}|\n"
+  end
+  text
+end
+
+# Submits the results to Reddit.
+# @!method submit_results(client, subreddit, title, text)
+# @param client [NeonRAW::Objects::Script] The client.
+# @param subreddit [String] The name of the subreddit to submit to.
+# @param title [String] The title of the thread.
+# @param text [String] The table to be submitted.
+def submit_results(client, subreddit, title, text)
+  reddit_exception_handling do
+    client.subreddit(subreddit).submit title, text: text
+    break
+  end
+end
+
+# Handles Reddit exceptions.
+# @!method reddit_exception_handling
+# @param block [&block] The block to be executed.
+def reddit_exception_handling
+  include NeonRAW::Errors
+  loop do
+    begin
+      yield
+    rescue InvalidCredentials, InvalidOAuth2Credentials => error
+      abort(error.message)
+    rescue CouldntReachServer, ServiceUnavailable
+      sleep(5)
+      redo
+    end
+  end
+end
+
+def main
+  config = YAML.load_file('settings.yaml')
+  client = login(config)
+  user = client.me.name
+  posts = get_posts(client, user, 1000)
+  data = tally_data(posts)
+  sorted_data = sort_data(data, :posts)
+  text = build_table(sorted_data)
+  submit_results(client, user, "#{user}'s user history", text)
+end
+
+main

data/examples/userhistorywiper.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+require 'NeonRAW'
+
+config = YAML.load_file('settings.yaml')
+client = NeonRAW.script(config['username'], config['password'],
+                        config['client_id'], config['secret'],
+                        user_agent: 'User history wiper by /u/SirNeon')
+
+# Wiping your user history has never been so easy!
+client.me.purge 'overview', months: 1

data/lib/NeonRAW/clients/base/listing.rb

@@ -0,0 +1,55 @@
+require_relative '../../objects/listing'
+require_relative '../../objects/subreddit'
+require_relative '../../objects/comment'
+require_relative '../../objects/access'
+require_relative '../../objects/privatemessage'
+require_relative '../../objects/modlogaction'
+require_relative '../../objects/inboxcomment'
+require_relative '../../errors'
+# rubocop:disable Metrics/AbcSize
+
+module NeonRAW
+  module Clients
+    class Base
+      # Methods for building listings.
+      module Listings
+        OBJECT_KINDS = {
+          'Listing' => Objects::Listing,
+          'modaction' => Objects::ModLogAction,
+          't1' => Objects::Comment,
+          't3' => Objects::Submission,
+          't4' => Objects::PrivateMessage,
+          't5' => Objects::Subreddit
+        }.freeze
+
+        # Creates the listing object.
+        # @!method build_listing(path, params)
+        # @param path [String] The API path for the listing.
+        # @param params [Hash] The parameters for the request.
+        # @return [NeonRAW::Objects::Listing] Returns the Listing object.
+        def build_listing(path, params)
+          data_arr = []
+          until data_arr.length == params[:limit]
+            data = request_data(path, :get, params)
+            params[:after] = data[:data][:after]
+            params[:before] = data[:data][:before]
+            data[:data][:children].each do |item|
+              data_arr << if item[:kind] == 't1' &&
+                             item[:data].key?(:was_comment)
+                            Objects::InboxComment.new(self, item[:data])
+                          else
+                            OBJECT_KINDS[item[:kind]].new(self, item[:data])
+                          end
+              break if data_arr.length == params[:limit]
+            end
+            break if params[:after].nil?
+          end
+          listing = OBJECT_KINDS['Listing'].new(params[:after], params[:before])
+          data_arr.each { |submission| listing << submission }
+          listing
+        end
+        private :build_listing
+      end
+    end
+  end
+end

data/lib/NeonRAW/clients/base/objectbuilder.rb

@@ -0,0 +1,173 @@
+require_relative '../../objects/subreddit'
+require_relative '../../objects/user'
+require_relative '../../objects/me'
+require_relative '../../objects/multireddit'
+require_relative '../../objects/wikipage'
+require_relative '../../objects/all'
+
+module NeonRAW
+  module Clients
+    class Base
+      # Methods for building objects.
+      module ObjectBuilder
+        SUBREDDIT_DEFAULTS = {
+          'allow_top' => true,
+          'collapse_deleted_comments' => false,
+          'comment_score_hide_mins' => 0,
+          'exclude_banned_modqueue' => false,
+          'header-title' => '',
+          'hide_ads' => false,
+          'lang' => 'en',
+          'link_type' => 'any',
+          'over_18' => false,
+          'public_traffic' => false,
+          'show_media' => true,
+          'spam_comments' => 'low',
+          'spam_links' => 'high',
+          'spam_selfposts' => 'high',
+          'submit_text_label' => 'Submit a new text post',
+          'submit_text' => '',
+          'submit_link_label' => 'Submit a new link',
+          'suggested_comment_sort' => 'confidence',
+          'type' => 'public',
+          'wiki_edit_age' => 0,
+          'wiki_edit_karma' => 100,
+          'wikimode' => 'disabled'
+        }.freeze
+
+        # Fetches a subreddit.
+        # @!method subreddit(name)
+        # @param name [String] The name of the subreddit.
+        # @return [NeonRAW::Objects::Subreddit/All] Returns the subreddit/all
+        #   object.
+        def subreddit(name)
+          if name == 'all'
+            Objects::All.new(self)
+          else
+            data = request_data("/r/#{name}/about.json", :get)[:data]
+            Objects::Subreddit.new(self, data)
+          end
+        end
+
+        # Fetches a user.
+        # @!method user(name)
+        # @param name [String] The name of the user.
+        # @return [NeonRAW::Objects::User] Returns the user object.
+        def user(name)
+          data = request_data("/user/#{name}/about.json", :get)[:data]
+          Objects::User.new(self, data)
+        end
+
+        # Fetches yourself.
+        # @!method me
+        # @return [NeonRAW::Objects::Me] Returns the me object.
+        def me
+          data = request_data('/api/v1/me', :get)
+          Objects::Me.new(self, data)
+        end
+
+        # Fetches a multireddit.
+        # @!method multireddit(multireddit_path)
+        # @param multireddit_path [String] The path to the multireddit (e.g.
+        #   /user/username/m/multireddit_name).
+        # @return [NeonRAW::Objects::MultiReddit] Returns the multireddit
+        #   object.
+        def multireddit(multireddit_path)
+          params = { multipath: multireddit_path, expand_srs: false }
+          data = request_data("/api/multi/#{multireddit_path}", :get, params)
+          Objects::MultiReddit.new(self, data[:data])
+        end
+
+        # Creates a multireddit.
+        # @!method create_multireddit(data, multireddit_path)
+        # @param data [JSON] The multireddit data.
+        # @param multireddit_path [String] The path to the multireddit (e.g.
+        #   /user/username/m/multireddit_name)
+        # @return [NeonRAW::Objects::MultiReddit] Returns the multireddit
+        #   object.
+        # @see https://www.reddit.com/dev/api#POST_api_multi_{multipath}
+        def create_multireddit(data, multireddit_path)
+          params = { model: data, multipath: multireddit_path,
+                     expand_srs: false }
+          data = request_data("/api/multi/#{multireddit_path}", :post, params)
+          Objects::MultiReddit.new(self, data[:data])
+        end
+
+        # Creates a subreddit.
+        # @!method create_subreddit(name, title, description, opts = {})
+        # @param name [String] The name of the subreddit.
+        # @param title [String] The title of the subreddit (100
+        #   characters maximum).
+        # @param description [String] The sidebar text for the subreddit.
+        # @param opts [Hash] Optional parameters.
+        # @option opts allow_top [Boolean] Whether or not the subreddit can be
+        #   displayed on /r/all.
+        # @option opts collapse_deleted_comments [Boolean] Whether or not to
+        #   collapse deleted comments.
+        # @option opts comment_score_hide_mins [0..1440] The number of minutes
+        #   to hide comment scores.
+        # @option opts exclude_banned_modqueue [Boolean] Whether or not to
+        #   exclude sitewide banned users from modqueue.
+        # @option opts header-title [String] The title for the subreddit (500
+        #   characters maximum).
+        # @option opts hide_ads [Boolean] Whether or not to hide ads in the
+        #   subreddit.
+        # @option opts lang [String] The IETF language tags of the subreddit
+        #   separated by underscores.
+        # @option opts link_type [String] The type of submissions allowed [any,
+        #   link, self].
+        # @option opts over_18 [Boolean] Whether or not the subreddit is NSFW.
+        # @option opts public_description [String] The message that will get
+        #   shown to people when the subreddit is private.
+        # @option opts public_traffic [Boolean] Whether or not the subreddit's
+        #   traffic stats are publicly available.
+        # @option opts show_media [Boolean] Whether or not to show media.
+        # @option opts spam_comments [String] Set the spamfilter [low, high,
+        #   all].
+        # @option opts spam_links [String] Set the spamfilter [low, high, all].
+        # @option opts spam_selfposts [String] Set the spamfilter [low, high,
+        #   all].
+        # @option opts submit_text_label [String] The label for the selfpost
+        #   button (60 characters maximum).
+        # @option opts submit_text [String] The text to display when making a
+        #   selfpost.
+        # @option opts submit_link_label [String] The label for the link button
+        #   (60 characters maximum).
+        # @option opts suggested_comment_sort [String] The suggested comment
+        #   sort for the subreddit [confidence, top, new, controversial, old,
+        #   random, qa].
+        # @option opts type [String] The subreddit type [gold_restricted,
+        #   archived, restricted, gold_only, employees_only, private, public].
+        # @option opts wiki_edit_age [Integer] The minimum account age needed to
+        #   edit the wiki.
+        # @option opts wiki_edit_karma [Integer] The minimum karma needed to
+        #   edit the wiki.
+        # @option opts wikimode [String] The mode of the subreddit's wiki
+        #   [disabled, modonly, anyone].
+        # @return [NeonRAW::Objects::Subreddit] Returns the subreddit object.
+        def create_subreddit(name, title, description, opts = {})
+          params = SUBREDDIT_DEFAULTS.dup
+          params.merge! opts
+          params['api_type'] = 'json'
+          params['name'] = name
+          params['title'] = title
+          params['description'] = description
+          request_data('/api/site_admin', :post, params)
+          subreddit(name)
+        end
+
+        # Fetches a wiki page.
+        # @!method wikipage(page)
+        # @param page [String] The name of the page.
+        # @return [NeonRAW::Objects::WikiPage] Returns the wiki page object.
+        def wikipage(page)
+          params = { page: page }
+          path = "/wiki/#{page}.json"
+          data = request_data(path, :get, params)
+          data[:data][:name] = page
+          Objects::WikiPage.new(self, data[:data])
+        end
+      end
+    end
+  end
+end

data/lib/NeonRAW/clients/base/utilities.rb

@@ -0,0 +1,46 @@
+module NeonRAW
+  module Clients
+    class Base
+      # Utilities for the base client.
+      module Utilities
+        # Search for subreddits.
+        # @!method find_subreddits(query)
+        # @param query [String] The name to search for (50 characters maximum).
+        # @return [Array<String>] Returns the list of subreddits.
+        def find_subreddits(query)
+          params = { query: query }
+          data = request_data('/api/subreddits_by_topic', :get, params)
+          data.map { |subreddit| subreddit[:name] }
+        end
+
+        # Fetches subreddits.
+        # @!method popular(params = { limit: 25 })
+        # @!method new(params = { limit: 25 })
+        # @!method gold(params = { limit: 25 })
+        # @!method defaults(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 of all the
+        #   subreddits.
+        %w(popular new gold defaults).each do |type|
+          define_method :"#{type}" do |params = { limit: 25 }|
+            type.chop! if type == 'defaults'
+            build_listing("/subreddits/#{type}", params)
+          end
+        end
+
+        # Fetches a list of wiki pages from Reddit.
+        # @!method wikipages
+        # @return [Array<String>] Returns a list of wiki pages.
+        def wikipages
+          request_data('/wiki/pages.json', :get)[:data]
+        end
+      end
+    end
+  end
+end

data/lib/NeonRAW/clients/base.rb

@@ -0,0 +1,109 @@
+require 'typhoeus'
+require 'json'
+require_relative 'base/listing'
+require_relative 'base/objectbuilder'
+require_relative 'base/utilities'
+require_relative '../errors'
+
+module NeonRAW
+  module Clients
+    # The underlying base for the client
+    class Base
+      include Base::Listings
+      include Base::ObjectBuilder
+      include Base::Utilities
+      include Errors
+
+      # Creates headers for oAuth2 requests.
+      # @!method api_headers
+      # @return [Hash] Returns oAuth2 headers.
+      def api_headers
+        {
+          'User-Agent' => @user_agent,
+          'Authorization' => "bearer #{@access.access_token}"
+        }
+      end
+
+      # Connects to Reddit for oAuth2 requests.
+      # @!method api_connection(path, meth, params)
+      # @param path [String] The API path.
+      # @param meth [Symbol] The request method.
+      # @param params [Hash] The parameters.
+      # @param opts [Hash] Optional parameters for the request body.
+      # @return [Typhoeus::Response] Returns the response.
+      def api_connection(path, meth, params, opts = {})
+        response = Typhoeus::Request.new(
+          'https://oauth.reddit.com' + path,
+          method: meth,
+          body: opts,
+          headers: api_headers,
+          params: params
+        ).run
+        error = assign_errors(response)
+        fail error unless error.nil?
+        handle_ratelimit(response.headers)
+        response
+      end
+
+      # Makes the connection used to authorize the client.
+      # @!method auth_connection(path, meth, params)
+      # @param path [String] The API path.
+      # @param meth [Symbol] The request method.
+      # @param params [Hash] The parameters.
+      # @return [Typhoeus::Response] Returns the response.
+      def auth_connection(path, meth, params)
+        response = Typhoeus::Request.new(
+          'https://www.reddit.com' + path,
+          method: meth,
+          userpwd: "#{@client_id}:#{@secret}",
+          headers: { 'User-Agent' => @user_agent },
+          params: params
+        ).run
+        error = assign_errors(response)
+        fail error unless error.nil?
+        response
+      end
+
+      # Refreshes the access token.
+      # @!method refresh_access!
+      def refresh_access!
+        response = auth_connection(
+          '/api/v1/access_token', :post,
+          grant_type: 'refresh_token',
+          refresh_token: @access.refresh_token
+        )
+        data = JSON.parse(response.body, symbolize_names: true)
+        @access.refresh! data
+      end
+
+      # Requests data from Reddit.
+      # @!method request_data(path, meth, params = {})
+      # @param path [String] The API path to connect to.
+      # @param meth [Symbol] The request method to use.
+      # @param params [Hash] Parameters for the request.
+      # @param opts [Hash] Optional parameters for methods that send stuff
+      #   via the request body.
+      # @return [Hash] Returns the parsed JSON containing the response data.
+      def request_data(path, meth, params = {}, opts = {})
+        refresh_access! if @access.expired?
+        response = api_connection(path, meth, params, opts)
+        data = JSON.parse(response.body, symbolize_names: true)
+        error = parse_errors(data)
+        fail error unless error.nil?
+        data
+      end
+
+      # Requests non-JSON data from Reddit.
+      # @!method request_nonjson(path, meth, params = {}, opts = {})
+      # @param path [String] The API path to connect to.
+      # @param meth [Symbol] The request method to use.
+      # @param params [Hash] Parameters for the request.
+      # @param opts [Hash] Optional parameters for methods that send stuff
+      #   via the request body.
+      def request_nonjson(path, meth, params = {}, opts = {})
+        refresh_access! if @access.expired?
+        api_connection(path, meth, params, opts).body
+      end
+    end
+  end
+end