snoo 0.0.2 → 0.0.3

data/examples/flairbot/README.md

@@ -0,0 +1,23 @@
+This is a simple flairbot you can use to automatically add flair to a subreddit.
+
+It is currently in use on [r/TheWalkingDead](http://www.reddit.com/r/thewalkingdead) and [r/BreakingBad](http://www.reddit.com/r/breakingbad). It provides automatic spoiler detection
+
+# Configuration
+
+## Account
+Configuring the bot's account is very simple. Simply edit `config.yaml` and fill out the username and password fields.
+
+## Subreddits
+Each subreddit can have multiple regexes, and the bot can run on multiple subreddits. It needs to have moderator on all subreddits.
+
+To add new subreddits, make a new first-level entry under `subreddits:`
+
+To add new flair parsers, add a new entry, with a regular expression as the name. Ex `(show|comic) spoilers`. Beneath this, set if you want to ignore case (recommended) and the flair id of the linkflair to apply. This shows up if you inspect the HTML source of the reddit flair dialog on links.
+
+# Caveats
+
+This bot scrapes new, and as such, will ususally catch most things. That said, it is imperfect, and things may slip through.
+
+To prevent re-duplicating flair calls, it hides a post on flair. This allows you to see which post a bot has flaired, simply by logging into its account.
+
+Finally, regexes are applied in a top-down cascade. Regexes at the bottom will override ones at the top. A post can only have one linkflair, so go from general to specific in your regexes.

data/examples/flairbot/config.yaml

@@ -0,0 +1,27 @@
+# Batch size, cannot go above 100
+limit: 100
+# Login details
+username: flair-o-tron
+password: 
+# Logging
+logging: false
+# Uncomment the following line to enable logging to file
+# logfile: /home/paradox/ruby/log/flair.log
+# Log rotation
+logrotate: weekly
+# Your subreddits
+# Just copy and paste what you see
+subreddits:
+  thewalkingdead:
+    'comic.spoiler':
+      ignore_case: true
+      id: 'e9452e44-846f-11e1-994b-12313d2c1af1'
+    '[(show)(tv)].spoiler':
+      ignore_case: true
+      id: 'ed8c5612-846f-11e1-837a-12313b08a511'
+  breakingbad:
+    'spoiler':
+      ignore_case: true
+      id: '083ccbc2-ce0d-11e1-85b5-12313b0c247a'
+
+

data/examples/flairbot/flair.rb

@@ -0,0 +1,108 @@
+require 'ostruct'
+require 'yaml'
+require 'snoo'
+require 'logger'
+
+class String
+  def colorize(color, options = {})
+    background = options[:background] || options[:bg] || false
+    style = options[:style]
+    offsets = ["gray","red", "green", "yellow", "blue", "magenta", "cyan","white"]
+    styles = ["normal","bold","dark","italic","underline","xx","xx","underline","xx","strikethrough"]
+    start = background ? 40 : 30
+    color_code = start + (offsets.index(color) || 8)
+    style_code = styles.index(style) || 0
+    "\e[#{style_code};#{color_code}m#{self}\e[0m"
+  end
+end
+
+config = OpenStruct.new YAML.load(File.read("/home/paradox/ruby/config.yaml"))
+
+log = config.logfile.nil? ? Logger.new(STDOUT) : Logger.new(config.logfile, config.logrotate)
+
+log.level = config.logging ? Logger::DEBUG : Logger::FATAL
+
+log.info("Starting log on #{Time.now}")
+reddit = Snoo::Client.new
+log.debug('Logging into reddit')
+reddit.log_in config.username, config.password
+log.debug('Success!')
+
+queue = Queue.new
+retried = nil
+config.subreddits.each do |subreddit, flairs|
+  begin
+    log.debug("Getting #{config.limit} new links for #{subreddit}")
+    listing = reddit.get_listing(subreddit: subreddit, page: 'new', sort: 'new', limit: config.limit)['data']['children']
+    log.debug("Getting #{config.limit} hot links for #{subreddit}")
+    listing.concat reddit.get_listing(subreddit: subreddit, limit: config.limit)['data']['children']
+    listing.uniq!
+  rescue
+    log.error("Got error #{$!}".colorize "red")
+    if !retried.nil?
+      retried = true
+      log.debug('Trying again')
+      retry
+    else
+      next
+        retried = nil
+    end
+  ensure
+    retried = nil
+  end
+  flairs.each do |reg, options|
+    r = Regexp.new reg, options['ignore_case']
+    log.debug("Matching against #{r}")
+    listing.each do |thing|
+      # binding.pry
+      if thing['data']['title'] =~ r
+        q = {
+          subreddit: subreddit,
+          template: options['id'],
+          thing: 't3_' + thing['data']['id']
+        }
+        log.debug("Queueing #{q}")
+        queue << q
+        log.debug("Hiding (#{thing['data']['id']}) #{thing['data']['title']}")
+        begin
+          reddit.hide 't3_' + thing['data']['id']
+          sleep 2
+        rescue
+          log.error("Got error #{$!}".colorize "red")
+          if retried.nil?
+            retried = true
+            sleep 5
+            log.debug('Trying again')
+            retry
+          else
+            next
+          end
+        ensure
+          retried = nil
+        end
+      end
+    end
+  end
+  sleep 2
+end
+
+queue.length.times do
+  flair = queue.pop
+  begin
+    log.debug("Setting flair on #{flair}")
+    reddit.select_flair_template( flair[:template], flair[:subreddit], link: flair[:thing])
+    sleep 2 # For reddit api limits, we sleep 2
+  rescue
+    log.error("Got error #{$!}".colorize "red")
+    if retried.nil?
+      retried = true
+      sleep 5
+      log.debug('Trying again')
+      retry
+    else
+      next
+    end
+  ensure
+    retried = nil
+  end
+end

data/lib/snoo.rb

@@ -16,7 +16,7 @@ module Snoo
       include inc
     end
 
-    attr_reader(:modhash, :username, :userid, :cookie)
+    attr_reader(:modhash, :username, :userid, :cookies)
 
 
     # Creates a new instance of Snoo.

data/lib/snoo/account.rb

@@ -13,17 +13,29 @@ module Snoo
       login = post("/api/login", :body => {user: username, passwd: password, api_type: 'json'})
       errors = login['json']['errors']
       raise errors[0][1] unless errors.size == 0
-      cookies login.headers['set-cookie']
+      set_cookies login.headers['set-cookie']
       @modhash = login['json']['data']['modhash']
       @username = username
       @userid = 't2_' + get('/api/me.json')['data']['id']
       return login
     end
 
+    # Auth into reddit via modhash and cookie. This has the advantage of not throttling you if you call it a lot
+    #
+    # @param modhash [String] The modhash to use
+    # @param cookies [String] The cookies string to give to the header
+    def auth modhash, cookies
+      set_cookies cookies
+      @modhash = modhash
+      meinfo = get("/api/me.json")
+      @username = meinfo['data']['name']
+      @userid = 't2_' + meinfo['data']['id']
+    end
+
     # Logs out of a reddit account. This is usually uneeded, you can just log_in as a new account to replace the current one.
     # This just nils the cookies and modhash
     def log_out
-      cookies nil
+      set_cookies nil
       @modhash = nil
       @userid = nil
       @username = nil
@@ -38,7 +50,7 @@ module Snoo
     def clear_sessions password
       logged_in?
       clear = post('/api/clear_sessions', body: { curpass: password, dest: @baseurl, uh: @modhash })
-      cookies clear.headers['set-cookie']
+      set_cookies clear.headers['set-cookie']
       return clear
     end
 
@@ -85,7 +97,7 @@ module Snoo
         }
       params[:email] = email if email
       update = post('/api/update', body: params )
-      cookies update.headers['set-cookie']
+      set_cookies update.headers['set-cookie']
       return update
     end
   end

data/lib/snoo/flair.rb

@@ -42,7 +42,7 @@ module Snoo
     # @param opts [Hash] An options hash.
     # @option opts [String] :css_class The class(es) applied to the flair. Whitespace separated
     # @option opts [String] :text The flair text
-    # @option opts [String] :name The user who we are flairing. This requires a username.r
+    # @option opts [String] :name The user who we are flairing. This requires a username
     # @option opts [String] :link The thing id of the link (if a link). Begins with `t3_`
     # @return (see #clear_sessions)
     def flair subreddit, opts = {}

data/lib/snoo/utilities.rb

@@ -1,9 +1,17 @@
 module Snoo
   # Utility functions.
-  # These are all private
   #
   # @author (see Snoo)
   module Utilities
+
+    # Set the cookie header and instance variable
+    #
+    # @param cookie [String] The cookie text, as show in a 'set-cookie' header
+    def set_cookies cookie
+      @cookies = cookie
+      self.class.headers 'Cookie' => cookie
+    end
+
     private
       # HTTParty get wrapper. This serves to clean up code, as well as throw webserver errors wherever needed
       #
@@ -20,18 +28,11 @@ module Snoo
         raise WebserverError, response.code unless response.code == 200
         response
       end
-      # Set the cookie header and instance variable
-      #
-      # @param cookie [String] The cookie text, as show in a 'set-cookie' header
-      def cookies cookie
-        @cookie = cookie
-        self.class.headers 'Cookie' => cookie
-      end
 
       # Raises an error if we aren't currently logged in
       #
       def logged_in?
-        raise NotAuthenticated if @cookie.nil? or @modhash.nil?
+        raise NotAuthenticated if @cookies.nil? or @modhash.nil?
       end
 
       # Posts to '/api/friend'. This method exists because there are tons of things that use this

data/lib/snoo/version.rb

@@ -1,4 +1,4 @@
 module Snoo
   # The version string (duh)
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snoo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-15 00:00:00.000000000 Z
+date: 2012-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -59,6 +59,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/flairbot/README.md
+- examples/flairbot/config.yaml
+- examples/flairbot/flair.rb
 - lib/snoo.rb
 - lib/snoo/account.rb
 - lib/snoo/exceptions.rb