redd 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce5057c5421178a5b9ad6a056b2fa33a161413f8
-  data.tar.gz: 11c8973bcb1fbd2786c40e3f929229c944883da0
+  metadata.gz: c41f2214b01198dd4f0a44f243bc73364af33b6c
+  data.tar.gz: a33587b7a36a41c11b3a4faa51814af24d86565f
 SHA512:
-  metadata.gz: 712701e751a6cc9e5bb552fafc451c22c3cfefd275da19305620e57b306f5645ae087484217f3049256424d3d40c55d786dbeef4f123c358845d24c94b7cec84
-  data.tar.gz: ac462c530eda68e27718333a386625f6b0921a99a0676a49655721b23d6ccddadf75b433a8d329d0e05f19217565d5029f607af6703b580d374323f1b1764d0d
+  metadata.gz: ba2ecdabcf4c991710428b08e57437a00e0b5c85a0164d7786fe4363f65f51617e544519393bc48cae3672debaa0b8c2ea4743aae67ae1e23dedfee32e24dfe9
+  data.tar.gz: ef71ea37b3375b7328f9f6f6298d8cb867dda0aa38eec6b0480fcc12063b935a6fcfea99216d0bac5563577fd8a86c98697ef1a697ebfab09365a3e60390e3a5

data/.gitignore

@@ -6,4 +6,5 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/examples.txt
 /tmp/

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --require spec_helper
 --color

data/.travis.yml

@@ -11,5 +11,5 @@ matrix:
   - rvm: ruby-head
   - rvm: jruby-head
 
-before_install: gem install bundler -v 1.13.7
+before_install: gem install bundler -v 1.14.6
 cache: bundler

data/lib/redd/api_client.rb

@@ -68,19 +68,16 @@ module Redd
       ensure_access_is_valid
       # Setup base API params and make request
       api_params = { api_type: 'json', raw_json: 1 }.merge(params)
-      response = @rate_limiter.after_limit { super(verb, path, params: api_params, **options) }
-      # Check for errors in the returned response
-      response_error = @error_handler.check_error(response, raw: raw)
-      raise response_error unless response_error.nil?
-      # All done, return the response
-      @failures = 0
-      response
-    rescue Redd::ServerError, HTTP::TimeoutError => e
-      # FIXME: maybe only retry GET requests, for obvious reasons?
-      @failures += 1
-      raise e if @failures > @max_retries
-      warn "Redd got a #{e.class.name} error (#{e.message}), retrying..."
-      retry
+
+      # This loop is retried @max_retries number of times until it succeeds
+      handle_retryable_errors do
+        response = @rate_limiter.after_limit { super(verb, path, params: api_params, **options) }
+        # Raise errors if encountered at the API level.
+        response_error = @error_handler.check_error(response, raw: raw)
+        raise response_error unless response_error.nil?
+        # All done, return the response
+        response
+      end
     end
 
     private
@@ -93,6 +90,19 @@ module Redd
       refresh if @access.expired? && @auto_refresh
     end
 
+    def handle_retryable_errors
+      response = yield
+    rescue Redd::ServerError, HTTP::TimeoutError => e
+      # FIXME: maybe only retry GET requests, for obvious reasons?
+      @failures += 1
+      raise e if @failures > @max_retries
+      warn "Redd got a #{e.class.name} error (#{e.message}), retrying..."
+      retry
+    else
+      @failures = 0
+      response
+    end
+
     def connection
       super.auth("Bearer #{@access.access_token}")
     end

data/lib/redd/models/comment.rb

@@ -43,15 +43,17 @@ module Redd
       end
 
       def default_loader
-        # Ensure we have the comment's id.
+        @attributes.key?(:link_id) ? load_with_comments : load_without_comments
+      end
+
+      def load_with_comments
         id = @attributes.fetch(:id) { @attributes.fetch(:name).sub('t1_', '') }
+        link_id = @attributes[:link_id].sub('t3_', '')
+        @client.get("/comments/#{link_id}/_/#{id}").body[1][:data][:children][0][:data]
+      end
 
-        # If we have the link_id, we can load the listing with replies.
-        if @attributes.key?(:link_id)
-          link_id = @attributes[:link_id].sub('t3_', '')
-          return @client.get("/comments/#{link_id}/_/#{id}").body[1][:data][:children][0][:data]
-        end
-        # We can only load the comment in isolation if we don't have the link_id.
+      def load_without_comments
+        id = @attributes.fetch(:id) { @attributes.fetch(:name).sub('t1_', '') }
         @client.get('/api/info', id: "t1_#{id}").body[:data][:children][0][:data]
       end
     end

data/lib/redd/models/listing.rb

@@ -19,12 +19,6 @@ module Redd
           get_attribute(:children).public_send(method_name, *args, &block)
         end
       end
-
-      private
-
-      def after_initialize
-        @attributes.fetch(:children).map! { |el| @client.unmarshal(el) }
-      end
     end
   end
 end

data/lib/redd/models/more_comments.rb

@@ -24,25 +24,21 @@ module Redd
       # @param depth [Number] the maximum recursion depth
       # @return [Array<Comment, MoreComments>] the expanded comments or self if past depth
       def recursive_expand(link:, sort: nil, lookup: {}, depth: 10)
-        return [self] if depth == 0
+        return [self] if depth <= 0
 
-        expand(link: link, sort: sort).flat_map do |thing|
-          if thing.is_a?(MoreComments) && thing.count > 0
-            # Get an array of expanded comments from the thing.
-            ary = thing.recursive_expand(link: link, sort: sort, lookup: lookup, depth: depth - 1)
-            # If we can't find its parent (or if the parent is the submission), add it to the root.
-            next ary unless lookup.key?(thing.parent_id)
-            # Since the thing has a parent that we're tracking, attach it to the parent.
-            lookup[thing.parent_id].replies.children.concat(ary)
-          elsif thing.is_a?(Comment)
+        expand(link: link, sort: sort).each_with_object([]) do |thing, coll|
+          target = (lookup.key?(thing.parent_id) ? lookup[thing.parent_id].replies.children : coll)
+
+          if thing.is_a?(Comment)
             # Add the comment to a lookup hash.
             lookup[thing.name] = thing
             # If the parent is not in the lookup hash, add it to the root listing.
-            next thing unless lookup.key?(thing.parent_id)
-            # If the parent was found, add the child to the parent's replies instead.
-            lookup[thing.parent_id].replies.children << thing
+            target.push(thing)
+          elsif thing.is_a?(MoreComments) && thing.count > 0
+            # Get an array of expanded comments from the thing.
+            ary = thing.recursive_expand(link: link, sort: sort, lookup: lookup, depth: depth - 1)
+            target.concat(ary)
           end
-          []
         end
       end
 

data/lib/redd/models/replyable.rb

@@ -9,7 +9,7 @@ module Redd
       # @return [Comment, PrivateMessage] The created reply.
       def reply(text)
         fullname = get_attribute(:name)
-        @client.model(:post, '/api/comment/', text: text, thing_id: fullname).first
+        @client.model(:post, '/api/comment', text: text, thing_id: fullname).first
       end
     end
   end

data/lib/redd/models/submission.rb

@@ -32,11 +32,16 @@ module Redd
       end
 
       # Set the sort order of the comments and reload if necessary.
-      # @param order [:confidence, :top, :controversial, :old, :qa] the sort order
-      def sort_order=(order)
-        @sort_order = order
-        reload if @definitely_fully_loaded
-        order
+      # @param new_order [:confidence, :top, :controversial, :old, :qa] the sort order
+      def sort_order=(new_order)
+        # If the comments were loaded in a different sort order, delete them and invalidate this
+        # model.
+        if @attributes.key?(:comments) && @sort_order != new_order
+          @attributes.delete(:comments)
+          @definitely_fully_loaded = false
+        end
+
+        @sort_order = new_order
       end
 
       # Get all submissions for the same url.
@@ -105,6 +110,15 @@ module Redd
         @client.post('/api/unlock', id: get_attribute(:name))
       end
 
+      # Set the suggested sort order for comments for all users.
+      # @param suggested ['blank', 'confidence', 'top', 'new', 'controversial', 'old', 'random',
+      #   'qa', 'live'] the sort type
+      def set_suggested_sort(suggested) # rubocop:disable Style/AccessorMethodName
+        # Style/AccessorMethodName is disabled because it feels wrong for accessor methods to make
+        # HTTP requests.
+        @client.post('/api/set_suggested_sort', id: get_attribute(:name), sort: suggested)
+      end
+
       private
 
       def default_loader

data/lib/redd/models/subreddit.rb

@@ -234,6 +234,23 @@ module Redd
         nil
       end
 
+      # Remove the flair from a user
+      # @param thing [User, String] a User from which to remove flair
+      def delete_flair(user)
+        name = user.is_a?(User) ? user.name : user
+        @client.post("/r/#{get_attribute(:display_name)}/api/deleteflair", name: name)
+      end
+
+      # Set a Submission's or User's flair based on a flair template id.
+      # @param thing [User, Submission] an object to assign a template to
+      # @param template_id [String] the UUID of the flair template to assign
+      # @param text [String] optional text for the flair
+      def set_flair_template(thing, template_id, text: nil)
+        key = thing.is_a?(User) ? :name : :link
+        params = { key => thing.name, flair_template_id: template_id, text: text }
+        @client.post("/r/#{get_attribute(:display_name)}/api/selectflair", params)
+      end
+
       # Add the subreddit to the user's subscribed subreddits.
       def subscribe(action: :sub, skip_initial_defaults: false)
         @client.post(

data/lib/redd/models/wiki_page.rb

@@ -6,16 +6,30 @@ module Redd
   module Models
     # A reddit user.
     class WikiPage < LazyModel
+      # Edit the wiki page.
+      # @param content [String] the new wiki page contents
+      # @param reason [String, nil] an optional reason for editing the page
+      def edit(content, reason: nil)
+        params = { page: @attributes.fetch(:title), content: content }
+        params[:reason] = reason if reason
+        @client.post("/r/#{@attributes.fetch(:subreddit).display_name}/api/wiki/edit", params)
+      end
+
       private
 
       def default_loader
         title = @attributes.fetch(:title)
         if @attributes.key?(:subreddit)
-          sr_name = attributes[:subreddit].display_name
+          sr_name = @attributes[:subreddit].display_name
           return @client.get("/r/#{sr_name}/wiki/#{title}").body[:data]
         end
         @client.get("/wiki/#{title}").body[:data]
       end
+
+      def after_initialize
+        return unless @attributes[:revision_by]
+        @attributes[:revision_by] = @client.unmarshal(@attributes[:revision_by])
+      end
     end
   end
 end

data/lib/redd/utilities/error_handler.rb

@@ -6,9 +6,13 @@ module Redd
   module Utilities
     # Handles response errors in API responses.
     class ErrorHandler
+      AUTH_HEADER        = 'www-authenticate'
+      INVALID_TOKEN      = 'invalid_token'
+      INSUFFICIENT_SCOPE = 'insufficient_scope'
+
       HTTP_ERRORS = {
         400 => Redd::BadRequest,
-        # 403 => Redd::Forbidden,
+        403 => Redd::Forbidden,
         404 => Redd::NotFound,
         500 => Redd::ServerError,
         502 => Redd::ServerError,
@@ -16,26 +20,43 @@ module Redd
         504 => Redd::ServerError
       }.freeze
 
-      AUTHORIZATION_ERRORS = {
-        'insufficient_scope' => Redd::InsufficientScope,
-        'invalid_token' => Redd::InvalidAccess
-      }.freeze
+      def check_error(res, raw:)
+        # Check for status code-based errors first and return it if we found one.
+        error = invalid_access_error(res) || insufficient_scope_error(res) || other_http_error(res)
+        return error if error || raw
 
-      def check_error(response, raw:)
+        # 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: }
-        if !raw && response.body.is_a?(Hash) && response.body[:json] &&
-           response.body[:json][:errors] && !response.body[:json][:errors].empty?
-          Redd::APIError.new(response)
-        elsif HTTP_ERRORS.key?(response.code)
-          HTTP_ERRORS[response.code].new(response)
-        elsif response.code == 401 || response.code == 403
-          # FIXME: i think insufficient_scope comes with 403 and invalid_token with 401
-          AUTHORIZATION_ERRORS.each do |key, klass|
-            auth_header = response.headers['www-authenticate']
-            return klass.new(response) if auth_header && auth_header.include?(key)
-          end
-          nil
-        end
+        api_error(res)
+      end
+
+      private
+
+      # Deal with an error caused by having an expired or invalid access token.
+      def invalid_access_error(res)
+        return nil unless res.code == 401 && res.headers[AUTH_HEADER] &&
+                          res.headers[AUTH_HEADER].include?(INVALID_TOKEN)
+        InvalidAccess.new(res)
+      end
+
+      # Deal with an error caused by not having enough the correct scope
+      def insufficient_scope_error(res)
+        return nil unless res.code == 403 && res.headers[AUTH_HEADER] &&
+                          res.headers[AUTH_HEADER].include?(INSUFFICIENT_SCOPE)
+        InsufficientScope.new(res)
+      end
+
+      # Deal with an error signalled by the HTTP response code.
+      def other_http_error(res)
+        HTTP_ERRORS[res.code].new(res) if HTTP_ERRORS.key?(res.code)
+      end
+
+      # Deal with those annoying errors that come with perfect 200 status codes.
+      def api_error(res)
+        return nil unless res.is_a?(Hash) && res.body[:json] && res.body[:json][:errors] &&
+                          !res.body[:json][:errors].empty?
+        APIError.new(res)
       end
     end
   end

data/lib/redd/utilities/rate_limiter.rb

@@ -4,8 +4,8 @@ module Redd
   module Utilities
     # Manages rate limiting by sleeping.
     class RateLimiter
-      def initialize(gap = 1)
-        @gap = 1
+      def initialize(gap)
+        @gap = gap
         @last_request_time = Time.now - gap
       end
 

data/lib/redd/utilities/unmarshaller.rb

@@ -14,7 +14,6 @@ module Redd
         't5'           => Models::Subreddit,
         'more'         => Models::MoreComments,
         'wikipage'     => Models::WikiPage,
-        'Listing'      => Models::Listing,
         'modaction'    => Models::Subreddit::ModAction,
         'LabeledMulti' => Models::Multireddit,
         'LiveUpdate'   => Models::LiveThread::LiveUpdate
@@ -24,18 +23,41 @@ module Redd
         @client = client
       end
 
-      def unmarshal(response)
-        if response[:json] && response[:json][:data]
-          if response[:json][:data][:things]
-            Models::Listing.new(@client, children: response[:json][:data][:things])
-          else
-            Models::BasicModel.new(@client, response[:json][:data])
-          end
-        elsif MAPPING.key?(response[:kind])
-          MAPPING[response[:kind]].new(@client, response[:data])
-        else
-          raise "unknown type to unmarshal: #{response[:kind].inspect}"
-        end
+      def unmarshal(res)
+        # I'm loving the hell out of this pattern.
+        model = js_listing(res) || js_model(res) || api_listing(res) || api_model(res)
+        raise "cannot unmarshal: #{res.inspect}" if model.nil?
+        model
+      end
+
+      private
+
+      # Unmarshal frontent API-style listings
+      def js_listing(res)
+        # One day I'll get to deprecate Ruby 2.2 and jump into the world of Hash#dig.
+        return nil unless res[:json] && res[:json][:data] && res[:json][:data][:things]
+        Models::Listing.new(@client, children: res[:json][:data][:things].map { |t| unmarshal(t) })
+      end
+
+      # Unmarshal frontend API-style models.
+      def js_model(res)
+        # FIXME: deprecate this? this shouldn't be happening in the API, so this is better handled
+        #   in the respective classes.
+        Models::BasicModel.new(@client, res[:json][:data]) if res[:json] && res[:json][:data]
+      end
+
+      # Unmarshal API-provided listings.
+      def api_listing(res)
+        return nil unless res[:kind] == 'Listing'
+        attributes = res[:data]
+        attributes[:children].map! { |child| unmarshal(child) }
+        Models::Listing.new(@client, attributes)
+      end
+
+      # Unmarshal API-provided model.
+      def api_model(res)
+        return nil unless MAPPING[res[:kind]]
+        MAPPING[res[:kind]].new(@client, res[:data])
       end
     end
   end

data/lib/redd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Redd
-  VERSION = '0.8.4'
+  VERSION = '0.8.5'
 end

data/redd.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'http', '~> 2.1'
+  spec.add_dependency 'http', '~> 2.2'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rubocop', '~> 0.47'
   spec.add_development_dependency 'pry', '~> 0.10'
@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'simplecov', '~> 0.13'
   spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'vcr', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - avinash@dwarapu.me
@@ -130,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"