flipper-consul 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9374d60afac720f7e9a69537095d0ef18a446d8
+  data.tar.gz: 9c0168f2b70514831ec184861274b5c2f96c0ed8
+SHA512:
+  metadata.gz: 45f3f908e1c96ce2e8c9d54fc10f264ece81a3364b0ef84a847de036328b40381881ebae2880574be03792e695a37f13d37e3b858a9eef74b95a1bd324706dbd
+  data.tar.gz: d9e9015f0ce965c8a82d5fbb899949e00c6d1c9e1c97ac8151b3350d1b5c9396241bb8a7507c6e0d1e131ba63cd1ee0b3f4d0147286a58ef7d44c27226c7b4d1

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+flipper-consul

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: required # don't run on container-based infrastructure
+language: ruby
+rvm:
+    - 1.9.3
+    - 2.0.0
+    - 2.1.0
+    - 2.2.0
+before_script:
+    - wget 'https://dl.bintray.com/mitchellh/consul/0.5.2_linux_amd64.zip'
+    - unzip '0.5.2_linux_amd64.zip'
+    - ./consul --version
+script:
+    - ./consul agent -server -bootstrap-expect 1 -data-dir /tmp/consul &

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flipper-consul.gemspec
+gemspec
+
+gem 'rspec'
+gem 'rspec-its'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Graham Davison
+
+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,31 @@
+# Flipper::Consul
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flipper-consul'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flipper-consul
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/flipper-consul/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,2 @@
+require "bundler/gem_tasks"
+

data/Vagrantfile

@@ -0,0 +1,59 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure(2) do |config|
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://atlas.hashicorp.com/search.
+  config.vm.box = "hashicorp/precise64"
+  
+#  config.berkshelf.enabled = true
+#  config.berkshelf.berksfile_path = "./Berksfile" 
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  config.vm.network "forwarded_port", guest: 8500, host: 8500
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  # config.vm.network "private_network", ip: "192.168.33.10"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  config.vm.provision "shell", inline: <<-SHELL
+    sudo apt-get update
+    #echo Installing dependencies...
+    #sudo apt-get install -y unzip curl
+    #echo Fetching Consul...
+    #cd /tmp/
+    #wget https://dl.bintray.com/mitchellh/consul/0.3.1_linux_amd64.zip -O consul.zip
+    #echo Installing Consul...
+    #unzip consul.zip
+    #sudo chmod +x consul
+    #sudo mv consul /usr/bin/consul
+    #echo Installing Ruby
+    #sudo apt-get install python-software-properties -y
+    #sudo apt-add-repository ppa:brightbox/ruby-ng -y
+    #sudo apt-get update
+    #sudo apt-get install ruby2.1 -y
+    wget -qO- https://get.docker.com/ | sh
+    
+    # add vagrant to docker group
+    sudo usermod -aG docker vagrant
+    
+    docker run -d -p 8400:8400 -p 8500:8500 -p 8600:53/udp -h node1 progrium/consul -server -bootstrap -ui-dir /ui
+  SHELL
+#  config.vm.provision "chef_zero" do |chef|
+#    chef.add_recipe "consul-cookbook"
+#  end
+end

data/flipper-consul.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+require File.expand_path('../lib/flipper/adapters/consul/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "flipper-consul"
+  spec.version       = Flipper::Adapters::Consul::VERSION
+  spec.authors       = ["Graham Davison"]
+  spec.email         = ["g.m.davison@computer.org"]
+  spec.summary       = %q{Consul adapter for Flipper}
+  spec.description   = %q{Consul adapter for Flipper}
+  spec.homepage      = "https://github.com/gdavison/flipper-consul"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  
+  spec.add_dependency 'flipper',  '~> 0.7.0.beta6'
+  spec.add_dependency 'diplomat', '~> 0.11'
+end

data/lib/flipper-consul.rb

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

data/lib/flipper/adapters/consul.rb

@@ -0,0 +1,176 @@
+require 'set'
+require 'diplomat'
+require 'flipper'
+
+module Flipper
+  module Adapters
+    class Consul
+      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
+      
+      attr_reader :namespace
+            
+      def initialize(client, namespace=nil)
+        @client = client
+        @name = :consul
+        if !namespace.nil?
+          namespace.strip!
+          if namespace == ''
+            namespace = nil
+          elsif namespace.start_with? '/'
+            namespace[0] = ''
+          end
+        end
+        @namespace = namespace
+      end
+
+      # Public: The set of known features.
+      def features
+        read_multiple build_path "#{FeaturesKey}/features"
+      end
+
+      # Public: Adds a feature to the set of known features.
+      def add(feature)
+        @client.put build_path("#{FeaturesKey}/features/#{feature.key}"), '1'
+        true
+      end
+
+      # Public: Removes a feature from the set of known features.
+      def remove(feature)
+        @client.delete build_path "#{FeaturesKey}/features/#{feature.key}"
+        clear feature
+        true
+      end
+
+      # Public: Clears the gate values for a feature.
+      def clear(feature)
+        @client.delete build_path "#{feature.key}/?recurse"
+        true
+      end
+
+      # Public: Gets the values for all gates for a given feature.
+      #
+      # Returns a Hash of Flipper::Gate#key => value.
+      def get(feature)
+        result = {}
+        values = get_feature_values(feature)
+
+        feature.gates.each do |gate|
+          result[gate.key] = case gate.data_type
+          when :boolean, :integer
+            values[gate.key.to_s]
+          when :set
+            gate_values_as_set(values, 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
+          @client.put key(feature, gate), thing.value.to_s
+        when :set
+          @client.put set_member_key(feature, gate, thing), '1'
+        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
+          @client.delete build_path "#{feature}/?recurse"
+        when :integer
+          @client.put key(feature, gate), thing.value.to_s
+        when :set
+          @client.delete set_member_key(feature, gate, thing)
+        else
+          unsupported_data_type gate.data_type
+        end
+
+        true
+      end
+      
+      private
+
+      # Private
+      def key(feature, gate)
+        build_path "#{feature.key}/#{gate.key}"
+      end
+      
+      def set_member_key(feature, gate, thing)
+        build_path "#{feature.key}/#{gate.key}/#{thing.value.to_s}"
+      end
+      
+      def build_path(key)
+        if namespace.nil?
+          key
+        else
+          "#{namespace}/#{key}"
+        end
+      end
+
+      def read_multiple(key_path)
+        begin
+          @client.get key_path, recurse: true
+          values = @client.raw
+          values = values.map do |item|
+            item['Key'].sub!("#{key_path}/", '')
+          end
+          value = values.to_set
+        rescue Diplomat::KeyNotFound
+          value = {}.to_set
+        end
+        value
+      end
+      
+      def get_feature_values(feature)
+        begin
+          key_path = build_path(feature.key)
+          @client.get key_path, recurse: true
+          values = @client.raw
+          result = {}
+          values.each do |item|
+            result[item['Key'].sub!("#{key_path}/", '')] = Base64.decode64(item['Value'])
+          end
+          result
+        rescue Diplomat::KeyNotFound
+          {}
+        end
+      end
+      
+      def gate_values_as_set(values, gate)
+        regex = /^#{Regexp.escape(gate.key.to_s)}\//
+        keys_for_gate = values.keys.grep regex
+        values = keys_for_gate.map { |key| key.split('/', 2).last }
+        values.to_set
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Flipper
+  module Adapters
+    class Consul
+      VERSION = "0.1.0"
+    end
+  end
+end

data/spec/flipper/consul_spec.rb

@@ -0,0 +1,61 @@
+require 'helper'
+require 'flipper/adapters/consul'
+require 'flipper/spec/shared_adapter_specs'
+
+describe Flipper::Adapters::Consul do
+  let(:client) { Diplomat::Kv.new }
+
+  before do
+    client.delete "/?recurse"
+  end
+  
+  context 'with no namespace' do
+    subject { described_class.new(client) }
+    
+    its(:namespace) { is_expected.to be_nil }
+
+    it_should_behave_like 'a flipper adapter'
+  end
+  
+  context 'with a namespace' do
+    
+    context 'with an empty namespace' do
+      subject { described_class.new(client, '') }
+      its(:namespace) { is_expected.to be_nil }
+    end
+    
+    context 'namespace starts with /' do
+      subject { described_class.new(client, '/foo') }
+      its(:namespace) { is_expected.to eq 'foo' }
+    end
+    
+    context 'adapter methods' do
+      subject { described_class.new(client, 'foo/bar') }
+
+      it_should_behave_like 'a flipper adapter'
+    end
+    
+    context 'data is namespaced' do
+      let(:namespace) { 'foo/bar' }
+      subject { described_class.new(client, namespace) }
+      context 'feature data' do
+        it 'is namespaced' do
+          feature = Flipper::Feature.new :search, subject
+          subject.add feature
+          
+          foo = client.get "#{namespace}/#{Flipper::Adapters::Consul::FeaturesKey}/features/search"
+          expect(foo).to eq '1'
+        end
+      end
+      context 'key/value data' do
+        it 'is namespaced' do
+          feature = Flipper::Feature.new :search, subject
+          subject.enable feature, feature.gate(:boolean), Flipper::Types::Boolean.new(true)
+          
+          foo = client.get "#{namespace}/search/boolean"
+          expect(foo).to eq 'true'
+        end
+      end
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,26 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+#require 'pathname'
+#require 'logger'
+#
+#root_path = Pathname(__FILE__).dirname.join('..').expand_path
+#lib_path  = root_path.join('lib')
+#log_path  = root_path.join('log')
+#log_path.mkpath
+#
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default, :test)
+
+require 'flipper-consul'
+
+#Logger.new(log_path.join('test.log'))
+
+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
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: flipper-consul
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Graham Davison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flipper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0.beta6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0.beta6
+- !ruby/object:Gem::Dependency
+  name: diplomat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Consul adapter for Flipper
+email:
+- g.m.davison@computer.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- flipper-consul.gemspec
+- lib/flipper-consul.rb
+- lib/flipper/adapters/consul.rb
+- lib/flipper/adapters/consul/version.rb
+- spec/flipper/consul_spec.rb
+- spec/helper.rb
+homepage: https://github.com/gdavison/flipper-consul
+licenses:
+- MIT
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Consul adapter for Flipper
+test_files:
+- spec/flipper/consul_spec.rb
+- spec/helper.rb