ibm-bluemix-service_discovery 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 597a238027842295e33f43e08e25b39847ac6aca
-  data.tar.gz: fdc70a7cb6989938debebfec5a763f77220ece5d
+  metadata.gz: 0fbba1e59deb4c85155c932c5c1bdef09b177e87
+  data.tar.gz: cc598b0b48e1831c25467699aa50377bf2bb0f4d
 SHA512:
-  metadata.gz: b260ec7e61925ef9a25e22e977f438af59175428fb948053151cc5dd9a836cf7662a864a0b4f62a1fc3d541d8fef5d6cf761ceca556a2448711a5991b59dcf4b
-  data.tar.gz: d2804500cfa05138004fff236b273adcf9f0dc73b364211df6d05dc0da39dee81eae5235b25b1cc3c3fd815c0603f8ac77ae374a5caccbfa9564a6c48b018885
+  metadata.gz: 9a4f2b919fd8244824f2fec320e1ea2a4b28ca211f7023b9bfb5abfb5f18bcf55ee9f60f9fc3c5de974b901ae6349e3234c2aca0c4b4f8c98617cc2f42b834e9
+  data.tar.gz: d4a73e7ad3c633a361de1bc2cfbcb96c287a9f87c7f12ac2ca4d3f0e6c37424ed10f5b44e16d06dca23bca381d510aa8088ae8c1e698a3233ab83fe5fbc9f3c1

data/ibm-bluemix-service_discovery.gemspec

@@ -27,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9.3'
+
   spec.add_dependency "unirest", "~> 1.1"
 
   spec.add_development_dependency "bundler", "~> 1.11"

data/lib/ibm/bluemix/service_discovery.rb

@@ -18,6 +18,8 @@ module IBM
       # URL for the production Bluemix Service Registry endpoint
       SERVICE_REGISTRY_ENDPOINT = "https://servicediscovery.ng.bluemix.net/api/v1/instances"
 
+      private_constant :SERVICE_DISCOVERY_ENDPOINT, :SERVICE_REGISTRY_ENDPOINT
+
       # cache of registered services
       @@services = {}
 
@@ -26,8 +28,14 @@ module IBM
 
       # dummy logger that can be overridden
       class << self
+        # logger attribute that can be overridden
         attr_writer :logger
 
+        # Logger function that should be overridden.
+        #
+        # @example
+        #   logger.debug 'this is a debug message'
+        #
         def logger
           @logger ||= Logger.new($stdout).tap do |log|
             log.progname = self.name
@@ -37,11 +45,11 @@ module IBM
 
       # Create a new ServiceDiscovery instance.
       #
-      # Example:
-      #   >> sd = ServiceDiscovery.new('token...')
+      # @example
+      #   sd = ServiceDiscovery.new('token...')
+      #
+      # @param auth_token [String] Valid `auth_token` from the IBM Bluemix Service Discovery service
       #
-      # ===Arguments
-      # [auth_token] (String) Valid `auth_token` from the IBM Bluemix Service Discovery service
       def initialize(auth_token)
         @auth_token = auth_token
 
@@ -55,24 +63,17 @@ module IBM
 
       # Register a service with Service Discovery
       #
-      # Example:
-      #   >> sd = ServiceDiscovery.new('token...')
+      # @example
+      #   sd = ServiceDiscovery.new('token...')
       #   => sd.register('sample_service', '192.168.1.100:8080', { ttl: 60, heartbeat: true }, {})
       #
-      # ===Arguments
-      # [service_name] (String) The name of the microservice
-      # [host] (String) The host and port where the microservice can be reached at
-      # [options] (Hash) Options, see below
-      # [meta] (Hash) Metadata to store with the service registration
-      #
-      # ====Options
-      # [heartbeat] (Boolean) Enable or disable automated heartbeat for the service
-      # [ttl] (Integer) Expire the service after this many seconds if a heartbeat has not been received.  Hearbeat is automatically set to 30% of this value
-      #
-      # ===Returns
-      # resulting payload from the call to Service Discovery
-      #
-      # ===Raises
+      # @param service_name [String] The name of the microservice
+      # @param host [String] The host and port where the microservice can be reached at
+      # @param options [Hash] Options to customize service discovery instance (see below)
+      # @option options [Boolean] :heartbeat Enable or disable automated heartbeat for the service
+      # @option options [Integer] :ttl Expire the service after this many seconds if a heartbeat has not been received.  Hearbeat is automatically set to 30% of this value
+      # @param meta [Hash] Metadata to store with the service registration
+      # @return [Hash] Resulting payload from the call to Service Discovery
       #
       def register(service_name, host, options = {}, meta = {})
 
@@ -134,16 +135,11 @@ module IBM
 
       # Send a heartbeat request to indicate the service is still alive and well
       #
-      # Example:
-      #   >> sd.renew('sample_service')
-      #
-      # ===Arguments
-      # [service_name] (String) The name of the microservice
+      # @example
+      #   sd.renew('sample_service')
       #
-      # ===Returns
-      # (Boolean) `true` if the service was renewed, `false` otherwise
-      #
-      # ===Raises
+      # @param service_name [String] The name of the microservice
+      # @return [Boolean] `true` if the service was renewed, `false` otherwise
       #
       def renew(service_name)
 
@@ -175,17 +171,12 @@ module IBM
       # Set-up a separate Thread to send continuous heartbeats (renew) calls to
       # indicate the service is alive.
       #
-      # Example:
-      #   >> sd.heartbeat('sample_service', 45)
-      #
-      # ===Arguments
-      # [service_name] (String) The name of the microservice
-      # [interval] (Integer) The number of seconds between heartbeats
-      #
-      # ===Returns
-      # (Boolean) `true` if the heartbeat thread was started, `false` otherwise
+      # @example
+      #   sd.heartbeat('sample_service', 45)
       #
-      # ===Raises
+      # @param service_name [String] The name of the microservice
+      # @param interval [Integer] The number of seconds between heartbeats
+      # @return [Boolean] `true` if the heartbeat thread was started, `false` otherwise
       #
       def heartbeat(service_name, interval=60)
 
@@ -211,16 +202,11 @@ module IBM
 
       # Stops a previously established heartbeat Thread
       #
-      # Example:
-      #   >> sd.unheartbeat('sample_service')
-      #
-      # ===Arguments
-      # [service_name] (String) The name of the microservice
-      #
-      # ===Returns
-      # (Boolean) `true` if the heartbeat thread was stopped, `false` otherwise
+      # @example
+      #   sd.unheartbeat('sample_service')
       #
-      # ===Raises
+      # @param service_name [String] The name of the microservice
+      # @return [Boolean] `true` if the heartbeat thread was stopped, `false` otherwise
       #
       def unheartbeat(service_name)
         Thread.kill @@heartbeats[service_name]
@@ -228,16 +214,11 @@ module IBM
 
       # Deletes a service entry from Service Discovery
       #
-      # Example:
-      #   >> sd.delete('sample_service')
+      # @example
+      #   sd.delete('sample_service')
       #
-      # ===Arguments
-      # [service_name] (String) The name of the microservice
-      #
-      # ===Returns
-      # (Boolean) `true` if the service was removed, `false` otherwise
-      #
-      # ===Raises
+      # @param service_name [String] The name of the microservice
+      # @return [Boolean] `true` if the service was removed, `false` otherwise
       #
       def delete(service_name)
 
@@ -265,16 +246,10 @@ module IBM
       # Resets the state of this service.  This includes stopping any existing
       # heartbeat Threads as well as deleting all registered services.
       #
-      # Example:
-      #   >> sd.reset
-      #
-      # ===Arguments
-      # +none+
+      # @example
+      #   sd.reset
       #
-      # ===Returns
-      # (Boolean) `true` if the reset was successful, `false` otherwise
-      #
-      # ===Raises
+      # @return [Boolean] `true` if the reset was successful, `false` otherwise
       #
       def reset
 
@@ -294,16 +269,10 @@ module IBM
       # Returns information about the current local state of Service Discovery.
       # This includes information about the services and the heartbeats.
       #
-      # Example:
-      #   >> sd.info
-      #
-      # ===Arguments
-      # +none+
+      # @example
+      #   sd.info
       #
-      # ===Returns
-      # (Hash) { services: ['s1', 's2'], heartbeats: ['s1'] }
-      #
-      # ===Raises
+      # @return [Hash] { services: ['s1', 's2'], heartbeats: ['s1'] }
       #
       def info
         { services: @@services.keys, heartbeats: heartbeats.keys }
@@ -311,16 +280,10 @@ module IBM
 
       # Get the current list of registered services within Service Discovery
       #
-      # Example:
-      #   >> sd.list
-      #
-      # ===Arguments
-      # +none+
-      #
-      # ===Returns
-      # (Hash) { services: ['s1', 's2'] }
+      # @example
+      #   sd.list
       #
-      # ===Raises
+      # @return [Hash] { services: ['s1', 's2'] }
       #
       def list
 
@@ -343,14 +306,11 @@ module IBM
 
       # Discovers the connection information for a given microservice.
       #
-      # Example:
-      #   >> sd.discover('sample_service')
+      # @example
+      #   sd.discover('sample_service')
       #
-      # ===Arguments
-      # [service_name] (String) The name of the microservice
-      #
-      # ===Returns
-      # (Hash)
+      # @param service_name [String] The name of the microservice
+      # @return [Hash]
       #   {
       #      "service_name":"my_service",
       #      "instances":[
@@ -366,8 +326,6 @@ module IBM
       #      }]
       #   }
       #
-      # ===Raises
-      #
       def discover(service_name)
         # curl -X GET -H "Authorization: bearer 12o191sqk5h***" https://servicediscovery.ng.bluemix.net/api/v1/services/my_service
 

data/lib/ibm/bluemix/service_discovery/version.rb

@@ -1,7 +1,7 @@
 module IBM
   module Bluemix
     class ServiceDiscovery
-      VERSION = "0.1.2"
+      VERSION = "0.1.3"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ibm-bluemix-service_discovery
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Christopher Young
@@ -115,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="