use localhost as url hostname if uris not available

also

* checking new Diego port env var CF_INSTANCE_PORT
* added CODE_OF_CONDUCT.md
* split out hacking bit from README.md into CONTRIBUTING.md

Author: pmuellr

CODE_OF_CONDUCT.md

@@ -0,0 +1,42 @@
+Contributor Code of Conduct
+================================================================================
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. By adopting this Code of Conduct, project
+maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the
+[Contributor Covenant](http://contributor-covenant.org),
+version 1.2.0, available at
+<http://contributor-covenant.org/version/1/2/0/>

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+Contributing
+================================================================================
+
+Awesome!  I'm happy that you want to contribute.
+
+Make sure that you're read and understand the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+
+Building from source
+--------------------------------------------------------------------------------
+
+If you want to modify the source to play with it, you'll also want to have the
+`jbuild` program installed.
+
+To install `jbuild`, use the command
+
+```text
+npm -g install jbuild
+```
+
+The `jbuild` command runs tasks defined in the `jbuild.coffee` file.  The
+task you will most likely use is `watch`, which you can run with the
+command:
+
+```text
+jbuild watch
+```
+
+When you run this command, the application will be built from source, the server
+started, and tests run.  When you subsequently edit and then save one of the
+source files, the application will be re-built, the server re-started, and the
+tests re-run.  For ever.  Use Ctrl-C to exit the `jbuild watch` loop.
+
+You can run those build, server, and test tasks separately.  Run `jbuild`
+with no arguments to see what tasks are available, along with a short
+description of them.
+
+
+GitHub usage
+--------------------------------------------------------------------------------
+
+* Develop major features on feature branches, and submit PRs to `master`.
+
+* Never force push onto `master`.

LICENSE renamed to LICENSE.txt

@@ -12,7 +12,6 @@ If not set, the functions run in "local" mode, otherwise they run in "cloud"
 mode.
 
 
-
 quick start
 ================================================================================
 
@@ -31,7 +30,6 @@ This code snippet above will get the port, binding host, and full URL to your HT
 server and use them to bind the server and print the server URL when starting.
 
 
-
 running in Cloud Foundry vs locally
 ================================================================================
 
@@ -48,14 +46,12 @@ it will provide useful values when you're running in Cloud Foundry AND
 when you're running locally.
 
 
-
 api
 ================================================================================
 
 The `cfenv` package exports the following function:
 
 
-
 `getAppEnv(options)`
 --------------------------------------------------------------------------------
 
@@ -126,6 +122,8 @@ is running locally, and `https:` otherwise; you can
 force a particular protocol by using the `protocol` property
 on the `options` parameter.
 
+When running in Cloud Foundry, the `url` and `urls` values will have
+`localhost` as their hostname, if the actual hostnames cannot be determined.
 
 
 AppEnv methods
@@ -303,39 +301,14 @@ Next, push the app with `cf push`.
 When you visit the site, you'll see the output of various cfenv calls.
 
 
-
-hacking
+changes
 ================================================================================
 
-If you want to modify the source to play with it, you'll also want to have the
-`jbuild` program installed.
-
-To install `jbuild` on Windows, use the command
-
-    npm -g install jbuild
-
-To install `jbuild` on Mac or Linux, use the command
+**1.0.3** - 2014/10/02
 
-    sudo npm -g install jbuild
+- fixes for compatibility with Diego - [issue #11][]
 
-The `jbuild` command runs tasks defined in the `jbuild.coffee` file.  The
-task you will most likely use is `watch`, which you can run with the
-command:
-
-    jbuild watch
-
-When you run this command, the application will be built from source, the server
-started, and tests run.  When you subsequently edit and then save one of the
-source files, the application will be re-built, the server re-started, and the
-tests re-run.  For ever.  Use Ctrl-C to exit the `jbuild watch` loop.
-
-You can run those build, server, and test tasks separately.  Run `jbuild`
-with no arguments to see what tasks are available, along with a short
-description of them.
-
-
-changes
-================================================================================
+[issue #11]: https://github.com/cloudfoundry-community/node-cfenv/issues/11
 
 **1.0.2** - 2014/09/29
 
@@ -344,15 +317,18 @@ changes
 
 **1.0.1** - 2014/09/29
 
-- remove node_modules from .cfignore - [issue #8](https://github.com/cloudfoundry-community/node-cfenv/issues/8)
+- remove node_modules from .cfignore - [issue #8][]
 - updated package dependencies
 - changed README.md to correct sample service to cf-env-test
 - files in lib/ recompiled due to coffee-script update
 
+[issue #8]: https://github.com/cloudfoundry-community/node-cfenv/issues/8
+
 **1.0.0** - 2014/09/03
 
 - initial 1.0.0 release
 
+
 license
 ================================================================================
 

README.md

@@ -142,7 +142,7 @@ getServices = (appEnv, options) ->
 
 #-------------------------------------------------------------------------------
 getPort = (appEnv) ->
-  portString = process.env.VCAP_APP_PORT || process.env.PORT
+  portString = process.env.PORT || process.env.CF_INSTANCE_PORT || process.env.VCAP_APP_PORT
 
   unless portString?
     return 3000 unless appEnv.name?
@@ -193,7 +193,7 @@ getURLs = (appEnv, options) ->
 
   else
     unless uris?
-      throwError "expecting VCAP_APPLICATION to contain uris when not runninng locally"
+      uris = [ "localhost" ]
 
   protocol = options.protocol
 

lib-src/cfenv.coffee

@@ -2,7 +2,7 @@
     "name":                 "cfenv",
     "main":                 "./lib/cfenv",
     "description":          "easy access to your Cloud Foundry application environment",
-    "version":              "1.0.2",
+    "version":              "1.0.3",
     "author":               "pmuellr",
     "license":              "Apache-2.0",
     "homepage":             "https://github.com/cloudfoundry-community/node-cfenv",

lib/cfenv.js

@@ -404,17 +404,59 @@ describe "appEnv", ->
     expect(fn).to.throwError /invalid PORT value:/
 
   #-----------------------------------------------------------------------------
-  it "error - missing uris", ->
+  it "Diego - use localhost in url", ->
 
+    # VCAP_APPLICATION with no uris/uri in it
     vcapApplication =
         name: SampleName
         host: "sample-host"
 
     process.env.VCAP_APPLICATION = JSON.stringify vcapApplication
 
-    fn = -> appEnv = cfenv.getAppEnv()
-    console.log "expecting an error printed below:"
-    expect(fn).to.throwError /expecting VCAP_APPLICATION to contain uris when not runninng locally/
+    appEnv = cfenv.getAppEnv()
+
+    expect(appEnv.isLocal).to.be     false
+    expect(appEnv.urls.length).to.be 1
+    expect(appEnv.url).to.be         "https://localhost"
+
+  #-----------------------------------------------------------------------------
+  it "env PORT", ->
+    vcapApplication =
+        name: SampleName
+        host: "sample-host"
+
+    process.env.VCAP_APPLICATION = JSON.stringify vcapApplication
+    process.env.PORT             = "4000"
+
+    appEnv = cfenv.getAppEnv()
+
+    expect(appEnv.port).to.be 4000
+
+  #-----------------------------------------------------------------------------
+  it "env CF_INSTANCE_PORT", ->
+    vcapApplication =
+        name: SampleName
+        host: "sample-host"
+
+    process.env.VCAP_APPLICATION = JSON.stringify vcapApplication
+    process.env.CF_INSTANCE_PORT = "4001"
+
+    appEnv = cfenv.getAppEnv()
+
+    expect(appEnv.port).to.be 4001
+
+  #-----------------------------------------------------------------------------
+  it "env VCAP_APP_PORT", ->
+    vcapApplication =
+        name: SampleName
+        host: "sample-host"
+
+    process.env.VCAP_APPLICATION = JSON.stringify vcapApplication
+    process.env.VCAP_APP_PORT    = "4002"
+
+    appEnv = cfenv.getAppEnv()
+
+    expect(appEnv.port).to.be 4002
 
 #-------------------------------------------------------------------------------
 SampleVCAPServices_1 =