RubyGems - redd - Versions diffs - 0.8.8 → 0.9.0.pre.1 - Mend

redd 0.8.8 → 0.9.0.pre.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (58) hide show

checksums.yaml +4 -4
data/.rubocop.yml +4 -1
data/CONTRIBUTING.md +63 -0
data/Guardfile +7 -0
data/README.md +6 -5
data/Rakefile +1 -1
data/TODO.md +423 -0
data/bin/console +91 -77
data/bin/guard +2 -0
data/lib/redd.rb +7 -5
data/lib/redd/api_client.rb +2 -3
data/lib/redd/auth_strategies/auth_strategy.rb +7 -2
data/lib/redd/auth_strategies/script.rb +7 -0
data/lib/redd/auth_strategies/userless.rb +7 -0
data/lib/redd/auth_strategies/web.rb +6 -1
data/lib/redd/client.rb +0 -3
data/lib/redd/errors.rb +56 -0
data/lib/redd/middleware.rb +10 -8
data/lib/redd/models/access.rb +30 -18
data/lib/redd/models/comment.rb +185 -27
data/lib/redd/models/front_page.rb +16 -36
data/lib/redd/models/gildable.rb +1 -1
data/lib/redd/models/inboxable.rb +13 -3
data/lib/redd/models/listing.rb +27 -6
data/lib/redd/models/live_thread.rb +76 -23
data/lib/redd/models/live_update.rb +46 -0
data/lib/redd/models/messageable.rb +1 -1
data/lib/redd/models/mod_action.rb +59 -0
data/lib/redd/models/model.rb +23 -0
data/lib/redd/models/moderatable.rb +6 -6
data/lib/redd/models/modmail.rb +61 -0
data/lib/redd/models/modmail_conversation.rb +154 -0
data/lib/redd/models/modmail_message.rb +35 -0
data/lib/redd/models/more_comments.rb +29 -5
data/lib/redd/models/multireddit.rb +63 -20
data/lib/redd/models/paginated_listing.rb +113 -0
data/lib/redd/models/postable.rb +11 -13
data/lib/redd/models/private_message.rb +78 -11
data/lib/redd/models/replyable.rb +2 -2
data/lib/redd/models/reportable.rb +14 -0
data/lib/redd/models/searchable.rb +2 -2
data/lib/redd/models/self.rb +17 -0
data/lib/redd/models/session.rb +75 -31
data/lib/redd/models/submission.rb +309 -56
data/lib/redd/models/subreddit.rb +330 -103
data/lib/redd/models/trophy.rb +34 -0
data/lib/redd/models/user.rb +185 -46
data/lib/redd/models/wiki_page.rb +37 -16
data/lib/redd/utilities/error_handler.rb +13 -13
data/lib/redd/utilities/unmarshaller.rb +7 -5
data/lib/redd/version.rb +1 -1
data/redd.gemspec +18 -15
metadata +82 -16
data/lib/redd/error.rb +0 -53
data/lib/redd/models/basic_model.rb +0 -80
data/lib/redd/models/lazy_model.rb +0 -75
data/lib/redd/models/mod_mail.rb +0 -142
data/lib/redd/utilities/stream.rb +0 -61

data/bin/console CHANGED

@@ -2,109 +2,123 @@
 # frozen_string_literal: true
 require 'webrick'
-require 'redd'
 require 'pry'
+require_relative '../lib/redd'
 # The REPL session to initialize Pry in.
-module Reddit
-  class << self
-    attr_accessor :reddit
-  end
+class Reddit
+  attr_accessor :session
 end
+reddit = Reddit.new
-server = WEBrick::HTTPServer.new(
-  Port: 8000,
-  BindAddress: '0.0.0.0',
-  Logger: WEBrick::Log.new(File.open(File::NULL, 'w')),
-  AccessLog: []
-)
+redd_file_path = File.join(Dir.home, '.redd.key')
+if File.exist?(redd_file_path)
+  auth = Redd::AuthStrategies::Web.new(
+    client_id: 'P4txR-D6TzF8cg',
+    redirect_uri: 'http://localhost:8000/redirect'
+  )
+  access = Redd::Models::Access.new(refresh_token: File.read(redd_file_path))
+  client = Redd::APIClient.new(auth, user_agent: "Ruby:Redd-Quickstart:v#{Redd::VERSION} (by /u/Mustermind)")
+  client.access = auth.refresh(access)
+  reddit.session = Redd::Models::Session.new(client)
+else
+  server = WEBrick::HTTPServer.new(
+    Port: 8000,
+    BindAddress: '0.0.0.0',
+    Logger: WEBrick::Log.new(File.open(File::NULL, 'w')),
+    AccessLog: []
+  )
-server.mount_proc '/' do |_, res|
-  res.body = <<-EOS
-    <!doctype html>
-    <title>Redd Quickstart</title>
-    <style>
-      html, body { margin: 0; height: 100vh; }
-      .wrapper { padding-top: 30vh; text-align: center; font-family: sans-serif; }
-      #btn { background-color: #3D9970; margin: 5px; border-radius: 5px; padding: 10px; color: #fff; text-decoration: none; }
-    </style>
-    <div class="wrapper">
-      <h1>redd // quickstart</h1>
-      <a href="/authenticate" target="_blank" id="btn">Start</a>
-      <span>a new session in your terminal?</span>
-    </div>
-  EOS
-end
+  server.mount_proc '/' do |_, res|
+    res.body = <<-HTML
+      <!doctype html>
+      <title>Redd Quickstart</title>
+      <style>
+        html, body { margin: 0; height: 100vh; }
+        .wrapper { padding-top: 30vh; text-align: center; font-family: sans-serif; }
+        #btn { background-color: #3D9970; margin: 5px; border-radius: 5px; padding: 10px; color: #fff; text-decoration: none; }
+      </style>
+      <div class="wrapper">
+        <h1>redd // quickstart</h1>
+        <a href="/authenticate" target="_blank" id="btn">Start</a>
+        <span>a new session in your terminal?</span>
+      </div>
+    HTML
+  end
-server.mount_proc '/authenticate' do |_, res|
-  res.set_redirect(
-    WEBrick::HTTPStatus[302],
-    Redd.url(
-      client_id: 'P4txR-D6TzF8cg',
-      response_type: 'code',
-      state: '0',
-      redirect_uri: 'http://localhost:8000/redirect',
-      duration: 'permanent',
-      scope: %w(account creddits edit flair history identity livemanage modconfig modcontributors
-                modflair modlog modmail modothers modposts modself modwiki mysubreddits
-                privatemessages read report save submit subscribe vote wikiedit wikiread)
+  server.mount_proc '/authenticate' do |_, res|
+    res.set_redirect(
+      WEBrick::HTTPStatus[302],
+      Redd.url(
+        client_id: 'P4txR-D6TzF8cg',
+        response_type: 'code',
+        state: '0',
+        redirect_uri: 'http://localhost:8000/redirect',
+        duration: 'permanent',
+        scope: %w[account creddits edit flair history identity livemanage modconfig modcontributors
+                  modflair modlog modmail modothers modposts modself modwiki mysubreddits
+                  privatemessages read report save submit subscribe vote wikiedit wikiread]
+      )
     )
-  )
-end
+  end
-server.mount_proc '/redirect' do |req, res|
-  err = req.query['error']
-  should_exit = err.nil? || err == 'access_denied'
-  res.body = <<-EOS
-    <!doctype html>
-    <title>Done!</title>
-    #{should_exit ? '<script>window.close();</script>' : "<p>Uh oh, there was an error: #{err}</p>"}
-  EOS
+  server.mount_proc '/redirect' do |req, res|
+    err = req.query['error']
+    should_exit = err.nil? || err == 'access_denied'
+    res.body = <<-HTML
+      <!doctype html>
+      <title>Done!</title>
+      #{should_exit ? '<script>window.close();</script>' : "<p>Uh oh, there was an error: #{err}</p>"}
+    HTML
-  unless err
-    Reddit.reddit = Redd.it(
-      user_agent: "Ruby:Redd-Quickstart:v#{Redd::VERSION} (by unknown)",
-      client_id: 'P4txR-D6TzF8cg',
-      redirect_uri: 'http://localhost:8000/redirect',
-      code: req.query['code'],
-      auto_refresh: true
-    )
-    server.stop
+    unless err
+      server.stop
+      reddit.session = Redd.it(
+        user_agent: "Ruby:Redd-Quickstart:v#{Redd::VERSION} (by /u/Mustermind)",
+        client_id: 'P4txR-D6TzF8cg',
+        redirect_uri: 'http://localhost:8000/redirect',
+        code: req.query['code'],
+        auto_refresh: true
+      )
+      File.open(redd_file_path, 'w') do |f|
+        f.write(reddit.session.client.access.refresh_token)
+      end
+    end
   end
-end
-# Get the server going and shut it all down if user hits Ctrl-C
-begin
-  puts "Listening at \e[34mhttp://localhost:8000\e[0m..."
-  server.start
-rescue Interrupt
-  server.shutdown
-  exit
+  # Get the server going and shut it all down if user hits Ctrl-C
+  begin
+    puts "Listening at \e[34mhttp://localhost:8000\e[0m..."
+    server.start
+  rescue Interrupt
+    server.shutdown
+    exit
+  end
 end
-Reddit.instance_exec do
+reddit.instance_exec do
   # Post a colourful welcome message
   suggestions = [
     # Session#me
-    'reddit.me.link_karma',
+    'session.me.link_karma',
     # Subreddit listings
-    "reddit.subreddit('pics').hot.first.title",
+    "session.subreddit('pics').hot.first.title",
     # User listings
-    'puts reddit.me.comments(sort: :top).first.body',
+    'puts session.me.comments(sort: :top).first.body',
     # Sending messages
-    "reddit.user('Mustermind').send_message(subject: 'Hi!', text: 'How are you?')",
+    "session.user('Mustermind').send_message(subject: 'Hi!', text: 'How are you?')",
     # Subscribing to subreddits
-    "reddit.subreddit('EarthPorn').subscribe",
+    "session.subreddit('EarthPorn').subscribe",
     # Upvoting
-    'reddit.front_page.hot(time: :month).first.upvote',
+    'session.front_page.hot(time: :month).first.upvote',
     # Add friend
-    "reddit.user('Mustermind').friend",
+    "session.user('Mustermind').friend",
     # List friends
-    'reddit.friends.each { |friend| puts friend.name };',
+    'session.friends.each { |friend| puts friend.name };',
     # Hiding / Duplicates
-    'reddit.front_page.hot.each { |l| l.hide if l.duplicates.count > 2 }'
+    'session.front_page.hot.each { |l| l.hide if l.duplicates.count > 2 }'
   ]
-  puts "Hi \e[35m/u/#{reddit.me.name}\e[0m! Try `\e[34m#{suggestions.sample}\e[0m`."
+  puts "Hi \e[35m/u/#{session.me.name}\e[0m! Try `\e[34m#{suggestions.sample}\e[0m`."
   # Load Pry
   Pry.start(self)

data/bin/guard ADDED

	@@ -0,0 +1,2 @@
1	+ #!/usr/bin/env bash
2	+ bundle exec guard

data/lib/redd.rb CHANGED

@@ -8,6 +8,8 @@ require_relative 'redd/version'
 Dir[File.join(__dir__, 'redd', 'models', '*.rb')].each { |f| require f }
 # Authentication Clients
 Dir[File.join(__dir__, 'redd', 'auth_strategies', '*.rb')].each { |f| require f }
+# Error Classes
+require_relative 'redd/errors'
 # Regular Client
 require_relative 'redd/api_client'
@@ -88,29 +90,29 @@ module Redd
     private
     def filter_auth(opts)
-      opts.select { |k| %i(client_id secret username password redirect_uri user_agent).include?(k) }
+      opts.select { |k| %i[client_id secret username password redirect_uri user_agent].include?(k) }
     end
     def filter_api(opts)
-      opts.select { |k| %i(user_agent limit_time max_retries auto_refresh).include?(k) }
+      opts.select { |k| %i[user_agent limit_time max_retries auto_refresh].include?(k) }
     end
     def script(opts = {})
-      return unless %i(client_id secret username password).all? { |o| opts.include?(o) }
+      return unless %i[client_id secret username password].all? { |o| opts.include?(o) }
       auth = AuthStrategies::Script.new(filter_auth(opts))
       api = APIClient.new(auth, **filter_api(opts))
       api.tap(&:authenticate)
     end
     def web(opts = {})
-      return unless %i(client_id redirect_uri code).all? { |o| opts.include?(o) }
+      return unless %i[client_id redirect_uri code].all? { |o| opts.include?(o) }
       auth = AuthStrategies::Web.new(**filter_auth(opts))
       api = APIClient.new(auth, **filter_api(opts))
       api.tap { |c| c.authenticate(opts[:code]) }
     end
     def userless(opts = {})
-      return unless %i(client_id secret).all? { |o| opts.include?(o) }
+      return unless %i[client_id secret].all? { |o| opts.include?(o) }
       auth = AuthStrategies::Userless.new(filter_auth(opts))
       api = APIClient.new(auth, **filter_api(opts))
       api.tap(&:authenticate)

data/lib/redd/api_client.rb CHANGED

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require_relative 'client'
-require_relative 'error'
 require_relative 'utilities/error_handler'
 require_relative 'utilities/rate_limiter'
 require_relative 'utilities/unmarshaller'
@@ -87,12 +86,12 @@ module Redd
       # If access is nil, panic
       raise 'client access is nil, try calling #authenticate' if @access.nil?
       # Refresh access if auto_refresh is enabled
-      refresh if @auto_refresh && @access.permanent? && @access.expired?
+      refresh if @access.expired? && @auto_refresh && @auth && @auth.refreshable?(@access)
     end
     def handle_retryable_errors
       response = yield
-    rescue Redd::ServerError, HTTP::TimeoutError => e
+    rescue Errors::ServerError, HTTP::TimeoutError => e
       # FIXME: maybe only retry GET requests, for obvious reasons?
       @failures += 1
       raise e if @failures > @max_retries

data/lib/redd/auth_strategies/auth_strategy.rb CHANGED

@@ -25,6 +25,11 @@ module Redd
         raise 'abstract method: this strategy cannot authenticate with reddit'
       end
+      # @return [Boolean] whether the access object can be refreshed
+      def refreshable?(_access)
+        false
+      end
       # @abstract Refresh the authentication and return the refreshed access
       # @param _access [Access, String] the access to refresh
       # @return [Access] the new access
@@ -54,8 +59,8 @@ module Redd
       def request_access(grant_type, options = {})
         response = post('/api/v1/access_token', { grant_type: grant_type }.merge(options))
-        raise AuthenticationError.new(response) if response.body.key?(:error)
-        Models::Access.new(self, response.body)
+        raise Errors::AuthenticationError.new(response) if response.body.key?(:error)
+        Models::Access.new(response.body)
       end
     end
   end

data/lib/redd/auth_strategies/script.rb CHANGED

@@ -18,6 +18,13 @@ module Redd
         request_access('password', username: @username, password: @password)
       end
+      # Since the access isn't used for refreshing, the strategy is inherently
+      # refreshable.
+      # @return [true]
+      def refreshable?(_access)
+        true
+      end
       # Refresh the authentication and return the refreshed access
       # @return [Access] the new access
       def refresh(_)

data/lib/redd/auth_strategies/userless.rb CHANGED

@@ -12,6 +12,13 @@ module Redd
         request_access('client_credentials')
       end
+      # Since the access isn't used for refreshing, the strategy is inherently
+      # refreshable.
+      # @return [true]
+      def refreshable?(_access)
+        true
+      end
       # Refresh the authentication and return the refreshed access
       # @return [Access] the new access
       def refresh(_)

data/lib/redd/auth_strategies/web.rb CHANGED

@@ -18,13 +18,18 @@ module Redd
         request_access('authorization_code', code: code, redirect_uri: @redirect_uri)
       end
+      # @return [Boolean] whether the access has a refresh token
+      def refreshable?(access)
+        access.permanent?
+      end
       # Refresh the authentication and return a new refreshed access
       # @return [Access] the new access
       def refresh(access)
         token = access.is_a?(String) ? refresh_token : access.refresh_token
         response = post('/api/v1/access_token', grant_type: 'refresh_token', refresh_token: token)
         # When refreshed, the response doesn't include an access token, so we have to add it.
-        Models::Access.new(self, response.body.merge(refresh_token: token))
+        Models::Access.new(response.body.merge(refresh_token: token))
       end
     end
   end

data/lib/redd/client.rb CHANGED

@@ -33,9 +33,6 @@ module Redd
     # @option options [Hash] :body the direct body contents
     # @return [Response] the response
     def request(verb, path, options = {})
-      # Uncomment if desperate
-      # puts "#{verb} #{path}: #{options}"
       response = connection.request(verb, path, **options)
       Response.new(response.status.code, response.headers, response.body.to_s)
     end

data/lib/redd/errors.rb ADDED

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+module Redd
+  # Namespace for Redd errors.
+  module Errors
+    # An error raised by {Redd::Middleware} when there was an error returned by reddit.
+    class TokenRetrievalError < StandardError; end
+    # An error with the API.
+    class APIError < StandardError
+      attr_reader :response, :name
+      def initialize(response)
+        @response = response
+        @name, message = response.body[:json][:errors][0]
+        super(message)
+      end
+    end
+    # Represents an error from reddit returned in a response.
+    class ResponseError < StandardError
+      attr_accessor :response
+      def initialize(response)
+        super(response.raw_body.length <= 80 ? response.raw_body : "#{response.raw_body[0..80]}...")
+        @response = response
+      end
+    end
+    # An error returned by AuthStrategy.
+    # @note A common cause of this error is not having a bot account registered as a developer on
+    #   the app.
+    class AuthenticationError < ResponseError; end
+    # An error with Redd, probably (let me know!)
+    class BadRequest < ResponseError; end
+    # Whatever it is, you're not allowed to do it.
+    class Forbidden < ResponseError; end
+    # You don't have the correct scope to do this.
+    class InsufficientScope < ResponseError; end
+    # The access object supplied was invalid.
+    class InvalidAccess < ResponseError; end
+    # Returned when reddit raises a 404 error.
+    class NotFound < ResponseError; end
+    # Too many requests and not enough rate limiting.
+    class TooManyRequests < ResponseError; end
+    # An unknown error on reddit's end. Usually fixed with a retry.
+    class ServerError < ResponseError; end
+  end
+end

data/lib/redd/middleware.rb CHANGED

@@ -22,7 +22,7 @@ module Redd
     #   redirects a user to reddit
     def initialize(app, opts = {})
       @app = app
-      strategy_opts = opts.select { |k| %i(user_agent client_id secret redirect_uri).include?(k) }
+      strategy_opts = opts.select { |k| %i[user_agent client_id secret redirect_uri].include?(k) }
       @strategy = Redd::AuthStrategies::Web.new(strategy_opts)
       @user_agent   = opts.fetch(:user_agent, "Redd:Web Application:v#{Redd::VERSION} (by unknown)")
@@ -95,7 +95,7 @@ module Redd
       message = nil
       message = 'invalid_state' if @request.GET['state'] != @request.session[:redd_state]
       message = @request.GET['error'] if @request.GET['error']
-      raise Redd::TokenRetrievalError, message if message
+      raise Errors::TokenRetrievalError, message if message
     end
     # Store the access token and other details in the user's browser, assigning any errors to
@@ -106,17 +106,19 @@ module Redd
       # Try to get a code (the rescue block will also prevent crazy crashes)
       access = @strategy.authenticate(@request.GET['code'])
       @request.session[:redd_session] = access.to_h
-    rescue Redd::TokenRetrievalError, Redd::ResponseError => error
+    rescue Errors::TokenRetrievalError, Errors::ResponseError => error
       @request.env['redd.error'] = error
     end
     # Return a {Redd::Models::Session} based on the hash saved into the browser's session.
     def parse_session
-      client = Redd::APIClient.new(
-        @strategy,
-        user_agent: @user_agent, limit_time: 0, auto_refresh: @auto_refresh
-      )
-      client.access = Redd::Models::Access.new(@strategy, @request.session[:redd_session])
+      parsed_session = @request.session[:redd_session]
+                               .each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      client = Redd::APIClient.new(@strategy,
+                                   user_agent: @user_agent,
+                                   limit_time: 0,
+                                   auto_refresh: @auto_refresh)
+      client.access = Redd::Models::Access.new(@strategy, parsed_session)
       Redd::Models::Session.new(client)
     end
   end