redd 0.7.8 → 0.7.9

data/lib/redd/clients/base/account.rb

@@ -1,20 +1,20 @@
-module Redd
-  module Clients
-    class Base
-      # Methods that require the "account" scope
-      module Account
-        # Edit some user preferences
-        # @param [Hash] changed_prefs The preferences to override.
-        # @return [Objects::Base] A Hashie-style container of the new prefs.
-        # @see https://www.reddit.com/dev/api/oauth#PATCH_api_v1_me_prefs
-        def edit_my_prefs(changed_prefs)
-          response = connection.patch do |req|
-            req.url "/api/v1/me/prefs"
-            req.body = MultiJson.dump(changed_prefs)
-          end
-          Objects::Base.new(self, response.body)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Clients
+    class Base
+      # Methods that require the "account" scope
+      module Account
+        # Edit some user preferences
+        # @param [Hash] changed_prefs The preferences to override.
+        # @return [Objects::Base] A Hashie-style container of the new prefs.
+        # @see https://www.reddit.com/dev/api/oauth#PATCH_api_v1_me_prefs
+        def edit_my_prefs(changed_prefs)
+          response = connection.patch do |req|
+            req.url "/api/v1/me/prefs"
+            req.body = MultiJson.dump(changed_prefs)
+          end
+          Objects::Base.new(self, response.body)
+        end
+      end
+    end
+  end
+end

data/lib/redd/clients/base/identity.rb

@@ -1,22 +1,22 @@
-module Redd
-  module Clients
-    class Base
-      # Methods that require the "identity" scope
-      module Identity
-        # @return [Objects::User] The logged-in user.
-        def me
-          response = get("/api/v1/me")
-          object_from_body(kind: "t2", data: response.body)
-        end
-
-        # @return [Objects::Base] Your current preferences.
-        # @see https://www.reddit.com/dev/api/oauth#GET_api_v1_me_prefs
-        def my_prefs
-          response = get("/api/v1/me/prefs")
-          # Basically an uneditable mashie.
-          Objects::Base.new(self, response.body)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Clients
+    class Base
+      # Methods that require the "identity" scope
+      module Identity
+        # @return [Objects::User] The logged-in user.
+        def me
+          response = get("/api/v1/me")
+          object_from_body(kind: "t2", data: response.body)
+        end
+
+        # @return [Objects::Base] Your current preferences.
+        # @see https://www.reddit.com/dev/api/oauth#GET_api_v1_me_prefs
+        def my_prefs
+          response = get("/api/v1/me/prefs")
+          # Basically an uneditable mashie.
+          Objects::Base.new(self, response.body)
+        end
+      end
+    end
+  end
+end

data/lib/redd/clients/base/none.rb

@@ -1,27 +1,27 @@
-module Redd
-  module Clients
-    class Base
-      # Methods that don't require any scope.
-      module None
-        # @return [Boolean] Whether a captcha is required for some API methods.
-        def needs_captcha?
-          get("/api/needs_captcha.json").body
-        end
-
-        # Create a new captcha identifier.
-        # @return [String] The identifier.
-        # @todo Maybe create some kind of set_captcha!(...) method for the
-        #   client to send automatically with the next response.
-        def new_captcha
-          post("/api/new_captcha").body[:json][:data][:iden]
-        end
-
-        # @param iden [String] The captcha identifier.
-        # @return The url for the captcha image.
-        def captcha_url(iden)
-          "http://www.reddit.com/captcha/#{iden}.png"
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Clients
+    class Base
+      # Methods that don't require any scope.
+      module None
+        # @return [Boolean] Whether a captcha is required for some API methods.
+        def needs_captcha?
+          get("/api/needs_captcha.json").body
+        end
+
+        # Create a new captcha identifier.
+        # @return [String] The identifier.
+        # @todo Maybe create some kind of set_captcha!(...) method for the
+        #   client to send automatically with the next response.
+        def new_captcha
+          post("/api/new_captcha").body[:json][:data][:iden]
+        end
+
+        # @param iden [String] The captcha identifier.
+        # @return The url for the captcha image.
+        def captcha_url(iden)
+          "http://www.reddit.com/captcha/#{iden}.png"
+        end
+      end
+    end
+  end
+end

data/lib/redd/clients/base/privatemessages.rb

@@ -1,33 +1,33 @@
-module Redd
-  module Clients
-    class Base
-      # Methods that require the "privatemessages" scope
-      module Privatemessages
-        # Return a listing of a user's private messages.
-        #
-        # @param category ["inbox", "unread", "sent"] The category of messages
-        #   to view.
-        # @param mark [Boolean] Whether to remove the orangered from the
-        #   user's inbox.
-        # @param params [Hash] A list of params to send with the request.
-        # @option params [String] :after Return results after the given
-        #   fullname.
-        # @option params [String] :before Return results before the given
-        #   fullname.
-        # @option params [Integer] :count (0) The number of items already seen
-        #   in the listing.
-        # @option params [1..100] :limit (25) The maximum number of things to
-        #   return.
-        def my_messages(category = "inbox", mark = false, params = {})
-          params[:mark] = mark
-          request_object(:get, "/message/#{category}.json", params)
-        end
-
-        # Mark all messages as read.
-        def read_all_messages
-          post("/api/read_all_messages")
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Clients
+    class Base
+      # Methods that require the "privatemessages" scope
+      module Privatemessages
+        # Return a listing of a user's private messages.
+        #
+        # @param category ["inbox", "unread", "sent"] The category of messages
+        #   to view.
+        # @param mark [Boolean] Whether to remove the orangered from the
+        #   user's inbox.
+        # @param params [Hash] A list of params to send with the request.
+        # @option params [String] :after Return results after the given
+        #   fullname.
+        # @option params [String] :before Return results before the given
+        #   fullname.
+        # @option params [Integer] :count (0) The number of items already seen
+        #   in the listing.
+        # @option params [1..100] :limit (25) The maximum number of things to
+        #   return.
+        def my_messages(category = "inbox", mark = false, params = {})
+          params[:mark] = mark
+          request_object(:get, "/message/#{category}.json", params)
+        end
+
+        # Mark all messages as read.
+        def read_all_messages
+          post("/api/read_all_messages")
+        end
+      end
+    end
+  end
+end

data/lib/redd/clients/base/read.rb

@@ -1,113 +1,113 @@
-module Redd
-  module Clients
-    class Base
-      # Methods that require the "read" scope
-      module Read
-        # @param [Array<String>] fnames A list of fullnames.
-        # @return [Objects::Listing<Objects::Thing>] A listing of things with
-        #   the fullname.
-        def from_fullname(*fnames)
-          names = fnames.join(",")
-          request_object(:get, "/api/info", id: names)
-        end
-
-        # @param [String] url The url of the thing.
-        # @return [Objects::Thing] The thing.
-        def from_url(url)
-          request_object(:get, "/api/info", url: url).first
-        end
-
-        # @param [String] name The username.
-        # @return [Objects::User] The user.
-        def user_from_name(name)
-          request_object(:get, "/user/#{name}/about.json")
-        end
-
-        # @param [String] name The subreddit's display name.
-        # @return [Objects::Subreddit] The subreddit if found.
-        def subreddit_from_name(name)
-          request_object(:get, "/r/#{name}/about.json")
-        end
-
-        # Fetch a list of multis belonging to the user.
-        def my_multis
-          multis = get("/api/multi/mine").body
-          multis.map { |thing| object_from_body(thing) }
-        end
-
-        # Fetch an individual multi from its path.
-        # @param [String] path The multi's path.
-        # @return [Objects::LabeledMulti]
-        def multi_from_path(path)
-          without_slash = path.gsub(/^\//, "")
-          request_object(:get, "/api/multi/" + without_slash)
-        end
-
-        # @!method get_hot(subreddit = nil, **params)
-        # @!method get_new(subreddit = nil, **params)
-        # @!method get_top(subreddit = nil, **params)
-        # @!method get_controversial(subreddit = nil, **params)
-        # @!method get_comments(subreddit = nil, **params)
-        #
-        # Get the appropriate listing.
-        # @param subreddit [Objects::Subreddit, String] The subreddit to query.
-        # @param params [Hash] A list of params to send with the request.
-        # @option params [String] :after Return results after the given
-        #   fullname.
-        # @option params [String :before Return results before the given
-        #   fullname.
-        # @option params [Integer] :count The number of items already seen in
-        #   the listing.
-        # @option params [1..100] :limit The maximum number of things to
-        #   return.
-        # @option params [:hour, :day, :week, :month, :year, :all] :t The
-        #   time period to consider when sorting.
-        #
-        # @note The option :t only applies to the top and controversial sorts.
-        # @return [Objects::Listing<Objects::Thing>]
-        # @todo Move all listing methods into a helper?
-        %w(hot new top controversial comments).each do |sort|
-          define_method :"get_#{sort}" do |subreddit = nil, **params|
-            srname = property(subreddit, :display_name) if subreddit
-            path = "/#{sort}.json"
-            path = path.prepend("/r/#{srname}") if subreddit
-            request_object(:get, path, params)
-          end
-        end
-
-        # Search.
-        # @param query [String] The query string.
-        # @param subreddit [Objects::Subreddit, String] The subreddit to query.
-        # @param params [Hash] A list of params to send with the request.
-        # @option params [String] :after Return results after the given
-        #   fullname.
-        # @option params [String] :before Return results before the given
-        #   fullname.
-        # @option params [Integer] :count The number of items already seen in
-        #   the listing.
-        # @option params [1..100] :limit The maximum number of things to
-        #   return.
-        # @option params [:cloudsearch, :lucene, :plain] :syntax The type of
-        #   syntax to use.
-        # @option params [:relevance, :new, :hot, :top, :comments] :sort The
-        #   way to sort the results.
-        # @option params [:hour, :day, :week, :month, :year, :all] :t The
-        #   time period to consider when sorting.
-        #
-        # @note The option :t only applies to the top and controversial sorts.
-        # @return [Objects::Listing<Objects::Thing>]
-        def search(query, subreddit = nil, **params)
-          path = "/search.json"
-          params[:q] = query
-          if subreddit
-            params[:restrict_sr] = true
-            srname = property(subreddit, :display_name)
-            path = path.prepend("/r/#{srname}")
-          end
-
-          request_object(:get, path, params)
-        end
-      end
-    end
-  end
-end
+module Redd
+  module Clients
+    class Base
+      # Methods that require the "read" scope
+      module Read
+        # @param [Array<String>] fnames A list of fullnames.
+        # @return [Objects::Listing<Objects::Thing>] A listing of things with
+        #   the fullname.
+        def from_fullname(*fnames)
+          names = fnames.join(",")
+          request_object(:get, "/api/info", id: names)
+        end
+
+        # @param [String] url The url of the thing.
+        # @return [Objects::Thing] The thing.
+        def from_url(url)
+          request_object(:get, "/api/info", url: url).first
+        end
+
+        # @param [String] name The username.
+        # @return [Objects::User] The user.
+        def user_from_name(name)
+          request_object(:get, "/user/#{name}/about.json")
+        end
+
+        # @param [String] name The subreddit's display name.
+        # @return [Objects::Subreddit] The subreddit if found.
+        def subreddit_from_name(name)
+          request_object(:get, "/r/#{name}/about.json")
+        end
+
+        # Fetch a list of multis belonging to the user.
+        def my_multis
+          multis = get("/api/multi/mine").body
+          multis.map { |thing| object_from_body(thing) }
+        end
+
+        # Fetch an individual multi from its path.
+        # @param [String] path The multi's path.
+        # @return [Objects::LabeledMulti]
+        def multi_from_path(path)
+          without_slash = path.gsub(/^\//, "")
+          request_object(:get, "/api/multi/" + without_slash)
+        end
+
+        # @!method get_hot(subreddit = nil, **params)
+        # @!method get_new(subreddit = nil, **params)
+        # @!method get_top(subreddit = nil, **params)
+        # @!method get_controversial(subreddit = nil, **params)
+        # @!method get_comments(subreddit = nil, **params)
+        #
+        # Get the appropriate listing.
+        # @param subreddit [Objects::Subreddit, String] The subreddit to query.
+        # @param params [Hash] A list of params to send with the request.
+        # @option params [String] :after Return results after the given
+        #   fullname.
+        # @option params [String :before Return results before the given
+        #   fullname.
+        # @option params [Integer] :count The number of items already seen in
+        #   the listing.
+        # @option params [1..100] :limit The maximum number of things to
+        #   return.
+        # @option params [:hour, :day, :week, :month, :year, :all] :t The
+        #   time period to consider when sorting.
+        #
+        # @note The option :t only applies to the top and controversial sorts.
+        # @return [Objects::Listing<Objects::Thing>]
+        # @todo Move all listing methods into a helper?
+        %w(hot new top controversial comments).each do |sort|
+          define_method :"get_#{sort}" do |subreddit = nil, **params|
+            srname = property(subreddit, :display_name) if subreddit
+            path = "/#{sort}.json"
+            path = path.prepend("/r/#{srname}") if subreddit
+            request_object(:get, path, params)
+          end
+        end
+
+        # Search.
+        # @param query [String] The query string.
+        # @param subreddit [Objects::Subreddit, String] The subreddit to query.
+        # @param params [Hash] A list of params to send with the request.
+        # @option params [String] :after Return results after the given
+        #   fullname.
+        # @option params [String] :before Return results before the given
+        #   fullname.
+        # @option params [Integer] :count The number of items already seen in
+        #   the listing.
+        # @option params [1..100] :limit The maximum number of things to
+        #   return.
+        # @option params [:cloudsearch, :lucene, :plain] :syntax The type of
+        #   syntax to use.
+        # @option params [:relevance, :new, :hot, :top, :comments] :sort The
+        #   way to sort the results.
+        # @option params [:hour, :day, :week, :month, :year, :all] :t The
+        #   time period to consider when sorting.
+        #
+        # @note The option :t only applies to the top and controversial sorts.
+        # @return [Objects::Listing<Objects::Thing>]
+        def search(query, subreddit = nil, **params)
+          path = "/search.json"
+          params[:q] = query
+          if subreddit
+            params[:restrict_sr] = true
+            srname = property(subreddit, :display_name)
+            path = path.prepend("/r/#{srname}")
+          end
+
+          request_object(:get, path, params)
+        end
+      end
+    end
+  end
+end

data/lib/redd/clients/base/stream.rb

@@ -1,81 +1,81 @@
-require "set"
-
-module Redd
-  module Clients
-    class Base
-      # Methods that stream delicious content into your bot's lazy mouth.
-      module Stream
-        # A class similar to PRAW's implementation of a BoundedSet.
-        class PRAWBoundedQueueSet < Set
-          def initialize(max, *args, &block)
-            @max = max
-            @queue = []
-            super(*args, &block)
-          end
-
-          # Add an element to the front if it isn't already in the queue.
-          # @param element
-          # @return [PRAWBoundedQueueSet] self
-          def enqueue(element)
-            @queue.push(element) if add?(element)
-            dequeue! if size > @max
-            self
-          end
-          alias_method :enq, :enqueue
-
-          # Add an element to the front if it isn't already in the queue.
-          # @param element
-          # @return [Boolean] Whether the element was added to the queue.
-          def enqueue?(element)
-            added = add?(element)
-            if added
-              @queue.push(element)
-              dequeue if size > @max
-            end
-            added
-          end
-          alias_method :enq?, :enqueue?
-
-          # Remove the last element of the queue.
-          # @return The removed element.
-          def dequeue
-            element = @queue.shift
-            delete(element)
-            element
-          end
-          alias_method :deq, :dequeue
-        end
-
-        # Stream the results of a method call to the given block.
-        # @param [Symbol] meth A method that returns a listing and has a
-        #   keyword parameter named `:before`.
-        # @param [Array] args The arguments supplied to the method.
-        # @param [Hash] kwargs The keyword arguments supplied to the method.
-        # @yield An element of the returned listing.
-        def stream(meth = :get_new, *args, **kwargs)
-          bset = PRAWBoundedQueueSet.new(10)
-          before = ""
-          loop do
-            begin
-              # Get the latest comments from the subreddit.
-              params = kwargs.merge(before: before)
-              listing = send(meth, *args, **params)
-              # Run the loop for each of the item in the listing
-              listing.reverse_each do |thing|
-                yield thing if bset.enqueue?(thing.fullname)
-              end
-              # Set the latest comment.
-              before = listing.first.fullname unless listing.empty?
-            rescue Redd::Error::RateLimited => error
-              # If this error pops up, you probably have an issue with your bot.
-              sleep(error.time)
-            rescue Redd::Error => error
-              # 5-something errors are usually errors on reddit's end.
-              raise error unless (500...600).include?(error.code)
-            end
-          end
-        end
-      end # <- See, this is why I sometimes prefer Python.
-    end # <- Thank god for code folding.
-  end
-end
+require "set"
+
+module Redd
+  module Clients
+    class Base
+      # Methods that stream delicious content into your bot's lazy mouth.
+      module Stream
+        # A class similar to PRAW's implementation of a BoundedSet.
+        class PRAWBoundedQueueSet < Set
+          def initialize(max, *args, &block)
+            @max = max
+            @queue = []
+            super(*args, &block)
+          end
+
+          # Add an element to the front if it isn't already in the queue.
+          # @param element
+          # @return [PRAWBoundedQueueSet] self
+          def enqueue(element)
+            @queue.push(element) if add?(element)
+            dequeue! if size > @max
+            self
+          end
+          alias_method :enq, :enqueue
+
+          # Add an element to the front if it isn't already in the queue.
+          # @param element
+          # @return [Boolean] Whether the element was added to the queue.
+          def enqueue?(element)
+            added = add?(element)
+            if added
+              @queue.push(element)
+              dequeue if size > @max
+            end
+            added
+          end
+          alias_method :enq?, :enqueue?
+
+          # Remove the last element of the queue.
+          # @return The removed element.
+          def dequeue
+            element = @queue.shift
+            delete(element)
+            element
+          end
+          alias_method :deq, :dequeue
+        end
+
+        # Stream the results of a method call to the given block.
+        # @param [Symbol] meth A method that returns a listing and has a
+        #   keyword parameter named `:before`.
+        # @param [Array] args The arguments supplied to the method.
+        # @param [Hash] kwargs The keyword arguments supplied to the method.
+        # @yield An element of the returned listing.
+        def stream(meth = :get_new, *args, **kwargs)
+          bset = PRAWBoundedQueueSet.new(10)
+          before = ""
+          loop do
+            begin
+              # Get the latest comments from the subreddit.
+              params = kwargs.merge(before: before)
+              listing = send(meth, *args, **params)
+              # Run the loop for each of the item in the listing
+              listing.reverse_each do |thing|
+                yield thing if bset.enqueue?(thing.fullname)
+              end
+              # Set the latest comment.
+              before = listing.first.fullname unless listing.empty?
+            rescue Redd::Error::RateLimited => error
+              # If this error pops up, you probably have an issue with your bot.
+              sleep(error.time)
+            rescue Redd::Error => error
+              # 5-something errors are usually errors on reddit's end.
+              raise error unless (500...600).include?(error.code)
+            end
+          end
+        end
+      end # <- See, this is why I sometimes prefer Python.
+    end # <- Thank god for code folding.
+  end
+end