SnoobyPlus 0.1

data/lib/snooby.rb

@@ -0,0 +1,178 @@
+%w[json net/http/persistent].each { |dep| require dep }
+
+CONFIG_FILE = '.snooby/config.json'
+
+# Creates and initializes configuration and caching on a per-directory basis.
+# Doesn't update if they already exist, but this might need to be fleshed out
+# a bit in future to merge values to be kept with new defaults in upgrades.
+unless File.exists? CONFIG_FILE
+  DEFAULT_CONFIG = File.join Gem.datadir('snooby'), 'config.json'
+  %w[.snooby .snooby/cache].each { |dir| Dir.mkdir dir }
+  File.open(CONFIG_FILE, 'w') { |file| file << File.read(DEFAULT_CONFIG) }
+end
+
+# reddit API (Snoo) + happy programming (Ruby) = Snooby
+module Snooby
+
+  class << self
+    attr_accessor :config, :active
+  end
+
+  # Raised with a pretty print of the relevant JSON object whenever an API call
+  # returns a non-empty "errors" array, typically in cases of rate limiting and
+  # missing or insufficient authorization. Also used as a general container for
+  # miscellaneous errors related to site functionality.
+  class RedditError < StandardError
+  end
+
+  # Changes to configuration should persist across multiple uses. This class is
+  # a simple modification to the standard hash's setter that updates the config
+  # file whenever a value changes.
+  class Config < Hash
+    def []=(key, value)
+      super
+      return unless Snooby.config # nil during initialization inside JSON#parse
+      File.open(CONFIG_FILE, 'w') do |file|
+        file << JSON.pretty_generate(Snooby.config)
+      end
+    end
+  end
+
+  @config = JSON.parse(File.read(CONFIG_FILE), object_class: Config)
+  raise RedditError, 'Insufficiently patient delay.' if @config['delay'] < 2
+
+  # Opens a persistent connection that provides a significant speed improvement
+  # during repeated calls; reddit's two-second rule pretty much nullifies this,
+  # but it's still a great library and persistent connections are a Good Thing.
+  Conn = Net::HTTP::Persistent.new 'Snooby'
+
+  paths = {
+    :comment            => 'api/comment',
+    :compose            => 'api/compose',
+    :delete             => 'api/del',
+    :disliked           => 'user/%s/disliked.json',
+    :domain_posts       => 'domain/%s.json',
+    :friend             => 'api/friend',
+    :hidden             => 'user/%s/hidden.json',
+    :hide               => 'api/hide',
+    :liked              => 'user/%s/liked.json',
+    :login              => 'api/login/%s',
+    :mark               => 'api/marknsfw',
+    :me                 => 'api/me.json',
+    :post_comments      => 'comments/%s.json',
+    :reddit             => '.json',
+    :save               => 'api/save',
+    :saved              => 'saved.json',
+    :submit             => 'api/submit',
+    :subreddit_about    => 'r/%s/about.json',
+    :subreddit_comments => 'r/%s/comments.json',
+    :subreddit_posts    => 'r/%s.json',
+    # Snooby-Plus adds Top/Controversial/New grabbing to Snooby
+    :subreddit_top      => 'r/%s/top.json',
+    :subreddit_new      => 'r/%s/new.json',
+    :subreddit_rising   => 'r/%s/rising.json',
+    :subreddit_contro   => 'r/%s/controversial.json',
+    # End Snooby-Plus additions
+    :subscribe          => 'api/subscribe',
+    :unfriend           => 'api/unfriend',
+    :unhide             => 'api/unhide',
+    :unmark             => 'api/unmarknsfw',
+    :unsave             => 'api/unsave',
+    :user               => 'user/%s',
+    :user_about         => 'user/%s/about.json',
+    :user_comments      => 'user/%s/comments.json',
+    :user_posts         => 'user/%s/submitted.json',
+    :vote               => 'api/vote',
+  }
+
+  # Provides a mapping of things and actions to their respective URL fragments.
+  Paths = paths.merge(paths) { |act, path| "http://www.reddit.com/#{path}" }
+
+  # Provides a mapping of things to a list of all the attributes present in the
+  # relevant JSON object. A lot of these probably won't get used too often, but
+  # might as well grab all available data (except body_html and selftext_html).
+  Fields = {
+    :comment => %w[author author_flair_css_class author_flair_text body created created_utc downs id likes link_id link_title name parent_id replies subreddit subreddit_id ups],
+    :post    => %w[author author_flair_css_class author_flair_text clicked created created_utc domain downs hidden id is_self likes media media_embed name num_comments over_18 permalink saved score selftext subreddit subreddit_id thumbnail title ups url]
+  }
+
+  # Wraps the connection for all requests to ensure that the two-second rule is
+  # adhered to. The uri parameter comes in as a string because it may have been
+  # susceptible to variables, so it gets turned into an actual URI here instead
+  # of all over the place. Since it's required for all POST requests other than
+  # logging in, the client's modhash is sent along by default.
+  def self.request(uri, data = nil)
+    uri = URI uri
+    if data && data != 'html'
+      unless active.uh || data[:passwd]
+        raise RedditError, 'You must be logged in to make POST requests.'
+      end
+      post = Net::HTTP::Post.new uri.path
+      post.set_form_data data.merge!(:uh => active.uh, :api_type => 'json')
+    end
+    wait if @last_request && Time.now - @last_request < @config['delay']
+    @last_request = Time.now
+
+    resp = Conn.request uri, post
+    raise ArgumentError, resp.code_type unless resp.code == '200'
+
+    # Raw HTML is parsed to obtain the user's trophy data and karma breakdown.
+    return resp.body if data == 'html'
+    
+    json = JSON.parse resp.body, :max_nesting => 100
+    if (resp = json['json']) && (errors = resp['errors'])
+      raise RedditError, jj(json) unless errors.empty?
+    end
+    json
+  end
+
+  # The crux of Snooby. Generates an array of structs from the Paths and Fields
+  # hashes defined above. In addition to just being a very neat container, this
+  # allows accessing the returned JSON values using thing.attribute, as opposed
+  # to thing['data']['attribute']. Only used for listings of posts and comments
+  # at the moment, but I imagine it'll be used for moderation down the road.
+  # Having to explicitly pass the path isn't very DRY, but deriving it from the
+  # object (say, Snooby::Comment) doesn't expose which kind of comment it is.
+  def self.build(object, path, which, count)
+    # A bit of string manipulation to determine which fields to populate the
+    # generated structs with. There might be a less fragile way to go about it,
+    # but it shouldn't be a problem as long as naming remains consistent.
+    kind = object.to_s.split('::')[1].downcase.to_sym
+
+    # Set limit to the maximum of 100 if we're grabbing more than that, give
+    # after a truthy value since we stop when it's no longer so, and initialize
+    # an empty result set that the generated structs will be pushed into.
+    limit, after, results = [count, 100].min, '', []
+
+    while results.size < count && after
+      uri = Paths[path] % which + "?limit=#{limit}&after=#{after}"
+      json = request uri
+      json = json[1] if path == :post_comments # skip over the post's data
+      json['data']['children'].each do |child|
+        # Converts each child's JSON data into the relevant struct based on the
+        # kind of object being built. The symbols of a struct definition are
+        # ordered, but Python dictionaries are not, so #values is insufficient.
+        # Preliminary testing showed that appending one at a time is slightly
+        # faster than concatenating the entire page of results and then taking
+        # a slice at the end. This also allows for premature stopping if the
+        # count is reached before all results have been processed.
+        results << object.new(*child['data'].values_at(*Fields[kind]))
+        return results if results.size == count
+      end
+      after = json['data']['after']
+    end
+    results
+  end
+
+  # Called whenever respecting the API is required.
+  def self.wait
+    sleep @config['delay']
+  end
+end
+
+# Snooby's parts are required down here, after its initial declaration, because
+# Post and Comment are structs whose definitions are taken from the Fields hash
+# and related bits might as well be kept together.
+%w[client actions user subreddit domain post comment].each do |dep|
+  require "snooby/#{dep}"
+end

data/lib/snooby/actions.rb

@@ -0,0 +1,73 @@
+module Snooby
+  
+  module About
+    # Returns a hash containing the calling object's about.json data.
+    def about
+      Snooby.request(Paths[:"#{@kind}_about"] % @name)['data']
+    end
+  end
+
+  module Posts
+    # Returns an array of structs containing the calling object's posts.
+    # Snooby-Plus adds the `srlist' parameter. This can be any one of `:top', `:new', `:rising', or `:contro'.
+    def posts(count = 25, srlist = :posts)
+      path = @name ? :"#{@kind}_#{@kind == :subreddit ? srlist : :posts}" : :reddit
+      Snooby.build Post, path, @name, count
+    end
+    alias :submissions :posts
+  end
+
+  module Comments
+    # Returns an array of structs containing the calling object's comments.
+    # TODO: return more than just top-level comments for posts.
+    def comments(count = @kind == 'post' ? 500 : 25)
+      # @name suffices for users and subreddits, but a post's name is obtained
+      # from its struct; the "t3_" must be removed before making the API call.
+      @name ||= self.name[3..-1]
+      Snooby.build Comment, :"#{@kind}_comments", @name, count
+    end
+  end
+
+  module Reply
+    # Posts a reply to the calling object, which is either a post or a comment.
+    def reply(text)
+      Snooby.request Paths[:comment], :parent => self.name, :text => text
+    end
+  end
+
+  module Delete
+    # Deletes the calling object, which is either a post or a comment.
+    def delete
+      Snooby.request Paths[:delete], :id => self.name
+    end
+  end
+
+  module Compose
+    # Sends a message to the calling object, which is either a subreddit or a
+    # user; in the case of the former, this behaves like moderator mail.
+    def compose(subject, text)
+      to = (@kind == 'user' ? '' : '#') + @name
+      data = {:to => to, :subject => subject, :text => text}
+      Snooby.request Paths[:compose], data
+    end
+    alias :message :compose
+  end
+
+  module Voting
+    def vote(dir)
+      Snooby.request Paths[:vote], :id => self.name, :dir => dir
+    end
+
+    def upvote
+      vote 1
+    end
+
+    def rescind
+      vote 0
+    end
+
+    def downvote
+      vote -1
+    end
+  end
+end

data/lib/snooby/client.rb

@@ -0,0 +1,105 @@
+module Snooby
+  
+  # Interface through which Snooby does all of its interacting with the API.
+  class Client
+    attr_reader :uh, :id
+
+    def initialize(user_agent = "Snooby, #{rand}")
+      # Net::HTTP's default User-Agent, "Ruby", is banned on reddit due to its
+      # frequent improper use; cheers to Eric Hodel (drbrain) for implementing
+      # this workaround for net-http-persistent.
+      Conn.override_headers['User-Agent'] = user_agent
+
+      # Allows Snooby's classes to access the currently active client, even if
+      # it has not been authorized, allowing the user to log in mid-execution.
+      Snooby.active = self
+    end
+
+    # Causes the client to be recognized as the given user during API calls.
+    # GET operations do not need to be authorized, so if your intent is simply
+    # to gather data, feel free to disregard this method entirely.
+    def authorize!(user, passwd, force_update = false)
+      if Snooby.config['auth'][user] && !force_update
+        # Authorization data exists, skip login and potential rate-limiting.
+        @uh, @cookie, @id = Snooby.config['auth'][user]
+      else
+        data = {:user => user, :passwd => passwd}
+        json = Snooby.request(Paths[:login] % user, data)['json']
+        @uh, @cookie = json['data'].values
+      end
+
+      # Sets the reddit_session cookie required for API calls to be recognized
+      # as coming from the intended user. Uses override_headers to allow for
+      # switching the current user mid-execution, if so desired.
+      Conn.override_headers['Cookie'] = "reddit_session=#{@cookie}"
+
+      # A second call is made, if required, to grab the client's id, which is
+      # necessary for (un)friending.
+      @id ||= "t2_#{me['id']}"
+
+      # Updates the config file to faciliate one-time authorization. This works
+      # because the authorization data is immortal unless the password has been
+      # changed; enable the force_update parameter if such is the case.
+      Snooby.config['auth'][user] = [@uh, @cookie, @id]
+    end
+
+    # Returns a User object through which all relevant data is accessed.
+    def user(name)
+      User.new name
+    end
+
+    # Returns a Subreddit object through which all relevant data is accessed.
+    # Supplying no name provides access to the client's front page.
+    def subreddit(name = nil)
+      Subreddit.new name
+    end
+
+    def domain(name)
+      Domain.new name
+    end
+
+    # Returns a hash containing the values given by me.json, used internally to
+    # obtain the client's id, but also the most efficient way to check whether
+    # or not the client has mail.
+    def me
+      Snooby.request(Paths[:me])['data']
+    end
+
+    # Returns an array of structs containing the current client's saved posts.
+    def saved(count = 25)
+      Snooby.build Post, :saved, nil, count
+    end
+
+    def submit(name, title, content)
+      Subreddit.new(name).submit title, content
+    end
+
+    def subscribe(name)
+			Subreddit.new(name).subscribe
+		end
+
+    def unsubscribe(name)
+			Subreddit.new(name).unsubscribe
+		end
+
+    def friend(name)
+			User.new(name).friend
+		end
+
+    def unfriend(name)
+			User.new(name).unfriend
+		end
+
+    def compose(to, subject, text)
+      data = {:to => to, :subject => subject, :text => text}
+      Snooby.request Paths[:compose], data
+    end
+
+    # Aliases all in one place for purely aesthetic reasons.
+    alias :u       :user
+    alias :r       :subreddit
+    alias :sub     :subscribe
+    alias :unsub   :unsubscribe
+    alias :message :compose
+  end
+end

data/lib/snooby/comment.rb

@@ -0,0 +1,11 @@
+module Snooby
+
+  class Comment < Struct.new(*Fields[:comment].map(&:to_sym))
+    include Reply, Delete, Voting
+    
+    def initialize(*)
+      super
+      @kind = 'comment'
+    end
+  end
+end

data/lib/snooby/domain.rb

@@ -0,0 +1,11 @@
+module Snooby
+
+  class Domain
+    include Posts
+
+    def initialize(name)
+      @name = name
+      @kind = 'domain'
+    end
+  end
+end

data/lib/snooby/post.rb

@@ -0,0 +1,35 @@
+module Snooby
+  
+  class Post < Struct.new(*Fields[:post].map(&:to_sym))
+    include Comments, Reply, Delete, Voting
+
+    def initialize(*)
+      super
+      @kind = 'post'
+    end
+
+    def save(un = '')
+      Snooby.request Paths[:"#{un}save"], :id => self.name
+    end
+
+    def unsave
+      save 'un'
+    end
+
+    def hide(un = '')
+      Snooby.request Paths[:"#{un}hide"], :id => self.name
+    end
+
+    def unhide
+      hide 'un'
+    end
+
+    def mark(un = '')
+      Snooby.request Paths[:"#{un}mark"], :id => self.name
+    end
+
+    def unmark
+      mark 'un'
+    end
+  end
+end

data/lib/snooby/user.rb

@@ -0,0 +1,48 @@
+module Snooby
+  
+  class User
+    include About, Posts, Comments, Compose
+
+    def initialize(name)
+      @name = name
+      @kind = 'user'
+    end
+
+    # Returns an array of arrays containing the user's trophy information in
+    # the form of [name, description], the latter containing the empty string
+    # if inapplicable.
+    def trophies
+      # Only interested in trophies; request the minimum amount of content.
+      html = Snooby.request(Paths[:user] % @name + '?limit=1', 'html')
+      # Entry-level black magic.
+      html.scan /"trophy-name">(.+?)<.+?"\s?>([^<]*)</
+    end
+
+    def karma_breakdown
+      html = Snooby.request(Paths[:user] % @name + '?limit=1', 'html')
+      rx = /h>(.+?)<.+?(\d+).+?(\d+)/
+      Hash[html.split('y>')[2].scan(rx).map { |r| [r.shift, r.map(&:to_i)] }]
+    end
+
+    def liked(count = 25)
+      Snooby.build Post, :liked, @name, count
+    end
+
+    def disliked(count = 25)
+      Snooby.build Post, :disliked, @name, count
+    end
+
+    def hidden(count = 25)
+      Snooby.build Post, :hidden, @name, count
+    end
+
+    def friend(un = '')
+      data = {:name => @name, :type => 'friend', :container => Snooby.active.id}
+      Snooby.request Paths[:"#{un}friend"], data
+    end
+
+    def unfriend
+      friend 'un'
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: SnoobyPlus
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- King Bowser
+- andkerosine
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-08-05 00:00:00 Z
+dependencies: []
+
+description: All the features of Snooby, along with TopRisingNewControversial list grabbing.
+email: backseat.rapist@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/snooby.rb
+- lib/snooby/actions.rb
+- lib/snooby/client.rb
+- lib/snooby/comment.rb
+- lib/snooby/domain.rb
+- lib/snooby/post.rb
+- lib/snooby/user.rb
+homepage: https://github.com/KingBowser/snooby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: All the features of Snooby, along with TopRisingNewControversial list grabbing.
+test_files: []
+