flipper-cassanity 0.5.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.3
+notifications:
+  email: false
+bundler_args: --without guard
+before_script: sudo service cassandra status
+services:
+ - cassandra

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'activesupport', :require => false
+
+group(:guard) do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+end

data/Guardfile

@@ -0,0 +1,20 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+rspec_options = {
+  :all_after_pass => false,
+  :all_on_start   => false,
+  :keep_failed    => false,
+}
+
+guard 'rspec', rspec_options do
+  watch(%r{^spec/.+_spec\.rb$}) { "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { "spec" }
+  watch(%r{shared_adapter_specs\.rb$}) { "spec" }
+  watch('spec/helper.rb') { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 John Nunemaker
+
+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,96 @@
+# Flipper::Cassanity
+
+A [Cassanity](https://github.com/jnunemaker/cassanity) adapter for [Flipper](https://github.com/jnunemaker/flipper).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flipper-cassanity'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flipper-cassanity
+
+## Usage
+
+```ruby
+# Assumes keyspace created and column family exists with this schema:
+#   {
+#     primary_key: [:key, :field],
+#     columns: {
+#       key: :text,
+#       field: :text,
+#       value: :text,
+#     },
+#   }
+
+require 'flipper/adapters/cassanity'
+column_family = Cassanity::Client.new[:cassanity][:flipper]
+adapter = Flipper::Adapters::Cassanity.new(column_family)
+flipper = Flipper.new(adapter)
+# profit...
+```
+
+## Internals
+
+Each feature is stored in a single row, which means getting a feature is single query.
+
+```ruby
+require 'flipper/adapters/cassanity'
+column_family = Cassanity::Client.new[:cassanity][:flipper]
+adapter = Flipper::Adapters::Cassanity.new(column_family)
+flipper = Flipper.new(adapter)
+
+# Register a few groups.
+Flipper.register(:admins) { |thing| thing.admin? }
+Flipper.register(:early_access) { |thing| thing.early_access? }
+
+# Create a user class that has flipper_id instance method.
+User = Struct.new(:flipper_id)
+
+flipper[:stats].enable
+flipper[:stats].enable flipper.group(:admins)
+flipper[:stats].enable flipper.group(:early_access)
+flipper[:stats].enable User.new('25')
+flipper[:stats].enable User.new('90')
+flipper[:stats].enable User.new('180')
+flipper[:stats].enable flipper.random(15)
+flipper[:stats].enable flipper.actors(45)
+
+flipper[:search].enable
+
+puts 'all docs in collection'
+pp column_family.select
+# all docs in collection
+# [{"_id"=>"stats",
+#   "actors"=>["25", "90", "180"],
+#   "boolean"=>"true",
+#   "groups"=>["admins", "early_access"],
+#   "percentage_of_actors"=>"45",
+#   "percentage_of_random"=>"15"},
+#  {"_id"=>"flipper_features", "features"=>["stats", "search"]},
+#  {"_id"=>"search", "boolean"=>"true"}]
+puts
+
+puts 'flipper get of feature'
+pp adapter.get(flipper[:stats])
+# flipper get of feature
+# {:boolean=>"true",
+#  :groups=>#<Set: {"admins", "early_access"}>,
+#  :actors=>#<Set: {"25", "90", "180"}>,
+#  :percentage_of_actors=>"45",
+#  :percentage_of_random=>"15"}
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/examples/basic.rb

@@ -0,0 +1,51 @@
+# Nothing to see here... move along.
+# Sets up load path for examples and requires some stuff
+require 'pp'
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'flipper/adapters/cassanity'
+require 'cassanity/instrumentation/log_subscriber'
+Cassanity::Instrumentation::LogSubscriber.logger = Logger.new(STDOUT, Logger::DEBUG)
+
+client = Cassanity::Client.new('127.0.0.1:9160', {
+  instrumenter: ActiveSupport::Notifications,
+})
+keyspace = client.keyspace(:cassanity)
+column_family = keyspace.column_family({
+  name: :flipper,
+  schema: {
+    primary_key: [:key, :field],
+    columns: {
+      key: :text,
+      field: :text,
+      value: :text,
+    },
+  },
+})
+
+keyspace.recreate
+column_family.create
+
+adapter = Flipper::Adapters::Cassanity.new(column_family)
+flipper = Flipper.new(adapter)
+
+flipper[:stats].enable
+
+if flipper[:stats].enabled?
+  puts "\n\nEnabled!\n\n\n"
+else
+  puts "\n\nDisabled!\n\n\n"
+end
+
+flipper[:stats].disable
+
+if flipper[:stats].enabled?
+  puts "\n\nEnabled!\n\n\n"
+else
+  puts "\n\nDisabled!\n\n\n"
+end

data/examples/internals.rb

@@ -0,0 +1,75 @@
+# Nothing to see here... move along.
+# Sets up load path for examples and requires some stuff
+require 'pp'
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'flipper/adapters/cassanity'
+require 'cassanity/instrumentation/log_subscriber'
+Cassanity::Instrumentation::LogSubscriber.logger = Logger.new(STDOUT, Logger::DEBUG)
+
+client = Cassanity::Client.new('127.0.0.1:9160', {
+  instrumenter: ActiveSupport::Notifications,
+})
+keyspace = client.keyspace(:cassanity)
+column_family = keyspace.column_family({
+  name: :flipper,
+  schema: {
+    primary_key: [:key, :field],
+    columns: {
+      key: :text,
+      field: :text,
+      value: :text,
+    },
+  },
+})
+
+keyspace.recreate
+column_family.create
+
+adapter = Flipper::Adapters::Cassanity.new(column_family)
+flipper = Flipper.new(adapter)
+
+# Register a few groups.
+Flipper.register(:admins) { |thing| thing.admin? }
+Flipper.register(:early_access) { |thing| thing.early_access? }
+
+# Create a user class that has flipper_id instance method.
+User = Struct.new(:flipper_id)
+
+flipper[:stats].enable
+flipper[:stats].enable flipper.group(:admins)
+flipper[:stats].enable flipper.group(:early_access)
+flipper[:stats].enable User.new('25')
+flipper[:stats].enable User.new('90')
+flipper[:stats].enable User.new('180')
+flipper[:stats].enable flipper.random(15)
+flipper[:stats].enable flipper.actors(45)
+
+flipper[:search].enable
+
+puts 'all docs in collection'
+pp column_family.select
+# all docs in collection
+# [{"_id"=>"stats",
+#   "actors"=>["25", "90", "180"],
+#   "boolean"=>"true",
+#   "groups"=>["admins", "early_access"],
+#   "percentage_of_actors"=>"45",
+#   "percentage_of_random"=>"15"},
+#  {"_id"=>"flipper_features", "features"=>["stats", "search"]},
+#  {"_id"=>"search", "boolean"=>"true"}]
+puts
+
+puts 'flipper get of feature'
+pp adapter.get(flipper[:stats])
+# flipper get of feature
+# {:boolean=>"true",
+#  :groups=>#<Set: {"admins", "early_access"}>,
+#  :actors=>#<Set: {"25", "90", "180"}>,
+#  :percentage_of_actors=>"45",
+#  :percentage_of_random=>"15"}

data/flipper-cassanity.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flipper/adapters/cassanity/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "flipper-cassanity"
+  gem.version       = Flipper::Adapters::Cassanity::VERSION
+  gem.authors       = ["John Nunemaker"]
+  gem.email         = ["nunemaker@gmail.com"]
+  gem.description   = %q{Cassanity adapter for Flipper.}
+  gem.summary       = %q{Cassanity adapter for Flipper.}
+  gem.homepage      = "http://jnunemaker.github.com/flipper-cassanity"
+  gem.require_paths = ["lib"]
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.add_dependency 'flipper', '~> 0.5.0'
+  gem.add_dependency 'cassanity', '~> 0.4.0'
+end

data/lib/flipper/adapters/cassanity/version.rb

@@ -0,0 +1,7 @@
+module Flipper
+  module Adapters
+    class Cassanity
+      VERSION = "0.5.0"
+    end
+  end
+end

data/lib/flipper/adapters/cassanity.rb

@@ -0,0 +1,172 @@
+require 'set'
+require 'flipper'
+require 'cassanity'
+
+module Flipper
+  module Adapters
+    class Cassanity
+      include Flipper::Adapter
+
+      # Private: The key that stores the set of known features.
+      FeaturesKey = :flipper_features
+
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Private: The column family where the data is stored.
+      attr_reader :column_family
+
+      # Public: Initializes a Cassanity flipper adapter.
+      #
+      # column_family - The Cassanity::ColumnFamily that should store the info.
+      def initialize(column_family)
+        @column_family = column_family
+        @name = :cassanity
+      end
+
+      # Public: Gets the values for all gates for a given feature.
+      #
+      # Returns a Hash of Flipper::Gate#key => value.
+      def get(feature)
+        result = {}
+        doc = doc_for(feature)
+        fields = doc.keys
+
+        feature.gates.each do |gate|
+          result[gate.key] = case gate.data_type
+          when :boolean, :integer
+            doc[gate.key.to_s]
+          when :set
+            fields_to_gate_value fields, gate
+          else
+            unsupported_data_type gate.data_type
+          end
+        end
+
+        result
+      end
+
+      # Public: Enables a gate for a given thing.
+      #
+      # feature - The Flipper::Feature for the gate.
+      # gate - The Flipper::Gate to disable.
+      # thing - The Flipper::Type being disabled for the gate.
+      #
+      # Returns true.
+      def enable(feature, gate, thing)
+        case gate.data_type
+        when :boolean, :integer
+          update feature.key, gate.key, thing.value.to_s
+        when :set
+          update feature.key, to_field(gate, thing), thing.value.to_s
+        else
+          unsupported_data_type gate.data_type
+        end
+
+        true
+      end
+
+      # Public: Disables a gate for a given thing.
+      #
+      # feature - The Flipper::Feature for the gate.
+      # gate - The Flipper::Gate to disable.
+      # thing - The Flipper::Type being disabled for the gate.
+      #
+      # Returns true.
+      def disable(feature, gate, thing)
+        case gate.data_type
+        when :boolean
+          delete feature.key
+        when :integer
+          update feature.key, gate.key, thing.value.to_s
+        when :set
+          delete feature.key, to_field(gate, thing)
+        else
+          unsupported_data_type gate.data_type
+        end
+
+        true
+      end
+
+      # Public: Adds a feature to the set of known features.
+      def add(feature)
+        update FeaturesKey, feature.name, 1
+        true
+      end
+
+      # Public: The set of known features.
+      def features
+        rows = select(FeaturesKey)
+        rows.map { |row| row['field'] }.to_set
+      end
+
+      # Private: Converts gate and thing to hash key.
+      def to_field(gate, thing)
+        "#{gate.key}/#{thing.value}"
+      end
+
+      # Private: Select rows matching key and optionally field.
+      #
+      # Returns an Array of Hashes.
+      def select(key, field = :skip)
+        @column_family.select({
+          select: [:field, :value],
+          where: where(key, field),
+        })
+      end
+
+      # Private: Update key/field combo to value.
+      #
+      # Returns nothing.
+      def update(key, field, value)
+        @column_family.update({
+          set: {value: value},
+          where: {key: key, field: field},
+        })
+      end
+
+      # Private: Delete rows matching key and optionally field as well.
+      #
+      # Returns nothing.
+      def delete(key, field = :skip)
+        @column_family.delete({
+          where: where(key, field),
+        })
+      end
+
+      # Private: Given a key and field it returns appropriate where hash for
+      # querying the column family.
+      #
+      # Returns a Hash to be used as criteria for a query.
+      def where(key, field)
+        where = {key: key}
+        where[:field] = field unless field == :skip
+        where
+      end
+
+      # Private: Gets a hash of fields => values for the given feature.
+      #
+      # Returns a Hash of fields => values.
+      def doc_for(feature)
+        field_value_pairs = select(feature.key).map { |row| row.values }
+        Hash[*field_value_pairs.flatten]
+      end
+
+      # Private: Returns a set of values given an array of fields and a gate.
+      #
+      # Returns a Set of the values enabled for the gate.
+      def fields_to_gate_value(fields, gate)
+        regex = /^#{Regexp.escape(gate.key)}\//
+        keys = fields.grep(regex)
+        values = keys.map { |key| key.split('/', 2).last }
+        values.to_set
+      end
+
+      # Private: Raises error letting user know that data type is not
+      # supported by this adapter.
+      def unsupported_data_type(data_type)
+        raise "#{data_type} is not supported by this adapter"
+      end
+    end
+  end
+end

data/lib/flipper-cassanity.rb

@@ -0,0 +1 @@
+require 'flipper/adapters/cassanity'

data/spec/cassanity_spec.rb

@@ -0,0 +1,30 @@
+require 'helper'
+require 'flipper/adapters/cassanity'
+require 'flipper/spec/shared_adapter_specs'
+
+describe Flipper::Adapters::Cassanity do
+  let(:client) { Cassanity::Client.new }
+  let(:keyspace) { client.keyspace(:cassanity) }
+  let(:column_family) {
+    keyspace.column_family({
+      name: :flipper,
+      schema: {
+        primary_key: [:key, :field],
+        columns: {
+          key: :text,
+          field: :text,
+          value: :text,
+        },
+      },
+    })
+  }
+
+  subject { described_class.new(column_family) }
+
+  before do
+    keyspace.recreate
+    column_family.create
+  end
+
+  it_should_behave_like 'a flipper adapter'
+end

data/spec/helper.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'bundler'
+Bundler.setup :default
+
+require 'flipper-cassanity'
+
+RSpec.configure do |config|
+  config.filter_run :focused => true
+  config.alias_example_to :fit, :focused => true
+  config.alias_example_to :xit, :pending => true
+  config.run_all_when_everything_filtered = true
+  config.fail_fast = true
+
+  config.backtrace_clean_patterns = [
+    /rspec-(core|expectations)/,
+  ]
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: flipper-cassanity
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flipper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: cassanity
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: Cassanity adapter for Flipper.
+email:
+- nunemaker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/basic.rb
+- examples/internals.rb
+- flipper-cassanity.gemspec
+- lib/flipper-cassanity.rb
+- lib/flipper/adapters/cassanity.rb
+- lib/flipper/adapters/cassanity/version.rb
+- spec/cassanity_spec.rb
+- spec/helper.rb
+homepage: http://jnunemaker.github.com/flipper-cassanity
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 216004828098320081
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 216004828098320081
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Cassanity adapter for Flipper.
+test_files:
+- spec/cassanity_spec.rb
+- spec/helper.rb