fake_consul 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 087388aaf9c337a09d8fb6d05600b4cfd0a66446
+  data.tar.gz: 26c8da7c6240c1a49599cd817b338b1c4cfa6018
+SHA512:
+  metadata.gz: eef9a1ead2f95216b0fa6a67a224f3ff547fecfda8dcce4b22dc9aabe67b6abcbbcabf0935eb82c921f26736bc032b35e95bc2571aaca82ce60d54b2da0f5534
+  data.tar.gz: e57f0dbf64dc5597f19a37586acf8494174ea1b79a29cdfff8051f8e367ca7d31a9662d9daa1c075389f96f04903e6050508dbeae3389d2eead9193e1edc98ca

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/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased][unreleased]
+
+## [v0.0.1] - 2015-11-27
+### Initial implementation
+- Adds simple consul client that fakes the consul server and provides state in an in-memory Hash.
+- Client API conforms to that of [Diplomat::Kv](http://www.rubydoc.info/github/WeAreFarmGeek/diplomat/Diplomat/Kv) (See source here: [Diplomat](https://github.com/WeAreFarmGeek/diplomat) )
+
+[unreleased]: https://github.com/teambox/cortana/compare/v0.0.1...HEAD
+[v1.0.0]: https://github.com/teambox/cortana/tree/v0.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Redbooth
+
+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,40 @@
+# FakeConsul
+
+Fakes a consul server. Usecase is for feature specs that need to maintain state written to consul kv store.
+
+- Adds simple consul client that fakes the consul server and provides state in an in-memory Hash.
+- Client API conforms to that of [Diplomat::Kv](http://www.rubydoc.info/github/WeAreFarmGeek/diplomat/Diplomat/Kv) (See source here: [Diplomat](https://github.com/WeAreFarmGeek/diplomat) )
+
+[![Build Status](https://circleci.com/gh/redbooth/fake_consul/tree/master.png)](https://circleci.com/gh/redbooth/fake_consul)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fake_consul'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fake_consul
+
+## Usage
+
+```require fake_consul```
+
+In your specs:
+
+```let(:fake_kv_store) { FakeConsul::Server.new }```
+
+```before { allow(my_instance_or_class).to receive(:kv_client).and_return(fake_kv_store) }```
+
+## Contributing
+
+1. Fork it ( http://github.com/redbooth/fake_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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end

data/circle.yml

@@ -0,0 +1,10 @@
+machine:
+  ruby:
+    version: 2.1.2
+
+dependencies:
+  pre:
+
+test:
+  override:
+    - bundle exec rake test

data/fake_consul.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fake_consul/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fake_consul"
+  spec.version       = FakeConsul::VERSION
+  spec.authors       = ["Saimon Moore"]
+  spec.email         = ["saimonmoore@gmail.com"]
+  spec.summary       = %q{Fakes a consul server. Usecase is for feature specs using Diplomat client}
+  spec.description   = %q{Fakes a consul server. Usecase is for feature specs using Diplomat client}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 3.2.21"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/fake_consul.rb

@@ -0,0 +1,58 @@
+require "fake_consul/version"
+
+module FakeConsul
+  class Server < HashWithIndifferentAccess
+
+    # Fake get
+    #
+    # Performs no http requests but stores data in local hash
+    #
+    # @param key [String]
+    # @param options [Hash]
+    # @options recurse [Boolean] wether to list all keys starting with this prefix
+    # @param not_found [Symbol] unused/unimplemented
+    # @param found [Symbol] not unused/unimplemented
+    # @return [Array<Hash>] e.g. [{key: 'foo', value: 'bar'}]
+    def get(key, options = nil, not_found = :reject, found = :return)
+      if options[:recurse]
+        find_keys_recursive(key)
+      else
+        consul_export_format(key)
+      end
+    end
+
+    # Fake put
+    #
+    # Performs no http requests but retrieves data from local hash
+    #
+    # @param key [String]
+    # @param options [Hash] unused/unimplemented
+    # @return [Boolean] true :trollface:
+    def kv_put(key, value, options = nil)
+      self[key] = value
+      true
+    end
+
+    private
+
+    # Returns the keys in the following format:
+    #  [{key: `key`, value: 'bar'}]
+    # @return [Array<Hash>]
+    def consul_export_format(keys)
+      Array(keys).map do
+        {'key' => key, 'value' => self[key]}
+      end
+    end
+
+    # Returns all keys that begin with the supplied `key`.
+    #
+    # @return [Array<Hash>] e.g. [{key: 'foo', value: 'bar'}]
+    def find_keys_recursive(key)
+      keys.select? do |_key|
+        _key.to_s.start_with?(key.to_s)
+      end.map do |_key|
+        consul_export_format(_key)
+      end
+    end
+  end
+end

data/lib/fake_consul/server.rb

@@ -0,0 +1,58 @@
+module FakeConsul
+  class Server < HashWithIndifferentAccess
+
+    # Fake get
+    #
+    # Performs no http requests but stores data in local hash
+    #
+    # @param key [String]
+    # @param options [Hash]
+    # @options recurse [Boolean] wether to list all keys starting with this prefix
+    # @param not_found [Symbol] unused/unimplemented
+    # @param found [Symbol] not unused/unimplemented
+    # @return [Array<Hash>] e.g. [{key: 'foo', value: 'bar'}]
+    def get(key, options = nil, not_found = :reject, found = :return)
+      options ||= {}
+
+      if options[:recurse]
+        find_keys_recursive(key)
+      else
+        consul_export_format(key)
+      end
+    end
+
+    # Fake put
+    #
+    # Performs no http requests but retrieves data from local hash
+    #
+    # @param key [String]
+    # @param options [Hash] unused/unimplemented
+    # @return [Boolean] true :trollface:
+    def put(key, value, options = nil)
+      self[key] = value
+      true
+    end
+
+    private
+
+    # Returns the keys in the following format:
+    #  [{key: `key`, value: 'bar'}]
+    # @return [Array<Hash>]
+    def consul_export_format(keys)
+      Array(keys).map do |key|
+        {'key' => key, 'value' => self[key]}
+      end
+    end
+
+    # Returns all keys that begin with the supplied `key`.
+    #
+    # @return [Array<Hash>] e.g. [{key: 'foo', value: 'bar'}]
+    def find_keys_recursive(key)
+      self.keys.select do |_key|
+        _key.to_s.start_with?(key.to_s)
+      end.map do |_key|
+        consul_export_format(_key)
+      end.flatten
+    end
+  end
+end

data/lib/fake_consul/version.rb

@@ -0,0 +1,3 @@
+module FakeConsul
+  VERSION = "0.0.1"
+end

data/spec/fake_consul/server_spec.rb

@@ -0,0 +1,50 @@
+require_relative '../spec_helper'
+
+describe FakeConsul::Server do
+  subject { FakeConsul::Server.new }
+
+  describe '#put' do
+    it 'stores key into Hash' do
+      subject.put('foo', 'bar')
+      subject['foo'].must_equal 'bar'
+    end
+
+    it 'returns true' do
+      subject.put('foo', 'bar').must_equal true
+    end
+  end
+
+  describe '#get' do
+    describe 'simple (no recursing)' do
+      before { subject.put('foo', 'bar') }
+      let(:expected_value) { [{'key' => 'foo', 'value' => 'bar'}] }
+
+      it 'retrieves key from Hash in an array' do
+        subject.get('foo').must_equal(expected_value)
+      end
+    end
+
+    describe 'with recursing' do
+      before do
+        subject.put('foo/bar/baz', 'baz')
+        subject.put('foo/bar/bif', 'bif')
+        subject.put('foo/bar/boz', 'boz')
+        subject.put('foo/boom/boz', 'boz')
+      end
+
+      let(:expected_value) do
+        [
+          {'key' => 'foo/bar/baz', 'value' => 'baz'},
+          {'key' => 'foo/bar/bif', 'value' => 'bif'},
+          {'key' => 'foo/bar/boz', 'value' => 'boz'},
+        ]
+      end
+
+      let(:unexpected_value) { [{'key' => 'foo/boom/boz', 'value' => 'boz'}] }
+
+      it 'retrieves all keys beginning with supplied key from Hash in an array' do
+        subject.get('foo/bar/', recurse: true).must_equal(expected_value)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'active_support/hash_with_indifferent_access'
+require 'fake_consul/server'
+

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: fake_consul
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Saimon Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.21
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.21
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Fakes a consul server. Usecase is for feature specs using Diplomat client
+email:
+- saimonmoore@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- fake_consul.gemspec
+- lib/fake_consul.rb
+- lib/fake_consul/server.rb
+- lib/fake_consul/version.rb
+- spec/fake_consul/server_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Fakes a consul server. Usecase is for feature specs using Diplomat client
+test_files:
+- spec/fake_consul/server_spec.rb
+- spec/spec_helper.rb