redd 0.9.0.pre.2 → 0.9.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5ff3c5e42a08a8f210131a46183225be92037b9
-  data.tar.gz: 8f85fe4a62585429fae41baad34db469a16f67e4
+  metadata.gz: 278f1a9525f8af1e0b38f8b1e45a7c6ac8115ee6
+  data.tar.gz: afefda832343e71ecf727ed7712d4c33e086ddd0
 SHA512:
-  metadata.gz: b79d75476d5c42f61afc58faad3f634823cde21372545c08dfa087dac3ae2c4cbeda2e6f820acee12e49fd19b198256212537da3fdc71cb4f37a12ab8e9fb2b6
-  data.tar.gz: dbf251810dd76b1da875f3659bf95243dfdf1e60692bfa891c1dfa18c1c22a3e5959d28bf90066b457c68fcec9139092e7ee3f5857185a947065bc991772de78
+  metadata.gz: 4c6db67d5f479822f50b6a5c8d8805d2d0f6993072149f23112c91610a92f47f4072227c15bd3ac40ea0d940284c32064d66d916f3ce92004315ebf63760e173
+  data.tar.gz: 81a85e4839ffc3f89e35983fef845314bcae9784ef57de336ef69917a367dbf24aef148d997bd44b1ef9447a7185facd29e68418f3e17e9f252eb7c0896421d3

data/lib/redd.rb

@@ -12,6 +12,8 @@ Dir[File.join(__dir__, 'redd', 'auth_strategies', '*.rb')].each { |f| require f
 require_relative 'redd/errors'
 # Regular Client
 require_relative 'redd/api_client'
+# Assists
+Dir[File.join(__dir__, 'redd', 'assist', '*.rb')].each { |f| require f }
 
 # Redd is a simple and intuitive API wrapper.
 module Redd

data/lib/redd/api_client.rb

@@ -15,6 +15,7 @@ module Redd
     attr_accessor :access
 
     # Create a new API client with an auth strategy.
+    # TODO: Give user option to pass through all retryable errors.
     # @param auth [AuthStrategies::AuthStrategy] the auth strategy to use
     # @param endpoint [String] the API endpoint
     # @param user_agent [String] the user agent to send
@@ -97,6 +98,10 @@ module Redd
       raise e if @failures > @max_retries
       warn "Redd got a #{e.class.name} error (#{e.message}), retrying..."
       retry
+    rescue Errors::RateLimitError => e
+      warn "Redd was rate limited for #{e.duration} seconds, waiting..."
+      sleep e.duration
+      retry
     else
       @failures = 0
       response

data/lib/redd/assist/delete_badly_scoring.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Redd
+  module Assist
+    # Helper class for deleting negative links or comments. You can run this as a separate process,
+    # as long as you set your rate limit time higher in your main process.
+    # @note Works with {Submission} and {Comment}.
+    # @example
+    #   assist = Redd::Assist::DeleteBadlyScoring.new(session.client)
+    #   assist.track(comment)
+    #   loop do
+    #     assist.delete_badly_scoring(under_score: 1, minimum_age: 600)
+    #     sleep 30
+    #   end
+    class DeleteBadlyScoring
+      # Create a DeleteBadlyScoring assist.
+      # @param client [APIClient] the API client
+      def initialize(client)
+        @client = client
+        @queue = []
+      end
+
+      # Add this model's id to the list of items that are tracked.
+      def track(model)
+        @queue << model.name
+      end
+
+      # Delete all items that are older than the minimum age and score 0 or below.
+      # @param under_score [Integer] the maximum score that the comment must have to be kept
+      # @param minimum_age [Integer] the minimum age for deletion (seconds)
+      # @return [Array<String>] the deleted item fullnames
+      def delete_badly_scoring!(under_score: 1, minimum_age: 15 * 60)
+        delete_if do |comment|
+          if comment.created_at + minimum_age > Time.now
+            :skip
+          elsif comment.score < under_score && !comment.deleted? && !comment.archived?
+            :delete
+          else
+            :keep
+          end
+        end
+      end
+
+      # Delete all items that the block returns true for.
+      # @param minimum_age [Integer] the minimum age for deletion
+      # @yieldparam comment [Comment] the comment to filter
+      # @yieldreturn [:keep, :delete, :skip] whether to keep, delete, or check again later
+      # @return [Array<String>] the deleted item fullnames
+      def delete_if
+        deleted = []
+        @queue.delete_if do |fullname|
+          comment = Models::Comment.new(@client, name: fullname).reload
+          action = yield comment
+          if action == :delete
+            comment.delete
+            deleted << fullname
+          end
+          action == :keep || action == :delete
+        end
+        deleted
+      end
+    end
+  end
+end

data/lib/redd/errors.rb

@@ -12,8 +12,17 @@ module Redd
 
       def initialize(response)
         @response = response
-        @name, message = response.body[:json][:errors][0]
-        super(message)
+        super(response.body[:json][:errors][0].join(', '))
+      end
+    end
+
+    # Indicates that you were rate limited. This should be taken care of automatically.
+    class RateLimitError < APIError
+      attr_reader :duration
+
+      def initialize(response)
+        super(response)
+        @duration = response.body[:json][:ratelimit]
       end
     end
 

data/lib/redd/models/comment.rb

@@ -49,7 +49,8 @@ module Redd
 
       # @!attribute [r] replies
       #   @return [Listing<Comment>] the comment replies
-      property :replies, with: ->(l) { Listing.new(client, l[:data]) if l.is_a?(Hash) }
+      property :replies,
+               with: ->(r) { r.is_a?(Hash) ? Listing.new(client, r[:data]) : Listing.empty(client) }
 
       # @!attribute [r] user_reports
       #   @return [Array<String>] user reports
@@ -63,6 +64,11 @@ module Redd
       #   @return [String] the comment id
       property :id
 
+      # @!attribute [r] title
+      #   @return ["comment reply", "post reply", "username mention"] the comment "title" (only
+      #     visible in messages)
+      property :title, :nil
+
       # @!attribute [r] banned_at
       #   @return [Time, nil] the time when the comment was banned
       property :banned_at, from: :banned_at_utc, with: ->(t) { Time.at(t) if t }
@@ -152,7 +158,7 @@ module Redd
       property :subreddit, with: ->(n) { Subreddit.new(client, display_name: n) }
 
       # @!attribute [r] score_hidden
-      #   @return [Boolean] whether the comment score is hidden 
+      #   @return [Boolean] whether the comment score is hidden
       property :score_hidden?, from: :score_hidden
 
       # @!attribute [r] subreddit_type
@@ -198,18 +204,18 @@ module Redd
       private
 
       def lazer_reload
-        self[:link] ? load_with_comments : load_without_comments
+        exists_locally?(:link) ? load_with_comments : load_without_comments
       end
 
       def load_with_comments
         fully_loaded!
-        id = self[:id] || read_attribute(:name).sub('t1_', '')
+        id = exists_locally?(:id) ? read_attribute(:id) : read_attribute(:name).sub('t1_', '')
         link_id = read_attribute(:link).name.sub('t3_', '')
         client.get("/comments/#{link_id}/_/#{id}").body[1][:data][:children][0][:data]
       end
 
       def load_without_comments
-        id = self[:id] || read_attribute(:name).sub('t1_', '')
+        id = exists_locally?(:id) ? read_attribute(:id) : read_attribute(:name).sub('t1_', '')
         response = client.get('/api/info', id: "t1_#{id}").body[:data][:children][0][:data]
         response.delete(:replies) # Make sure replies are lazy-loaded later.
         response

data/lib/redd/models/listing.rb

@@ -9,6 +9,13 @@ module Redd
     class Listing < Model
       include Enumerable
 
+      # Create an empty listing with a client.
+      # @param client [APIClient] the client to create the listing with
+      # @return [Listing] the empty listing
+      def self.empty(client)
+        Listing.new(client, children: [])
+      end
+
       # Create a fully initialized listing.
       # @param client [APIClient] the api client
       # @param attributes [Hash] the attribute hash

data/lib/redd/models/paginated_listing.rb

@@ -68,7 +68,7 @@ module Redd
 
       # Go backward through the listing.
       # @yield [Object] the object returned in the listings
-      def _stream(&block)
+      def _stream
         buffer = RingBuffer.new(100)
         remaining = @limit > 0 ? reverse_each.to_a : []
 
@@ -107,7 +107,7 @@ module Redd
       # Fetch the previous listing with @caller and update @before.
       def fetch_prev_listing
         listing = @caller.call(before: @before, after: nil, limit: 100)
-        @before = listing.first.name unless listing.empty?
+        @before = listing.empty? ? nil : listing.first.name
         listing
       end
     end

data/lib/redd/models/postable.rb

@@ -17,6 +17,11 @@ module Redd
         client.post('/api/del', id: read_attribute(:name))
       end
 
+      # @return [Boolean] whether the item is probably deleted
+      def deleted?
+        read_attribute(:author).name == '[deleted]'
+      end
+
       # Save a link or comment to the user's account.
       # @param category [String] a category to save to
       def save(category = nil)

data/lib/redd/models/session.rb

@@ -101,8 +101,8 @@ module Redd
 
       # Return a listing of the user's inbox (including comment replies and private messages).
       #
-      # @param category ['inbox', 'unread', 'sent', 'moderator', 'messages'] the category of
-      #   messages to view
+      # @param category ['inbox', 'unread', 'sent', 'moderator', 'messages', 'comments',
+      #   'selfreply', 'mentions'] 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 optional params to send with the request
       # @option params [String] :after return results after the given fullname
@@ -188,7 +188,7 @@ module Redd
       #       "TheGoodPlace"
       #     ],
       #     "comment_count": 176,
-      #     "comment_url": "/r/trendingsubreddits/comments/73dkin/trending_subreddits_for_20170930_rasklibertarians/"
+      #     "comment_url": "/r/trendingsubreddits/comments/73dkin/trending_subreddits_for_..."
       #   }
       def trending_subreddits
         client.get('/api/trending_subreddits').body

data/lib/redd/models/submission.rb

@@ -111,7 +111,7 @@ module Redd
 
       # @!attribute [r] approved_at
       #   @return [Time, nil] when the submission was last approved
-      property :approved_at, :approved_at_utc, with: ->(t) { Time.at(t) if t }
+      property :approved_at, from: :approved_at_utc, with: ->(t) { Time.at(t) if t }
 
       # @!attribute [r] banned_by
       #   @return [String] not sure what this does
@@ -382,11 +382,11 @@ module Redd
         fully_loaded!
 
         # Ensure we have the link's id.
-        id = self[:id] ? read_attribute(:id) : read_attribute(:name).sub('t3_', '')
+        id = exists_locally?(:id) ? read_attribute(:id) : read_attribute(:name).sub('t3_', '')
 
         # If a specific sort order was requested, provide it.
         params = {}
-        params[:sort] = read_attribute(:sort_order) if self[:sort_order]
+        params[:sort] = read_attribute(:sort_order) if exists_locally?(:sort_order)
 
         # `response` is a pair (2-element array):
         #   - response[0] is a one-item listing containing the submission

data/lib/redd/models/subreddit.rb

@@ -404,9 +404,13 @@ module Redd
       property :display_name, :required
 
       # @!attribute [r] id
-      #   @return [String] the subreddit's t5_ id.
+      #   @return [String] the subreddit's base36 id.
       property :id
 
+      # @!attribute [r] name
+      #   @return [String] the subreddit's t5_ fullname.
+      property :name
+
       # @!attribute [r] title
       #   @return [String] the subreddit's page title text.
       property :title
@@ -613,7 +617,7 @@ module Redd
       property :link_flair_enabled?, from: :link_flair_enabled
 
       # @!attribute [r] allow_images?
-      #   @return [Boolean] whether images are allowed 
+      #   @return [Boolean] whether images are allowed
       property :allow_images?, from: :allow_images
 
       # @!attribute [r] show_media_preview
@@ -636,7 +640,7 @@ module Redd
 
       def lazer_reload
         fully_loaded!
-        self[:name] ? load_from_fullname : load_from_display_name
+        exists_locally?(:name) ? load_from_fullname : load_from_display_name
       end
 
       # Return the attributes using the display_name (best option).

data/lib/redd/models/wiki_page.rb

@@ -48,7 +48,7 @@ module Redd
       def lazer_reload
         fully_loaded!
         path = "/wiki/#{read_attribute(:title)}"
-        path = "/r/#{read_attribute(:subreddit).display_name}#{path}" if self[:subreddit]
+        path = "/r/#{read_attribute(:subreddit).display_name}#{path}" if exists_locally?(:subreddit)
         client.get(path).body[:data]
       end
     end

data/lib/redd/utilities/error_handler.rb

@@ -29,7 +29,7 @@ module Redd
         # If there wasn't an status code error and we're allowed to look into the response, parse
         # it and check for errors.
         # TODO: deal with errors of type { fields:, explanation:, message:, reason: }
-        api_error(res)
+        rate_limit_error(res) || other_api_error(res)
       end
 
       private
@@ -53,8 +53,13 @@ module Redd
         HTTP_ERRORS[res.code].new(res) if HTTP_ERRORS.key?(res.code)
       end
 
+      def rate_limit_error(res)
+        return nil unless res.body.is_a?(Hash) && res.body[:json] && res.body[:json][:ratelimit]
+        Errors::RateLimitError.new(res)
+      end
+
       # Deal with those annoying errors that come with perfect 200 status codes.
-      def api_error(res)
+      def other_api_error(res)
         return nil unless res.body.is_a?(Hash) && res.body[:json] && res.body[:json][:errors] &&
                           !res.body[:json][:errors].empty?
         Errors::APIError.new(res)

data/lib/redd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Redd
-  VERSION = '0.9.0.pre.2'
+  VERSION = '0.9.0.pre.3'
 end

data/redd.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.require_paths = ['lib']
 
   spec.add_dependency 'http', '~> 2.2'
-  spec.add_dependency 'lazy_lazer', '~> 0.6'
+  spec.add_dependency 'lazy_lazer', '~> 0.8.1'
 
   spec.add_development_dependency 'pry', '~> 0.10'
   spec.add_development_dependency 'bundler', '~> 1.14'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.9.0.pre.2
+  version: 0.9.0.pre.3
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +216,7 @@ files:
 - bin/setup
 - lib/redd.rb
 - lib/redd/api_client.rb
+- lib/redd/assist/delete_badly_scoring.rb
 - lib/redd/auth_strategies/auth_strategy.rb
 - lib/redd/auth_strategies/script.rb
 - lib/redd/auth_strategies/userless.rb