snoo 0.1.0.pre.8 → 0.1.0

data/README.md

@@ -53,11 +53,6 @@ See the [docs](http://rubydoc.info/github/paradox460/snoo/) for more info.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## Testing
-
-1. Edit `spec/auth.rb` and fill out all the globals with a test user account and test reddit
-2. Run rspec
-
 ## License
 
 ```

data/lib/snoo/account.rb

@@ -49,7 +49,7 @@ module Snoo
     # @return (see #log_in)
     def clear_sessions password
       logged_in?
-      clear = post('/api/clear_sessions', body: { curpass: password, dest: @baseurl, uh: @modhash })
+      clear = post('/api/clear_sessions', body: { curpass: password, dest: @baseurl, uh: @modhash, api_type: 'json' })
       set_cookies clear.headers['set-cookie']
       return clear
     end
@@ -67,7 +67,8 @@ module Snoo
         delete_message: reason,
         passwd: password,
         uh: @modhash,
-        user: @username
+        user: @username,
+        api_type: 'json'
         })
       return delete
     end
@@ -93,7 +94,8 @@ module Snoo
         newpass: newPass,
         uh: @modhash,
         verify: true,
-        verpass: newPass
+        verpass: newPass,
+        api_type: 'json'
         }
       params[:email] = email if email
       update = post('/api/update', body: params )

data/lib/snoo/flair.rb

@@ -12,7 +12,7 @@ module Snoo
     # @return (see #clear_sessions)
     def clear_flair_templates type, subreddit
       logged_in?
-      post('/api/clearflairtemplates', body: { flair_type: type, r: subreddit, uh: @modhash})
+      post('/api/clearflairtemplates', body: { flair_type: type, r: subreddit, uh: @modhash, api_type: 'json'})
     end
 
     # Deletes a user's flair
@@ -22,16 +22,16 @@ module Snoo
     # @return (see #clear_sessions)
     def delete_user_flair user, subreddit
       logged_in?
-      post('/api/deleteflair', body: {name: user, r: subreddit, uh: @modhash})
+      post('/api/deleteflair', body: {name: user, r: subreddit, uh: @modhash, api_type: 'json'})
     end
 
     # Deletes a flair template by ID.
     #
-    # @param id [String] The flair template's ID to delete. Get this from {#flair_template_list}
+    # @param id [String] The flair template's ID to delete.
     # @param subreddit [String] The subreddit targeted.
     def delete_flair_template id, subreddit
       logged_in?
-      post('/api/deleteflairtemplate', body: {flair_template_id: id, r: subreddit, uh: @modhash})
+      post('/api/deleteflairtemplate', body: {flair_template_id: id, r: subreddit, uh: @modhash, api_type: 'json'})
     end
 
     # Sets flair on a thing, currently supports links and users. Must specify **either** link *or* user, **not** both
@@ -48,6 +48,7 @@ module Snoo
       params = {
         r: subreddit,
         uh: @modhash,
+        api_type: 'json'
       }
       params.merge! opts
 
@@ -73,7 +74,8 @@ module Snoo
         link_flair_position: 'right',
         link_flair_self_assign_enabled: false,
         uh: @modhash,
-        r: subreddit
+        r: subreddit,
+        api_type: 'json'
       }
       options.merge! opts
 
@@ -124,7 +126,8 @@ module Snoo
         flair_type: 'USER_FLAIR',
         text_editable: false,
         uh: @modhash,
-        r: subreddit
+        r: subreddit,
+        api_type: 'json'
       }
       params.merge! opts
 
@@ -133,7 +136,7 @@ module Snoo
 
     # Select a flair template and apply it to a user or link
     #
-    # @param template_id [String] The template id to apply. Get this from {#flair_template_list}
+    # @param template_id [String] The template id to apply.
     # @param subreddit [String] The subreddit targeted.
     # @param (see LinksComments#info)
     # @option opts [String] :link The link id to apply to
@@ -145,7 +148,8 @@ module Snoo
       params = {
         flair_template_id: template_id,
         uh: @modhash,
-        r: subreddit
+        r: subreddit,
+        api_type: 'json'
       }
       params.merge! opts
       post('/api/selectflair', body: params)
@@ -158,12 +162,12 @@ module Snoo
     # @return (see #clear_sessions)
     def flair_toggle enabled, subreddit
       logged_in?
-      post('/api/setflairenabled', body: {flair_enabled: enabled, uh: @modhash, r: subreddit})
+      post('/api/setflairenabled', body: {flair_enabled: enabled, uh: @modhash, r: subreddit, api_type: 'json'})
     end
 
     # @todo implement this.
     #   it will probably require nokogiri and some trickery.
-    def flair_template_list
-    end
+    # def flair_template_list
+    # end
   end
 end

data/lib/snoo/links_comments.rb

@@ -11,7 +11,7 @@ module Snoo
     # @return (see #clear_sessions)
     def comment text, id
       logged_in?
-      post('/api/comment', body: { text: text, thing_id: id, uh: @modhash})
+      post('/api/comment', body: { text: text, thing_id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Deletes a thing from the site
@@ -20,7 +20,7 @@ module Snoo
     # @return (see #clear_sessions)
     def delete id
       logged_in?
-      post('/api/del', body: { id: id, uh: @modhash })
+      post('/api/del', body: { id: id, uh: @modhash, api_type: 'json' })
     end
 
     # Edits a thing.
@@ -30,7 +30,7 @@ module Snoo
     # @return (see #clear_sessions)
     def edit text, id
       logged_in?
-      post('/api/editusertext', body: {text: text, thing_id: id, uh: @modhash})
+      post('/api/editusertext', body: {text: text, thing_id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Hides a thing
@@ -39,7 +39,7 @@ module Snoo
     # @return (see #clear_sessions)
     def hide id
       logged_in?
-      post('/api/hide', body: {id: id, uh: @modhash})
+      post('/api/hide', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Get a listing of things which have the provided URL.
@@ -63,7 +63,7 @@ module Snoo
     # @return (see #clear_sessions)
     def mark_nsfw id
       logged_in?
-      post('/api/marknsfw', body: {id: id, uh: @modhash})
+      post('/api/marknsfw', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Reports a comment or link
@@ -72,7 +72,7 @@ module Snoo
     # @reutrn (see #comment)
     def report id
       logged_in?
-      post('/api/report', body: {id: id, uh: @modhash})
+      post('/api/report', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Saves a link
@@ -81,7 +81,7 @@ module Snoo
     # @return (see #clear_sessions)
     def save id
       logged_in?
-      post('/api/save', body: { id: id, uh: @modhash})
+      post('/api/save', body: { id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Submit a link or self post
@@ -98,7 +98,8 @@ module Snoo
         title: title,
         sr: subreddit,
         uh: @modhash,
-        kind: (opts[:url] ? "link" : "self")
+        kind: (opts[:url] ? "link" : "self"),
+        api_type: 'json'
       }
       post.merge! opts
       post('/api/submit', body: post)
@@ -110,7 +111,7 @@ module Snoo
     # @return (see #clear_sessions)
     def unhide id
       logged_in?
-      post('/api/unhide', body: {id: id, uh: @modhash})
+      post('/api/unhide', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Un-mark NSFW a thing.
@@ -119,7 +120,7 @@ module Snoo
     # @return (see #clear_sessions)
     def unmark_nsfw id
       logged_in?
-      post('/api/unmarknsfw', body: {id: id, uh: @modhash})
+      post('/api/unmarknsfw', body: {id: id, uh: @modhash, api_type: 'json'})
     end
     alias_method :mark_sfw, :unmark_nsfw
 
@@ -130,7 +131,7 @@ module Snoo
     # @return (see #clear_sessions)
     def vote direction, id
       logged_in?
-      post('/api/vote', body: {id: id, dir: direction, uh: @modhash})
+      post('/api/vote', body: {id: id, dir: direction, uh: @modhash, api_type: 'json'})
     end
 
     # Upvote

data/lib/snoo/listings.rb

@@ -6,7 +6,6 @@ module Snoo
 
     # Get a comment listing from the site
     #
-    # @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
@@ -57,11 +56,6 @@ module Snoo
     # @option opts [cloudsearch, lucene] :syntax The search syntax.
     # @return (see #clear_sessions)
     def search query, opts = {}
-      raise ArgumentError, 'restrict_subreddit needs to be boolean' unless [true, false].include?(opts[:restrict_sr]) or opts[:restrict_sr].nil?
-      raise ArgumentError, "limit needs to be 1..100, is #{opts[:limit]}" unless (1..100).include?(opts[:limit]) or opts[:limit].nil?
-      raise ArgumentError, "sort needs to be one of relevance, new, top, is #{opts[:sort]}" unless %w{relevance new top}.include?(opts[:sort]) or opts[:sort].nil?
-      raise ArgumentError, "syntax needs to be one of cloudsearch, lucene; is #{opts[:syntax]}" if %w{cloudsearch lucene}.include?(opts[:syntax])
-
       # This supports searches with and without a subreddit
       url = "%s/search.json" % ('/r/' + opts[:subreddit] if opts[:subreddit])
 

data/lib/snoo/moderation.rb

@@ -10,7 +10,7 @@ module Snoo
     # @return (see #clear_sessions)
     def approve id
       logged_in?
-      post('/api/approve', body: {id: id, uh: @modhash})
+      post('/api/approve', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Distinguish a thing
@@ -21,7 +21,7 @@ module Snoo
     def distinguish id, how = "yes"
       logged_in?
       hows = %w{yes no admin special}
-      post('/api/distinguish', body: {id: id, how: how, uh: @modhash})
+      post('/api/distinguish', body: {id: id, how: how, uh: @modhash, api_type: 'json'})
     end
 
     # Removes you from a subreddits list of contributors
@@ -31,7 +31,7 @@ module Snoo
     # @return (see #clear_sessions)
     def leave_contributor id
       logged_in?
-      post('/api/leavecontributor', body: {id: id, uh: @modhash})
+      post('/api/leavecontributor', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Removes you from a subreddits moderators
@@ -41,7 +41,7 @@ module Snoo
     # @return (see #clear_sessions)
     def leave_moderator id
       logged_in?
-      post('/api/leavemoderator', body: {id: id, uh: @modhash})
+      post('/api/leavemoderator', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Removes a thing
@@ -51,7 +51,7 @@ module Snoo
     # @return (see #clear_sessions)
     def remove id, spam = false
       logged_in?
-      post('/api/remove', body: {id: id, spam: spam, uh: @modhash})
+      post('/api/remove', body: {id: id, spam: spam, uh: @modhash, api_type: 'json'})
     end
 
     # Gets a moderation log

data/lib/snoo/pms.rb

@@ -10,7 +10,7 @@ module Snoo
     # @return (see #clear_sessions)
     def block_pm id
       logged_in?
-      post('/api/block', body: {id: id, uh: @modhash})
+      post('/api/block', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Send a private message
@@ -22,7 +22,7 @@ module Snoo
     # @return (see #clear_sessions)
     def send_pm to, subject, text
       logged_in?
-      post('/api/compose.json', body: {to: to, subject: subject, text: text, uh: @modhash})
+      post('/api/compose.json', body: {to: to, subject: subject, text: text, uh: @modhash, api_type: 'json'})
     end
 
     # Mark a PM as read
@@ -31,7 +31,7 @@ module Snoo
     # @return (see #clear_sessions)
     def mark_read id
       logged_in?
-      post('/api/read_message', body: {id: id, uh: @modhash})
+      post('/api/read_message', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Mark a PM as unread
@@ -40,7 +40,7 @@ module Snoo
     # @return (see #clear_sessions)
     def mark_unread id
       logged_in?
-      post('/api/unread_message', body: {id: id, uh: @modhash})
+      post('/api/unread_message', body: {id: id, uh: @modhash, api_type: 'json'})
     end
 
     # Gets a listing of PMs

data/lib/snoo/subreddits.rb

@@ -10,7 +10,7 @@ module Snoo
     # @return (see #clear_sessions)
     def delete_header subreddit
       logged_in?
-      post('/api/delete_sr_header', body: {r: subreddit, uh: @modhash})
+      post('/api/delete_sr_header', body: {r: subreddit, uh: @modhash, api_type: 'json'})
     end
 
     # Deletes an image from a subreddit. This is for css, not removing posts
@@ -20,7 +20,7 @@ module Snoo
     # @return (see #clear_sessions)
     def delete_image subreddit, image_name
       logged_in?
-      post('/api/delete_sr_image', body: {r: subreddit, img_name: image_name, uh: @modhash})
+      post('/api/delete_sr_image', body: {r: subreddit, img_name: image_name, uh: @modhash, api_type: 'json'})
     end
 
     # Gets a hash of the subreddit settings
@@ -58,6 +58,7 @@ module Snoo
         allow_top: true,
         show_media: true,
         over_18: false,
+        api_type: 'json'
       }
       params.merge! opts
       post('/api/site_admin', body: params)
@@ -70,7 +71,7 @@ module Snoo
     # @return (see #clear_sessions)
     def set_stylesheet stylesheet, subreddit
       logged_in?
-      post('/api/subreddit_stylesheet', body: {op: 'save', r: subreddit, stylesheet_contents: stylesheet, uh: @modhash})
+      post('/api/subreddit_stylesheet', body: {op: 'save', r: subreddit, stylesheet_contents: stylesheet, uh: @modhash, api_type: 'json'})
     end
 
     # Subscribe to a subreddit
@@ -80,7 +81,7 @@ module Snoo
     # @return (see #clear_sessions)
     def subscribe subreddit, action = "sub"
       logged_in?
-      post('/api/subscribe', body: {action: action, sr: subreddit, uh: @modhash})
+      post('/api/subscribe', body: {action: action, sr: subreddit, uh: @modhash, api_type: 'json'})
     end
 
     # Unsubscribe from a subreddit
@@ -184,7 +185,6 @@ module Snoo
 
     # Remove a moderator from a subreddit
     #
-    # @param id [String] The user id
     # @param (see #add_moderator)
     # @return (see #clear_sessions)
     def remove_moderator container, user, subreddit
@@ -238,7 +238,7 @@ module Snoo
     # @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})
+      post('/api/accept_moderator_invite', body: {r: subreddit, uh: @modhash, api_type: 'json'})
     end
   end
 end

data/lib/snoo/utilities.rb

@@ -41,12 +41,12 @@ module Snoo
       # @param opts [Hash] an options hash
       # @option opts [String] :type The type of action to add.
       # @option opts [String] :container The id of the containing user/object/thing
-      # @options opt [String] :note The reddit gold user node
+      # @option opt [String] :note The reddit gold user node
       # @option opts [String] :name The name of a reddit user
       # @return [HTTParty::Response] The response object.
       def friend_wrapper opts = {}
         logged_in?
-        params = {uh: @modhash}
+        params = {uh: @modhash, api_type: 'json'}
         params.merge! opts
         post('/api/friend', body: params)
       end
@@ -60,7 +60,7 @@ module Snoo
       # @return (see #friend_wrapper)
       def unfriend_wrapper opts = {}
         logged_in?
-        params = { uh: @modhash}
+        params = { uh: @modhash, api_type: 'json'}
         params.merge! opts
         post('/api/unfriend', body: params)
       end

data/lib/snoo/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: snoo
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.8
-  prerelease: 6
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Jeff Sandberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-24 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: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23