nexaas-throttle 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 239db002ccd08f97b093b62ac0769c8febb3781f
-  data.tar.gz: dc712921f451ec379ffba1d71d5321dea329f592
+  metadata.gz: d04c7fa7e0cf23c2a2d1381c1eb971aea3d4cc89
+  data.tar.gz: fa011ca4b2fec123adc1f3efb834222634196c1f
 SHA512:
-  metadata.gz: 04b82f2bddc6be8464287e23d6bd4eadee2382ceb6eb53a233b11696d280b14b89fdcf86b254b8a50109f5d9dcb340f183e460cda2658c8a9a603ebd073cf91b
-  data.tar.gz: a1c58b5330e94c33fb306ade160ab3e36aca9f237d49a027a62cdb1d0f8bb30bbc1703d0baee7f18cdc56fd2e8c367e2a2d55f33fa98b3227033a7a77f0c84d4
+  metadata.gz: 474d0584b741c34e6a76a108d1d7a9f2b782d38e726e2a46d9fe599d6cf242c8cfff85dbe0d575ee11724f3daa0878f71568f354495bd6ccd3a38a33c9b83866
+  data.tar.gz: 8751747095078371f503f70c084146d575466b5bad8326c262857e18655ba19258b361d0deb27c21a4680abe0f3af944452c7a2060896b7f1412d93a9f4fa7c8

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 *.rbc
+*.swp
 /.config
 /coverage/
 /InstalledFiles

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## v2.0
+- The gem no longer checks if the request is made from an API client. See [#6](https://github.com/myfreecomm/nexaas-throttle/pull/6) for discussion.
+## v1.0
+- Allow the configuration of user-agents to ignore when throttling. [#5](https://github.com/myfreecomm/nexaas-throttle/pull/5)
+### v0.1.0
+- Initial commit

data/README.md

@@ -94,7 +94,7 @@ end
   </tr>
   <tr>
     <td><code>ignored_user_agents</code></td>
-    <td>Ignores how many User-Agent the application wants, in case of other applications from the same organization.</td>
+    <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>
 </table>
@@ -104,6 +104,8 @@ end
 `Nexaas::Throttle` doesn't know how to identify a consumer. Some applications might rely on request IP, others on an API TOKEN. You must provide a way of getting an unique token
 that identify a request consumer.
 
+If there is no token, the request will go through and won't be accounted for.
+
 `Nexaas::Throttle` do this by providing a configuration `request_identifier`, a class where your application would keep the logic that identifies a consumer. This class must have the following
 interface:
 

data/lib/nexaas/throttle/configuration.rb

@@ -37,7 +37,8 @@ module Nexaas
       # @return [Hash]
       attr_reader :redis_options
 
-      # Ignores how many User-Agent the application wants, in case of other applications from the same organization.
+      # An array of User Agents that should be ignored by the throttler.
+      # Values are regexes that will be matched against the request User-Agent.
       # Example: [/[Gg]oogle/, /Amazon/]
       # @return [Array]
       attr_accessor :ignored_user_agents

data/lib/nexaas/throttle/guardian.rb

@@ -22,7 +22,7 @@ module Nexaas
       attr_reader :request, :token, :ignored_user_agents
 
       def validate
-        return if ignore_user_agents? || assets? || !api? || token.blank?
+        return if ignore_user_agents? || assets? || token.blank?
         request.env["nexaas.token"] = token
         yield if block_given?
       end
@@ -32,11 +32,6 @@ module Nexaas
         path.match(/\/assets/).present? || path.match(extensions_regexp).present?
       end
 
-      def api?
-        content_type = (request.media_type || request.env["Content-Type"]).to_s
-        %w(application/json application/xml).include?(content_type)
-      end
-
       def extensions_regexp
         @assets_extensions ||= begin
           extensions = %w(css js png jpg gif)

data/lib/nexaas/throttle/version.rb

@@ -1,5 +1,5 @@
 module Nexaas
   module Throttle
-    VERSION = "1.0.0".freeze
+    VERSION = "2.0.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexaas-throttle
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Wanderson Policarpo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2017-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -182,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A tiny engine to allow throttling and blacklisting requests.