xcflushd 1.0.0.rc2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 694ae11bc7807759b892802c006f028b0a10013b
-  data.tar.gz: 6a11f6bc59ceb76f3dae647a0d1be9d985c56591
+  metadata.gz: 99f1cb623f33f531541f29169d019be6f8cc16cc
+  data.tar.gz: 44ddf936023001785ab6f09a959bc56ad9ea401e
 SHA512:
-  metadata.gz: 0196ba49fbbe148073389232a18941af5533e267c16d054d04a62877660fcfe67558027f9077d3b440ce6f6026280742297f2b1884ff091c18488741caf06205
-  data.tar.gz: 50d187cab468d4546c498a6254d56fa144ac910ce4e7597aa921d43d3c10e82bc7833205f0fe6608d43b062c6ba1c2ea8363ffc47b7289dbc9cb7a6c5f7c5024
+  metadata.gz: 4c15f4195eec039d97a9a1626a920b245496460253428ccd3f0117d6bc8153ca30f37c2aebfcb43d1c73f123b71941398950eca58829257277271636babe4990
+  data.tar.gz: 5a421824e1e674541a76206f183a7e5ca8af42e464eed2c537974a4ad522a5d2ee895b99a1b3f2f80eb6b11643ef6b4a28bcb5b949c8635b37a5f44ebc876a25

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    xcflushd (1.0.0.rc2)
-      3scale_client (~> 2.10.0)
+    xcflushd (1.0.0)
+      3scale_client (~> 2.10)
       concurrent-ruby (= 1.0.2)
       daemons (= 1.2.4)
       gli (= 2.14.0)
       hiredis (= 0.6.1)
       net-http-persistent (= 2.9.4)
-      redis (= 3.3.1)
+      redis (= 3.3.2)
 
 GEM
   remote: https://rubygems.org/
@@ -33,13 +33,13 @@ GEM
       ast (~> 2.2)
     powerpack (0.1.1)
     rainbow (2.1.0)
-    rake (11.2.2)
-    redis (3.3.1)
+    rake (11.3.0)
+    redis (3.3.2)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.2)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -66,7 +66,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.12)
+  bundler (~> 1.13)
   fakeredis (~> 0.6.0)
   rake (~> 11.0)
   rspec (~> 3.0)

data/README.md

@@ -5,7 +5,7 @@
 ## Description
 
 This is the daemon that flushes the data that the gateway side of XC like the
-[apicast-xc](https://github.com/3scale/apicast-xc) module running on top of [Apicast](https://github.com/3scale/apicast), stores for reporting and authorizing to 3scale.
+[apicast-xc](https://github.com/3scale/apicast-xc) module running on top of [APIcast](https://github.com/3scale/apicast), stores for reporting and authorizing to 3scale.
 
 When you deploy 3scale to a gateway you usually have a request performed to
 3scale for every request that needs authorization, which introduces latency and
@@ -68,7 +68,7 @@ $ docker run --rm xcflushd bundle exec xcflushd help run
 
 You can send the options as params in the `xcflushd` command:
 ```
-$ docker run --rm xcflushd bundle exec xcflushd run --auth-ttl 900 --provider-key my_provider_key --redis 127.0.0.1:6379 --frequency 300 --backend https://su1.3scale.net:443
+$ docker run --rm -it xcflushd bundle exec xcflushd run --auth-ttl 900 --provider-key my_provider_key --redis 127.0.0.1:6379 --frequency 300 --backend https://su1.3scale.net:443
 ```
 
 Please note that the help command will also show you abbreviated flags you can
@@ -88,7 +88,7 @@ $ bundle exec xcflushd help
 
 ### Openshift
 
-If what you need is deploying Xcflushd together with Apicast and XC, you can
+If what you need is deploying Xcflushd together with APIcast and XC, you can
 follow the instructions provided in the [apicast-xc repo](https://github.com/3scale/apicast-xc).
 
 

data/docs/design.md

@@ -3,7 +3,7 @@
 ## Description
 
 xcflushd is a daemon used together with [XC](https://github.com/3scale/apicast-xc),
-which is a module for [Apicast](https://github.com/3scale/apicast), 3scale's
+which is a module for [APIcast](https://github.com/3scale/apicast), 3scale's
 API Gateway.
 
 If you are not familiar with XC yet, we recommend you to start reading its
@@ -61,7 +61,7 @@ in the reports sent to 3scale's backend, and 2) do not have any limits defined.
 The whole flushing process makes 2 calls to 3scale per application reported.
 One call to send the report to 3scale, and another one to get the current
 authorization status. Compare that to making one request for each one that
-arrives to the proxy as in the case of Apicast. Imagine that you have 1k rps,
+arrives to the proxy as in the case of APIcast. Imagine that you have 1k rps,
 and 100 apps. If you define a period of 1 minute for the flushing process, you
 will be making 200 requests to 3scale's backend per minute instead of 60k.
 

data/lib/xcflushd/logger.rb

@@ -3,6 +3,28 @@ require 'logger'
 module Xcflushd
   class Logger
     def self.new(*args)
+      # Logging to a IO-like object.
+      #
+      # When the IO object is a TTY, Ruby sets line buffered mode, which is
+      # ok for logs. However, when it is not a TTY, Ruby sets up a buffer
+      # of unspecified size that causes applications that write few logs to
+      # appear as inactive in the log stream. This is a problem when trying
+      # to diagnose issues.
+      #
+      # Unfortunately Ruby only exposes a couple of limited ways to control
+      # the underlying buffering: IO#(f)sync and IO#flush. Apparently the C
+      # runtime stdio buffering is replaced by Ruby's own, so there is no
+      # point in trying to call setvbuf, and no point either in trying to
+      # control a TTY, since that case is fine.
+      #
+      # Since our logging stream activity is fairly low it's reasonable to
+      # use IO#sync for the non TTY case to have (hopefully) a behaviour
+      # similar to line-buffered standard I/O.
+      #
+      # More info on http://tuxdna.in/files/notes/ruby-io.html.
+      #
+      io = args[0]
+      io.sync = true unless io.tty?
       ::Logger.new(*args)
     end
   end

data/lib/xcflushd/runner.rb

@@ -97,6 +97,8 @@ module Xcflushd
           end
         end
         @logger.info('Exiting')
+      rescue SignalException => e
+        @logger.fatal("Received unhandled signal #{e.cause}, shutting down")
       rescue Exception => e
         @logger.fatal("Unhandled exception #{e.class}, shutting down: #{e.cause} - #{e}")
       ensure
@@ -157,8 +159,12 @@ module Xcflushd
 
       def setup_sighandlers
         @exit = false
-        Signal.trap('EXIT') { @exit = true }
-        Signal.trap('INT') { @exit = true }
+        ['HUP', 'USR1', 'USR2'].each do |sig|
+          Signal.trap(sig, "SIG_IGN")
+        end
+        ['EXIT', 'TERM', 'INT'].each do |sig|
+          Signal.trap(sig) { @exit = true }
+        end
       end
     end
   end

data/lib/xcflushd/storage_keys.rb

@@ -80,10 +80,12 @@ module Xcflushd
       # Returns an array of size 2 with a service and the credentials encoded
       # given a key marked as 'to be flushed' and its suffix.
       def service_and_creds(key_to_flush, suffix)
-        escaped_service, escaped_creds =
-            key_to_flush.sub("#{KEY_TO_FLUSH_PREFIX}#{REPORT_KEY_PREFIX}", '')
-                        .sub(suffix, '')
-                        .split(/(?<!\\),/)
+        split_key = key_to_flush.sub("#{KEY_TO_FLUSH_PREFIX}#{REPORT_KEY_PREFIX}", '')
+                                .sub(suffix, '')
+                                .split(/(?<!\\),/)
+
+        escaped_service = split_key.first
+        escaped_creds = split_key[1..-1].join(','.freeze)
 
         # escaped_service is a string with 'service_id:' followed by the escaped
         # service ID. escaped_creds starts with 'credentials:' and is followed

data/lib/xcflushd/version.rb

@@ -1,3 +1,3 @@
 module Xcflushd
-  VERSION = "1.0.0.rc2"
+  VERSION = "1.0.0"
 end

data/xcflushd.gemspec

@@ -10,7 +10,11 @@ Gem::Specification.new do |spec|
   spec.email         = ["support@3scale.net"]
 
   spec.summary       = %q{Daemon for flushing XC reports to 3scale.}
-  spec.description   = %q{Daemon for flushing XC reports to 3scale.}
+  spec.description   = "xcflushd is a daemon that connects to a Redis database " \
+                       "containing 3scale's XC API Management data and flushes " \
+                       "it to the 3scale service for cached reporting and " \
+                       "authorizations. Check https://github.com/3scale/apicast-xc" \
+                       " for an implementation of a 3scale's XC gateway."
   spec.homepage      = "https://github.com/3scale/xcflushd"
 
   spec.license       = "Apache-2.0"
@@ -22,15 +26,15 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.1.0'
 
-  spec.add_runtime_dependency "3scale_client", "~> 2.10.0"
+  spec.add_runtime_dependency "3scale_client", "~> 2.10"
   spec.add_runtime_dependency "gli", "= 2.14.0"
-  spec.add_runtime_dependency "redis", "= 3.3.1"
+  spec.add_runtime_dependency "redis", "= 3.3.2"
   spec.add_runtime_dependency "hiredis", "= 0.6.1"
   spec.add_runtime_dependency "concurrent-ruby", "1.0.2"
   spec.add_runtime_dependency "net-http-persistent", "2.9.4"
   spec.add_runtime_dependency "daemons", "= 1.2.4"
 
-  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "fakeredis", "~> 0.6.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcflushd
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: 3scale_client
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: '2.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: 3.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: 3.3.2
 - !ruby/object:Gem::Dependency
   name: hiredis
   requirement: !ruby/object:Gem::Requirement
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +193,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.46.0
-description: Daemon for flushing XC reports to 3scale.
+description: xcflushd is a daemon that connects to a Redis database containing 3scale's
+  XC API Management data and flushes it to the 3scale service for cached reporting
+  and authorizations. Check https://github.com/3scale/apicast-xc for an implementation
+  of a 3scale's XC gateway.
 email:
 - support@3scale.net
 executables:
@@ -254,12 +257,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Daemon for flushing XC reports to 3scale.