faraday_middleware-reddit 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb5d504dc531f50831b4b47a26b6a18599e23116
+  data.tar.gz: cc735e9f121b089f0b6d5f6fab22581b1baa0468
+SHA512:
+  metadata.gz: f8fe0ab6c2532f336dc901309782a7dd9cd3e25f568eb5cf73cc5e9dbd8455da32dbaa7d3d1a0d5bf5b3ce3c137b6f7a2312170f02badead8aa35a0f4f425469
+  data.tar.gz: b18fdbb8d7575f5a0d0d461e6b7a50d0fb101c2511f2e9151a83f3300850c8ab9f47c13ebb99aa5d274fe00ceb152b11f9b0a968898b1a127f9f59893e59c5b2

data/.rubocop.yml

@@ -0,0 +1,2 @@
+LineLength:
+  Max: 158

data/lib/faraday_middleware/reddit.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'faraday'
 
 module FaradayMiddleware
@@ -9,11 +11,11 @@ module FaradayMiddleware
 
     if Faraday::Middleware.respond_to? :register_middleware
       Faraday::Request.register_middleware \
-        :reddit_authentication => lambda { Authentication }
+        reddit_authentication: -> { Authentication }
       Faraday::Middleware.register_middleware \
-        :reddit_force_json     => lambda { ForceJson },
-        :reddit_modhash        => lambda { Modhash },
-        :reddit_rate_limit     => lambda { RateLimit }
+        reddit_force_json: -> { ForceJson },
+        reddit_modhash: -> { Modhash },
+        reddit_rate_limit: -> { RateLimit }
     end
   end
 end

data/lib/faraday_middleware/reddit/request/authentication.rb

@@ -1,48 +1,62 @@
+# encoding: utf-8
+
 require 'faraday'
 
-module FaradayMiddleware::Reddit
-  # Request middleware that automatically handles user login.
-  #
-  # Requires that either a `user` and `password` are provided or a
-  # pre-generated `cookie`. Performs an additional login request when no
-  # valid login cookie is available.
-  class Authentication < Faraday::Middleware
-    AUTH_URL = 'https://ssl.reddit.com/post/login'.freeze
-
-    dependency do
-      require 'json' unless defined?(::JSON)
-    end
+module FaradayMiddleware
+  module Reddit
+    # Request middleware that automatically handles user login.
+    #
+    # Requires that either a `user` and `password` are provided or a
+    # pre-generated `cookie`. Performs an additional login request when no
+    # valid login cookie is available.
+    class Authentication < Faraday::Middleware
+      AUTH_URL = 'https://ssl.reddit.com/post/login'.freeze
+
+      dependency do
+        require 'json' unless defined?(::JSON)
+      end
 
-    def initialize(app, options)
-      super(app)
-      @options = options
-      @user    = @options[:user]
-      @passwd  = @options[:password]
-      @rem     = @options[:remember]
-      @cookie  = @options[:cookie]
+      def initialize(app, options)
+        super(app)
+        @options      = options
+        @user         = @options[:user]
+        @passwd       = @options[:password]
+        @rem          = @options[:remember]
+        @access_token = @options[:access_token]
+        @cookie       = @options[:cookie]
 
-      unless (@options[:user] && @options[:password]) || @options[:cookie]
-        raise ArgumentError, 'Either `user` and `password` or `cookie` need to be provided as options to the :reddit_authentication middleware'
+        unless (@options[:user] && @options[:password]) || @options[:cookie] || @options[:access_token]
+          fail ArgumentError, 'Either `user` and `password`, `cookie`, or `access_token` need to be provided as options to the :reddit_authentication middleware'
+        end
       end
-    end
 
-    def call(env)
-      authenticate(env) unless @cookie
-      set_cookie(env)
-      @app.call(env)
-    end
+      def call(env)
+        if @access_token
+          apply_access_token(env)
+        elsif @cookie
+          apply_cookie(env)
+        else
+          authenticate(env)
+        end
 
-    def authenticate(env)
-      response = Faraday.post AUTH_URL, {:user => @user, :passwd => @passwd, :rem => @rem, :api_type => 'json'}
-      @cookie = response.headers['set-cookie']
-    end
+        @app.call(env)
+      end
+
+      def apply_access_token(env)
+        env.url.scheme = 'https'
+        env.url.port = 443
+        env.url.host = 'oauth.reddit.com'
+        env[:request_headers]['Authorization'] = "bearer #{@access_token}"
+      end
+
+      def apply_cookie(env)
+        upstream_cookies = env[:request_headers]['Cookie']
+        env[:request_headers]['Cookie'] = upstream_cookies ? "#{upstream_cookies}; #{@cookie}" : @cookie
+      end
 
-    def set_cookie(env)
-      upstream_cookies = env[:request_headers]['Cookie']
-      env[:request_headers]['Cookie'] = if upstream_cookies
-        "#{upstream_cookies}; #{@cookie}"
-      else
-        @cookie
+      def authenticate(env)
+        response = Faraday.post AUTH_URL, user: @user, passwd: @passwd, rem: @rem, api_type: 'json'
+        @cookie = response.headers['set-cookie']
       end
     end
   end

data/lib/faraday_middleware/reddit/use/force_json.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'faraday'
 
 module FaradayMiddleware

data/lib/faraday_middleware/reddit/use/modhash.rb

@@ -1,41 +1,47 @@
+# encoding: utf-8
+
 require 'faraday'
 
-module FaradayMiddleware::Reddit
-  # Middleware that keeps track of and sets modhash-related HTTP headers.
-  #
-  # Reddit uses modhashes as a form of XSS protection and requires them for
-  # most POST and PUT requests. Modhashes are currently provided in response
-  # to listing GET requests.
-  class Modhash < Faraday::Middleware
-    dependency do
-      require 'json' unless defined?(::JSON)
-    end
+module FaradayMiddleware
+  module Reddit
+    # Middleware that keeps track of and sets modhash-related HTTP headers.
+    #
+    # Reddit uses modhashes as a form of XSS protection and requires them for
+    # most POST and PUT requests. Modhashes are currently provided in response
+    # to listing GET requests.
+    class Modhash < Faraday::Middleware
+      dependency do
+        require 'json' unless defined?(::JSON)
+      end
 
-    def initialize(app, options = nil)
-      super(app)
-      @options = options || {}
-      @modhash = @options[:modhash]
-    end
+      def initialize(app, options = nil)
+        super(app)
+        @options = options || {}
+        @modhash = @options[:modhash]
+      end
 
-    def call(env)
-      @modhash = env[:modhash] if env[:modhash]
-      env[:request_headers]['X-Modhash'] = @modhash if @modhash
-      @app.call(env).on_complete do |env|
-        update_modhash(env)
+      def call(env)
+        @modhash = env[:modhash] if env[:modhash]
+        env[:request_headers]['X-Modhash'] = @modhash if @modhash
+        @app.call(env).on_complete do |response_env|
+          update_modhash(response_env)
+        end
       end
-    end
 
-    def from_json(data)
-      if data.is_a?(String) && !data.strip.empty? && data.include?('modhash')
-        JSON.parse(data)
-      else
-        data
+      def from_json(data)
+        if data.is_a?(String) && !data.strip.empty? && data.include?('modhash')
+          JSON.parse(data)
+        else
+          data
+        end
       end
-    end
 
-    def update_modhash(env)
-      body = from_json(env[:body])
-      @modhash = body['data']['modhash'] if body['data']
+      def update_modhash(env)
+        body = from_json(env[:body])
+        @modhash = body['data']['modhash'] if body['data']
+      rescue JSON::JSONError
+        # Ignore -- modhash can be acquired lazily.
+      end
     end
   end
 end

data/lib/faraday_middleware/reddit/use/rate_limit.rb

@@ -1,46 +1,50 @@
+# encoding: utf-8
+
 require 'faraday'
 
-module FaradayMiddleware::Reddit
-  # Middleware for automatic rate limiting.
-  #
-  # Logs reddit's ratelimit HTTP headers and applies a caching strategy
-  # based on them. The default strategy is to block for x-ratelimit-reset /
-  # x-ratelimit_remaining.
-  class RateLimit < Faraday::Middleware
-    def initialize(app, options = nil)
-      super(app)
-      @options = options || {}
-      @strategy = @options[:strategy] || lambda { linear_strategy }
-
-      # Default rate limit settings.
-      @ratelimit_remaining = 30
-      @ratelimit_used      = 0
-      @ratelimit_reset     = 60
-      @ratelimit_cap       = 30
-    end
+module FaradayMiddleware
+  module Reddit
+    # Middleware for automatic rate limiting.
+    #
+    # Logs reddit's ratelimit HTTP headers and applies a caching strategy
+    # based on them. The default strategy is to block for x-ratelimit-reset /
+    # x-ratelimit_remaining.
+    class RateLimit < Faraday::Middleware
+      def initialize(app, options = nil)
+        super(app)
+        @options = options || {}
+        @strategy = @options[:strategy] || -> { burst_strategy }
+
+        # Default rate limit settings.
+        @ratelimit_remaining = 30
+        @ratelimit_used      = 0
+        @ratelimit_reset     = 60
+        @ratelimit_cap       = 30
+      end
 
-    def call(env)
-      if @ratelimit_remaining <= 0 || env[:status] == 429
-        sleep(@ratelimit_reset)
-      else
-        @strategy.call
+      def call(env)
+        if @ratelimit_remaining <= 0 || env[:status] == 429
+          sleep(@ratelimit_reset)
+        else
+          @strategy.call
+        end
+
+        @app.call(env).on_complete { |response_env| on_complete_callback(response_env) }
       end
 
-      @app.call(env).on_complete do |env|
+      def on_complete_callback(env)
         @ratelimit_remaining = env[:response_headers]['x-ratelimit-remaining'].to_i
         @ratelimit_used      = env[:response_headers]['x-ratelimit-used'].to_i
         @ratelimit_reset     = env[:response_headers]['x-ratelimit-reset'].to_i
         @ratelimit_cap       = @ratelimit_remaining + @ratelimit_used
       end
-    end
 
-    def linear_strategy
-      sleep (@ratelimit_reset.to_f / [1, @ratelimit_remaining].max)
-    end
+      def linear_strategy
+        sleep @ratelimit_reset.to_f / [1, @ratelimit_remaining].max
+      end
 
-    def burst_strategy(threshold = 0.5)
-      if (@ratelimit_used / @ratelimit_cap.to_f) > threshold
-        linear_strategy
+      def burst_strategy(threshold = 0.5)
+        linear_strategy if (@ratelimit_used / @ratelimit_cap.to_f) > threshold
       end
     end
   end

data/lib/faraday_middleware/reddit/version.rb

@@ -1,5 +1,7 @@
+# encoding: utf-8
+
 module FaradayMiddleware
   module Reddit
-    VERSION = "0.2.1"
+    VERSION = '0.3.0'
   end
 end

data/spec/helper.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-reddit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel O'Brien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,23 +27,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -83,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -98,27 +90,26 @@ files:
 homepage: ''
 licenses:
 - Apache 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A collection of Faraday middleware for use with the Reddit API.
 test_files:
 - spec/helper.rb