seiso-connector 0.0.1 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjVjNmFhZGViYzk0MWRkOGY1MjFlZDYxNGY1OGNkMTZhYWVjMzk4MA==
+    MGQwOTc5MGEyMzk1ODZiODQ3MGU1MGJhMjNkMmQyNTBjMjExZGY1Mg==
   data.tar.gz: !binary |-
-    YjA5ODI4NWQxMmFkM2I0NzVjY2ZjNjE3MGVmMWZmOWY4YTlhMDZkNw==
+    NDE5OWZiNjQ1OWMzY2RmZjYxNDg4NGMzZjA4ZWY3YmU1MDJjOTFhOQ==
 SHA512:
   metadata.gz: !binary |-
-    ODEyOWZjMzIyNjE0YTA2NWI1ZTk5NDY3MTkxN2U2MzM1ZGI0YTFhZjM2MGM2
-    ODhlMzEwMjRlNzBhNGEwNDljNWQ5NjhmMWFhOTZkMjI2YmYwZGIwMTM0ZGUz
-    ZTViN2NhNDRiNzkxZDE4MzczMzU0MDk0N2Y3NTQ5NDZiNjliMDk=
+    YjNjMjRkOGFkNGQ2ZGFhNzVmMTlhZWQyMWNjN2RmOTE5ZjVmZmNjNWY0NjYz
+    Nzk3MmJiYjBhNGVlOWRkYjgzMzZhOGI4ODNkNjIyODJjY2JjY2ZjM2UyN2I4
+    NzhhZTcxNWUzY2Q0YTgzZDQ4ZjRmZTQyNjJjMzBiNzE4ZmU4Y2M=
   data.tar.gz: !binary |-
-    NGVlM2U2NWI5M2M2N2Q5OTA0ZDg3NDU1NmQzYjljNDhkNTlmYmVmODdmYWQx
-    NGQ1MmRlYWJiMDg3YjMyZjcwYTExNzRlYjUxMTMwMmQ0ZDA1ZDU0ZTA4MmZm
-    MGE1MzJiMTEzMzdhNWQ1NGQ3ZTllYmNhZGU1YjY3YWI5NzQxMDU=
+    ZjY0NDgwOWU3NmY0YTMyNzg1N2M0ZTk0YzY5NjIyMzEwMGNkZjE2NTIyZmEx
+    MGZkNzc2ZjlhM2Q5OTFkYjc4ZTk2MjY5ZDE1YzBkYmZhOTJkYjIxNzU1NGE0
+    MzQyOWQyMWJlZmU0NGYxNzE0NTk1MGZmYmJhNDhmY2E1ZDQ1YmE=

data/.gitignore

@@ -5,10 +5,12 @@
 /coverage/
 /doc/
 /pkg/
+/refresh
 /spec/reports/
 /tmp/
 *.bundle
 *.so
 *.o
 *.a
+*.gem
 mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/README.md

@@ -1,5 +1,9 @@
 # Seiso::Connector
 
+[![Gem Version](https://badge.fury.io/rb/seiso-connector.svg)](http://badge.fury.io/rb/seiso-connector)
+[![Build Status](https://travis-ci.org/ExpediaDotCom/seiso-connector-ruby.svg)](https://travis-ci.org/ExpediaDotCom/seiso-connector-ruby)
+[![Inline docs](http://inch-ci.org/github/ExpediaDotCom/seiso-connector-ruby.svg?branch=master)](http://inch-ci.org/github/ExpediaDotCom/seiso-connector-ruby)
+
 Seiso connector for Ruby clients.
 
 ## Installation

data/lib/seiso/connector/connector_v1.rb

@@ -0,0 +1,62 @@
+require 'net/http'
+require_relative 'request_failed_error'
+
+module Seiso
+  class Connector
+    class ConnectorV1
+      attr_reader :http
+      attr_reader :username
+      
+      def initialize(http, username, password)
+        @http = http
+        @username = username
+        @password = password
+        @request_headers = {
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "X-User-Agent" => username
+        }
+      end
+
+      def do_get(path)
+        request = Net::HTTP::Get.new(path, initheader = @request_headers)
+        request.basic_auth(@username, @password)
+        response = @http.request(request)
+        raise(Seiso::Connector::RequestFailedError, response.body) if !response.kind_of?(Net::HTTPSuccess)
+        response.body
+      end
+
+      def do_post(path, data)
+        puts "POST #{path}"
+        request = Net::HTTP::Post.new(path, initheader = @request_headers)
+        request.basic_auth(@username, @password)
+        request.body = data.to_json
+        response = @http.request(request)
+        display_response(response)
+      end
+
+      def do_put(path, data)
+        puts "PUT #{path}"
+        request = Net::HTTP::Put.new(path, initheader = @request_headers)
+        request.basic_auth(@username, @password)
+        request.body = data.to_json
+        response = @http.request(request)
+        display_response(response)
+      end
+
+      private
+      
+      # Displays an HTTP response on the command line.
+      # - response: response to display
+      def display_response(response)
+        case response.code
+        when "500"
+          puts "Server error: #{response.code} #{response.message}"
+        else
+          puts "#{response.code} #{response.message}"
+          puts "#{response.body}"
+        end
+      end
+    end
+  end
+end

data/lib/seiso/connector/connector_v2.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+require_relative 'request_failed_error'
+
+module Seiso
+  class Connector
+    class ConnectorV2
+      attr_reader :http
+      attr_reader :username
+      
+      def initialize(http, username, password)
+        @http = http
+        @username = username
+        @password = password
+        @request_headers = {
+          "Accept" => "application/hal+json",
+          "Content-Type" => "application/hal+json"
+        }
+      end
+
+      # TODO
+    end
+  end
+end

data/lib/seiso/connector/request_failed_error.rb

@@ -0,0 +1,6 @@
+module Seiso
+  class Connector
+    # Indicates that a connector request failed
+    class RequestFailedError < StandardError; end
+  end
+end

data/lib/seiso/connector.rb

@@ -1,60 +1,64 @@
 require "net/http"
 require "uri"
+require_relative "connector/connector_v1"
+require_relative "connector/connector_v2"
 
-# Seiso connector.
-#
-# TODO Update to use _self links when pushing data to Seiso.
-#
-# Author:: Willie Wheeler (mailto:wwheeler@expedia.com)
-# Copyright:: Copyright (c) 2014-2015 Expedia, Inc.
-# License:: Apache 2.0
-
+# Seiso namespace module
 module Seiso
   
+  # Seiso connector.
+  #
+  # Author:: Willie Wheeler
+  # Copyright:: Copyright (c) 2014-2015 Expedia, Inc.
+  # License:: Apache 2.0
   class Connector
-    attr_reader :base_uri
-    attr_reader :username
-    
-    # FIXME X-User-Agent is deprecated.
-    REQUEST_HEADERS = {
-      "Accept" => "application/json",
-      "Content-Type" => "application/json",
-      "X-User-Agent" => "dummy"
-    }
     
-    # settings is a hash containing the following entries:
-    # - host
-    # - port
-    # - use_ssl (default false)
-    # - ignore_cert (default false)
-    # - username
-    # - password
+    # - settings: a hash containing the following entries:
+    #   - host
+    #   - port
+    #   - use_ssl (default false)
+    #   - ignore_cert (default false)
+    #   - username
+    #   - password
     def initialize(settings)
       host = settings['host']
       port = settings['port']
       use_ssl = settings['use_ssl'] | false
       ignore_cert = settings['ignore_cert'] | false
-      @http = create_http(host, port, use_ssl, ignore_cert)
+      username = settings['username']
+      password = settings['password']
       
-      # TODO Is there a way to get this directly from @http? [WLW]
-      if use_ssl
-        @base_uri = "https://#{host}"
-        if port != 443
-          @base_uri << ":#{port}"
-        end
-      else
-        @base_uri = "http://#{host}"
-        if port != 80
-          @base_uri << ":#{port}"
-        end
-      end
-      puts "Using base_uri=#{@base_uri}"
+      http = create_http(host, port, use_ssl, ignore_cert)
       
-      @username = settings['username']
-      @password = settings['password']
+      @connector_v1 = Seiso::Connector::ConnectorV1.new(http, username, password)
+      @connector_v2 = Seiso::Connector::ConnectorV2.new(http, username, password)
+    end
+    
+    # Tests can override this
+    def connector_v1
+      @connector_v1
+    end
+
+    # Tests can override this
+    def connector_v2
+      @connector_v2
+    end
+    
+    # GET item list
+    def get_items(type)
+      connector_v1.do_get("/v1/#{type}")
     end
     
-    def put_items(type, items)
+    # GET key list. We currently support only type=people.
+    # - type: item type
+#    def get_keys(type, source, page)
+#      raise(NotImplementedError, "get_keys not implemented for type #{type}") if type != "people"
+#      path = "/v2/#{type}?view=keys&source=#{source}&page=#{page}"
+#      do_get path
+#    end
+    
+    # POST items to Seiso
+    def post_items(type, items)
       if type == 'ip-address-roles'
         do_put_ip_address_roles items
       elsif type == 'node-ip-addresses'
@@ -62,12 +66,25 @@ module Seiso
       elsif type == 'service-instance-ports'
         do_put_service_instance_ports items
       else
-        do_post_items(type, items)
+        connector_v1.do_post("/v1/#{type}?mode=batch", items)
       end
     end
     
+    # PUT a single item to Seiso.
+    # - type: Item type
+    # - item: Item
+    # - key: Item key
+    def put_item(type, item, key)
+      connector_v1.do_put("/v1/#{type}/#{key}", item)
+    end
+
     private
-    
+
+    # Create HTTP connector
+    # - host: Seiso host
+    # - port: Seiso port
+    # - use_ssl: Use HTTPS?
+    # - ignore_cert: Ignore bad certs?
     def create_http(host, port, use_ssl, ignore_cert)
       http = Net::HTTP.new(host, port)
       if use_ssl
@@ -81,63 +98,36 @@ module Seiso
       http
     end
     
-    # Batch posts the items
-    def do_post_items(type, items)
-      do_post("/v1/#{type}?mode=batch", items)
-    end
-    
-    def do_post(path, item)
-      puts "POST #{path}"
-      request = Net::HTTP::Post.new(path, initheader = REQUEST_HEADERS)
-      request.basic_auth(@username, @password)
-      request.body = item.to_json
-      response = @http.request request
-      if response.code == "500"
-        puts "Error: #{response.code} #{response.message}"
-      else
-        puts "#{response.code} #{response.message}"
-        puts "#{response.body}"
-      end
-    end
-    
+    # PUTs a list of IP address roles
+    # - roles: IP address roles
     def do_put_ip_address_roles(roles)
       # TODO Implement batch endpoint
       roles.each do |r|
         si_key = r['serviceInstance']['key']
         name = r['name']
-        do_put("/v1/service-instances/#{si_key}/ip-address-roles/#{name}", r)
+        connector_v1.do_put("/v1/service-instances/#{si_key}/ip-address-roles/#{name}", r)
       end
     end
-    
+
+    # PUTs a list of node IP addresses
+    # - nips: Node IP addresses
     def do_put_node_ip_addresses(nips)
       # TODO Implement batch endpoint
       nips.each do |nip|
         node_name = nip['node']['name']
         ip_address = nip['ipAddress']
-        do_put("/v1/nodes/#{node_name}/ip-addresses/#{ip_address}", nip)
+        connector_v1.do_put("/v1/nodes/#{node_name}/ip-addresses/#{ip_address}", nip)
       end
     end
-    
+
+    # PUTs a list of service instance ports
+    # - ports: Service instance ports
     def do_put_service_instance_ports(ports)
       # TODO Implement batch endpoint
       ports.each do |p|
         si_key = p['serviceInstance']['key']
         number = p['number']
-        do_put("/v1/service-instances/#{si_key}/ports/#{number}", p)
-      end
-    end
-    
-    def do_put(path, item)
-      puts "PUT #{path}"
-      request = Net::HTTP::Put.new(path, initheader = REQUEST_HEADERS)
-      request.basic_auth(@username, @password)
-      request.body = item.to_json
-      response = @http.request request
-      if response.code == "500"
-        puts "Error: #{response.code} #{response.message}"
-      else
-        puts "#{response.code} #{response.message}"
-        puts "#{response.body}"
+        connector_v1.do_put("/v1/service-instances/#{si_key}/ports/#{number}", p)
       end
     end
   end

data/seiso-connector.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "seiso-connector"
-  spec.version       = "0.0.1"
+  spec.version       = "0.1.0"
   spec.authors       = ["Willie Wheeler"]
   spec.email         = ["wwheeler@expedia.com"]
   spec.summary       = "Connector to make it easier for Ruby clients to talk to the Seiso REST API."

data/test/test_connector.rb

@@ -1,10 +1,9 @@
 require 'seiso/connector'
 require 'minitest/autorun'
 
-# Author:: Willie Wheeler (mailto:wwheeler@expedia.com)
+# Author:: Willie Wheeler
 # Copyright:: Copyright (c) 2014-2015 Expedia, Inc.
 # License:: Apache 2.0
-
 class TestConnector < MiniTest::Unit::TestCase
 
   def setup
@@ -19,10 +18,11 @@ class TestConnector < MiniTest::Unit::TestCase
 
     # This creates the HTTP connector internally.
     # Probably want to inject a mock?
-    @connector = Seiso::Connector.new @settings
+    @connector = Seiso::Connector.new(@settings)
   end
 
   def test_init
-    assert_equal(@settings['username'], @connector.username)
+    refute_nil(@connector.connector_v1)
+    refute_nil(@connector.connector_v2)
   end
 end

data/test/test_connector_v1.rb

@@ -0,0 +1,26 @@
+require 'seiso/connector/connector_v1'
+require 'minitest/autorun'
+
+# Author:: Willie Wheeler
+# Copyright:: Copyright (c) 2015 Expedia, Inc.
+# License:: Apache 2.0
+class TestConnectorV1 < MiniTest::Unit::TestCase
+
+  def setup
+
+    # Test data
+    @username = "willie"
+    @password = "rocket88"
+
+    # Dependencies
+    @http = {}
+
+    # Class under test
+    @connector = Seiso::Connector::ConnectorV1.new(@http, @username, @password)
+  end
+
+  def test_init
+    assert_equal(@http, @connector.http)
+    assert_equal(@username, @connector.username)
+  end
+end

data/test/test_connector_v2.rb

@@ -0,0 +1,26 @@
+require 'seiso/connector/connector_v2'
+require 'minitest/autorun'
+
+# Author:: Willie Wheeler
+# Copyright:: Copyright (c) 2015 Expedia, Inc.
+# License:: Apache 2.0
+class TestConnectorV2 < MiniTest::Unit::TestCase
+
+  def setup
+
+    # Test data
+    @username = "willie"
+    @password = "rocket88"
+
+    # Dependencies
+    @http = {}
+
+    # Class under test
+    @connector = Seiso::Connector::ConnectorV2.new(@http, @username, @password)
+  end
+
+  def test_init
+    assert_equal(@http, @connector.http)
+    assert_equal(@username, @connector.username)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seiso-connector
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Willie Wheeler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2015-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,13 +61,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/seiso/connector.rb
+- lib/seiso/connector/connector_v1.rb
+- lib/seiso/connector/connector_v2.rb
+- lib/seiso/connector/request_failed_error.rb
 - seiso-connector.gemspec
 - test/test_connector.rb
+- test/test_connector_v1.rb
+- test/test_connector_v2.rb
 homepage: http://seiso.io
 licenses:
 - Apache-2.0
@@ -94,3 +100,5 @@ specification_version: 4
 summary: Connector to make it easier for Ruby clients to talk to the Seiso REST API.
 test_files:
 - test/test_connector.rb
+- test/test_connector_v1.rb
+- test/test_connector_v2.rb