conversion to new name and version (changed apis)

Author: pmuellr

README.md

@@ -72,8 +72,9 @@ The `options` parameter is optional, and can contain the following properties:
 
   If not specified, the name will looked for in the following places:
 
-  * the `application_name` property of the `VCAP_APPLICATION` environment variable
-  * the `name` property from the`manifest.yml` file in the current directory
+  * the `name` property of the `VCAP_APPLICATION` environment variable
+  * the `name` property from the `manifest.yml` file in the current directory
+  * the `name` property from the `package.json` file in the current directory
 
 * `protocol` - protocol used in the generated URLs
 
@@ -87,6 +88,9 @@ The `options` parameter is optional, and can contain the following properties:
   properties `application` and/or `services`, whose values are the same
   as the values serialized in the respective environment variables.
 
+  Note that the `url` and `urls` properties of the returned object are not
+  based on the vcap `application` object, when running locally.
+
   This option property is ignored if not running locally.
 
 This function returns an object with the following properties:
@@ -250,6 +254,16 @@ Assume you run the following code:
 
 The `url` result will be `https://userid:passw0rd@example.com/database`
 
+Note that there **MUST** be a `url` property in the credentials,
+or replacement for it, in the
+service, or the call will return `null`.  Also, because the `url` is parsed
+first with `url.parse()`, there will be a `host` property in the result, so
+you won't be able to use the `hostname` and `port` values directly.  You
+can **ONLY** set the resultant hostname and port with the `host` property.
+
+Since the `appEnv.getServiceURL()` method operates against the
+`appEnv.services` property, you can fudge this object if that makes your
+life easier.
 
 
 testing with Cloud Foundry

jbuild.coffee

@@ -14,7 +14,7 @@ tasks = defineTasks exports,
     build: "build the server"
     test:  "run tests"
 
-WatchSpec = "lib-src/**/* tests/**/*"
+WatchSpec = "lib-src lib-src/* tests tests/*"
 
 #-------------------------------------------------------------------------------
 mkdir "-p", "tmp"
@@ -35,8 +35,6 @@ tasks.build = ->
 
     cleanDir "lib"
 
-    log "running build"
-
     log "- compiling server coffee files"
     coffee "--output lib lib-src"
 

lib-src/cfenv.coffee

@@ -3,6 +3,7 @@
 fs   = require "fs"
 URL  = require "url"
 
+pkg   = require "../package.json"
 _     = require "underscore"
 ports = require "ports"
 yaml  = require "js-yaml"
@@ -21,9 +22,15 @@ class AppEnv
 
   #-----------------------------------------------------------------------------
   constructor: (options = {}) ->
-    @app      = getApp options
-    @services = getServices options
     @isLocal  = not process.env.VCAP_APPLICATION?
+    unless @isLocal
+      try
+        JSON.parse process.env.VCAP_APPLICATION
+      catch
+        @isLocal = true
+
+    @app      = getApp      @, options
+    @services = getServices @, options
 
     @name     = getName @, options
     @port     = getPort @
@@ -66,6 +73,7 @@ class AppEnv
   #-----------------------------------------------------------------------------
   getServiceURL: (spec, replacements={}) ->
     service     = @getService spec
+
     credentials = service?.credentials
     return null unless credentials?
 
@@ -74,7 +82,7 @@ class AppEnv
     if replacements.url
       url = credentials[replacements.url]
     else
-      url = credentials.url
+      url = credentials.url || credentials.uri
 
     return null unless url?
 
@@ -92,43 +100,38 @@ class AppEnv
     return URL.format purl
 
 #-------------------------------------------------------------------------------
-getApp = (options) ->
-  val = options?.vcap?.application
-  return val if val?
-
+getApp = (appEnv, options) ->
   string = process.env.VCAP_APPLICATION
-  try
-    return JSON.parse string
-  catch e
-    return null
 
-#-------------------------------------------------------------------------------
-getServices = (options) ->
-  val = options?.vcap?.services
-  return val if val?
+  envValue = {}
+  if string?
+    try
+      envValue = JSON.parse string
+    catch e
+      throwError "env var VCAP_APPLICATION is not JSON: /#{string}/"
 
-  string = process.env.VCAP_SERVICES
-  try
-    return JSON.parse string
-  catch e
-    return null
+  return envValue unless appEnv.isLocal
 
-#-------------------------------------------------------------------------------
-getName = (appEnv, options) ->
-  return options.name if options.name?
-
-  val = appEnv.app?.name
-  return val if val?
+  locValue = options?.vcap?.application
+  return locValue if locValue?
+  return envValue
 
-  return null unless fs.existsSync "manifest.yml"
+#-------------------------------------------------------------------------------
+getServices = (appEnv, options) ->
+  string = process.env.VCAP_SERVICES
 
-  yString = fs.readFileSync "manifest.yml", "utf8"
-  yObject = yaml.safeLoad yString, filename: "manifest.yml"
+  envValue = {}
+  if string?
+    try
+      envValue = JSON.parse string
+    catch e
+      throwError "env var VCAP_SERVICES is not JSON: /#{string}/"
 
-  yObject = yObject.applications[0] if yObject.applications?
-  return yObject.name if yObject.name?
+  return envValue unless appEnv.isLocal
 
-  return null
+  locValue = options?.vcap?.services
+  return locValue if locValue?
+  return envValue
 
 #-------------------------------------------------------------------------------
 getPort = (appEnv) ->
@@ -140,29 +143,70 @@ getPort = (appEnv) ->
     portString = "#{ports.getPort appEnv.name}"
 
   port = parseInt portString, 10
-  throw new Error "invalid port string: #{portString}" if isNaN port
+  throwError "invalid PORT value: /#{portString}/" if isNaN port
 
   return port
 
+#-------------------------------------------------------------------------------
+getName = (appEnv, options) ->
+  return options.name if options.name?
+
+  val = appEnv.app?.name
+  return val if val?
+
+  if fs.existsSync "manifest.yml"
+    yString = fs.readFileSync "manifest.yml", "utf8"
+    yObject = yaml.safeLoad yString, filename: "manifest.yml"
+
+    yObject = yObject.applications[0] if yObject.applications?
+    return yObject.name if yObject.name?
+
+  if fs.existsSync "package.json"
+    pString = fs.readFileSync "package.json", "utf8"
+    try
+      pObject = JSON.parse pString
+    catch
+      pObject = null
+
+    return pObject.name if pObject?.name
+
+  return null
+
 #-------------------------------------------------------------------------------
 getBind = (appEnv) ->
   return appEnv.app?.host || "localhost"
 
 #-------------------------------------------------------------------------------
 getURLs = (appEnv, options) ->
+
   uris = appEnv.app?.uris
 
-  unless uris
-    protocol = options.protocol || "http:"
-    return [ "#{protocol}//localhost:#{appEnv.port}" ]
+  if appEnv.isLocal
+    uris = [ "localhost:#{appEnv.port}" ]
+
+  else
+    unless uris?
+      throwError "expecting VCAP_APPLICATION to contain uris when not runninng locally"
 
-  protocol = options.protocol || "https:"
+  protocol = options.protocol
+
+  unless protocol?
+    if appEnv.isLocal
+      protocol = "http:"
+    else
+      protocol = "https:"
 
   urls = for uri in uris
     "#{protocol}//#{uri}"
 
   return urls
 
+#-------------------------------------------------------------------------------
+throwError = (message) ->
+  message = "#{pkg.name}: #{message}"
+  console.log "error: #{message}"
+  throw new Error message
+
 #-------------------------------------------------------------------------------
 # Copyright IBM Corp. 2014
 #

lib-src/server.coffee

@@ -9,7 +9,7 @@ exports.main = ->
   appEnv = cfenv.getAppEnv()
 
   dump = generateDump appEnv
-  console.log "#{dump}\n"
+  # console.log "#{dump}\n"
 
   server = http.createServer()