flipper-echo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d0193b01d3747866567392b00529405385d4b23
+  data.tar.gz: 03d2d537df9c51aca849cc279245dd39f63835cb
+SHA512:
+  metadata.gz: 361febaf3cf8772c5eb2f723a3896068c00588e9f6e2aaf2003d3a52fb00a65356ba0dd3c94fb70b08767bfacdf3dd209e5f1e649140c95ec3b7b0b35d355982
+  data.tar.gz: 94c0a649e23ff84a9b9c41fce70c1145c3a24a9222377c073e237c4fae93ceabb7a12f1fa82cfdd4f8594d2a21c89d220e80f11256eb57c01c39b26ad25ea378

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flipper-echo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Heather Rivers
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Flipper::Echo
+
+This gem adds a simple callback interface for
+[Flipper](https://github.com/jnunemaker/flipper) adapter events.
+
+For example, when a Flipper feature is changed, you can:
+
+* send a Slack notification
+* write the change to a database or log file
+* send a YO
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flipper-echo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flipper-echo
+
+## Usage
+
+First, [configure Flipper](https://github.com/jnunemaker/flipper#usage) as you
+normally would (any adapter will do), e.g.:
+
+```ruby
+FLIPPER = Flipper.new(Flipper::Adapters::Memory.new)
+```
+
+Then configure `Flipper::Echo`:
+
+#### Option 1: handle event with a proc
+
+```ruby
+Flipper::Echo.configure do |config|
+  config.flipper = FLIPPER
+
+  config.notifier = proc do |event|
+    # Do something with the event...
+    #
+    puts "#{event.feature.name} changed: #{event.action}"
+  end
+end
+```
+
+#### Option 2: handle event with a notifier class
+
+`Flipper::Echo` can also use any object that has a `notify` method:
+
+```ruby
+class FlipperNotifier
+  def notify(event)
+    # Do something with the event...
+  end
+end
+
+Flipper::Echo.configure do |config|
+  config.flipper  = FLIPPER
+  config.notifier = FlipperNotifier.new
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/mode/flipper-echo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/flipper-echo.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flipper/echo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flipper-echo'
+  spec.version       = Flipper::Echo::VERSION
+  spec.authors       = ['Heather Rivers']
+  spec.email         = ['heather@modeanalytics.com']
+  spec.summary       = 'Flipper event notifier'
+  spec.description   = 'Extensible event notifier for Flipper gem'
+  spec.homepage      = 'https://github.com/mode/flipper-echo'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_dependency 'flipper', '~> 0.6'
+
+  spec.add_development_dependency 'bundler',   '~> 1.7'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'rspec',     '~> 3.2'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'yard',      '~> 0.8'
+end

data/lib/flipper/echo.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+#
+require 'flipper/echo/configuration'
+require 'flipper/echo/event'
+require 'flipper/echo/version'
+
+# Flipper namespace
+#
+module Flipper
+  # Echo namespace
+  #
+  module Echo
+    class << self
+      # Yield configuration instance for modification
+      #
+      def configure
+        yield configuration if block_given?
+      end
+
+      # Configuration instance
+      #
+      def configuration
+        @configuration ||= Flipper::Echo::Configuration.new
+      end
+    end
+
+    # Instance methods to be included in the adapter's singleton class
+    #
+    module InstanceMethods
+      # Notify adapter enable events
+      #
+      def enable(feature, gate, target)
+        super.tap do
+          Flipper::Echo::Event.new(
+            feature, :enable, gate: gate, target: target).notify
+        end
+      end
+
+      # Notify adapter disable events
+      #
+      def disable(feature, gate, target)
+        super.tap do
+          Flipper::Echo::Event.new(
+            feature, :disable, gate: gate, target: target).notify
+        end
+      end
+
+      # Notify adapter remove events
+      #
+      def remove(feature)
+        super.tap { Flipper::Echo::Event.new(feature, :remove).notify }
+      end
+
+      # Notify adapter clear events
+      #
+      def clear(feature)
+        super.tap { Flipper::Echo::Event.new(feature, :clear).notify }
+      end
+    end
+  end
+end

data/lib/flipper/echo/configuration.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+#
+module Flipper
+  module Echo
+    # General configuration class
+    #
+    # If `notifier` is not assigned, notification events will not be sent.
+    #
+    # Only one of `#flipper=` or `#adapter=`, as preferred, must be called for
+    # intended behavior.
+    #
+    class Configuration
+      attr_accessor :notifier
+
+      # Assign Flipper instance
+      #
+      # @param flipper [Flipper::DSL] the Flipper instance
+      #
+      # @return [Class] the adapter singleton class
+      #
+      def flipper=(flipper)
+        self.adapter = flipper.adapter
+      end
+
+      # Assign Flipper adapter instance
+      #
+      # @param adapter [Flipper::Adapter] the Flipper adapter instance
+      #
+      # @return [Class] the adapter singleton class
+      #
+      def adapter=(adapter)
+        adapter.singleton_class.include Flipper::Echo::InstanceMethods
+      end
+    end
+  end
+end

data/lib/flipper/echo/event.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+#
+module Flipper
+  module Echo
+    # Encapsulates relevant information about a Flipper adapter event
+    #
+    class Event
+      attr_reader :feature, :action, :options
+
+      # Construct a new Event instance
+      #
+      # @param feature [Flipper::Feature] the feature that was changed
+      # @param action [Symbol] the action
+      #   (`:enable`, `:disable`, `:remove` or `:clear`)
+      # @param options [optional, Hash] hash of options
+      #
+      # @option options [Flipper::Type] :target the event target
+      # @option options [Flipper::Gate] :gate the event gate
+      #
+      # @return [Flipper::Echo::Event] the instance
+      #
+      def initialize(feature, action, options = {})
+        @feature = feature
+        @action  = action
+        @options = options
+      end
+
+      # Boolean target
+      #
+      # @return [Flipper::Types::Boolean, nil]
+      #
+      def boolean
+        target if target.is_a?(Flipper::Types::Boolean)
+      end
+
+      # Group target
+      #
+      # @return [Flipper::Types::Group, nil]
+      #
+      def group
+        target if target.is_a?(Flipper::Types::Group)
+      end
+
+      # Actor target
+      #
+      # @return [Flipper::Types::Actor, nil]
+      #
+      def actor
+        target if target.is_a?(Flipper::Types::Actor)
+      end
+
+      # Percentage of actors target
+      #
+      # @return [Flipper::Types::PercentageOfActors, nil]
+      #
+      def percentage_of_actors
+        target if target.is_a?(Flipper::Types::PercentageOfActors)
+      end
+
+      # Percentage of random target
+      #
+      # @return [Flipper::Types::PercentageOfRandom, nil]
+      #
+      def percentage_of_random
+        target if target.is_a?(Flipper::Types::PercentageOfRandom)
+      end
+
+      # Passes this event to the configured notifier
+      #
+      def notify
+        if notifier.is_a?(Proc)
+          notifier.call(self)
+        elsif notifier.respond_to?(:notify)
+          notifier.notify(self)
+        end
+      end
+
+      # The event target, if any
+      #
+      # @return [Flipper::Type]
+      #
+      def target
+        options[:target]
+      end
+
+      # The event gate, if any
+      #
+      # @return [Flipper::Gate]
+      #
+      def gate
+        options[:gate]
+      end
+
+      private
+
+      def notifier
+        Flipper::Echo.configuration.notifier
+      end
+    end
+  end
+end

data/lib/flipper/echo/version.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+#
+module Flipper
+  module Echo
+    # Current gem version
+    #
+    VERSION = '0.0.1'
+  end
+end

data/spec/flipper/echo/configuration_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe Flipper::Echo::Configuration do
+  let :adapter do
+    adapter_class.new
+  end
+
+  let :flipper do
+    double(:flipper, adapter: adapter)
+  end
+
+  let :configuration do
+    Flipper::Echo::Configuration.new
+  end
+
+  describe '#adapter=' do
+    it 'assigns adapter' do
+      expect(adapter.singleton_class).to receive(:include)
+
+      configuration.adapter = adapter
+    end
+  end
+
+  describe '#flipper=' do
+    it 'assigns adapter' do
+      expect(adapter.singleton_class).to receive(:include)
+
+      configuration.flipper = flipper
+    end
+  end
+end

data/spec/flipper/echo/event_spec.rb

@@ -0,0 +1,177 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+require 'flipper'
+
+describe Flipper::Echo::Event do
+  let :feature do
+    double(:feature)
+  end
+
+  let :action do
+    double(:action)
+  end
+
+  let :group do
+    Flipper::Types::Group.new(:dummy)
+  end
+
+  let :boolean do
+    Flipper::Types::Boolean.new
+  end
+
+  let :actor do
+    Flipper::Types::Actor.new(double(:actor, flipper_id: nil))
+  end
+
+  let :percentage_of_actors do
+    Flipper::Types::PercentageOfActors.new(nil)
+  end
+
+  let :percentage_of_random do
+    Flipper::Types::PercentageOfRandom.new(nil)
+  end
+
+  describe '#boolean' do
+    it 'returns nil if target type does not match' do
+      event = Flipper::Echo::Event.new(feature, action, target: group)
+
+      expect(event.boolean).to eq(nil)
+    end
+
+    it 'returns target if target type matches' do
+      event = Flipper::Echo::Event.new(feature, action, target: boolean)
+
+      expect(event.boolean).to eq(boolean)
+    end
+  end
+
+  describe '#group' do
+    it 'returns nil if target type does not match' do
+      event = Flipper::Echo::Event.new(feature, action, target: boolean)
+
+      expect(event.group).to eq(nil)
+    end
+
+    it 'returns target if target type matches' do
+      event = Flipper::Echo::Event.new(feature, action, target: group)
+
+      expect(event.group).to eq(group)
+    end
+  end
+
+  describe '#actor' do
+    it 'returns nil if target type does not match' do
+      event = Flipper::Echo::Event.new(feature, action, target: boolean)
+
+      expect(event.actor).to eq(nil)
+    end
+
+    it 'returns target if target type matches' do
+      event = Flipper::Echo::Event.new(feature, action, target: actor)
+
+      expect(event.actor).to eq(actor)
+    end
+  end
+
+  describe '#percentage_of_actors' do
+    it 'returns nil if target type does not match' do
+      event = Flipper::Echo::Event.new(feature, action, target: boolean)
+
+      expect(event.percentage_of_actors).to eq(nil)
+    end
+
+    it 'returns target if target type matches' do
+      event = Flipper::Echo::Event.new(
+        feature, action, target: percentage_of_actors)
+
+      expect(event.percentage_of_actors).to eq(percentage_of_actors)
+    end
+  end
+
+  describe '#percentage_of_random' do
+    it 'returns nil if target type does not match' do
+      event = Flipper::Echo::Event.new(feature, action, target: boolean)
+
+      expect(event.percentage_of_random).to eq(nil)
+    end
+
+    it 'returns target if target type matches' do
+      event = Flipper::Echo::Event.new(
+        feature, action, target: percentage_of_random)
+
+      expect(event.percentage_of_random).to eq(percentage_of_random)
+    end
+  end
+
+  describe '#gate' do
+    it 'returns gate from options' do
+      gate = double(:gate)
+
+      event = Flipper::Echo::Event.new(feature, action, gate: gate)
+
+      expect(event.gate).to eq(gate)
+    end
+  end
+
+  describe '#notify' do
+    let :event do
+      Flipper::Echo::Event.new(feature, action)
+    end
+
+    describe 'when notifier is a proc' do
+      it 'calls proc' do
+        procedure = proc {}
+
+        allow(event).to receive(:notifier).and_return(procedure)
+
+        expect(procedure).to receive(:call)
+
+        event.notify
+      end
+    end
+
+    describe 'when notifier is a non proc object' do
+      let :notifier do
+        double(:notifier)
+      end
+
+      it 'calls instance method if it exists' do
+        allow(event).to receive(:notifier).and_return(notifier)
+
+        expect(notifier).to receive(:notify)
+
+        event.notify
+      end
+
+      it 'does nothing if method does not exist' do
+        allow(event).to receive(:notifier).and_return(notifier)
+
+        event.notify
+      end
+    end
+
+    describe 'when notifier is nil' do
+      it 'does nothing' do
+        allow(event).to receive(:notifier).and_return(nil)
+
+        event.notify
+      end
+    end
+  end
+
+  describe '#notifier' do
+    let :notifier do
+      double(:notifier)
+    end
+
+    it 'returns notifier from config' do
+      allow(Flipper::Echo.configuration).to(
+        receive(:notifier).and_return(notifier))
+
+      event = Flipper::Echo::Event.new(feature, action)
+
+      expect(event.send(:notifier)).to eq(notifier)
+    end
+  end
+end

data/spec/flipper/echo_spec.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe Flipper::Echo do
+  describe '.configure' do
+    it 'sets configuration variables' do
+      expect_any_instance_of(
+        Flipper::Echo::Configuration).to receive(:setting=).once
+
+      Flipper::Echo.configure do |config|
+        config.setting = 'value'
+      end
+    end
+  end
+
+  describe '.configuration' do
+    it 'is a configuration instance' do
+      expect(Flipper::Echo.configuration).to(
+        be_an_instance_of(Flipper::Echo::Configuration))
+    end
+  end
+
+  describe Flipper::Echo::InstanceMethods do
+    let :adapter do
+      adapter_class.new.tap do |inst|
+        inst.singleton_class.include Flipper::Echo::InstanceMethods
+      end
+    end
+
+    let :feature do
+      double(:feature)
+    end
+
+    let :gate do
+      double(:gate)
+    end
+
+    let :target do
+      double(:target)
+    end
+
+    describe '#enable' do
+      it 'enables feature' do
+        expect_any_instance_of(Flipper::Echo::Event).to receive(:notify) do |e|
+          expect(e.action).to eq(:enable)
+        end
+
+        adapter.enable(feature, gate, target)
+      end
+    end
+
+    describe '#disable' do
+      it 'disables feature' do
+        expect_any_instance_of(Flipper::Echo::Event).to receive(:notify) do |e|
+          expect(e.action).to eq(:disable)
+        end
+
+        adapter.disable(feature, gate, target)
+      end
+    end
+
+    describe '#remove' do
+      it 'removes feature' do
+        expect_any_instance_of(Flipper::Echo::Event).to receive(:notify) do |e|
+          expect(e.action).to eq(:remove)
+        end
+
+        adapter.remove(feature)
+      end
+    end
+
+    describe '#clear' do
+      it 'clears feature' do
+        expect_any_instance_of(Flipper::Echo::Event).to receive(:notify) do |e|
+          expect(e.action).to eq(:clear)
+        end
+
+        adapter.clear(feature)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+#
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'flipper/echo'
+
+Dir['./spec/support/**/*.rb'].each(&method(:require))
+
+RSpec.configure do |config|
+  config.include AdapterSupport
+end

data/spec/support/adapter_support.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+#
+module AdapterSupport
+  def adapter_class
+    @adapter_class ||= Class.new do
+      %w(remove clear enable disable).each do |method|
+        define_method(method) { |*_args| }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: flipper-echo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Heather Rivers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flipper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Extensible event notifier for Flipper gem
+email:
+- heather@modeanalytics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flipper-echo.gemspec
+- lib/flipper/echo.rb
+- lib/flipper/echo/configuration.rb
+- lib/flipper/echo/event.rb
+- lib/flipper/echo/version.rb
+- spec/flipper/echo/configuration_spec.rb
+- spec/flipper/echo/event_spec.rb
+- spec/flipper/echo/version_spec.rb
+- spec/flipper/echo_spec.rb
+- spec/spec_helper.rb
+- spec/support/adapter_support.rb
+homepage: https://github.com/mode/flipper-echo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.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: Flipper event notifier
+test_files:
+- spec/flipper/echo/configuration_spec.rb
+- spec/flipper/echo/event_spec.rb
+- spec/flipper/echo/version_spec.rb
+- spec/flipper/echo_spec.rb
+- spec/spec_helper.rb
+- spec/support/adapter_support.rb
+has_rdoc: