snoo 0.0.7 → 0.1.0.pre.1

data/lib/snoo/flair.rb

@@ -59,30 +59,28 @@ module Snoo
 
     # Configures flair options for a subreddit. All options are required
     #
-    # @param enabled [true, false] Flair enabled?
-    # @param position [left, right] Position of user flair.
-    # @param self_assign [true, false] Allow users to assign their own flair from templates
-    # @param link_position [none, left, right] The position of link flair. Set to `none` to disable
-    # @param link_assign [true, false] Allow a submitter to assign their own link flair
     # @param subreddit [String] The subreddit targeted.
+    # @param opts [Hash] An options hash
+    # @option opts [true, false] :flair_enabled (true) Flair enabled?
+    # @option opts [left, right] :flair_position ('right') Position of user flair.
+    # @option opts [true, false] :flair_self_assign_enabled (false) Allow users to assign their own flair from templates
+    # @option opts [none, left, right] :link_flair_position ('right') The position of link flair. Set to `none` to disable
+    # @option opts [true, false] :link_flair_self_assign_enabled (false) Allow a submitter to assign their own link flair
     # @return (see #clear_sessions)
-    def flair_config enabled, position, self_assign, link_position, link_assign, subreddit
+    def flair_config subreddit, opts = {}
       logged_in?
-      # Test the params
-      tests = [true, false]
-      raise "parameter error" unless tests.include?(enabled) && tests.include?(self_assign) && tests.include?(link_assign)
-      tests << "none"
-      raise "parameter error" unless tests.include?(link_position)
-
-      post('/api/flairconfig', body: {
-        flair_enabled: enabled,
-        flair_position: position,
-        flair_self_assign_enabled: self_assign,
-        link_flair_position: link_position,
-        link_flair_self_assign_enabled: link_assign,
+      options = {
+        flair_enabled: true,
+        flair_position: 'right',
+        flair_self_assign_enabled: false,
+        link_flair_position: 'right',
+        link_flair_self_assign_enabled: false,
         uh: @modhash,
         r: subreddit
-        })
+      }
+      options.merge! opts
+
+      post('/api/flairconfig', body: options)
     end
 
     # Post flair in a CSV file to reddit
@@ -116,29 +114,28 @@ module Snoo
 
     # Create or edit a flair template.
     #
-    # @param css_class [String] The list of css classes applied to this style, space separated
-    # @param type [USER_FLAIR, LINK_FLAIR] The type of flair template.
-    # @param text [String] The flair template's text.
-    # @param user_editable [true, false] If the templ
     # @param subreddit [String] The subreddit targeted.ate allows users to specify their own text
-    # @param template_id [String] The flair template ID, for editing. Get this from {#flair_template_list}
+    # @param opts [Hash] An options hash
+    # @option opts [String] css_class The list of css classes applied to this style, space separated
+    # @option opts [USER_FLAIR, LINK_FLAIR] flair_type ('USER_FLAIR') The type of flair template.
+    # @option opts [String] text The flair template's text.
+    # @option opts [true, false] text_editable (false) If the user is allowed to edit their flair text
+    # @option opts [String] template_id The flair template ID, for editing.
     # @return (see #clear_sessions)
-    def flair_template css_class, type, text, user_editable, subreddit, template_id = nil
+    def flair_template subreddit, opts = {}
       logged_in?
-      test = ['USER_FLAIR', 'LINK_FLAIR']
-      raise ArgumentError, 'type is either USER_FLAIR or LINK_FLAIR' unless test.include?(type)
-      test = [true, false]
-      raise ArgumentError, 'user_editable needs to be true or false' unless test.include?(user_editable)
-
       params = {
-        css_class: css_class,
-        flair_type: type,
-        text: text,
-        text_editable: user_editable,
+        flair_type: 'USER_FLAIR',
+        text_editable: false,
         uh: @modhash,
         r: subreddit
       }
-      params[:flair_template_id] = template_id if template_id
+      params.merge! opts
+      test = ['USER_FLAIR', 'LINK_FLAIR']
+      raise ArgumentError, 'type is either USER_FLAIR or LINK_FLAIR' unless test.include?(params[:flair_type])
+      test = [true, false]
+      raise ArgumentError, 'user_editable needs to be true or false' unless test.include?(params[:text_editable])
+
       post('/api/flairtemplate', body: params)
     end
 

data/lib/snoo/links_comments.rb

@@ -123,6 +123,7 @@ module Snoo
       logged_in?
       post('/api/unmarknsfw', body: {id: id, uh: @modhash})
     end
+    alias_method :mark_sfw, :unmark_nsfw
 
     # Vote on a comment or link
     #
@@ -138,14 +139,23 @@ module Snoo
     # Upvote
     # An alias for `vote 1, id`
     #
+    def upvote id
+      vote 1, id
+    end
 
     # Downvote
     # An alias for `vote -1, id`
     #
+    def downvote id
+      vote -1, id
+    end
 
     # Sidevote (clear your vote)
     # An alias for `vote 0, id`
     #
+    def sidevote id
+      vote 0, id
+    end
 
   end
 end

data/lib/snoo/listings.rb

@@ -8,18 +8,20 @@ module Snoo
     #
     # @param link_id [String] The link id of the comment thread. Must always be present
     # @param (see LinksComments#info)
+    # @option opts [String] :subreddit The subreddit to fetch the comments of
+    # @option opts [String] :link_id The link to get the comments of
     # @option opts [String] :comment_id The parent comment of a thread.
     # @option opts [Fixnum] :context The context of the thread, that is, how far above the `comment_id` to return
     # @option opts [Fixnum] :limit (100) The total number of comments to return. If you have gold this can include the whole thread, but is buggy. Recommend no more than 1000
     # @option opts [Fixnum] :depth How deep to render a comment thread.
     # @option opts [old, new, hot, top, controversial, best] :sort The sort used.
     # @return (see #clear_sessions)
-    def get_comments link_id, opts = {}
+    def get_comments opts = {}
       sorts = %w{old new hot top controversial best}
       raise ArgumentError, "sort cannot be #{sort}" unless sorts.include?(opts[:sort]) or opts[:sort].nil?
       query = { limit: 100 }
       query.merge! opts
-      url = "/comments/%s%s.json" % [link_id, ('/' + opts[:comment_id] if opts[:comment_id])]
+      url = "%s/comments/%s%s.json" % [('/r/' + opts[:subreddit] if opts[:subreddit]), opts[:link_id], ('/' + opts[:comment_id] if opts[:comment_id])]
       get(url, query: query)
     end
 
@@ -27,7 +29,7 @@ module Snoo
     #
     # @param (see LinksComments#info)
     # @option opts [String] :subreddit The subreddit targeted. Can be psuedo-subreddits like `all` or `mod`. If blank, the front page
-    # @option opts [new, controversial, top] :page The page to view.
+    # @option opts [new, controversial, top, saved] :page The page to view.
     # @option opts [new, rising] :sort The sorting method. Only relevant on the `new` page
     # @option opts [hour, day, week, month, year] :t The timeframe. Only relevant on some pages, such as `top`. Leave empty for all time
     # @option opts [1..100] :limit The number of things to return.
@@ -35,7 +37,7 @@ module Snoo
     # @option opts [String] :before Get things *before* this thing id
     # @return (see #clear_sessions)
     def get_listing opts = {}
-      pages = %w{new controversial top}
+      pages = %w{new controversial top saved}
       sorts = %w{new rising}
       times = %w{hour day week month year}
       # Invalid Page

data/lib/snoo/moderation.rb

@@ -16,12 +16,12 @@ module Snoo
     # Distinguish a thing
     #
     # @param (see #approve)
-    # @param how [yes, no, admin, special] Determines how to distinguish something. Only works for the permissions you have.
+    # @param how [yes, no, admin, special] (yes) Determines how to distinguish something. Only works for the permissions you have.
     # @return (see #clear_sessions)
-    def distinguish id, how
+    def distinguish id, how = "yes"
       logged_in?
       hows = %w{yes no admin special}
-      raise ArgumentError, "how should be one of #{hows * ', '}, is #{how}" if hows.include?(how)
+      raise ArgumentError, "how should be one of #{hows * ', '}, is #{how}" unless hows.include?(how)
       post('/api/distinguish', body: {id: id, how: how, uh: @modhash})
     end
 
@@ -50,7 +50,7 @@ module Snoo
     # @param (see #approve)
     # @param spam [true, false] Mark this removal as a spam removal (and train the spamfilter)
     # @return (see #clear_sessions)
-    def remove id, spam
+    def remove id, spam = false
       logged_in?
       spams = [true, false]
       raise ArgumentError, "spam should be boolean, is #{spam}" unless spams.include?(spam)

data/lib/snoo/pms.rb

@@ -54,10 +54,6 @@ module Snoo
     # @return (see #clear_sessions)
     def get_messages where = "inbox", opts = {},
       bools = [true, false]
-      wheres = %w{inbox unread sent}
-      raise ArgumentError, "where must be #{wheres * ', '}, is #{where}" unless wheres.include?(where)
-      raise ArgumentError, "mark must be boolean, is #{opts[:mark]}" unless bools.include?(opts[:mark]) or opts[:mark].nil?
-      raise ArgumentError, "limit must be 1..100, is #{opts[:limit]}" unless (1..100).include?(opts[:limit]) or opts[:limit].nil?
 
       query = {
         mark: false

data/lib/snoo/subreddits.rb

@@ -238,5 +238,13 @@ module Snoo
       logged_in?
       get("/r/#{subreddit}/about/banned.json")
     end
+
+    # Accept a moderatorship
+    # 
+    # @param subreddit [String] The subreddit to accept in. You must have been invited
+    def accept_moderator subreddit
+      logged_in?
+      post('/api/accept_moderator_invite', body: {r: subreddit, uh: @modhash})
+    end
   end
 end

data/lib/snoo/users.rb

@@ -47,9 +47,6 @@ module Snoo
     # @option opts [1..100] :limit Number of results to return
     # @return (see #clear_sessions)
     def get_user_listing username, opts = {}
-      raise ArgumentError, "type is invalid" unless %w{overview submitted commented liked disliked hidden saved}.include?(opts[:type]) or opts[:type].nil?
-      raise ArgumentError, "sort is invalid" unless %w{new hot top controversial}.include?(opts[:sort]) or opts[:type].nil?
-      raise ArgumentError, "limit must be within 1..100; is #{opts[:limit]}" unless (1..100).include?(opts[:limit]) or opts[:limit].nil?
       opts[:type] = 'overview' if opts[:type].nil?
       url = "/user/%s%s.json" % [username, ('/' + opts[:type] if opts[:type] != 'overview')]
       opts.delete :type

data/lib/snoo/version.rb

@@ -1,4 +1,4 @@
 module Snoo
   # The version string (duh)
-  VERSION = "0.0.7"
+  VERSION = "0.1.0.pre.1"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: snoo
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.1.0.pre.1
+  prerelease: 6
 platform: ruby
 authors:
 - Jeff Sandberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-04 00:00:00.000000000 Z
+date: 2012-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -112,9 +112,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24