job_notifier 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4a42600c4c16fa382df5bfe5c6cf10bde4dfc75
-  data.tar.gz: edabfe1c6b5adafc952228d277ef9edbdfd7068e
+  metadata.gz: 21ffc220bcb6f8ff44ad12e24bd1194de072ce08
+  data.tar.gz: 43341870fcd7f3423f140b9d3a48c65305dd083e
 SHA512:
-  metadata.gz: 80191498e36199a9525b997a9e5f863d9c9557c3e93a52e089324e3beba3b91e5fc4f2236d20f72a24b5dc18dbadb8364e9b65d9d55a41c53038cab498579445
-  data.tar.gz: 4a0b2960c96969726b856f9c422d859d9168b277dd9dd2aaa102efc4c16cb4c0681b0ba046a8bcfaf51635578db2863417c41e5644fbf3d0a5d0d2f2908cf563
+  metadata.gz: 32cfd08816e6318de16e6d4a7a728e76f586ab29409e200d5258decbc35188151f4b915f8ed2e7c4bad10a59d07567bfd325cc862834ef3a212fa44145cf135f
+  data.tar.gz: 96888a7b4bff7199c1d633a068478559d8df213cd17819238f03f2ee2fbd2a67c47b681a91d972ae1ca24b20700cd23e003082523198c5118efd2aaebe6fc754

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### v1.3.0
+
+##### Added
+
+- Add silenced_log config option to disable silencer gem.
+
 ### v1.2.4
 
 ##### Fixed
@@ -12,7 +18,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ##### Changed
 
-- Avoid raising error with undefined verify_authenticity_token method
+- Avoid raising error with undefined verify_authenticity_token method.
 
 ### v1.2.2
 
@@ -73,4 +79,4 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### v0.1.0
 
-* Initial release.
+- Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    job_notifier (1.2.4)
+    job_notifier (1.3.0)
       colorize (>= 0.7.7)
       enumerize (>= 1.0)
       rails (>= 4.2.0)
@@ -71,7 +71,7 @@ GEM
     json (2.0.3)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
-    mail (2.6.5)
+    mail (2.6.6)
       mime-types (>= 1.16, < 4)
     method_source (0.8.2)
     mime-types (3.1)

data/README.md

@@ -2,17 +2,17 @@
 
 It's a Rails engine built on top of [Active Job](https://github.com/rails/activejob) in order to **improve user experience related to background processes**. To achieve this goal, the gem allows us to:
 
-1. **Relate jobs with entities**
+- **Relate jobs with entities**
 
  Using [Active Job](https://github.com/rails/activejob), you can perform background jobs but, you can not relate them with, for example, a logged user. Job Notifier allows you to connect an entity with a job easily.
 
-1. **Persist job results**
+- **Persist job results**
 
  Using [Active Job](https://github.com/rails/activejob), you can run jobs in background but, you are not be able to store the result of those jobs. This is a desired behavior if you, for example, want to provide validation feedback to users.
 
-1. **Notify users when their jobs change state.**
+- **Notify users when their jobs change state.**
 
- Using [Active Job](https://github.com/rails/activejob), you can run jobs in background but, you lose a real time response. To bring a solution to this issue, Job Notifier, through polling technique,  gives you a way to know what's happening with your jobs.
+ Using [Active Job](https://github.com/rails/activejob), you can run jobs in background but, you lose a real time response. To bring a solution to this issue, Job Notifier, through polling technique, gives you a way to know what's happening with your jobs.
 
 ## Installation
 

data/lib/generators/job_notifier/install/templates/initializer.rb

@@ -2,4 +2,8 @@ JobNotifier.setup do |config|
   # If you're using an app client that is not part of rails project where Job Notifier gem was
   #  installed, you can define a custom root_url. For example: "http://app.platan.us/"
   # config.root_url = "/"
+
+  # This gem uses the polling technique to inform what's happening with your jobs. This generates
+  #  a noisy log output. If you want to silence this output
+  # config.silenced_log = false
 end

data/lib/job_notifier.rb

@@ -6,13 +6,18 @@ require "silencer"
 module JobNotifier
   extend self
 
-  attr_writer :root_url
+  attr_writer :root_url, :silenced_log
 
   def root_url
     return "/" unless @root_url
     @root_url
   end
 
+  def silenced_log
+    return false unless @silenced_log
+    @silenced_log
+  end
+
   def setup
     yield self
     require "job_notifier"

data/lib/job_notifier/engine.rb

@@ -20,9 +20,15 @@ module JobNotifier
         helper(JobNotifier::ApplicationHelper)
       end
 
-      Rails.application.middleware.swap(
-        Rails::Rack::Logger, Silencer::Logger, silence: [%r{\/job_notifier\/\w+\/jobs\/\w+.json}])
-      Rails.application.middleware.insert_before(Silencer::Logger, JobNotifier::Logger)
+      if JobNotifier.silenced_log
+        Rails.application.middleware.swap(
+          Rails::Rack::Logger,
+          Silencer::Logger,
+          silence: [%r{\/job_notifier\/\w+\/jobs\/\w+.json}]
+        )
+
+        Rails.application.middleware.insert_before(Silencer::Logger, JobNotifier::Logger)
+      end
     end
   end
 end

data/lib/job_notifier/error.rb

@@ -1,31 +1,31 @@
 module JobNotifier
   module Error
-    class InvalidIdentifier < Exception
+    class InvalidIdentifier < RuntimeError
       def initialize
         super("you need to pass a non blank identifier")
       end
     end
 
-    class MissingAttributes < Exception
+    class MissingAttributes < RuntimeError
       def initialize
         super("you need to execute identify_job_through method on host model")
       end
     end
 
-    class BlankAttribute < Exception
+    class BlankAttribute < RuntimeError
       def initialize(attribute)
         super("#{attribute} cant be blank")
       end
     end
 
-    class InvalidAdapter < Exception
+    class InvalidAdapter < RuntimeError
       def initialize
         file_names = JobNotifier::Adapters.names.join(", ")
         super("The adapter must be one of: #{file_names}")
       end
     end
 
-    class Validation < Exception
+    class Validation < RuntimeError
       attr_reader :error
 
       def initialize(error)

data/lib/job_notifier/version.rb

@@ -1,3 +1,3 @@
 module JobNotifier
-  VERSION = "1.2.4"
+  VERSION = "1.3.0"
 end

data/spec/dummy/config/initializers/job_notifier.rb

@@ -2,4 +2,8 @@ JobNotifier.setup do |config|
   # If you're using an app client that is not part of rails project where Job Notifier gem was
   #  installed, you can define a custom root_url. For example: "http://app.platan.us/"
   # config.root_url = "/"
+
+  # This gem uses the polling technique to inform what's happening with your jobs. This generates
+  #  a noisy log output. If you want to silence this output
+  # config.silenced_log = false
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: job_notifier
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Platanus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails