redd 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c41f2214b01198dd4f0a44f243bc73364af33b6c
-  data.tar.gz: a33587b7a36a41c11b3a4faa51814af24d86565f
+  metadata.gz: 9143e5925475c5e0143ac3aacb6c10666986c18f
+  data.tar.gz: 6c7be0b33836c21aa36765937795cabe6c7aa8e6
 SHA512:
-  metadata.gz: ba2ecdabcf4c991710428b08e57437a00e0b5c85a0164d7786fe4363f65f51617e544519393bc48cae3672debaa0b8c2ea4743aae67ae1e23dedfee32e24dfe9
-  data.tar.gz: ef71ea37b3375b7328f9f6f6298d8cb867dda0aa38eec6b0480fcc12063b935a6fcfea99216d0bac5563577fd8a86c98697ef1a697ebfab09365a3e60390e3a5
+  metadata.gz: 541cffb6f3ad7b15b2d1560b30ae400d7d9db898290c7a252ee9ad2c7bae3d1c8aa9591d202e9f32190f28e0fe37539b33443a0d8f5adccc0c3af8aa84f5def4
+  data.tar.gz: 707d66c874d7c74fbbe1710d52247f5dbc4e5c5e88fc4ab66b7c739075a30b4cfeb28d59965d762779b61d3bd9ca323432b6e543316f24237f916b694612d12c

data/README.md

@@ -1,8 +1,7 @@
 <div align="center">
   <p>
     <!-- Redd -->
-    <img src="logo.png" width="500"><br>
-
+    <img src="https://raw.githubusercontent.com/avinashbot/redd/master/logo.png" width="500"><br>
     <!-- Badges -->
     <a href="https://rubygems.org/gems/redd">
       <img src="http://img.shields.io/gem/v/redd.svg?style=flat-square" alt="Gem Version">
@@ -14,7 +13,6 @@
       <img src="http://img.shields.io/gem/dt/redd.svg?style=flat-square" alt="Gem Downloads">
     </a>
   </p>
-
   <!-- Intro Text -->
   <p>
     <strong>Redd</strong> is a <strong>batteries-included</strong>
@@ -46,31 +44,67 @@ session = Redd.it(
 
 session.subreddit('all').comment_stream do |comment|
   if comment.body.include?('roll a dice')
-    comment.reply("I just rolled a dice! It's a #{rand(1..6)}!")
+    comment.reply("It's a #{rand(1..6)}!")
   elsif comment.body.include?('flip a coin')
-    comment.reply("I just flipped a coin! It's a #{%w(heads tails).sample}!")
+    comment.reply("It's a #{%w(heads tails).sample}!")
+  end
+end
+```
+
+```ruby
+require 'sinatra'
+require 'redd/middleware'
+
+use Rack::Session::Cookie
+use Redd::Middleware,
+    user_agent:   'Redd:Username App:v1.0.0 (by /u/Mustermind)',
+    client_id:    'PQgS0UaX9l70oQ',
+    secret:       'PsF_kVZrW8nSVCG5kNsIgl-AaXE',
+    redirect_uri: 'http://localhost:4567/auth/reddit/callback',
+    scope:        %w(identity),
+    via:          '/auth/reddit'
+
+get '/' do
+  reddit = request.env['redd.session']
+
+  if reddit
+    "Hello /u/#{reddit.me.name}! <a href='/logout'>Logout</a>"
+  else
+    "<a href='/auth/reddit'>Sign in with reddit</a>"
   end
 end
+
+get '/auth/reddit/callback' do
+  redirect to('/') unless request.env['redd.error']
+  "Error: #{request.env['redd.error'].message} (<a href='/'>Back</a>)"
+end
+
+get '/logout' do
+  request.env['redd.session'] = nil
+  redirect to('/')
+end
 ```
 
 ### FAQ
 
-#### Is that bot fully functional?
+#### Are those examples fully functional?
 **Yes**, that's all there is to it! You don't need to handle rate-limiting, refresh access tokens or protect against issues on reddit's end (like 5xx errors).
 
 #### Where can I find the documentation?
 
 [**Gem**](http://www.rubydoc.info/gems/redd/Redd/Models/Session) / [**GitHub**](http://www.rubydoc.info/github/avinashbot/redd/master/Redd/Models/Session)
 
+#### Where can I ask for help if I'm having issues?
+Check out the [**official subreddit**](https://www.reddit.com/r/Redd) or raise a [**GitHub issue**](https://github.com/avinashbot/redd/issues/new).
+
 #### How do I request a feature / contribute?
 
-- The quickest way to get a feature into Redd is to raise a GitHub issue.
+- The quickest way to get a feature into Redd is to raise a [**GitHub issue**](https://github.com/avinashbot/redd/issues/new).
 - Pull requests are also appreciated!
 - Don't hesitate! There are no stupid questions!
 
 #### How can I contact you?
 [Reddit](https://www.reddit.com/message/compose/?to=Mustermind) /
-[GitHub](https://github.com/avinashbot/redd/issues/new) /
 [Email](mailto:avinash@dwarapu.me)
 
 ---

data/lib/redd/api_client.rb

@@ -87,7 +87,7 @@ 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 @access.expired? && @auto_refresh
+      refresh if @auto_refresh && @access.permanent? && @access.expired?
     end
 
     def handle_retryable_errors

data/lib/redd/error.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module Redd
+  # 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
@@ -42,6 +45,9 @@ module Redd
   # 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

data/lib/redd/middleware.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'securerandom'
+
+require_relative '../redd'
+
+module Redd
+  # Rack middleware.
+  class Middleware
+    # @param opts [Hash] the options to create the object with
+    # @option opts [String] :user_agent your app's *unique* and *descriptive* user agent
+    # @option opts [String] :client_id the client id of your app
+    # @option opts [String] :redirect_uri the provided redirect URI
+    # @option opts [String] :secret ('') the app secret (for the web type)
+    # @option opts [Array<String>] :scope (['identity']) a list of scopes to request
+    # @option opts ['temporary', 'permanent'] :duration ('permanent') the duration to request the
+    #   code for.
+    # @option opts [Boolean] :auto_refresh (true) allow refreshing a permanent access automatically
+    #   (only if duration is 'permanent')
+    # @option opts [String] :via ('/auth/reddit') the relative path in the application that
+    #   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 = Redd::AuthStrategies::Web.new(strategy_opts)
+
+      @user_agent   = opts.fetch(:user_agent, "Redd:Web Application:v#{Redd::VERSION} (by unknown)")
+      @client_id    = opts.fetch(:client_id)
+      @redirect_uri = opts.fetch(:redirect_uri)
+      @scope        = opts.fetch(:scope, ['identity'])
+      @duration     = opts.fetch(:duration, 'permanent')
+      @auto_refresh = opts.fetch(:auto_refresh, true) && @duration == 'permanent'
+      @via          = opts.fetch(:via, '/auth/reddit')
+    end
+
+    def call(env)
+      # This is done for thread safety so that each thread has its own copy
+      # of the middleware logic.
+      dup._call(env)
+    end
+
+    protected
+
+    def _call(env)
+      @request = Rack::Request.new(env)
+      return redirect_to_reddit! if @request.path == @via
+
+      before_call
+      response = @app.call(env)
+      after_call
+      response
+    end
+
+    private
+
+    # Creates a unique state and redirects the user to reddit for authentication.
+    def redirect_to_reddit!
+      state = SecureRandom.urlsafe_base64
+      url = Redd.url(
+        client_id: @client_id,
+        redirect_uri: @redirect_uri,
+        scope: @scope,
+        duration: @duration,
+        state: state
+      )
+      @request.session[:redd_state] = state
+      [302, { 'Location' => url }, []]
+    end
+
+    # Do any setup before calling the rest of the application.
+    def before_call
+      # Convert the code to an access token if returning from authentication.
+      create_session! if @request.base_url + @request.path == @redirect_uri
+      # Clear the state for any other request.
+      @request.session.delete(:redd_state)
+      # Load a Session model from the access token in the user's cookies.
+      @request.env['redd.session'] = (@request.session[:redd_session] ? parse_session : nil)
+    end
+
+    # Do any cleanup or changes after calling the application.
+    def after_call
+      env_session = @request.env['redd.session']
+      if env_session && env_session.client.access
+        # Make sure to flush any changes made to the Session client to the browser.
+        @request.session[:redd_session] = env_session.client.access.to_h
+      else
+        # Clear the session if the app explicitly set 'redd.session' to nil.
+        @request.session.delete(:redd_session)
+      end
+    end
+
+    # Assigns a single string representing a reddit authentication errors.
+    def handle_token_error
+      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
+    end
+
+    # Store the access token and other details in the user's browser, assigning any errors to
+    # the 'redd.error' env variable.
+    def create_session!
+      # Skip authorizing if there was an error from the authorization.
+      handle_token_error
+      # 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
+      @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])
+      Redd::Models::Session.new(client)
+    end
+  end
+end

data/lib/redd/models/access.rb

@@ -5,10 +5,27 @@ require_relative 'basic_model'
 module Redd
   module Models
     # Models access_token and related keys.
+    # @note This model also supports an additional key, called `:created_at` which is a UNIX time
+    #   representing the time the access was created. The default value is the time the object was
+    #   initialized.
     class Access < BasicModel
+      # Create a non-lazily initialized Access.
+      # @param client [Object] (deprecated) the client to create the object with
+      # @param attributes [Hash] the Access's attributes
+      # @example
+      #   access = Redd::Models::Access.new(access_token: ...)
+      def initialize(client = nil, attributes = {})
+        if client.is_a?(Hash)
+          super(nil, client)
+        else
+          super(client, attributes)
+        end
+      end
+
       def expired?(grace_period = 60)
+        # We're not sure, so we just assume it hasn't expired.
         return false unless @attributes[:expires_in]
-        Time.now > @created_at + (@attributes[:expires_in] - grace_period)
+        Time.now.to_i > @attributes[:created_at] + (@attributes[:expires_in] - grace_period)
       end
 
       def permanent?
@@ -18,7 +35,7 @@ module Redd
       private
 
       def after_initialize
-        @created_at = Time.now
+        @attributes[:created_at] ||= Time.now.to_i
       end
     end
   end

data/lib/redd/utilities/error_handler.rb

@@ -14,6 +14,7 @@ module Redd
         400 => Redd::BadRequest,
         403 => Redd::Forbidden,
         404 => Redd::NotFound,
+        429 => Redd::TooManyRequests,
         500 => Redd::ServerError,
         502 => Redd::ServerError,
         503 => Redd::ServerError,

data/lib/redd/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redd
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Avinash Dwarapu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -162,6 +162,7 @@ files:
 - lib/redd/auth_strategies/web.rb
 - lib/redd/client.rb
 - lib/redd/error.rb
+- lib/redd/middleware.rb
 - lib/redd/models/access.rb
 - lib/redd/models/basic_model.rb
 - lib/redd/models/comment.rb