add getServiceCreds(), update packages, v 1.0.0

Author: pmuellr

README.md

@@ -109,6 +109,7 @@ The returned object also has the following methods available:
 * `appEnv.getServices()`
 * `appEnv.getService(spec)`
 * `appEnv.getServiceURL(spec, replacements)`
+* `appEnv.getServiceCreds(spec)`
 
 If no value can be determined for `port`, and the `name` property on the
 `options` parameter is not set and cannot be determined,
@@ -194,7 +195,7 @@ Returns the service object from VCAP_SERVICES or null if not found.
 
 
 
-`appEnv.getServiceURL(spec, replacements)`
+**`appEnv.getServiceURL(spec, replacements)`**
 --------------------------------------------------------------------------------
 
 Returns a service URL by name.
@@ -265,6 +266,21 @@ Since the `appEnv.getServiceURL()` method operates against the
 `appEnv.services` property, you can fudge this object if that makes your
 life easier.
 
+**`appEnv.getServiceCreds(spec)`**
+--------------------------------------------------------------------------------
+
+Returns the `credentials` object of a service by name.
+
+The `spec` parameter is the same as that used by the `appEnv.getServiceURL()`
+method.  If there is no service that matches the `spec` parameter, this method
+will return `null`.
+
+If there is a service that matches the `spec` parameter, the value of it's
+`credentials` property will be returned.  If for some reason, there is no
+`credentials` property on the service, an empty object - `{}` - will be
+returned.
+
+
 
 testing with Cloud Foundry
 ================================================================================

lib-src/cfenv.coffee

@@ -99,6 +99,13 @@ class AppEnv
 
     return URL.format purl
 
+  #-----------------------------------------------------------------------------
+  getServiceCreds: (spec) ->
+    service     = @getService spec
+    return null unless service?
+
+    return service.credentials || {}
+
 #-------------------------------------------------------------------------------
 getApp = (appEnv, options) ->
   string = process.env.VCAP_APPLICATION

lib/cfenv.js

@@ -2,7 +2,7 @@
     "name":                 "cfenv",
     "main":                 "./lib/cfenv",
     "description":          "easy access to your Cloud Foundry application environment",
-    "version":              "0.2.0",
+    "version":              "1.0.0",
     "author":               "pmuellr",
     "license":              "Apache-2.0",
     "homepage":             "https://github.com/cloudfoundry-community/node-cfenv",
@@ -11,13 +11,13 @@
         "url":              "https://github.com/cloudfoundry-community/node-cfenv.git"
     },
     "dependencies": {
-        "js-yaml":          "3.0.x",
+        "js-yaml":          "3.2.x",
         "ports":            "1.1.x",
-        "underscore":       "1.6.x"
+        "underscore":       "1.7.x"
     },
     "devDependencies": {
-        "coffee-script":    "1.7.x",
-        "mocha":            "1.19.x",
+        "coffee-script":    "1.8.x",
+        "mocha":            "1.21.x",
         "expect.js":        "0.3.x"
     }
 }

package.json

@@ -190,6 +190,48 @@ describe "appEnv", ->
 
     expect(url).to.be "org-protocol://org-host:666/org-path"
 
+  #-----------------------------------------------------------------------------
+  it "local - getServiceCreds()", ->
+
+    #-------------------------------------------
+    vcap = getVCAPServicesWithCreds "service-a",
+      url: "foo"
+
+    appEnv = cfenv.getAppEnv {vcap}
+    creds  = appEnv.getServiceCreds "service-b"
+    expect(creds).to.be null
+
+    #-------------------------------------------
+    vcap = getVCAPServicesWithCreds "service-a",
+      url: "foo"
+
+    vcap["services"]["service-a-label"][0].credentials = null
+
+    appEnv = cfenv.getAppEnv {vcap}
+    creds  = appEnv.getServiceCreds "service-a"
+    creds  = JSON.stringify(creds)
+    expect(creds).to.be '{}'
+
+    #-------------------------------------------
+    vcap = getVCAPServicesWithCreds "service-a",
+      url: "foo"
+
+    delete vcap["services"]["service-a-label"][0].credentials
+
+    appEnv = cfenv.getAppEnv {vcap}
+    creds  = appEnv.getServiceCreds "service-a"
+    creds  = JSON.stringify(creds)
+    expect(creds).to.be '{}'
+
+    #-------------------------------------------
+    vcap = getVCAPServicesWithCreds "service-a",
+      url: "foo"
+
+    appEnv = cfenv.getAppEnv {vcap}
+    creds  = appEnv.getServiceCreds "service-a"
+    creds  = JSON.stringify(creds)
+    expect(creds).to.be '{"url":"foo"}'
+
   #-----------------------------------------------------------------------------
   it "remote - VCAP_APPLICATION", ->