uat-discovery 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97ca4955b3d8e9b62e2bdb81704477408ad27026
+  data.tar.gz: 130dbadc2dcb9d1d8cce88bfdf370e857173a90b
+SHA512:
+  metadata.gz: 962e62bc8e89950afc96577b917dc4c84e5fea363717d0a664f1f126c0d20d61e94800a1d15503b51fdb01847af43145ba373f451add9cbdcd703be3d70cae34
+  data.tar.gz: 3a302aa33e59fd7523fbd07a7001bc6fb857c783b3db768435e90ce42fe7cff63caad2225e80cda8994468cc4e28895a502ce2d32dccc8f3d93d6e8ccbb4d5ef

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper --format documentation --color true

data/Gemfile

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

data/README.md

@@ -0,0 +1,60 @@
+UAT::Discovery
+-----------
+
+Interact with, or simulate, discovery using this gem.
+
+# Usage
+
+The behavior for how a client provides the urls for a given named service is determined by how the API was configured.
+See below for example configuration hashes for different desired behaviors.
+
+    ```
+    config = UAT::Discovery::Configuration.new(config_hash)
+    api = UAT::Discovery::API.new(config)
+
+    client = api.new_client
+    client.urls_for_service('service_name')
+    ```
+
+# Configuration Options
+
+Local Mode
+
+    ```
+    {
+        "local_mode": true,
+        "local_service_urls_keyed_by_service_name": {
+            "service1": [
+                "url1",
+                "url2"
+            ]
+        }
+    }
+    ```
+
+Server Mode
+
+    Append a locally configured path to the end of the host/port (support for multiple service N/A)
+
+    ```
+    {
+        "local_mode": false,
+        "url": "http://discovery-server:8080",
+        "protocol": "http",
+        "discover_paths": false,
+        "append_service_path": "/path/to/append/after/host"
+    }
+    ```
+
+    Discover the pathing information via Discovery's Key/Value store:
+
+    ```
+    {
+        "local_mode": false,
+        "url": "http://discovery-server:8080",
+        "protocol": "http",
+        "discover_paths": true,
+        "service_metadata_key_value_prefix": "chef/services/",
+        "metadata_property_for_path": "root_url_path"
+    }
+    ```

data/Rakefile

@@ -0,0 +1,7 @@
+#-*- mode: ruby -*-
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+task :default => [ :spec ]
+
+# vim: syntax=Ruby

data/lib/uat/discovery/api.rb

@@ -0,0 +1,81 @@
+module UAT
+  module Discovery
+    # An instance of this API should be used to create all objects needed from this gem
+    # The configuration with which it is instantiated controls all instances
+    class API
+      # @param configuration [UAT::Discovery::Configuration]
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      # @return [UAT::Discovery::Interfaces::IClient] returns a client implementation based on configuration
+      def new_client
+        @configuration.local_mode? ? new_mock_client : new_real_client
+      end
+
+      # @return [UAT::Discovery::Client]
+      def new_real_client
+        Client.new(
+            new_diplomat_service,
+            @configuration.protocol,
+            self,
+            new_path_provider
+        )
+      end
+
+      # @return [UAT::Discovery::MockClient]
+      def new_mock_client
+        MockClient.new(
+            @configuration.local_service_urls_keyed_by_service_name,
+            self
+        )
+      end
+
+      # @param uri_string the uri string that should be converted to a URI object
+      # @return [URI::Generic]
+      def new_uri(uri_string)
+        URI(uri_string)
+      end
+
+      private
+
+      # @return [UAT::Discovery::Interfaces::IPathProvider]
+      # @private
+      def new_path_provider
+        @configuration.discover_paths? ? new_discovery_path_provider : new_configured_path_provider
+      end
+
+      # @return [UAT::Discovery::ConsulPathProvider]
+      # @private
+      def new_discovery_path_provider
+        ConsulPathProvider.new(
+            Diplomat,
+            @configuration.service_metadata_key_value_prefix,
+            JSON,
+            @configuration.metadata_property_for_path
+        )
+      end
+
+      # @return [UAT::Discovery::ConfiguredSinglePathProvider]
+      # @private
+      def new_configured_path_provider
+        ConfiguredSinglePathProvider.new(@configuration.append_service_path)
+      end
+
+      # @return [Diplomat::Service]
+      # @private
+      def new_diplomat_service
+        configure_diplomat
+        Diplomat::Service
+      end
+
+      # @return [Void] configures diplomat to use the configured discovery_url
+      # @private
+      def configure_diplomat
+        Diplomat.configure do |config|
+          config.url = @configuration.url
+        end
+      end
+    end
+  end
+end

data/lib/uat/discovery/client.rb

@@ -0,0 +1,31 @@
+module UAT
+  module Discovery
+    # A discovery client that uses Diplomat to get urls for a named service
+    # @see [UAT::Discovery::IClient]
+    class Client < Interfaces::IClient
+      # @param diplomat_service [Class<Diplomat::Service>] the diplomat service class reference
+      # @param protocol [String] the protocol that should be prepended to urls_for_service
+      # @param api [#new_uri] a factory method for creating new URIs
+      # @param path_provider [UAT::Discovery::Interfaces::IPathProvider] provides path for after host/port
+      def initialize(diplomat_service, protocol, api, path_provider)
+        @diplomat_service = diplomat_service
+        @protocol = protocol
+        @api = api
+        @path_provider = path_provider
+      end
+
+      # @see [UAT::Discovery::IClient]
+      def urls_for_service(service_name)
+        diplomat_services = @diplomat_service.get(service_name, :all)
+        path = @path_provider.path_to_append_for(service_name)
+        diplomat_services.uniq.map {|diplomat_service| @api.new_uri(uri_string(diplomat_service, path)) }
+      end
+
+      private
+
+      def uri_string(diplomat_service, path)
+        "#{@protocol}://#{diplomat_service.Address.to_s}:#{diplomat_service.ServicePort}#{path}"
+      end
+    end
+  end
+end

data/lib/uat/discovery/configuration.rb

@@ -0,0 +1,50 @@
+module UAT
+  module Discovery
+    class Configuration
+      # @param config_hash [Hash]
+      def initialize(config_hash)
+          @config_hash = config_hash
+      end
+
+      # @return [Hash<String, Array<String>>]
+      def local_service_urls_keyed_by_service_name
+        @config_hash['local_service_urls_keyed_by_service_name']
+      end
+
+      # @return [Boolean]
+      def local_mode?
+        @config_hash['local_mode']
+      end
+
+      # @return [Boolean]
+      def discover_paths?
+        @config_hash['discover_paths']
+      end
+
+      # @return [String]
+      def protocol
+        @config_hash['protocol']
+      end
+
+      # @return [String] path that will be appended to discovery host/port, no matter what service name
+      def append_service_path
+        @config_hash['append_service_path']
+      end
+
+      # @return [String] the prefix to prepend to a service name, used to retrieve discovery key value requests for a service
+      def service_metadata_key_value_prefix
+        @config_hash['service_metadata_key_value_prefix']
+      end
+
+      # @return [String] the property name in discovery key/value metadata hash containing a service's path
+      def metadata_property_for_path
+        @config_hash['metadata_property_for_path']
+      end
+
+      # @return [String]
+      def url
+        @config_hash['url']
+      end
+    end
+  end
+end

data/lib/uat/discovery/configured_path_provider.rb

@@ -0,0 +1,16 @@
+module UAT
+  module Discovery
+    class ConfiguredSinglePathProvider < Interfaces::IPathProvider
+      # @param append_service_path [String] the path (if any) to append after the domain and port. Should include leading slash /
+      def initialize(append_service_path)
+        @append_service_path = append_service_path
+      end
+
+      # @param service_name [String] the name of the service for which one would like to get the path - ignored
+      # @return [String]
+      def path_to_append_for(service_name)
+        @append_service_path
+      end
+    end
+  end
+end

data/lib/uat/discovery/consul_path_provider.rb

@@ -0,0 +1,25 @@
+module UAT
+  module Discovery
+    class ConsulPathProvider < Interfaces::IPathProvider
+      # @param diplomat_service [Module<Diplomat>] the diplomat module
+      # @param service_metadata_key_value_prefix [String] the key value prefix that comes before a service name
+      # @param json_parser [JSON] native JSON module or compatible parser
+      # @param metadata_property_for_path [String] the property on the metadata node containing the path
+      def initialize(diplomat_module, service_metadata_key_value_prefix, json_parser, metadata_property_for_path)
+        @diplomat_module = diplomat_module
+        @service_metadata_key_value_prefix = service_metadata_key_value_prefix
+        @json_parser = json_parser
+        @metadata_property_for_path = metadata_property_for_path
+      end
+
+      # @param service_name [String] the name of the service for which one would like to get the path - ignored
+      # @return [String]
+      def path_to_append_for(service_name)
+        #'chef/services/lookout-bluffdale'
+        metadata = @diplomat_module.get("#{@service_metadata_key_value_prefix}#{service_name}")
+        metadata_hash = @json_parser.parse(metadata)
+        metadata_hash['metadata'][@metadata_property_for_path]
+      end
+    end
+  end
+end

data/lib/uat/discovery/interfaces/i_client.rb

@@ -0,0 +1,13 @@
+module UAT
+  module Discovery
+    module Interfaces
+      # @abstract
+      class IClient
+        # @abstract
+        # @param service_name [String] the name of the service for which one would like to retrieve the host urls
+        # @return [Array<URI::Generic>]
+        def urls_for_service(service_name) raise NotImplementedError end
+      end
+    end
+  end
+end

data/lib/uat/discovery/interfaces/i_path_provider.rb

@@ -0,0 +1,13 @@
+module UAT
+  module Discovery
+    module Interfaces
+      # @abstract
+      class IPathProvider
+        # @abstract
+        # @param service_name [String] the name of the service for which one would like to get the path
+        # @return [String]
+        def path_to_append_for(service_name) raise NotImplementedError end
+      end
+    end
+  end
+end

data/lib/uat/discovery/mock_client.rb

@@ -0,0 +1,24 @@
+module UAT
+  module Discovery
+    # A mock discovery client, mainly for use when running tests locally
+    # Allows one to locally configure the hosts associated with a service name
+    # @see [UAT::Discovery::IClient]
+    class MockClient < Interfaces::IClient
+      # @param hash_of_service_urls_keyed_by_service_name [Hash]
+      # @param api [UAT::Discovery::API]
+      def initialize(hash_of_service_urls_keyed_by_service_name, api)
+        @hash_of_service_urls = hash_of_service_urls_keyed_by_service_name
+        @api = api
+      end
+
+      # @see [UAT::Discovery::IClient#urls_for_service]
+      def urls_for_service(service_name)
+        if @hash_of_service_urls.has_key? service_name
+          @hash_of_service_urls[service_name].map {|service_url| @api.new_uri(service_url)}
+        else
+          raise "URL for service #{service_name} could not be found"
+        end
+      end
+    end
+  end
+end

data/lib/uat/discovery/version.rb

@@ -0,0 +1,5 @@
+module UAT
+  module Discovery
+    VERSION = "0.0.1.pre"
+  end
+end

data/lib/uat/discovery.rb

@@ -0,0 +1,5 @@
+require 'diplomat'
+require 'uri'
+
+Dir["#{File.dirname(__FILE__)}/discovery/interfaces/**/*.rb"].each { |f| require(f) }
+Dir["#{File.dirname(__FILE__)}/discovery/**/*.rb"].each { |f| require(f) }

data/uat-discovery.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uat/discovery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uat-discovery"
+  spec.version       = UAT::Discovery::VERSION
+  spec.authors       = ["Tommy Sullivan", "Blaine Schanfeldt"]
+  spec.email         = ["thomas.sullivan@lookout.com", "blaine.schanfeldt@lookout.com"]
+
+  spec.summary       = "helper for discovery / service discovery during testing"
+  spec.homepage      = "https://github.com/lookout/uat"
+  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 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9.2'
+  spec.add_development_dependency 'ipaddress', '~> 0.8.0'
+  spec.add_development_dependency 'yard', '~> 0.8.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+
+  spec.add_dependency 'diplomat', '~> 0.5.1'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: uat-discovery
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Tommy Sullivan
+- Blaine Schanfeldt
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2015-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  name: simplecov
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  name: ipaddress
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  name: yard
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  name: webmock
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  name: diplomat
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+description:
+email:
+- thomas.sullivan@lookout.com
+- blaine.schanfeldt@lookout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/uat/discovery.rb
+- lib/uat/discovery/api.rb
+- lib/uat/discovery/client.rb
+- lib/uat/discovery/configuration.rb
+- lib/uat/discovery/configured_path_provider.rb
+- lib/uat/discovery/consul_path_provider.rb
+- lib/uat/discovery/interfaces/i_client.rb
+- lib/uat/discovery/interfaces/i_path_provider.rb
+- lib/uat/discovery/mock_client.rb
+- lib/uat/discovery/version.rb
+- uat-discovery.gemspec
+homepage: https://github.com/lookout/uat
+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: 1.3.1
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: helper for discovery / service discovery during testing
+test_files: []
+has_rdoc: