server-registry-client 0.0.1

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael James
+
+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,29 @@
+# Server::Registry::Client
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'server-registry-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install server-registry-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test) do |t|
+	t.rspec_opts = "--color --format nested --backtrace"
+end
+
+# desc "Run all tests"
+# task :test do |t|
+# 	sh %{ ruby -S rspec --color --format nested --backtrace }
+# end

data/bin/srctool

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "../lib")
+
+require 'server-registry-client'
+require 'server-registry-client/cli'
+
+ServerRegistryClient::CLI.start(ARGV)

data/lib/server-registry-client/cli.rb

@@ -0,0 +1,94 @@
+require 'thor'
+require 'active_support/core_ext/object/blank'
+
+module ServerRegistryClient
+	class CLI < ::Thor
+		class_option :server, :type => :string, :banner => "URL of the server registry"
+
+		option :hostname, :banner => "server hostname"
+		option :ip_address, :banner => "server IP address"
+		option :port, :type => :numeric, :banner => "server port"
+		option :categories, :required => true, :banner => "comma-separated string of category names"
+		desc "add_server", "add server to registry server"
+		def add_server
+			require_server_option
+			require_server_hostname_or_ip_address
+
+			server = construct_server_from_options
+
+			categories = parse_csv(options[:categories])
+
+			client = construct_client
+			client.add_server_to_categories(server, categories)
+		end
+
+		option :hostname, :banner => "server hostname"
+		option :ip_address, :banner => "server IP address"
+		option :port, :type => :numeric, :banner => "server port"
+		option :categories, :required => true, :banner => "comma-separated string of category names"
+		desc "remove_server_from_category", "remove server from categories on registry server"
+		def remove_server_from_category
+			require_server_option
+			require_server_hostname_or_ip_address
+
+			server = construct_server_from_options
+
+			categories = parse_csv(options[:categories])
+
+			client = construct_client
+			categories.each do |category_name|
+				client.remove_server_from_category(server, category_name)
+			end
+		end
+
+		option :hostname, :banner => "server hostname"
+		option :ip_address, :banner => "server IP address"
+		option :port, :type => :numeric, :banner => "server port"
+		desc "remove_server", "remove all entries with the specified server attributes"
+		def remove_server
+			require_server_option
+			require_server_hostname_or_ip_address
+
+			server = construct_server_from_options
+
+			client = construct_client
+			client.remove_servers_like(server)
+		end
+
+		private
+
+		def construct_client
+			return ServerRegistryClient::Client.new(options[:server])
+		end
+
+		def construct_server_from_options
+			server = ServerRegistryClient::Server.new
+			server.hostname = options[:hostname]
+			server.ip_address = options[:ip_address]
+			server.port = (options[:port].to_i > 0 ? options[:port].to_i : nil)
+
+			return server
+		end
+
+		def parse_csv(value)
+			categories = []
+
+			categories << value.to_s.split(",")
+			categories.flatten!
+
+			return categories
+		end
+
+		def require_server_hostname_or_ip_address
+			if options[:hostname].blank? && options[:ip_address].blank?
+				raise ::Thor::RequiredArgumentMissingError, "--hostname or --ip_address option must not be blank"
+			end			
+		end
+
+		def require_server_option
+			if options[:server].blank?
+				raise ::Thor::RequiredArgumentMissingError, "--server options must not be blank"
+			end			
+		end
+	end
+end

data/lib/server-registry-client/client.rb

@@ -0,0 +1,37 @@
+module ServerRegistryClient
+	class Client
+		attr_accessor :server_processor
+
+		def initialize(server_registry_url, version_number=1)
+			use_version(server_registry_url, version_number)
+		end
+
+		def servers_in_category(category)
+			return server_processor.servers_in_category(category)
+		end
+
+		def add_server_to_categories(server, category_names)
+			return server_processor.add_server_to_categories(server, category_names)
+		end
+
+		def remove_server_from_category(server, category_name)
+			return server_processor.remove_server_from_category(server, category_name)
+		end
+
+		def remove_servers_like(server)
+			return server_processor.remove_servers_like(server)
+		end
+
+		def server_registry_url
+			return server_processor.server_registry_url_root
+		end
+
+		protected
+
+		def use_version(server_registry_url, version_number)
+			raise "version number must be a number greater than zero" if version_number.to_i <= 0
+
+			self.server_processor = ServerRegistryClient::ServerProcessor.const_get("V#{version_number}".to_sym).new(server_registry_url)
+		end
+	end
+end

data/lib/server-registry-client/errors.rb

@@ -0,0 +1,4 @@
+module ServerRegistryClient
+	class ServerCommunicationError < ::StandardError
+	end
+end

data/lib/server-registry-client/models/server.rb

@@ -0,0 +1,58 @@
+require 'active_support/core_ext/object/blank'
+
+module ServerRegistryClient
+	class Server
+		attr_accessor :id
+		attr_accessor :hostname
+		attr_accessor :ip_address
+		attr_accessor :port
+
+		def initialize(id=nil, hostname=nil, ip_address=nil, port=nil)
+			@id = id
+			@hostname = hostname
+			@ip_address = ip_address
+			@port = port
+		end
+
+		def matches?(server)
+			result = false
+
+			we_have_hostname = !self.hostname.blank?
+			we_have_ip_address = !self.ip_address.blank?
+			we_have_port = !self.port.blank?
+
+			they_have_hostname = !server.hostname.blank?
+			they_have_ip_address = !server.ip_address.blank?
+			they_have_port = !server.port.blank?
+
+			ip_address_matches = (we_have_ip_address && they_have_ip_address && self.ip_address == server.ip_address)
+			hostname_matches = (we_have_hostname && they_have_hostname && self.hostname == server.hostname)
+
+			port_matches = if we_have_port && they_have_port && self.port == server.port && (ip_address_matches || hostname_matches)
+				true
+			elsif they_have_port && !we_have_port && (ip_address_matches || hostname_matches)
+				true
+			elsif !they_have_port && !we_have_port && (ip_address_matches || hostname_matches)
+				true
+			elsif we_have_port && they_have_port && self.port == server.port && (!we_have_hostname && they_have_hostname)
+				true
+			else
+				false
+			end
+
+			if self.id == server.id
+				result = true
+			else
+				if ip_address_matches
+					result = (true && port_matches)
+				elsif hostname_matches
+					result = (true && port_matches)
+				else
+					result = port_matches
+				end
+			end
+
+			return result
+		end
+	end
+end

data/lib/server-registry-client/models.rb

@@ -0,0 +1,3 @@
+module ServerRegistryClient
+	autoload :Server, 'server-registry-client/models/server'
+end

data/lib/server-registry-client/server_processor/base.rb

@@ -0,0 +1,77 @@
+require 'typhoeus'
+require 'uri'
+require 'yajl'
+
+module ServerRegistryClient
+	module ServerProcessor
+		class Base
+			attr_reader :server_registry_url_root
+			attr_reader :last_response
+			attr_reader :api_version
+
+			def initialize(server_registry_url_root)
+				@server_registry_url_root = server_registry_url_root
+				@hydra = ::Typhoeus::Hydra.new
+			end
+
+			protected
+
+			attr_reader :hydra
+			attr_writer :api_version
+
+			def default_typhoeus_options
+				{
+					:timeout => 5000
+				}
+			end
+
+			def make_web_request(api_fragment, options={}, &block)
+				typhoeus_options = default_typhoeus_options.merge(options)
+
+				request = ::Typhoeus::Request.new(URI.join(self.server_registry_url_root, api_fragment).to_s, typhoeus_options)
+				response_body = nil
+
+				request.on_complete do |response|
+					if response.timed_out?
+						raise ServerRegistryClient::ServerCommunicationError, "Request to #{request.url} timed out"
+					elsif response.success?
+						if response.headers["Content-Type"].include?("application/json")
+							response_body = parse_json(response.body)
+						else
+							response_body = response.body
+						end
+					end
+				end
+
+				self.hydra.queue(request)
+				self.hydra.run
+
+				@last_response = request.response
+
+				unless block.nil?
+					block.call(self.last_response, response_body)
+				end
+
+				return response_body
+			end
+
+			def print_typhoeus_response(response)
+				return <<-EOF
+					#{response.code} #{response.status_message}
+					#{response.headers}
+
+					#{response.body}
+				EOF
+			end
+
+			def parse_json(data)
+				json = Yajl::Parser.parse(data, :symbolize_keys => true)
+				return json
+			end
+
+			def jsonify(data)
+				return Yajl::Encoder.encode(data, :pretty => true)
+			end
+		end
+	end
+end

data/lib/server-registry-client/server_processor/v1.rb

@@ -0,0 +1,98 @@
+module ServerRegistryClient
+	module ServerProcessor
+		class V1 < Base
+			def initialize(server_registry_url)
+				super
+				self.api_version = "v1"
+			end
+
+			def servers_in_category(category)
+				response_json = make_web_request("/api/#{api_version}/category/#{category}")
+
+				if response_json.nil? || last_response.response_code == 404
+					return []
+				else
+					return response_json[:servers].map do |server_json|
+						server_from_json(server_json)
+					end
+				end
+			end
+
+			def get_all_servers
+				response_json = make_web_request("/api/#{api_version}/servers")
+					
+				return response_json.map do |server_json|
+					server_from_json(server_json)
+				end
+			end
+
+			def add_server_to_categories(server, category_names)
+				server_json_hash = server_to_json_hash(server)
+				server_json_hash[:categories] = (category_names.kind_of?(Array) ? category_names : [category_names])
+
+				server_json = jsonify(server_json_hash)
+
+				make_web_request("/api/#{api_version}/servers", {
+					:method => :post,
+					:body => server_json
+				}) do |response, response_body|
+					unless response.success?
+						raise ServerRegistryClient::ServerCommunicationError, "Server responded: #{print_typhoeus_response(response)}"
+					end
+				end
+			end
+
+			def remove_server_from_category(server, category_name)
+				server_name = server.hostname || server.ip_address
+				server_removed = true
+
+				make_web_request("/api/#{api_version}/category/#{category_name}/server/#{server_name}", {
+					:method => :delete
+				}) do |response, response_body|
+					unless response.success?
+						server_removed = false
+					end
+				end
+
+				return server_removed
+			end
+
+			def remove_servers_like(server_to_match)
+				all_servers = get_all_servers
+
+				servers_to_delete = all_servers.find_all do |server|
+					server_to_match.matches?(server)	
+				end
+
+				servers_to_delete.each do |server|
+					make_web_request("/api/#{api_version}/server/#{server.id}", {
+						:method => :delete
+					})
+				end
+			end
+
+			protected
+
+			def server_from_json(server_json)
+				server = ::ServerRegistryClient::Server.new
+
+				server.id = server_json[:id]
+				server.hostname = server_json[:hostname]
+				server.ip_address = server_json[:ip_address]
+				server.port = server_json[:port]
+
+				return server
+			end
+
+			def server_to_json_hash(server)
+				json = {}
+
+				json[:hostname] = server.hostname
+				json[:ip_address] = server.ip_address
+				json[:port] = server.port
+
+				return json
+			end
+		end
+	end
+end

data/lib/server-registry-client/server_processor.rb

@@ -0,0 +1,6 @@
+module ServerRegistryClient
+	module ServerProcessor
+		autoload :Base, 'server-registry-client/server_processor/base'
+		autoload :V1, 'server-registry-client/server_processor/v1'
+	end
+end

data/lib/server-registry-client/version.rb

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

data/lib/server-registry-client.rb

@@ -0,0 +1,5 @@
+require "server-registry-client/version"
+require "server-registry-client/errors"
+require "server-registry-client/client"
+require "server-registry-client/server_processor"
+require "server-registry-client/models"

data/server-registry-client.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/server-registry-client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael James"]
+  gem.email         = ["umjames29@gmail.com"]
+  gem.description   = %q{Client library and command-line tools for interacting with the server registry (https://github.com/umjames/server-registry)}
+  gem.summary       = %q{Client library and command-line tools for interacting with the server registry (https://github.com/umjames/server-registry)}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\) - [".gitignore"]
+  gem.executables   = %w(srctool) #gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "server-registry-client"
+  gem.require_paths = ["lib"]
+  gem.version       = ServerRegistryClient::VERSION
+
+  gem.required_ruby_version = ">= 1.9.1"
+  gem.required_rubygems_version = ">= 1.8.5"
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+
+  gem.add_runtime_dependency 'typhoeus', '0.5.3'
+  gem.add_runtime_dependency 'yajl-ruby', '~> 1.1'
+  gem.add_runtime_dependency 'thor', '~> 0.16'
+  gem.add_runtime_dependency 'activesupport', '~> 3.2'
+end

data/spec/client_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe ServerRegistryClient::Client do
+	it "should be able to create a client with a valid URL" do
+		expect do
+			client = ServerRegistryClient::Client.new("http://www.apple.com")
+		end.to_not raise_error
+	end
+
+	it "should recognize localhost URLs" do
+		expect do
+			client = ServerRegistryClient::Client.new("http://localhost:3000/api/")
+		end.to_not raise_error
+	end
+	
+end

data/spec/server_spec.rb

@@ -0,0 +1,96 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe ServerRegistryClient::Server do
+	context "matching algorithm" do
+		before(:each) do
+			@test_server = ServerRegistryClient::Server.new
+			@test_server.id = 1
+			@test_server.hostname = "localhost"
+			@test_server.ip_address = "127.0.0.1"
+			@test_server.port = 3000
+		end
+
+		it "should match if ids are the same" do
+			server = ServerRegistryClient::Server.new
+			server.id = 1
+			server.hostname = "www.example.com"
+			server.ip_address = "1.2.3.4"
+			server.port = @test_server.port + 1
+			
+			@test_server.matches?(server).should be_true
+		end
+
+		it "should not match if the ports are different" do
+			server = ServerRegistryClient::Server.new
+			server.port = @test_server.port + 1
+
+			@test_server.matches?(server).should_not be_true
+		end
+
+		it "should not match less specific server attributes" do
+			server = ServerRegistryClient::Server.new
+			server.hostname = @test_server.hostname
+
+			@test_server.matches?(server).should_not be_true
+
+			server.hostname = nil
+			server.ip_address = @test_server.ip_address
+
+			@test_server.matches?(server).should_not be_true
+
+			server.hostname = @test_server.hostname
+
+			@test_server.matches?(server).should_not be_true
+
+			server.port = @test_server.port
+
+			@test_server.matches?(server).should be_true
+		end
+
+		it "should match more specific server attributes" do
+			server = ServerRegistryClient::Server.new
+			server.hostname = @test_server.hostname
+
+			server.matches?(@test_server).should be_true
+			@test_server.matches?(server).should_not be_true
+
+			server.hostname = nil
+			server.ip_address = @test_server.ip_address
+
+			server.matches?(@test_server).should be_true
+			@test_server.matches?(server).should_not be_true
+
+			server.hostname = nil
+			server.ip_address = nil
+			server.port = @test_server.port
+
+			server.matches?(@test_server).should be_true
+			@test_server.matches?(server).should_not be_true
+
+			server.hostname = @test_server.hostname
+			server.ip_address = @test_server.ip_address
+
+			@test_server.matches?(server).should be_true
+			server.matches?(@test_server).should be_true
+		end
+
+		it "should be able to find the correct servers" do
+			servers = []
+
+			server_to_match = ServerRegistryClient::Server.new(nil, "www.example.com")
+
+			servers << ServerRegistryClient::Server.new(3, "stage.shindig.io", "4.3.2.1", 345)
+			servers << ServerRegistryClient::Server.new(1, "www.apple.com", "1.2.3.4")
+			servers << ServerRegistryClient::Server.new(8, "www.example.com")
+			servers << ServerRegistryClient::Server.new(9, "www.example.com", nil, 80)
+			servers << ServerRegistryClient::Server.new(10, "www.example.com", nil, 1221)
+			servers << ServerRegistryClient::Server.new(2, "www.test.com", "1.2.3.4")
+
+			found_servers = servers.find_all do |server|
+				server_to_match.matches?(server)
+			end
+
+			found_servers.map(&:id).should == [8, 9, 10]
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "server-registry-client"

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: server-registry-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael James
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70335946949280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70335946949280
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70335946948820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70335946948820
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &70335946948320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70335946948320
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70335946947780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70335946947780
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70335946947320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70335946947320
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70335946946860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70335946946860
+description: Client library and command-line tools for interacting with the server
+  registry (https://github.com/umjames/server-registry)
+email:
+- umjames29@gmail.com
+executables:
+- srctool
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/srctool
+- lib/server-registry-client.rb
+- lib/server-registry-client/cli.rb
+- lib/server-registry-client/client.rb
+- lib/server-registry-client/errors.rb
+- lib/server-registry-client/models.rb
+- lib/server-registry-client/models/server.rb
+- lib/server-registry-client/server_processor.rb
+- lib/server-registry-client/server_processor/base.rb
+- lib/server-registry-client/server_processor/v1.rb
+- lib/server-registry-client/version.rb
+- server-registry-client.gemspec
+- spec/client_spec.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb
+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: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Client library and command-line tools for interacting with the server registry
+  (https://github.com/umjames/server-registry)
+test_files:
+- spec/client_spec.rb
+- spec/server_spec.rb
+- spec/spec_helper.rb