vidocq 0.0.7

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Companybook AS
+
+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,35 @@
+# Vidocq
+
+As you know, a gem isn't cool without an obscure name. Which is why Vidocq gets its name from the first known private investigator, [Eugène
+François Vidocq](http://en.wikipedia.org/wiki/Eug%C3%A8ne_Fran%C3%A7ois_Vidocq).
+Vidocq is a library for hunting down service instances. Services that
+register as running using an ephemeral zookeeper znode can be discovered
+with Vidocq.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'vidocq'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+    $ gem install vidocq
+
+## Usage
+```ruby
+v = Vidocq.new('my-service', '0.1', :zk => 'myzkserver:2181', :ttl => 10)
+response = v.call(:id => '42')
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/vidocq.rb

@@ -0,0 +1,55 @@
+require 'zk'
+require 'json'
+require 'vidocq/connection'
+require 'vidocq/railtie' if defined? ::Rails::Railtie
+
+module Vidocq
+
+  class NoEndpointError < StandardError; end
+  class NoResponseError < StandardError; end
+
+  # Connection factory
+  def self.new(sid, version, opts = {})
+    Connection.new(sid, version, opts || {})
+  end
+
+  def self.logger=(new_logger)
+    @logger = new_logger
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  # Lists all the services, versions and instances
+  # in an  hierarcical format like the following:
+  #
+  # [
+  #   {:name => 'fooservice', :versions =>
+  #     [
+  #       {:number => '0.1', :instances =>
+  #         [
+  #           {:endpoint => 'http://198.0.0.1:8900/foo'}, ...
+  #         ]
+  #       }, ...
+  #     ]
+  #   }, ...
+  # ]
+  def self.services(connect_string = nikjl)
+    base_path = "/companybook/services"
+    ZK.open(connect_string || 'localhost:2181') do |zk|
+      return [] unless zk.exists?(base_path)
+      return zk.children(base_path).collect do |service|
+        service_path = base_path + '/' + service
+        versions = zk.children(service_path).collect do |version|
+          version_path = service_path + '/' + version
+          instances = zk.children(version_path).collect do |instance|
+            JSON.parse(zk.get(version_path + '/' + instance).first)
+          end
+          {:number => version, :instances => instances}
+        end
+        {:name => service, :versions => versions}
+      end
+    end
+  end
+end

data/lib/vidocq/cache.rb

@@ -0,0 +1,37 @@
+require 'json'
+require 'zk'
+
+module Vidocq
+  class Cache
+    def initialize(sid, version, opts = {})
+      @ttl = opts.fetch(:ttl, 0)
+      @cs = opts.fetch(:zk, 'localhost:2181')
+      @parent = "/companybook/services/#{sid}/#{version}"
+      @endpoints = []
+    end
+
+    def endpoints
+      outdated? ? expire! : @endpoints
+    end
+
+    private
+
+    def get_children(zk, path)
+      zk.children(path) rescue []
+    end
+
+    def outdated?
+      @endpoints.empty? or Time.now > (@last_request + @ttl)
+    end
+
+    def expire!
+      @last_request = Time.now
+
+      ZK.open(@cs) do |zk|
+        @endpoints = zk.children(@parent).collect do |child|
+          JSON.parse(zk.get(@parent + '/' + child).first)['endpoint']
+        end
+      end
+    end
+  end
+end

data/lib/vidocq/connection.rb

@@ -0,0 +1,52 @@
+require 'httparty'
+require 'cgi'
+require 'vidocq/cache'
+
+module Vidocq
+  class Connection
+    def initialize(sid, version, opts = {})
+      @fallbacks = opts.delete(:fallbacks) || []
+      @cache = Cache.new(sid, version, opts)
+    end
+
+    # Finds an endpoint and calls it with the given options.
+    # If there is a connection failure, new attempts are
+    # made with new endpoints.
+    #
+    # Two failure modes are handled:
+    # 1. There are no registered endpoints: NoEndpointError
+    # 2. None of the registered endpoints respond: NoResponseError
+    def call(opts = {})
+      resource_id = opts.delete(:id)
+      endpoints = get_endpoints
+      raise NoEndpointError if endpoints.empty?
+      Vidocq.logger.info "Vidocq endpoints: #{endpoints}"
+        
+      begin
+        endpoint = endpoints.slice!(rand(endpoints.size))
+        path = [endpoint, resource_id].compact.join('/')
+        url = "#{path}?#{build_querystring(opts)}"
+        begin
+          return HTTParty.get(url)
+        rescue Exception => e
+          Vidocq.logger.warn "Error requesting '#{url}': #{e}."
+        end
+      end while endpoints.any?
+
+      Vidocq.logger.warn "Vidocq: Unable to reach any of the endpoints"
+
+      raise NoResponseError
+    end
+
+    def get_endpoints
+      endpoints = @cache.endpoints || []
+      endpoints.empty? ? @fallbacks : endpoints
+    end
+
+    private
+
+    def build_querystring(opts = {})
+      opts.collect { |k,v| "#{k}=#{CGI::escape(v.to_s)}" }.join('&')
+    end
+  end
+end

data/lib/vidocq/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module Vidocq
+  class Railtie < ::Rails::Railtie
+    initializer 'Rails logger' do
+      Vidocq.logger = Rails.logger
+    end
+  end
+end

data/lib/vidocq/version.rb

@@ -0,0 +1,3 @@
+module Vidocq
+  VERSION = "0.0.7"
+end 

data/vidocq.gemspec

@@ -0,0 +1,19 @@
+require File.expand_path('../lib/vidocq/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alexander Mossin"]
+  gem.email         = ["alexander@companybook.no"]
+  gem.description   = %q{A library for discover service instances registered in ZooKeeper.}
+  gem.summary       = %q{A library for discover service instances registered in ZooKeeper.}
+  gem.homepage      = ""
+
+  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.name          = "vidocq"
+  gem.require_paths = ["lib"]
+  gem.version       = Vidocq::VERSION
+
+  gem.add_dependency('zk', '>= 1.6.4')
+  gem.add_dependency('httparty', '>= 0.8.0')
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: vidocq
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Mossin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zk
+  requirement: &70342550833760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70342550833760
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70342550833260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70342550833260
+description: A library for discover service instances registered in ZooKeeper.
+email:
+- alexander@companybook.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vidocq.rb
+- lib/vidocq/cache.rb
+- lib/vidocq/connection.rb
+- lib/vidocq/railtie.rb
+- lib/vidocq/version.rb
+- vidocq.gemspec
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A library for discover service instances registered in ZooKeeper.
+test_files: []
+has_rdoc: