offline_consul-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c743ffb8b2e4a7cdf3c505fb33ddf10f6663bc9e
+  data.tar.gz: f81f4f8267a540598515ff80f8a14db60130d69e
+SHA512:
+  metadata.gz: de1ac02621828642b1fa5ad9bc61ac1b4a4b4534f2a5438e5ecb1adec36cbf9ee3689eb948ba9c9a15c8e67253d8783131c5c4c3605b4e4e91129288bd0fe21a
+  data.tar.gz: fd517ffa9afdc27b7d3e1a9c59bd3e3537b38f01a498343e1e3febbc2dd9ea588a4d814ca7ed3645905e50779731be6d6d18ea64ae64528638c2ab9e9790e6ca

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/pkg/
+/coverage/
+/doc/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Goldstar Events
+
+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,71 @@
+# Consul::Client
+
+A consul client that gracefully supports offline reads/writes for dev
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'consul-client', :git => 'ssh://git@github.com/goldstar/consul-client.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+###Basic Usage
+
+The main methods to use are `Consul::Client.read` and `Consul::Client.write`, these will perform all kv queries within the namespace defined by `Consul::Client.namespace` 
+
+```ruby
+>> Consul::Client.namespace = "/bags"
+>> mydata = {foo:1, bar:[1,2,:three], baz:false, bat:{one:1, two:2, three:3}}
+=> {:foo=>1, :bar=>[1, 2, :three], :baz=>false, :bat=>{:one=>1, :two=>2, :three=>3}}
+>> consul::Client.write('/some/key', mydata)
+=> #<Consul::Response:0x007fec1c893180
+>> Consul::Client.read('/some/key')
+=> {:foo=>1, :bar=>[1, 2, :three], :baz=>false, :bat=>{:one=>1, :two=>2, :three=>3}}
+
+```
+
+```bash
+curl "http://consul:8500/v1/kv/bags/some/key?raw"
+---
+:foo: 1
+:bar:
+- 1
+- 2
+- :three
+:baz: false
+:bat:
+  :one: 1
+  :two: 2
+  :three: 3
+```
+
+###Tweakables
+
+```ruby
+>> Consul::Client.host = "consul_server"   # default: "consul"
+>> Consul::Client.port = 12345             # default: 8500
+>> Consul::Client.namespace = "/foo"       # default: "/bags"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/goldstar/consul-client.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "consul/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/consul-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'consul/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "offline_consul-client"
+  spec.version       = Consul::Client::VERSION
+  spec.authors       = ["Jason Scholl"]
+  spec.email         = ["jscholl@goldstar.com"]
+
+  spec.summary       = %q{Consul client with dev mode}
+  spec.description   = %q{Consul client with offline mode for dev, and recursive queries, presenting data as a hash}
+  spec.homepage      = "https://github.com/goldstar/consul-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/lib/consul/client/config.rb

@@ -0,0 +1,25 @@
+module Consul::Client
+  class Config
+    attr_reader :host, :port
+    attr_accessor :namespace
+
+    def initialize
+      @port = 8500
+      @host = "consul"
+      @namespace = "/bags"
+    end
+
+    def host=(newhost)
+      @host = newhost
+      Consul::Client.http.load_config
+      @host
+    end
+
+    def port=(newport)
+      @port = newport
+      Consul::Client.http.load_config
+      @port
+    end
+
+  end
+end

data/lib/consul/client/fake_http_response.rb

@@ -0,0 +1,20 @@
+require 'net/http'
+
+module Consul
+  module Client
+    class FakeNetHttpResponse
+      attr_reader :body
+      def initialize(body="Good news everyone!")
+        @body = body
+      end
+
+      def code
+        "200"
+      end
+
+      def code_type
+        Net::HTTPOK
+      end
+    end
+  end
+end

data/lib/consul/client/version.rb

@@ -0,0 +1,5 @@
+module Consul
+  module Client
+    VERSION = "0.1.0"
+  end
+end

data/lib/consul/client.rb

@@ -0,0 +1,139 @@
+require "consul/client/version"
+require "consul/client/config"
+require "consul/client/fake_http_response"
+require "consul/http"
+require "consul/response"
+require "consul/data"
+
+require "psych"
+require "fileutils"
+
+module Consul
+  module Client
+    attr_writer :namespace
+
+    def self.config
+      @@config ||= Config.new
+    end
+
+    def self.online_read(keypath, recurse=false)
+      response = http.get("/kv" + path(keypath) + (recurse ? '?recurse' : ''))
+      keyname = File.basename(keypath)
+      if response.length == 1 && response.keys.first == keyname
+        response = response.data[keyname]
+      end
+      decode_r(response)
+    end
+
+    def self.offline_read(keypath, recurse=false)
+      files = if recurse
+                Dir.glob(File.join(local_path, path(keypath) + '*'))
+              else
+                [File.join(local_path, path(keypath) + ".yaml")]
+              end
+
+      response = Hash[files.map do |filename|
+        [File.basename(filename).sub(/\.yaml$/, ''), File.open(filename){ |f| Consul::Data.new('Value' => Base64.encode64(f.read) )}]
+      end]
+      keyname = File.basename(keypath)
+      if response.length == 1 && response.keys.first == keyname
+        response = response[keyname]
+      end
+      decode_r(response)
+    end
+
+    def self.read(keypath, recurse=false)
+      if is_online?
+        online_read(keypath, recurse)
+      else
+        offline_read(keypath, recurse)
+      end
+    end
+
+    def self.online_write(keypath,data=nil,path_mimic=false)
+      data = encode(data)
+      http.put("/kv" + path(keypath), data)
+    end
+
+    def self.offline_write(keypath,data=nil)
+      data = encode(data)
+      filename = File.join(local_path, path(keypath) + ".yaml")
+      dirname = File.dirname(filename)
+
+      unless File.directory?(dirname)
+        FileUtils.mkdir_p(dirname)
+      end
+      File.open(filename, 'w') { |f| f.write(data) }
+      Response.new(FakeNetHttpResponse.new)
+    end
+
+    def self.write(keypath,data=nil)
+      if is_online?
+        online_write(keypath,data)
+      else
+        offline_write(keypath,data)
+      end
+    end
+
+
+    #def self.lock(keypath, data=nil)
+    #  write(keypath + "?acquire=#{session_id}", data)
+    #end
+
+    #def self.unlock(keypath, data=nil)
+    #  write(keypath + "?release=#{session_id}", data)
+    #end
+
+    #def self.session_id
+    #  @@session_id ||= http.put("/session/create")
+    #end
+
+    #def self.has_lock?(keypath)
+    #  read("/kv/" + keypath).session == session_id
+    #end
+
+    def self.http
+      @http ||= Http.new
+    end
+
+    def self.local_path
+      ENV['CONSUL_CLIENT_YAML_PATH'] || "/tmp/consul_client"
+    end
+
+    def self.path(keypath)
+      File.join("/" + config.namespace,  keypath).gsub(%r{//}, '/')
+    end
+
+    def self.is_online?
+      !::Chef::Config[:solo]
+    end
+
+    def self.decode_r(data)
+      if data.respond_to?(:keys)
+        Hash[ data.map{ |k,v| [k,decode_r(v)] } ]
+      else
+        decode(data.value)
+      end
+    end
+
+    def self.decode(value)
+      Psych.safe_load(value, [Symbol])
+    end
+
+    def self.encode(value)
+      encoded = Psych.dump(value)
+      if decode(encoded) != value
+        raise TypeError, "Unable to relaibly decode #{value.class}"
+      end
+      encoded
+    end
+
+    def self.encode_r(data)
+      if data.respond_to?(:keys)
+        Hash[ data.map{ |k,v| [k, encode_r(v)] } ]
+      else
+        encode(data)
+      end
+    end
+  end
+end

data/lib/consul/data.rb

@@ -0,0 +1,25 @@
+require 'base64'
+
+module Consul
+  class Data
+
+    def initialize(response_hash)
+      @response = response_hash
+    end
+
+    def value
+      Base64.decode64(hash_map('Value'))
+    end
+
+    def flags
+      hash_map(__callee__)
+    end
+    [:lock_index, :create_index, :modify_index, :session].each{ |a| alias_method a, :flags }
+
+    private 
+    def hash_map(key)
+      @response[key.to_s.split('_').map{ |w| w.capitalize }.join]
+    end
+
+  end
+end

data/lib/consul/http.rb

@@ -0,0 +1,28 @@
+require 'net/http'
+
+module Consul
+  class Http
+    attr_accessor :http_client
+
+    def initialize
+      load_config
+    end
+
+    def request(method, uri, data=nil)
+      response = http_client.send_request(method, ("/v1" + uri), data)
+      Response.new(response, uri.gsub(%r{^/kv/}, ''))
+    end
+
+    def put(path, data=nil)
+      request('PUT', path, data)
+    end
+
+    def get(path)
+      request('GET', path)
+    end
+
+    def load_config
+      self.http_client = Net::HTTP.new(Consul::Client.config.host, Consul::Client.config.port, nil, nil)
+    end
+  end
+end

data/lib/consul/response.rb

@@ -0,0 +1,54 @@
+require 'psych'
+require 'net/http'
+require 'forwardable'
+
+module Consul
+  class Response
+    extend Forwardable
+    include Enumerable
+
+    attr_reader :response, :data
+    def_delegators :response, :body, :code, :code_type
+    def_delegators :data, :keys, :values, :each, :to_a, :length
+
+    def initialize(net_http_response, request_path='/')
+      @response = net_http_response
+      @request_path = File.dirname(request_path)
+    end
+
+    def data
+      @data ||= init_data
+    end
+
+    #def locked?
+    #  to_h.has_key?("Session")
+    #end
+
+    private
+
+    def init_data
+      {}.tap do |retval|
+        to_ruby.each do |metadata|
+          hash_path = metadata['Key'].gsub(%r{^/?#{@request_path}/?}, '')
+          retval.merge!(build_data_hash(hash_path,metadata), &merger)
+        end
+      end
+    end
+
+    def build_data_hash(hash_path, consul_metadata)
+      hash_path.split('/').reverse.inject(Data.new(consul_metadata)) { |memo,key| { key => memo } }
+    end
+
+    def to_ruby
+      if response.code_type == Net::HTTPOK
+        Psych.safe_load(response.body)
+      else
+        []
+      end
+    end
+
+    def merger
+      proc { |key,new,old| new.respond_to?(:merge) && new.class == old.class ? new.merge(old, &merger) : old }
+    end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: offline_consul-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Scholl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: vcr
+  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: webmock
+  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: Consul client with offline mode for dev, and recursive queries, presenting
+  data as a hash
+email:
+- jscholl@goldstar.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- consul-client.gemspec
+- lib/consul/client.rb
+- lib/consul/client/config.rb
+- lib/consul/client/fake_http_response.rb
+- lib/consul/client/version.rb
+- lib/consul/data.rb
+- lib/consul/http.rb
+- lib/consul/response.rb
+homepage: https://github.com/goldstar/consul-client
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Consul client with dev mode
+test_files: []
+has_rdoc: