bystander 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab91cc6152250993e6eddd5e7aa68d7ebf0928d8
+  data.tar.gz: 10d52f786b8856f329a4c03119095127096ab673
+SHA512:
+  metadata.gz: 796472da0f45288fa328c7ad406cdb815613e0f54a61d92ddfebf9a8b387d976740c323284f48186f2ec098f63a81e4425a0952ac152c3e218bc2b95489f036d
+  data.tar.gz: 83453d0e50711c9ded9b60048253949c390b66b4f8da979a11716e905352dca0668d0b063b7a550fdf339d2eda0f4f9368a8ffd15cca603870967cc67d330dad

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'minitest'
+gem 'mocha'
+
+gem 'slack-notifier'

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    metaclass (0.0.4)
+    minitest (5.3.2)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    rake (10.3.2)
+    slack-notifier (0.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  mocha
+  rake
+  slack-notifier

data/README.md

@@ -0,0 +1,84 @@
+# Bystander
+
+A Ruby Gem that makes it easy to log your application's Critical Paths™ without
+having to touch the behaviour of your code.
+
+![Bystander in action, in a Slack channel](/screenshot.png?raw=true)
+
+## Getting started
+
+### How does it work?
+
+With some basic configuration, Bystander hooks in to your Ruby classes
+and creates a log entry every time one of the methods you specify is
+called, and when the method returns.
+
+### Where does it log to?
+
+Anywhere! Well, if you want it to. Currently it defaults to logging to a
+[Slack](https://slack.com) channel, but is designed to work with any
+transport method (warning: you're gonna have to write some code).
+
+### Usage
+
+#### Automatic Logging
+
+At the top of the class containing the methods you want to log, include
+the `Bystander` module and tell it what methods you're interested in.
+
+```ruby
+class MaintenanceHandler
+  include Bystander
+  notify [:under_maintenance]
+
+  def under_maintenance
+    #...
+  end
+end
+```
+
+Whenever this method is called, Bystander will log the call and the
+return:
+
+```
+Calling: MaintenanceHandler::under_maintenance([])
+Finished: MaintenanceHandler::under_maintenance([])
+```
+
+#### Manual Logging
+
+Bystander has a basic capability to log custom messages, inline in your
+code, like a normal logger.
+
+```ruby
+Bystander.log("I've made a huge mistake")
+```
+
+### Configuration
+
+#### Slack
+
+Before you use Bystander, ensure you run the following configuration
+block (e.g., in a Rails initializer):
+
+```ruby
+Bystander::Transports::Slack.configure do |slack|
+  slack.domain      'wcmc'
+  slack.username    'Bystander'
+  slack.auth_token  ENV['SLACK_AUTH_TOKEN']
+  slack.channel     '#bystander'
+
+  # Prepend all messages with this string. Useful for env info, etc.
+  slack.prepend     "#{ENV['RAILS_ENV']} - (##{Process.pid}):"
+end
+```
+
+## Using Bystander in Tests
+
+Most of the time you won't want Bystander running during tests. To
+disable Bystander, preface your test code (for example, in your
+`test_helper.rb`) with:
+
+```
+Bystander.enable_testing!
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/bystander.gemspec

@@ -0,0 +1,20 @@
+require File.expand_path('../lib/bystander/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Adam Mulligan", "Andrea Rossi"]
+  gem.email         = ["adam.mulligan@unep-wcmc.org", "andrea.rossi@unep-wcmc.org"]
+  gem.description   = gem.summary =  "Log your application flow without any ugly loggers"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- test/*`.split("\n")
+  gem.name          = "bystander"
+  gem.require_paths = ["lib"]
+  gem.version       = Bystander::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'mocha'
+
+  gem.add_dependency 'slack-notifier', '~> 0.6.0'
+end
+

data/lib/bystander.rb

@@ -0,0 +1,20 @@
+require 'bystander/transports/slack'
+require 'bystander/class_methods'
+
+module Bystander
+  def self.included base
+    base.extend ClassMethods
+  end
+
+  def self.log message
+    transport.notify message
+  end
+
+  def self.transport
+    @transport ||= Bystander::Transports::Slack
+  end
+
+  def self.transport= transport
+    @transport = transport
+  end
+end

data/lib/bystander/class_methods.rb

@@ -0,0 +1,53 @@
+require 'bystander/notifier'
+require 'bystander/util/testing'
+
+module Bystander
+  module ClassMethods
+    @@methods_to_notify = []
+    @@redefined_methods = []
+
+    def notify methods
+      @@methods_to_notify = methods
+    end
+
+    def method_added method
+      if notify?(method) && !redefined?(method)
+        @@redefined_methods << method
+        wrap_instance_method instance_method(method)
+      end
+    end
+
+    def singleton_method_added method
+      if notify?(method) && !redefined?(method)
+        @@redefined_methods << method
+        wrap_class_method method(method)
+      end
+    end
+
+    private
+
+    def notify? method
+      @@methods_to_notify.include? method
+    end
+
+    def redefined? method
+      @@redefined_methods.include? method
+    end
+
+    def wrap_instance_method method
+      define_method(method.name) do |*args, &block|
+        Bystander::Notifier.wrap("#{self.class.to_s}##{method.name}(#{args.join(', ')})") do
+          method.bind(self).call(*args, &block)
+        end
+      end
+    end
+
+    def wrap_class_method method
+      define_singleton_method(method.name) do |*args, &block|
+        Bystander::Notifier.wrap("#{self.to_s}::#{method.name}(#{args.join(', ')})") do
+          method.call(*args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/bystander/notifier.rb

@@ -0,0 +1,13 @@
+module Bystander
+  module Notifier
+
+    def self.wrap identifier
+      Bystander.transport.notify "Calling: #{identifier}"
+      return_value = yield
+      Bystander.transport.notify "Finished: #{identifier}"
+
+      return_value
+    end
+
+  end
+end

data/lib/bystander/transports/dev_null.rb

@@ -0,0 +1,14 @@
+module Bystander
+  module Transports
+    module DevNull
+      def self.notify message
+        # `echo #{message} > /dev/null`
+      end
+
+      def self.configure
+        yield self
+      end
+    end
+  end
+end
+

data/lib/bystander/transports/slack.rb

@@ -0,0 +1,32 @@
+require 'slack-notifier'
+
+module Bystander
+  module Transports
+    module Slack
+      SETTINGS = [:domain, :username, :auth_token, :channel, :prepend]
+
+      SETTINGS.each do |setting|
+        define_singleton_method(setting) do |*args|
+          return instance_variable_get(:"@#{setting}") if args.length == 0
+          instance_variable_set(:"@#{setting}", args[0])
+        end
+      end
+
+      def self.slack
+        @slack ||= ::Slack::Notifier.new(domain, auth_token).tap { |slack|
+          slack.channel = channel
+          slack.username = username
+        }
+      end
+
+      def self.notify message
+        slack.ping "_#{prepend}_ `#{message}`"
+      end
+
+      def self.configure
+        yield self
+      end
+
+    end
+  end
+end

data/lib/bystander/util/testing.rb

@@ -0,0 +1,7 @@
+require 'bystander/transports/dev_null'
+
+module Bystander
+  def self.enable_testing!
+    transport = Bystander::Transports::DevNull
+  end
+end

data/lib/bystander/version.rb

@@ -0,0 +1,3 @@
+module Bystander
+  VERSION = "1.0.0"
+end

data/test/bystander_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class TestObject < Object; end;
+
+class BystanderTest < MiniTest::Test
+  def test_notify_notifies_before_and_after_method
+    TestObject.class_eval do
+      include Bystander
+      notify [:manbonify]
+      define_method(:manbonify) {|an_arg| "fake return value" }
+    end
+
+    object = TestObject.new
+
+    Bystander.transport.expects(:notify).with("Calling: TestObject#manbonify(yo)")
+    Bystander.transport.expects(:notify).with("Finished: TestObject#manbonify(yo)")
+
+    return_value = object.manbonify "yo"
+    assert_equal "fake return value", return_value
+  end
+
+  def test_notify_notifies_before_and_after_class_method
+    TestObject.class_eval do
+      include Bystander
+      notify [:classest_of_methods]
+      define_singleton_method(:classest_of_methods){}
+    end
+
+    Bystander.transport.expects(:notify).with("Calling: TestObject::classest_of_methods()")
+    Bystander.transport.expects(:notify).with("Finished: TestObject::classest_of_methods()")
+    TestObject.classest_of_methods
+  end
+
+  def test_log_notifies_the_transport_with_given_message
+    message = 'I just logged something'
+    Bystander.transport.expects(:notify).with(message)
+
+    Bystander.log message
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'bystander'
+
+require 'minitest/autorun'
+require 'mocha/mini_test'
+
+
+Mocha::Configuration.prevent(:stubbing_non_existent_method)

data/test/transports/slack_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class TransportsSlackTest < Minitest::Test
+  def test_notify_pings_slack
+    message = 'a message'
+
+    slack_mock = mock()
+    slack_mock.expects(:ping).with("__ `#{message}`")
+    Bystander::Transports::Slack.stubs(:slack).returns(slack_mock)
+
+    Bystander::Transports::Slack.notify message
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: bystander
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Mulligan
+- Andrea Rossi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+description: Log your application flow without any ugly loggers
+email:
+- adam.mulligan@unep-wcmc.org
+- andrea.rossi@unep-wcmc.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bystander.gemspec
+- lib/bystander.rb
+- lib/bystander/class_methods.rb
+- lib/bystander/notifier.rb
+- lib/bystander/transports/dev_null.rb
+- lib/bystander/transports/slack.rb
+- lib/bystander/util/testing.rb
+- lib/bystander/version.rb
+- screenshot.png
+- test/bystander_test.rb
+- test/test_helper.rb
+- test/transports/slack_test.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Log your application flow without any ugly loggers
+test_files:
+- test/bystander_test.rb
+- test/test_helper.rb
+- test/transports/slack_test.rb