junk_drawer 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe91b47103e71acabd9a3948463e8760ccb56b81
-  data.tar.gz: 0cdbd3e51949f57e6f865e8d67151c6972108f17
+  metadata.gz: 7f11e6f56418b14bf2a44d91ffadff154fcf79a6
+  data.tar.gz: 2240a549479b367d864b343fc3d5106821fa074c
 SHA512:
-  metadata.gz: e19cd6d3fd82a1a1f54dc3fafad7f36eaef11f2d8518e18ab14eeb0a5f92dbaa1b79c2a715dcc63e312f13f22a6eb897364a1351a414692e15111da9074d632e
-  data.tar.gz: b3ec736499d2381f9a11dc36c26cd61b71f50fb8cb8964b12c7e40ddfd53e27834f085c29a50fa7682b82f76616349326471343c61388ff7cd556d413c0e19da
+  metadata.gz: b1692ef49d130c6b5e761fe1587871cbc3ebced928965eb98464dfc88ec0e436fa80de0837f4fa87162f2d162c3aba70cd571e72d3844380a5c1811a0bbadb7e
+  data.tar.gz: baaa55a6d653c4f514b0850777e31616f93af87758bfb592f629240934e7f7675eb5fa03780e8933618bc9140f8a399bf969138b1ce0ce391ac8bf28100effdd

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Guardfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 guard :rspec, cmd: 'bundle exec rspec' do
   require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)

data/README.md

@@ -25,7 +25,9 @@ Or install it yourself as:
 
 `JunkDrawer::Callable` is a module that provides constraints and conveniences
 for objects that implement a single method `#call`. It comes with the
-philosophy that objects that *do* something, should do only one thing. When including the `JunkDrawer::Callable` in one of your classes, you will get the following:
+philosophy that objects that *do* something, should do only one thing. When
+including the `JunkDrawer::Callable` in one of your classes, you will get the
+following:
 
 1) It raises an error if you try to implement a public method other than
   `#call`.
@@ -87,6 +89,51 @@ philosophy that objects that *do* something, should do only one thing. When incl
 
   http://www.brianstorti.com/understanding-ruby-idiom-map-with-symbol/
 
+-------------------------------------------------------------------------------
+
+### JunkDrawer::Notifier
+
+`JunkDrawer::Notifier` is a class that provides simple notification strategies
+for different environments. When you call it, it will send a notification via
+your selected strategy. The strategies available are as follows:
+
+1) `:raise` raises an error when you call the notifier:
+
+  ```ruby
+  JunkDrawer::Notifier.strategy = :raise
+  JunkDrawer::Notifier.call('some message', some: 'context')
+  ```
+
+  produces:
+
+  ```
+  JunkDrawer::NotifierError: some message, context: {:some=>"context"}
+  ```
+
+2) `:honeybadger` will send a notification to Honeybadger. You'll need to make
+  sure you have Honeybadger required in your application and configured for
+  this to work.
+
+3) `:null` is a noop. If you want to disable notifications temporarily, you can
+  configure the strategy to `:null`.
+
+If you're using Rails, you may want to configure `Notifier` based on the
+environment, so in your `config/environments/development.rb` you might have:
+
+```ruby
+config.after_initialize do
+  JunkDrawer::Notifier.strategy = :raise
+end
+```
+
+While in `production.rb` you might want:
+
+```ruby
+config.after_initialize do
+  JunkDrawer::Notifier.strategy = :honeybadger
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/junk_drawer.gemspec

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'lib/junk_drawer/version'
 
 Gem::Specification.new do |spec|

data/lib/junk_drawer.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
+
 require_relative 'junk_drawer/callable'
+require_relative 'junk_drawer/notifier'
 require_relative 'junk_drawer/version'
 
 # namespace for all JunkDrawer code
 module JunkDrawer
+  class NotifierError < StandardError
+  end
 end

data/lib/junk_drawer/callable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module JunkDrawer
   # error to be thrown by Callable
   class CallableError < StandardError

data/lib/junk_drawer/notifier.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'notifier/honeybadger_strategy'
+require_relative 'notifier/null_strategy'
+require_relative 'notifier/raise_strategy'
+
+module JunkDrawer
+  # class to send dev notifications to different channels
+  class Notifier
+
+    include Callable
+
+    class << self
+
+      attr_accessor :strategy
+
+    end
+
+    STRATEGIES = {
+      honeybadger: HoneybadgerStrategy,
+      raise: RaiseStrategy,
+      null: NullStrategy,
+    }.freeze
+
+    def call(*args)
+      strategy.(*args)
+    end
+
+  private
+
+    def strategy
+      STRATEGIES.fetch(self.class.strategy)
+    end
+
+  end
+end

data/lib/junk_drawer/notifier/honeybadger_strategy.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module JunkDrawer
+  class Notifier
+
+    # Notifier strategy to send a notification to Honeybadger
+    class HoneybadgerStrategy
+
+      include Callable
+
+      def call(message, **context)
+        error = message.is_a?(Exception) ? message : NotifierError.new(message)
+        Honeybadger.notify(error, context: context)
+      end
+
+    end
+
+  end
+end

data/lib/junk_drawer/notifier/null_strategy.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JunkDrawer
+  class Notifier
+
+    # Notifier strategy to silently swallow notifications and do nothing
+    class NullStrategy
+
+      include Callable
+
+      def call(*); end
+
+    end
+
+  end
+end

data/lib/junk_drawer/notifier/raise_strategy.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module JunkDrawer
+  class Notifier
+
+    # Notifier strategy to raise an error when notification is triggered
+    class RaiseStrategy
+
+      include Callable
+
+      def call(message, **context)
+        raise NotifierError, "#{message}, context: #{context}"
+      end
+
+    end
+
+  end
+end

data/lib/junk_drawer/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module JunkDrawer
-  VERSION = '1.1.1'
+  VERSION = '1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: junk_drawer
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - Robert Fletcher
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,6 +172,10 @@ files:
 - junk_drawer.gemspec
 - lib/junk_drawer.rb
 - lib/junk_drawer/callable.rb
+- lib/junk_drawer/notifier.rb
+- lib/junk_drawer/notifier/honeybadger_strategy.rb
+- lib/junk_drawer/notifier/null_strategy.rb
+- lib/junk_drawer/notifier/raise_strategy.rb
 - lib/junk_drawer/version.rb
 homepage: https://github.com/mockdeep/junk_drawer
 licenses:
@@ -193,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: random useful Ruby utilities