redd 0.7.10 → 0.8.0.pre.1

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

@@ -1,81 +0,0 @@
-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

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

@@ -1,19 +0,0 @@
-module Redd
-  module Clients
-    class Base
-      # Methods that require the "submit" scope
-      module Submit
-        # Add a comment to a link, reply to a comment or reply to a message.
-        # Bit of an all-purpose method, this one.
-        # @param thing [Objects::Submission, Objects::Comment,
-        #   Objects::PrivateMessage] A thing to add a comment to.
-        # @param text [String] The text to comment.
-        # @return [Objects::Comment, Objects::PrivateMessage] The reply.
-        def add_comment(thing, text)
-          response = post("/api/comment", text: text, thing_id: thing.fullname)
-          object_from_body(response.body[:json][:data][:things][0])
-        end
-      end
-    end
-  end
-end

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

@@ -1,104 +0,0 @@
-require_relative "../../objects/base"
-require_relative "../../objects/thing"
-require_relative "../../objects/listing"
-require_relative "../../objects/wiki_page"
-require_relative "../../objects/labeled_multi"
-require_relative "../../objects/more_comments"
-require_relative "../../objects/comment"
-require_relative "../../objects/user"
-require_relative "../../objects/submission"
-require_relative "../../objects/private_message"
-require_relative "../../objects/subreddit"
-
-module Redd
-  module Clients
-    class Base
-      # Internal methods that make life easier.
-      # @todo Move this out to Redd::Utils?
-      module Utilities
-        # The kind strings and the objects that should be used for them.
-        OBJECT_KINDS = {
-          "Listing"      => Objects::Listing,
-          "wikipage"     => Objects::WikiPage,
-          "LabeledMulti" => Objects::LabeledMulti,
-          "more"         => Objects::MoreComments,
-          "t1"           => Objects::Comment,
-          "t2"           => Objects::User,
-          "t3"           => Objects::Submission,
-          "t4"           => Objects::PrivateMessage,
-          "t5"           => Objects::Subreddit
-        }
-
-        # Request and create an object from the response.
-        # @param [Symbol] meth The method to use.
-        # @param [String] path The path to visit.
-        # @param [Hash] params The data to send with the request.
-        # @return [Objects::Base] The object returned from the request.
-        def request_object(meth, path, params = {})
-          body = send(meth, path, params).body
-          object_from_body(body)
-        end
-
-        # Create an object instance with the correct attributes when given a
-        # body.
-        #
-        # @param [Hash] body A JSON hash.
-        # @return [Objects::Thing, Objects::Listing]
-        def object_from_body(body)
-          return nil unless body.is_a?(Hash)
-          object = object_from_kind(body[:kind])
-          flat = flatten_body(body)
-          object.new(self, flat)
-        end
-
-        # @param [Objects::Submission, Objects::Comment] base The start of the
-        #   comment tree.
-        # @author Bryce Boe (@bboe) in Python
-        # @return [Array<Objects::Comment, Objects::MoreComments>] A linear
-        #   array of the submission's comments or the comments' replies.
-        def flat_comments(base)
-          meth = (base.is_a?(Objects::Submission) ? :comments : :replies)
-          stack = base.send(meth).dup
-          flattened = []
-
-          until stack.empty?
-            comment = stack.shift
-            if comment.is_a?(Objects::Comment)
-              replies = comment.replies
-              stack = replies + stack if replies
-            end
-            flattened << comment
-          end
-
-          flattened
-        end
-
-        # Get a given property of a given object.
-        # @param [Objects::Base, String] object The object with the property.
-        # @param [Symbol] property The property to get.
-        def property(object, property)
-          object.respond_to?(property) ? object.send(property) : object.to_s
-        end
-
-        private
-
-        # Take a multilevel body ({kind: "tx", data: {...}}) and flatten it
-        # into something like {kind: "tx", ...}
-        # @param [Hash] body The response body.
-        # @return [Hash] The flattened hash.
-        def flatten_body(body)
-          data = body[:data] || body
-          data[:kind] = body[:kind]
-          data
-        end
-
-        # @param [String] kind A kind in the format /t[1-5]/.
-        # @return [Objects::Base, Objects::Listing] The appropriate object for
-        #   a given kind.
-        def object_from_kind(kind)
-          OBJECT_KINDS.fetch(kind, Objects::Base)
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-module Redd
-  module Clients
-    class Base
-      # Methods that require the "wikiread" scope.
-      # @note This method is not limited to {Objects::Subreddit} because there
-      #   are also top-level wiki pages.
-      module Wikiread
-        # Get a list of pages in the subreddit wiki.
-        # @param subreddit [Objects::Subreddit, String] The subreddit to
-        #   look in.
-        # @return [Array<String>] An array of wikipage titles.
-        def get_wikipages(subreddit = nil)
-          path = "/wiki/pages.json"
-          name = property(subreddit, :display_name)
-          path.prepend("/r/#{name}") if subreddit
-          get(path).body[:data]
-        end
-
-        # Get a wiki page.
-        # @param page [String] The title of the wiki page.
-        # @param subreddit [Objects::Subreddit, String] The subreddit to
-        #   look in.
-        # @return [Objects::WikiPage] A wiki page.
-        def wikipage(page, subreddit = nil)
-          path = "/wiki/#{page}.json"
-          name = property(subreddit, :display_name)
-          path.prepend("/r/#{name}") if subreddit
-          request_object(:get, path)
-        end
-      end
-    end
-  end
-end

data/lib/redd/clients/installed.rb

@@ -1,57 +0,0 @@
-require "cgi"
-require_relative "base"
-
-module Redd
-  module Clients
-    # The client for installed apps that can't keep a secret.
-    # It might even work with Rubymotion (fingers crossed).
-    class Installed < Base
-      # @!attribute [r] client_id
-      attr_reader :client_id
-
-      # @!attribute [r] redirect_uri
-      attr_reader :redirect_uri
-
-      # @param [Hash] options The options to create the client with.
-      # @see Base#initialize
-      # @see Redd.it
-      def initialize(client_id, redirect_uri, **options)
-        @client_id = client_id
-        @redirect_uri = redirect_uri
-        super(**options)
-      end
-
-      # @param [String] state A random string to double-check later.
-      # @param [Array<String>] scope The scope to request access to.
-      # @param [:temporary, :permanent] duration
-      # @return [String] The url to redirect the user to.
-      def auth_url(state, scope = ["identity"], duration = :temporary)
-        query = {
-          response_type: "token",
-          client_id: @client_id,
-          redirect_uri: @redirect_uri,
-          state: state,
-          scope: scope.join(","),
-          duration: duration
-        }
-
-        url = URI.join(auth_endpoint, "/api/v1/authorize")
-        url.query = URI.encode_www_form(query)
-        url.to_s
-      end
-
-      # Authorize using the url fragment.
-      # @param [String] fragment The part of the url after the "#".
-      # @return [Access] The access given by reddit.
-      def authorize!(fragment)
-        parsed = CGI.parse(fragment)
-        @access = Access.new(
-          access_token: parsed[:access_token].first,
-          expires_in: parsed[:expires_in].first,
-          scope: parsed[:scope]
-        )
-        reset_connection!
-      end
-    end
-  end
-end

data/lib/redd/clients/script.rb

@@ -1,41 +0,0 @@
-require_relative "base"
-
-module Redd
-  module Clients
-    # The client for an account you own (e.g. bots).
-    class Script < Base
-      # @!attribute [r] client_id
-      attr_reader :client_id
-
-      # @!attribute [r] username
-      attr_reader :username
-
-      # @param [Hash] options The options to create the client with.
-      # @see Base#initialize
-      # @see Redd.it
-      def initialize(client_id, secret, username, password, **options)
-        @client_id = client_id
-        @secret = secret
-        @username = username
-        @password = password
-        super(**options)
-      end
-
-      # Authorize using the given data.
-      # @return [Access] The access given by reddit.
-      def authorize!
-        response = auth_connection.post(
-          "/api/v1/access_token",
-          grant_type: "password",
-          username: @username,
-          password: @password
-        )
-
-        @access = Access.new(response.body)
-        reset_connection!
-      end
-
-      alias_method :refresh_access!, :authorize!
-    end
-  end
-end

data/lib/redd/clients/userless.rb

@@ -1,32 +0,0 @@
-require_relative "base"
-
-module Redd
-  module Clients
-    # The client that doesn't need a user to function.
-    # @note Of course, that means many editing methods throw an error.
-    class Userless < Base
-      # @!attribute [r] client_id
-      attr_reader :client_id
-
-      # @param [Hash] options The options to create the client with.
-      # @see Base#initialize
-      # @see Redd.it
-      def initialize(client_id, secret, **options)
-        @client_id = client_id
-        @secret = secret
-        super(**options)
-      end
-
-      # Authorize using the given data.
-      # @return [Access] The access given by reddit.
-      def authorize!
-        response = auth_connection.post(
-          "/api/v1/access_token",
-          grant_type: "client_credentials"
-        )
-        @access = Access.new(response.body)
-        reset_connection!
-      end
-    end
-  end
-end

data/lib/redd/clients/web.rb

@@ -1,58 +0,0 @@
-require "uri"
-require_relative "base"
-
-module Redd
-  module Clients
-    # The client for a web-based flow (e.g. "login with reddit")
-    class Web < Base
-      # @!attribute [r] client_id
-      attr_reader :client_id
-
-      # @!attribute [r] redirect_uri
-      attr_reader :redirect_uri
-
-      # @param [Hash] options The options to create the client with.
-      # @see Base#initialize
-      # @see Redd.it
-      def initialize(client_id, secret, redirect_uri, **options)
-        @client_id = client_id
-        @secret = secret
-        @redirect_uri = redirect_uri
-        super(**options)
-      end
-
-      # @param [String] state A random string to double-check later.
-      # @param [Array<String>] scope The scope to request access to.
-      # @param [:temporary, :permanent] duration
-      # @return [String] The url to redirect the user to.
-      def auth_url(state, scope = ["identity"], duration = :temporary)
-        query = {
-          response_type: "code",
-          client_id: @client_id,
-          redirect_uri: @redirect_uri,
-          state: state,
-          scope: scope.join(","),
-          duration: duration
-        }
-
-        url = URI.join(auth_endpoint, "/api/v1/authorize")
-        url.query = URI.encode_www_form(query)
-        url.to_s
-      end
-
-      # Authorize using the code given.
-      # @param [String] code The code from the get params.
-      # @return [Access] The access given by reddit.
-      def authorize!(code)
-        response = auth_connection.post(
-          "/api/v1/access_token",
-          grant_type: "authorization_code",
-          code: code,
-          redirect_uri: @redirect_uri
-        )
-        @access = Access.new(response.body)
-        reset_connection!
-      end
-    end
-  end
-end

data/lib/redd/objects/base.rb

@@ -1,39 +0,0 @@
-require "hashie"
-require "forwardable"
-
-module Redd
-  # A bunch of objects that can hold properties.
-  module Objects
-    # A base for all objects to inherit from.
-    class Base < Hashie::Hash
-      include Hashie::Extensions::MergeInitializer
-      include Hashie::Extensions::MethodReader
-      include Hashie::Extensions::MethodQuery
-      include Hashie::Extensions::DeepMerge
-
-      # The `delete` method is called `delete_path` because it conflicts with
-      # Hash#delete.
-      extend Forwardable
-      def_delegators :@client, :get, :post, :put, :delete_path
-
-      # @!attribute [r] client
-      # @return [Clients::Base] The client that used to make requests.
-      attr_reader :client
-
-      # @param [Clients::Base] client The client instance.
-      # @param [Hash] attributes A hash of attributes.
-      def initialize(client, attributes = {})
-        @client = client
-        super(attributes)
-      end
-
-      # Define an alias for a property.
-      # @param [Symbol] new_name The alias.
-      # @param [Symbol] old_name The existing property.
-      def self.alias_property(new_name, old_name)
-        define_method(new_name) { send(old_name) }
-        define_method(:"#{new_name}?") { send(old_name) }
-      end
-    end
-  end
-end