rain_catcher 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5a8179b67bd0e585a9628916d516553f49c3b1c0023c469cdad1039a039f3e7
-  data.tar.gz: c1dfc52ef6467aead13a9028f51d076c94e0afbb212262d59e6a9c4b1c830ccb
+  metadata.gz: e69ef6215e313b33dacd8494eaf81230c721aa5e5f3870041bf196e9b2d22522
+  data.tar.gz: 947ba71bd43c15ae2b9788b334588a278869291e06509e8297e05c4584686af5
 SHA512:
-  metadata.gz: 792732e90285d60a51980e97d1fd0e01b64248114020d721c93ca5b92bc4d555063ef6fb4621b83d65c78fc37a7ccac96e5796266f43e63a8f76231177aead42
-  data.tar.gz: c029628b26fabe140bb3ca97d06dc655e77f1734e117a14503cf66383995eee9ac1e24a8a92b46a4b00045f18f8eefb14796982e6f5d2b72626d80a1812d5afe
+  metadata.gz: '0781633bbfc99b03708a95899c13dc4b1e1fd349c6a7d2528e72dc2f40719aad107d73464a6b04f520e5001ef0d2dc7d6f9dbc2faf0d40e9e3873d58cd042f80'
+  data.tar.gz: ef5509c7b0c29e572726e2dc8375af8a088e0c7ed794e07a83875abe51d88bb030caa1c2635ae86aacc581c094ec387b49dc1a32b1c997c781ec62a9dec9ef87

data/.gitignore

@@ -13,3 +13,6 @@
 # vim artefacts
 *.swo
 *.swp
+
+*.gem
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'

data/Gemfile.lock

@@ -1,22 +1,115 @@
 PATH
   remote: .
   specs:
-    rain_catcher (0.1.0)
+    rain_catcher (0.1.2)
+      rails (~> 5.0)
+      raindrops (~> 0.19.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
     ast (2.4.0)
+    builder (3.2.3)
+    byebug (11.0.1)
     concurrent-ruby (1.1.5)
+    crass (1.0.4)
     diff-lcs (1.3)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
     paint (2.1.0)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
+    raindrops (0.19.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -27,6 +120,9 @@ GEM
     rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
     rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
@@ -39,19 +135,35 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
     strong_versions (0.3.2)
       i18n (>= 0.5.0)
       paint (~> 2.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
+  byebug (~> 11.0)
   rain_catcher!
   rake (~> 10.0)
   rspec (~> 3.0)
+  rspec-its (~> 1.3)
   rubocop (~> 0.69.0)
   strong_versions (~> 0.3.2)
 

data/Makefile

@@ -0,0 +1,7 @@
+all: test
+
+.PHONY: test
+test:
+	bundle exec rspec
+	bundle exec rubocop
+	bundle exec strong_versions

data/README.md

@@ -1,13 +1,13 @@
 # RainCatcher
 
-_RainCatcher_ utilises the [raindrops](https://bogomips.org/raindrops/) statistics tool to automatically log _Rack_ web server queue data for _Rails_ applications.
+_RainCatcher_ utilises the [raindrops](https://bogomips.org/raindrops/) statistics tool to automatically log queue data for _Rack_ web servers (e.g. [Unicorn](https://bogomips.org/unicorn/) for _Rails_.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rain_catcher', '~> 0.1.0'
+gem 'rain_catcher', '~> 0.1.2'
 ```
 
 And rebuild your bundle:

data/lib/rain_catcher.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require 'rails'
+require 'raindrops'
+
 require 'rain_catcher/version'
 require 'rain_catcher/railtie'
+require 'rain_catcher/subscriber'
 
 module RainCatcher
   class Error < StandardError; end

data/lib/rain_catcher/railtie.rb

@@ -4,51 +4,40 @@ module RainCatcher
   class Railtie < Rails::Railtie
     initializer :rain_catcher do
       notifications.subscribe('process_action.action_controller') do |_args|
-        log_if_interval_elapsed
+        subscriber.log_if_interval_elapsed
       end
     end
 
-    private
+    class << self
+      private
 
-    def notifications
-      ActiveSupport::Notifications
-    end
-
-    def log_if_interval_elapsed
-      return unless elapsed?
-
-      Rails.logger.send(level, queue_data.to_json)
-      @last_logged = Time.now.utc
-    end
-
-    def queue_data
-      Raindrops::ListenStats.new(0, 0).to_h.merge(
-        source: 'rain_catcher',
-        application: application_name,
-        environment: Rails.env.to_s
-      )
-    end
-
-    def elapsed?
-      return true if @last_logged.nil?
-      return true if (Time.now.utc - @last_logged).seconds >= interval
+      def subscriber
+        @subscriber ||= RainCatcher::Subscriber.new(
+          interval: interval,
+          log_level: log_level,
+          application_name: application_name,
+          environment: Rails.env.to_s
+        )
+      end
 
-      false
-    end
+      def notifications
+        ActiveSupport::Notifications
+      end
 
-    def interval
-      @interval ||= ENV.fetch('RAIN_CATCHER_LOG_INTERVAL', '30').to_i
-    end
+      def interval
+        ENV.fetch('RAIN_CATCHER_LOG_INTERVAL', '30').to_i
+      end
 
-    def level
-      @level ||= ENV.fetch('RAIN_CATCHER_LOG_LEVEL', 'INFO').downcase.to_sym
-    end
+      def log_level
+        ENV.fetch('RAIN_CATCHER_LOG_LEVEL', 'INFO')
+      end
 
-    def application_name
-      @application_name ||= ENV.fetch(
-        'RAIN_CATCHER_APPLICATION_NAME',
-        Rails.application.class.name.split('::').first.downcase
-      )
+      def application_name
+        ENV.fetch(
+          'RAIN_CATCHER_APPLICATION_NAME',
+          Rails.application.class.name.split('::').first.downcase
+        )
+      end
     end
   end
 end

data/lib/rain_catcher/subscriber.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RainCatcher
+  class Subscriber
+    def initialize(options)
+      @interval = options.fetch(:interval)
+      @log_level = options.fetch(:log_level).to_s.downcase.to_sym
+      @application_name = options.fetch(:application_name)
+      @environment = options.fetch(:environment)
+      @last_logged = nil
+    end
+
+    def log_if_interval_elapsed
+      return unless elapsed?
+
+      Rails.logger.send(@log_level, queue_data.to_json)
+      @last_logged = Time.now.utc
+    end
+
+    private
+
+    def queue_data
+      Raindrops::ListenStats.new(0, 0).to_h.merge(
+        source: 'rain_catcher',
+        application: @application_name,
+        environment: @environment
+      )
+    end
+
+    def elapsed?
+      return true if @last_logged.nil?
+      return true if (Time.now.utc - @last_logged).seconds >= @interval
+
+      false
+    end
+  end
+end

data/lib/rain_catcher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RainCatcher
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/rain_catcher.gemspec

@@ -23,9 +23,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'rails', '~> 5.0'
+  spec.add_runtime_dependency 'raindrops', '~> 0.19.0'
+
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug', '~> 11.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.3'
   spec.add_development_dependency 'rubocop', '~> 0.69.0'
   spec.add_development_dependency 'strong_versions', '~> 0.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rain_catcher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Bob Farrell
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2019-05-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: raindrops
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -89,16 +145,18 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- Makefile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/rain_catcher.rb
 - lib/rain_catcher/railtie.rb
+- lib/rain_catcher/subscriber.rb
 - lib/rain_catcher/version.rb
-- rain_catcher-0.1.0.gem
 - rain_catcher.gemspec
 homepage: https://github.com/bobf/rain_catcher
 licenses: []