neonredd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a84912f5d82a8f8b944023f8712dea6e8e43eea9
+  data.tar.gz: d68880ed1124a58477c1a820dcacc63589ebca0d
+SHA512:
+  metadata.gz: 1b0438751bfdd66ef3d1b1efc1f7e486f0cf4de3dc13091216e2848030553f137e24baa231eb6ad71d5d196782c7fdfc87213437eded7d3a31d6ef6d6ae016b8
+  data.tar.gz: d7d7ffe5b266a9e216c7e69d09c3cc23c9b3ebc6ae79b73376297ad75edff0d91b31ca0a20edb9bee927fad8060cd2d4d42ed59e0499b70a7843328566e9bd5d

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redd.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2016 SirNeon
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+# Neonredd

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/Redd.LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Avinash Dwarapu
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/RedditKit.LICENSE.md

@@ -0,0 +1,9 @@
+Copyright (c) 2013 Sam Symons
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/redd/access.rb

@@ -0,0 +1,76 @@
+require 'multi_json'
+
+module Redd
+  # A container for the client's access to their account via OAuth2
+  class Access
+    # @!attribute [r] access_token
+    # @return [String] The access token used to access the users account.
+    attr_reader :access_token
+
+    # @!attribute [r] refresh_token
+    # @return [String, nil] The refresh token, if the access was permanent.
+    attr_reader :refresh_token
+
+    # @!attribute [r] scope
+    # @return [Array] The scope that the client is allowed to access.
+    attr_reader :scope
+
+    # @!attribute [r] expires_at
+    # @return [Time] The time when the access token expires.
+    attr_reader :expires_at
+
+    # @param [String] body The response body containing the required info.
+    def initialize(body)
+      @access_token = body[:access_token]
+      @refresh_token = body[:refresh_token]
+      @scope = (body[:scope] ? body[:scope].split(',') : [])
+      @expires_at =
+        if body[:expires_at]
+          Time.at(body[:expires_at])
+        else
+          Time.now + (body[:expires_in] || 0)
+        end
+    end
+
+    # @return [Boolean] Whether the access is temporary.
+    def temporary?
+      !refresh_token
+    end
+
+    # @return [Boolean] Whether the access is permanent.
+    def permanent?
+      !temporary?
+    end
+
+    # @return [Boolean] Whether the access has expired.
+    def expired?
+      Time.now > (@expires_at + 60)
+    end
+
+    # Refresh the object with the new response body.
+    # This happens when a new access token is requested using a request token.
+    # @param [Hash] body The new response body.
+    def refreshed!(body)
+      @access_token = body[:access_token]
+      @expires_at = Time.now + body[:expires_in]
+    end
+
+    # @return [String] A JSON version of the data that can be loaded later.
+    def to_json
+      MultiJson.dump(
+        access_token: @access_token,
+        refresh_token: @refresh_token,
+        scope: @scope.join(','),
+        expires_at: @expires_at.to_i
+      )
+    end
+
+    # Create a new instance of the class from the JSON returned from #to_json
+    # @param [String] json
+    # @return [Access]
+    def self.from_json(json)
+      hash = MultiJson.load(json, symbolize_keys: true)
+      new(hash)
+    end
+  end
+end

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,114 @@
+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)
+          # rubocop:disable Style/RegexpLiteral
+          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..1000] :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

@@ -0,0 +1,82 @@
+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 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 enq? enqueue?
+
+          # Remove the last element of the queue.
+          # @return The removed element.
+          def dequeue
+            element = @queue.shift
+            delete(element)
+            element
+          end
+          alias 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.
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        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).cover?(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

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

@@ -0,0 +1,143 @@
+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
+        }.freeze
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        # 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 = {})
+          unless params[:limit].nil?
+            if params[:limit] > 100
+              multiplier = params[:limit] / 100
+              last_block_limit = params[:limit] - (multiplier * 100)
+              multiplier -= 1
+              params[:limit] = 100
+              body = send(meth, path, params).body
+              listing = object_from_body(body)
+
+              params[:after] = listing.after
+              after = append_to_listing(meth, path, params, multiplier, listing)
+
+              params[:limit] = last_block_limit
+              params[:after] = after
+
+              unless after.nil?
+                append_to_listing(meth, path, params, 1, listing)
+              end
+              return listing
+            end
+          end
+          body = send(meth, path, params).body
+          object_from_body(body)
+        end
+
+        # appends items to a listing when the limit is > 100
+        # @param [Symbol] meth The method to use.
+        # @param [String] path The path to visit.
+        # @param [Hash] params The data to send with the request.
+        # @param [Integer] multiplier The number of times to get listings
+        # @param [Redd::Objects::Listing] listing The listing to append to
+        # @return [String] returns the last Redd::Objects::Listing#after.
+        def append_to_listing(meth, path, params, multiplier, listing)
+          multiplier.times do
+            body = send(meth, path, params).body
+            new_listing = object_from_body(body)
+            params[:after] = new_listing.after
+            new_listing.each { |item| listing << item }
+          end
+          params[:after]
+        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

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