cloudfoundry-env 0.0.2 → 0.0.4

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+.idea
 .bundle
 Gemfile.lock
 pkg/*

data/README.md

@@ -0,0 +1,77 @@
+This is a small gem which an application running on a Cloud Foundry instance can use to access their environment.
+If the application is not running on Cloud Foundry then all methods will return nil so its easy to provide an alternate configuration.
+
+## Installation
+
+### Command Line
+```bash
+gem install cloudfoundry-env
+```
+
+### Gemfile
+
+``` ruby
+gem "cloudfoundry-env","~> 0.0.2", :require => "cloudfoundry/environment"
+```
+
+## Usage
+
+#### Listening on the proper HTTP port
+
+``` ruby
+configure do
+  set(:port, CloudFoundry::Environment.port || 4567)
+end
+```
+
+#### Connecting to a service
+
+``` ruby
+@redis = Redis.new(CloudFoundry::Environment.redis_cnx || {host: "127.0.0.1", port: "6379"})
+```
+
+#### Conditional logic for multiple instances of an app
+
+``` ruby
+# The new wordpress path
+@blog_rss = "#{@blog}/post/category/announcement/feed"
+
+freq = 60 + (60 * 5 * (CloudFoundry::Environment.instance_index || 0))
+
+@blog_feed = CloudFoundry::Feed.new(@blog_rss, @redis, crawl_frequency: freq)
+
+```
+
+## CloudFoundry::Environment Methods
+
+* host - Return a string with the host ip address or nil if not running on cloud
+* port - Returns integer with port number
+* instance_index - Returns integer with instance index starting at 1
+* running_local? - returns `true` if the app is not running on a CloudFoundry instance
+* is_prod_app?(regex) - Returns `true` if the app name starts with regex provided. Good for having staging and prod apps
+
+* services - Returns a Hashie::Mash representation of the services so it can be used as a class with native attributes
+  * Cloud Foundry Services - http://start.cloudfoundry.com/services.html
+  * Hashie - https://github.com/intridea/hashie
+* [service_name]_cnx - Returns a Hashie::Mash representation of only the credentials for a service. Example from rspec test:
+
+```ruby
+cf = CloudFoundry::Environment
+cf.redis_cnx.port.should == 5076
+cf.redis_cnx.host.should == "172.30.48.40"
+cf.redis_cnx.password.should == "49badd9d-40a9-aaa-4e8fcdc15a75"
+```
+
+* [service_name]_info - Returns a Hashie::Mash representation of the service. Example from rspec test:
+
+``` ruby
+cf = CloudFoundry::Environment
+cf.mongo_info.name.should == "mongodb-78564"
+cf.mongo_info.credentials.port.should == 25084
+cf.mongo_cnx.host.should == "172.30.48.64"
+cf.mongo_cnx.db.should == "db"
+cf.mongo_cnx.username.should == "1aaca416-fb89-4a08-8b7b-3d022ef3c44b"
+cf.mongo_cnx.password.should == "7ea3c7ab-bd10-4ff9-8131-50d951b5863f"
+```
+
+

data/cloudfoundry-env.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Cloudfoundry::Environment::VERSION
   s.authors     = ["ciberch"]
   s.email       = ["monica.keller@gmail.com"]
-  s.homepage    = "http://github.com/cloudfoundry-samples"
+  s.homepage    = "https://github.com/cloudfoundry-samples/cloudfoundry-env"
   s.summary     = "Ruby Apps can use gem to parse the Cloud Foundry Environment"
   s.description = "App Name, App Owner, Port Number, Host, Services, Instances"
 

data/lib/cloudfoundry/environment.rb

@@ -11,6 +11,10 @@ module CloudFoundry
         raw_port.to_i if raw_port
       end
 
+      def host
+        ENV["VCAP_APP_HOST"]
+      end
+
       def instance_index
         return app_info.instance_index if app_info
       end

data/lib/cloudfoundry/version.rb

@@ -1,5 +1,5 @@
 module Cloudfoundry
   module Environment
-    VERSION = "0.0.2"
+    VERSION = "0.0.4"
   end
 end

data/spec/environment_spec.rb

@@ -10,6 +10,12 @@ describe "CloudFoundry::Environment" do
     cf.redis_cnx.should be_nil
   end
 
+  it "should read the host" do
+    CloudFoundry::Environment.host.should be_nil
+    ENV["VCAP_APP_HOST"] = "localhost"
+    CloudFoundry::Environment.host.should == "localhost"
+  end
+
   it "should recognize when its running on Cloud Foundry" do
     ENV["VCAP_APP_PORT"] = "9456"
     ENV["VCAP_APPLICATION"]  = load_fixture("vcap_application.json")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudfoundry-env
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-05 00:00:00.000000000Z
+date: 2012-03-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70311463917620 !ruby/object:Gem::Requirement
+  requirement: &70203930070160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70311463917620
+  version_requirements: *70203930070160
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70311463917200 !ruby/object:Gem::Requirement
+  requirement: &70203930069740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70311463917200
+  version_requirements: *70203930069740
 description: App Name, App Owner, Port Number, Host, Services, Instances
 email:
 - monica.keller@gmail.com
@@ -44,6 +44,7 @@ files:
 - .rspec
 - .rvmrc
 - Gemfile
+- README.md
 - Rakefile
 - cloudfoundry-env.gemspec
 - lib/cloudfoundry/environment.rb
@@ -57,7 +58,7 @@ files:
 - spec/spec_helper.rb
 - spec/test_app/Gemfile
 - spec/test_app/sample.rb
-homepage: http://github.com/cloudfoundry-samples
+homepage: https://github.com/cloudfoundry-samples/cloudfoundry-env
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -91,3 +92,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/test_app/Gemfile
 - spec/test_app/sample.rb
+has_rdoc: