nexaas-throttle 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7c4964a580e1a99b516bd954446768224236b885
-  data.tar.gz: '014842f2eec77ec70cd58ddc9fba63e8072bdb83'
+SHA256:
+  metadata.gz: 63a2423df0234df78dcb667687185860e9fffe7da34bdafc520f57e480c7d2e3
+  data.tar.gz: 51516ec7615f7e3fc9e5db4561b35bae394df11cc513cfc53274175b68ee824c
 SHA512:
-  metadata.gz: 0d70753f56f4f791dee1745d4ba2b4d426ae652c3bf343257fd1da442ec3fed98041b7870dd1fb78b1d31dc29abbc460c69731a382a7161c0892ac6a1b0da74e
-  data.tar.gz: 78bc184861a5a32fe0c618b0d6a14deff7d12c3021bf991a745f785d7f093c1e7267803d8c74cc2f61c6a76fd08241f4563bb6f5836d958fd245dc5c14f83d78
+  metadata.gz: f4e40bbf21e279edb238494a6cc4872060148fe7edd50595878c77ba042c0a3afe2bfc86e33ba2ca23df8064ba4dc24a6422b57bcc9f65c38d2f404bbd7789b2
+  data.tar.gz: a41733cddfcb736f25b3c235c3389c87668d7bc13465b6024a194b455547d2d6896db8a5bd298714b3cb9ac989f86bbccfe9935e9cad79c046678109e390c2e1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### v2.0.2
+- Stop checking for query string in request#path. [#10](https://github.com/myfreecomm/nexaas-throttle/pull/10)
+- Add information on README regarding X-RateLimit headers. [#9](https://github.com/myfreecomm/nexaas-throttle/pull/9)
 ### v2.0.1
 - Fix regex matching when checking if a given request is asset-related. [#7](https://github.com/myfreecomm/nexaas-throttle/pull/7)
 ## v2.0

data/README.md

@@ -42,6 +42,7 @@ Nexaas::Throttle.configure do |config|
     namespace: "nexaas:throttle"
   }
   config.ignored_user_agents = [/[Gg]oogle/, /Amazon/]
+  config.assets_extensions = %w[bmp tiff css js jpg jpeg png gif woff ttf svg]
 end
 ```
 
@@ -97,6 +98,11 @@ end
     <td>An array of User Agents that should be ignored by the throttler. Values are regexes that will be matched against the request User-Agent</td>
     <td><code>nil</code></td>
   </tr>
+  <tr>
+    <td><code>assets_extensions</code></td>
+    <td>An array of file extensions considered to be asset-related. Values are strings that will be matched against the request path. Paths that match will be not be throttled</td>
+    <td><code>%w[css js jpg jpeg png gif woff ttf svg]</code></td>
+  </tr>
 </table>
 
 ### Request Identification
@@ -139,6 +145,16 @@ end
 
 If you want, you can access the request token by inspecting `request.env["nexaas.token"]`. This is the token your `request_identifier` provided after evaluating the request.
 
+### Response headers
+
+Rate limit headers are available for all request responses and provide information for API users. They are the following:
+
+```ruby
+"X-RateLimit-Limit"     # Total of requests allowed until next reset.
+"X-RateLimit-Remaining" # Amount of requests the user can still send before being throttled.
+"X-RateLimit-Reset"     # Epoch time for the reset of the request count.
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/nexaas/throttle/configuration.rb

@@ -43,6 +43,13 @@ module Nexaas
       # @return [Array]
       attr_accessor :ignored_user_agents
 
+      # An array of file extensions considered to be asset-related.
+      # Values are strings that will be matched against the request path.
+      # Paths that match will be not be throttled.
+      # Example: ["css", "js", "jpeg", "jpg", "png"]
+      # @return [Array]
+      attr_accessor :assets_extensions
+
       alias_method :throttleable?, :throttle
       alias_method :trackable?, :track
 
@@ -54,6 +61,7 @@ module Nexaas
         @request_identifier = nil
         @redis_options = default_redis_options
         @ignored_user_agents = nil
+        @assets_extensions = %w[css js jpg jpeg png gif woff ttf svg]
       end
 
       def check!

data/lib/nexaas/throttle/guardian.rb

@@ -7,6 +7,7 @@ module Nexaas
         @request = request
         @token = configuration.request_identifier.new(request).token
         @ignored_user_agents = configuration.ignored_user_agents
+        @assets_extensions = configuration.assets_extensions
       end
 
       def throttle!
@@ -19,24 +20,22 @@ module Nexaas
 
       private
 
-      attr_reader :request, :token, :ignored_user_agents
+      attr_reader :request, :token, :ignored_user_agents, :assets_extensions
 
       def validate
-        return if ignore_user_agents? || assets? || token.blank?
+        return if ignore_user_agents? || asset_request? || token.blank?
         request.env["nexaas.token"] = token
         yield if block_given?
       end
 
-      def assets?
+      def asset_request?
         path = request.path
-        path.match(%r{/assets}).present? || path.match(extensions_regexp).present?
+        path.match(%r{/assets}).present? || path.match(assets_extensions_regexp).present?
       end
 
-      def extensions_regexp
-        @assets_extensions ||= begin
-                                 extensions_group = %w(css js png jpg gif).join("|")
-                                 /\.(#{extensions_group})(\?\S*)?$/
-                               end
+      def assets_extensions_regexp
+        extensions = assets_extensions.join("|")
+        /\.(#{extensions})$/
       end
 
       def ignore_user_agents?

data/lib/nexaas/throttle/version.rb

@@ -1,5 +1,5 @@
 module Nexaas
   module Throttle
-    VERSION = "2.0.1".freeze
+    VERSION = "2.0.2".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexaas-throttle
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Wanderson Policarpo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2018-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A tiny engine to allow throttling and blacklisting requests.