redditkit 1.0.1 → 1.0.2

data/lib/redditkit/client/wiki.rb

@@ -43,6 +43,8 @@ module RedditKit
       # @option options [String] revision The revision to hide.
       # @return [Boolean] True if the revision is now hidden, false if it is not hidden.
       def hide_wiki_revision(options)
+        options = options.clone
+
         subreddit_name = extract_string(options[:subreddit], :display_name)
         options.delete :subreddit
 
@@ -56,6 +58,8 @@ module RedditKit
       # @option options [String] page The name of an existing wiki page.
       # @option options [String] revision The revision to revert to.
       def revert_to_revision(options)
+        options = options.clone
+
         subreddit_name = extract_string(options[:subreddit], :display_name)
         options.delete :subreddit
 

data/lib/redditkit/comment.rb

@@ -26,8 +26,8 @@ module RedditKit
     attr_reader :subreddit
     attr_reader :subreddit_id
 
-    alias text body
-    alias posted_at created_at
+    alias_method :text, :body
+    alias_method :posted_at, :created_at
 
     # Whether a comment has been deleted by its submitter or a moderator.
     def deleted?
@@ -37,12 +37,12 @@ module RedditKit
     # The replies to a comment.
     def replies
       replies_listing = @attributes[:replies]
-      return Array.new if replies_listing.empty?
+      return [] if replies_listing.blank?
 
       replies_array = replies_listing[:data][:children]
 
       @comment_objects ||= replies_array.map do |comment|
-        RedditKit::Comment.new(comment) 
+        RedditKit::Comment.new(comment)
       end
     end
 

data/lib/redditkit/error.rb

@@ -6,7 +6,7 @@ module RedditKit
 
       def from_status_code_and_body(status_code, body)
         error_value = extract_error_value body
-        return if status_code == 200 and error_value.nil?
+        return if status_code == 200 && error_value.nil?
 
         case status_code
         when 200
@@ -53,7 +53,7 @@ module RedditKit
       def extract_error_value(body)
         return nil unless body.instance_of? Hash
 
-        if body.key?(:json) and body[:json].key?(:errors)
+        if body.key?(:json) && body[:json].key?(:errors)
           body[:json][:errors].to_s
         elsif body.key?(:jquery)
           body[:jquery].to_s
@@ -74,7 +74,7 @@ module RedditKit
 
   # Raised when the user attempts to create a multireddit with an invalid name.
   class InvalidMultiredditName < Error; end
-  
+
   # Raised when reddit returns a 409 status code.
   class Conflict < Error; end
 

data/lib/redditkit/link.rb

@@ -93,18 +93,18 @@ module RedditKit
 
     # Whether the link has been visited by the current user. Requires that the current user have reddit gold.
     attr_reader :visited
-    
-    alias approved? approved_by
-    alias banned? banned_by
-    alias nsfw? over_18
-    alias self_post? is_self
-    alias sticky? stickied
-    alias subreddit_full_name subreddit_id
-    alias text selftext
-    alias text_html selftext_html
-    alias thumbnail_url thumbnail
-    alias total_comments num_comments
-    alias total_reports num_reports
+
+    alias_method :approved?, :approved_by
+    alias_method :banned?, :banned_by
+    alias_method :nsfw?, :over_18
+    alias_method :self_post?, :is_self
+    alias_method :sticky?, :stickied
+    alias_method :subreddit_full_name, :subreddit_id
+    alias_method :text, :selftext
+    alias_method :text_html, :selftext_html
+    alias_method :thumbnail_url, :thumbnail
+    alias_method :total_comments, :num_comments
+    alias_method :total_reports, :num_reports
 
     def title
       @escaped_title ||= HTMLEntities.new.decode(@attributes[:title])
@@ -133,11 +133,11 @@ module RedditKit
     # @return [Boolean]
     def image_link?
       extensions = %w(.png .jpg .jpeg .gif)
-      extensions.any?{ |extension| url.end_with? extension }
+      extensions.any? { |extension| url.end_with? extension }
     end
 
     def permalink
-      @permalink ||= "http://reddit.com/" << @attributes[:permalink]
+      @permalink ||= URI.join('http://www.reddit.com', URI.encode(@attributes[:permalink])).to_s
     end
 
     # Returns the short URL for a link.

data/lib/redditkit/moderator_action.rb

@@ -10,10 +10,10 @@ module RedditKit
     attr_reader :subreddit
     attr_reader :sub_id36
 
-    alias moderator_username mod
-    alias moderator_identifier mod_id36
-    alias subreddit_name subreddit
-    alias subreddit_identifier sub_id36
+    alias_method :moderator_username, :mod
+    alias_method :moderator_identifier, :mod_id36
+    alias_method :subreddit_name, :subreddit
+    alias_method :subreddit_identifier, :sub_id36
 
   end
 end

data/lib/redditkit/multireddit.rb

@@ -12,13 +12,13 @@ module RedditKit
     attr_reader :visibility
     attr_reader :path
 
-    alias editable? can_edit
+    alias_method :editable?, :can_edit
 
     # An array of subreddit display names.
     #
     # @return [Array<String>]
     def subreddits
-      @subreddits ||= @attributes[:subreddits].collect { |subreddit| subreddit[:name] }
+      @subreddits ||= @attributes[:subreddits].map { |subreddit| subreddit[:name] }
     end
 
     # The username of the multireddit's owner.

data/lib/redditkit/multireddit_description.rb

@@ -4,11 +4,11 @@ module RedditKit
 
   # A class representing a multireddit description.
   class MultiredditDescription < RedditKit::Base
-    
+
     attr_reader :body_html
     attr_reader :body_md
 
-    alias text body_md
+    alias_method :text, :body_md
 
   end
 end

data/lib/redditkit/private_message.rb

@@ -21,7 +21,7 @@ module RedditKit
     attr_reader :subreddit
     attr_reader :was_comment
 
-    alias unread? new
-    alias recipient dest
+    alias_method :unread?, :new
+    alias_method :recipient, :dest
   end
 end

data/lib/redditkit/response/parse_json.rb

@@ -20,10 +20,16 @@ module RedditKit
 
       def on_complete(env)
         if respond_to?(:parse)
-          env[:body] = parse(env[:body]) unless [204, 301, 302, 304].include?(env[:status])
+          unless bad_status_codes.include? env[:status]
+            env[:body] = parse env[:body]
+          end
         end
       end
 
+      def bad_status_codes
+        @status_codes ||= [204, 301, 302, 304]
+      end
+
     end
   end
 end

data/lib/redditkit/response/raise_error.rb

@@ -5,17 +5,16 @@ module RedditKit
 
   # Methods for handling responses from reddit.
   module Response
-    class RaiseError < Faraday::Response::Middleware
 
+    # Middleware for detecting errors from response codes and bodies.
+    class RaiseError < Faraday::Response::Middleware
       def on_complete(env)
         status_code = env[:status]
         body = env[:body]
 
-        if error = RedditKit::Error.from_status_code_and_body(status_code, body)
-          raise error
-        end
+        error = RedditKit::Error.from_status_code_and_body(status_code, body)
+        fail error if error
       end
-
     end
   end
 end

data/lib/redditkit/subreddit.rb

@@ -72,15 +72,18 @@ module RedditKit
     # Whether the current user is a subscriber to the subreddit.
     attr_reader :user_is_subscriber
 
-    alias banned? user_is_banned
-    alias comment_spam_filter_strength spam_comments
-    alias contributor? user_is_contributor
-    alias link_spam_filter_strength spam_links
-    alias moderator? user_is_moderator
-    alias name display_name
-    alias nsfw? over18
-    alias self_post_spam_filter_strength spam_selfpost
-    alias subscriber? user_is_subscriber
-
+    alias_method :banned?, :user_is_banned
+    alias_method :comment_spam_filter_strength, :spam_comments
+    alias_method :contributor?, :user_is_contributor
+    alias_method :link_spam_filter_strength, :spam_links
+    alias_method :moderator?, :user_is_moderator
+    alias_method :name, :display_name
+    alias_method :nsfw?, :over18
+    alias_method :self_post_spam_filter_strength, :spam_selfpost
+    alias_method :subscriber?, :user_is_subscriber
+
+    def uri
+      @uri ||= URI.join "http://www.reddit.com/r/", name
+    end
   end
 end

data/lib/redditkit/thing.rb

@@ -9,6 +9,7 @@ module RedditKit
     attr_reader :kind
 
     def ==(other)
+      return false unless other.is_a?(Thing)
       full_name == other.full_name
     end
 

data/lib/redditkit/user.rb

@@ -18,13 +18,17 @@ module RedditKit
     attr_reader :is_mod
     attr_reader :over_18
 
-    alias friend? is_friend
-    alias gold? is_gold
-    alias mail? has_mail
-    alias mod? is_mod
-    alias mod_mail? has_mod_mail
-    alias over_18? over_18
-    alias username name
-    alias verified? has_verified_email
+    alias_method :friend?, :is_friend
+    alias_method :gold?, :is_gold
+    alias_method :mail?, :has_mail
+    alias_method :mod?, :is_mod
+    alias_method :mod_mail?, :has_mod_mail
+    alias_method :over_18?, :over_18
+    alias_method :username, :name
+    alias_method :verified?, :has_verified_email
+
+    def uri
+      @uri ||= URI.join "http://www.reddit.com/user/", username
+    end
   end
 end

data/lib/redditkit/version.rb

@@ -4,16 +4,12 @@ module RedditKit
   class Version
     MAJOR = 1
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
 
     class << self
-
-      # Return RedditKit.rb's version number as a string.
       def to_s
         [MAJOR, MINOR, PATCH].join('.')
       end
-
     end
-
   end
 end

data/lib/redditkit/votable.rb

@@ -2,7 +2,7 @@ module RedditKit
 
   # Methods which determine the voting status of objects.
   module Votable
-    
+
     # The number of upvotes an item has.
     def upvotes
       @attributes[:ups]
@@ -30,7 +30,7 @@ module RedditKit
 
     # Whether the user has voted on this item (either upvoted or downvoted).
     def voted?
-      !@attributes[:likes].nil? 
+      !@attributes[:likes].nil?
     end
 
   end

data/redditkit.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'htmlentities', "~> 4.3"
   spec.add_dependency 'multi_json', '~> 1.8'
 
-  spec.add_development_dependency 'dotenv', '~> 0.9', '>= 0.9.0'
+  spec.add_development_dependency 'dotenv', '~> 0.11'
 end

data/spec/cassettes/RedditKit_Client_Flair/_flair_list/returns_the_list_of_flair.yml

@@ -16,7 +16,7 @@ http_interactions:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - "*/*"
+      - '*/*'
   response:
     status:
       code: 200
@@ -31,14 +31,61 @@ http_interactions:
       Pragma:
       - no-cache
       Server:
-      - "'; DROP TABLE servertypes; --"
+      - '''; DROP TABLE servertypes; --'
       Date:
       - Sun, 10 Nov 2013 19:56:32 GMT
       Connection:
       - keep-alive
     body:
       encoding: UTF-8
-      string: "{\"users\": []}"
+      string: '{"users": []}'
     http_version: 
   recorded_at: Sun, 10 Nov 2013 19:56:31 GMT
-recorded_with: VCR 2.6.0
+- request:
+    method: get
+    uri: http://www.reddit.com/r/<REDDIT_USERNAME>_testsub/api/flairlist.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Cookie:
+      - reddit_session=20332937,2013-11-10T11:35:59,2077074c26ccd8ec123c996b77eeb7afb6090af9
+      X-Modhash:
+      - 36zuxndsdf695692a68e32384990478663dadfc30f0a1dd959
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Content-Length:
+      - '14'
+      Content-Type:
+      - application/json; charset=UTF-8
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Server:
+      - '''; DROP TABLE servertypes; --'
+      Date:
+      - Wed, 29 Jan 2014 23:31:47 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"error": 403}'
+    http_version: 
+  recorded_at: Wed, 29 Jan 2014 23:30:32 GMT
+recorded_with: VCR 2.8.0

data/spec/cassettes/RedditKit_Client_Moderation/_ban/requests_the_correct_resource.yml

@@ -16,7 +16,7 @@ http_interactions:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - "*/*"
+      - '*/*'
   response:
     status:
       code: 200
@@ -31,24 +31,24 @@ http_interactions:
       Pragma:
       - no-cache
       Server:
-      - "'; DROP TABLE servertypes; --"
+      - '''; DROP TABLE servertypes; --'
       Date:
       - Sun, 10 Nov 2013 22:21:38 GMT
       Connection:
       - keep-alive
     body:
       encoding: UTF-8
-      string: "{\"kind\": \"t5\", \"data\": {\"submit_text_html\": null, \"user_is_banned\":
-        false, \"id\": \"2ylc5\", \"submit_text\": \"\", \"spam_selfposts\": null,
-        \"display_name\": \"RedditKitTesting\", \"header_img\": null, \"description_html\":
-        null, \"title\": \"RedditKit Testing\", \"over18\": false, \"user_is_moderator\":
-        true, \"header_title\": null, \"description\": \"\", \"submit_link_label\":
-        null, \"accounts_active\": 6, \"spam_comments\": null, \"spam_links\": null,
-        \"header_size\": null, \"subscribers\": 1, \"submit_text_label\": null, \"name\":
-        \"t5_2ylc5\", \"created\": 1379988259.0, \"url\": \"/r/RedditKitTesting/\",
-        \"created_utc\": 1379984659.0, \"user_is_contributor\": false, \"public_traffic\":
-        false, \"public_description\": \"\", \"comment_score_hide_mins\": 0, \"subreddit_type\":
-        \"public\", \"submission_type\": \"any\", \"user_is_subscriber\": false}}"
+      string: '{"kind": "t5", "data": {"submit_text_html": null, "user_is_banned":
+        false, "id": "2ylc5", "submit_text": "", "spam_selfposts": null, "display_name":
+        "RedditKitTesting", "header_img": null, "description_html": null, "title":
+        "RedditKit Testing", "over18": false, "user_is_moderator": true, "header_title":
+        null, "description": "", "submit_link_label": null, "accounts_active": 6,
+        "spam_comments": null, "spam_links": null, "header_size": null, "subscribers":
+        1, "submit_text_label": null, "name": "t5_2ylc5", "created": 1379988259.0,
+        "url": "/r/RedditKitTesting/", "created_utc": 1379984659.0, "user_is_contributor":
+        false, "public_traffic": false, "public_description": "", "comment_score_hide_mins":
+        0, "subreddit_type": "public", "submission_type": "any", "user_is_subscriber":
+        false}}'
     http_version: 
   recorded_at: Sun, 10 Nov 2013 22:21:37 GMT
 - request:
@@ -69,7 +69,7 @@ http_interactions:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
-      - "*/*"
+      - '*/*'
   response:
     status:
       code: 200
@@ -84,20 +84,67 @@ http_interactions:
       Pragma:
       - no-cache
       Server:
-      - "'; DROP TABLE servertypes; --"
+      - '''; DROP TABLE servertypes; --'
       Date:
       - Sun, 10 Nov 2013 22:21:38 GMT
       Connection:
       - keep-alive
     body:
       encoding: UTF-8
-      string: "{\"jquery\": [[0, 1, \"call\", [\"body\"]], [1, 2, \"attr\", \"find\"],
-        [2, 3, \"call\", [\".status\"]], [3, 4, \"attr\", \"hide\"], [4, 5, \"call\",
-        []], [5, 6, \"attr\", \"html\"], [6, 7, \"call\", [\"\"]], [7, 8, \"attr\",
-        \"end\"], [8, 9, \"call\", []], [1, 10, \"attr\", \"find\"], [10, 11, \"call\",
-        [\".error.NO_USER.field-name\"]], [11, 12, \"attr\", \"show\"], [12, 13, \"call\",
-        []], [13, 14, \"attr\", \"text\"], [14, 15, \"call\", [\"please enter a username\"]],
-        [15, 16, \"attr\", \"end\"], [16, 17, \"call\", []]]}"
+      string: '{"jquery": [[0, 1, "call", ["body"]], [1, 2, "attr", "find"], [2, 3,
+        "call", [".status"]], [3, 4, "attr", "hide"], [4, 5, "call", []], [5, 6, "attr",
+        "html"], [6, 7, "call", [""]], [7, 8, "attr", "end"], [8, 9, "call", []],
+        [1, 10, "attr", "find"], [10, 11, "call", [".error.NO_USER.field-name"]],
+        [11, 12, "attr", "show"], [12, 13, "call", []], [13, 14, "attr", "text"],
+        [14, 15, "call", ["please enter a username"]], [15, 16, "attr", "end"], [16,
+        17, "call", []]]}'
     http_version: 
   recorded_at: Sun, 10 Nov 2013 22:21:37 GMT
-recorded_with: VCR 2.6.0
+- request:
+    method: get
+    uri: http://www.reddit.com/r/<REDDIT_USERNAME>_testsub/about.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.8
+      Cookie:
+      - reddit_session=20332937,2013-11-10T11:35:59,2077074c26ccd8ec123c996b77eeb7afb6090af9
+      X-Modhash:
+      - 36zuxndsdf695692a68e32384990478663dadfc30f0a1dd959
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Content-Length:
+      - '14'
+      Content-Type:
+      - application/json; charset=UTF-8
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block
+      Server:
+      - '''; DROP TABLE servertypes; --'
+      Date:
+      - Wed, 29 Jan 2014 23:31:48 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"error": 403}'
+    http_version: 
+  recorded_at: Wed, 29 Jan 2014 23:30:33 GMT
+recorded_with: VCR 2.8.0