cfoundry_helper 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9e5eea3ba6528384eca3da7e4e0f58ba46caf4f
-  data.tar.gz: 9560df1f344b424b325e4c421f87731dcc087451
+  metadata.gz: adb8f6ca8a613c1c8b2cf30c86414353bd05a5cb
+  data.tar.gz: 0dc73d74b5abb77ca19a35de693fa90d5b53ad77
 SHA512:
-  metadata.gz: 5463df4c0675a0af8405883ff4c1cebfab58e47d8b649208bde9360f88dd8c1620f10d5b7959acd37eb1fc17b789002fc512201fe23ecf488abee522d2e63655
-  data.tar.gz: 63e2fab1f26d3538db51c6619d06c687675981e1543fa0c12b76ee31d080579ff6e493f86b57ac5fee528df110c51f49ea2ce56297823addd349d52a115251e2
+  metadata.gz: c9dd54b554659eaa2e78a54fb2cc98a956a9e6d7d8d5594dd250cdab1ccc66b966dd3ca5fb8ed7c2f9d1f1174cfdfa59b334b0556b4810830af1687634f6f752
+  data.tar.gz: 392f7e4c848e3463a6045baedb9a3f1921e74c6172972421696696243cb15e9059fe40507ea6699b49e2d93deb10a33eb2342772f139def65bd2c0de33877e09

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cfoundry_helper (0.2.3)
+    cfoundry_helper (0.3.0)
       activesupport
       cfoundry
 
@@ -21,7 +21,7 @@ GEM
     builder (3.1.4)
     cf-uaa-lib (2.0.0)
       multi_json
-    cfoundry (4.5.1)
+    cfoundry (4.5.3)
       activemodel (>= 3.2.13, < 5.0.0)
       cf-uaa-lib (~> 2.0.0)
       multi_json (~> 1.7)

data/README.textile

@@ -3,6 +3,15 @@ h1. CFoundry Helper
 This collection of scripts provides helper methods to the cfoundry gem's
 API. It implements common use cases when administrating a Cloud Foundry installation.
 
+h2. Configuration
+
+You can configure multiple targets within the services.yml configuration file. Please refer to the services.yml.example file for a detailed example.
+
+h2. Usage
+
+Since cfoundry_helper now supports multiple CF targets you have to set your desired target by using the 
+    CFoundryHelper::Helpers::ClientHelper.current_target_url= method for selecting a target from your service configuration file.
+
 h2. Organization management
 
 The CFoundryHelper::Helpers::OrganizationHelper modules' methods provide helper methods for the following use cases:
@@ -31,7 +40,7 @@ The CFoundryHelper::Helpers::OrganizationHelper modules' methods provide helper
 
 h2. Client Helper
 
-The CFoundryHelper::Helpers::ClientHelper is a factory for uaa and cloud controller clients.
+The CFoundryHelper::Helpers::ClientHelper is a factory for uaa and cloud controller clients. The current_target_url has to point to your desired endpoint as defined in the config yaml file.
 
 
 h2. Scripts
@@ -49,7 +58,7 @@ h2. Important environment variables
 
 h2. Console Usage
 
-Use the following command to start the console with the associated target: 
+Use the following command to start the console: 
 RAILS_ENV=<target_env> CFOUNDRY_HELPER_CONFIG=<services config file> rake c
 
 e.g.: RAILS_ENV=production CFOUNDRY_HELPER_CONFIG=config/services.yml rake c

data/config/services.yml.example

@@ -1,22 +1,25 @@
 production: &defaults
-  uaa:
-    site:           "http://uaa.any9app.com"
-    client_id:      ""
-    client_secret:  ""
-  cloud_controller:
-    site:           "http://api.any9app.com"
-    username:       ""
-    password:       ""
+  "http://api.any9app.com":
+    uaa:
+      site:           "http://uaa.any9app.com"
+      client_id:      "user_registrator"
+      client_secret:  "user_registrator_password"
+    cloud_controller:
+      site:           "http://api.any9app.com"
+      username:       "admin"
+      password:       "admin_password"
+  "http://api.other_target.com":
+    uaa:
+      site:           "http://uaa.other_target.com"
+      client_id:      "user_registrator"
+      client_secret:  "user_registrator_password"
+    cloud_controller:
+      site:           "http://api.other_target.com"
+      username:       "admin"
+      password:       "admin_password"
 
 development:
   <<: *defaults
 
 test:
-  uaa:
-    site:           ""
-    client_id:      ""
-    client_secret:  ""
-  cloud_controller:
-    site:           ""
-    user:           ""
-    password:       ""
+  <<: *defaults

data/lib/cfoundry_helper/errors.rb

@@ -0,0 +1,4 @@
+module CFoundryHelper::Errors
+  class ConfigurationError < StandardError
+  end
+end

data/lib/cfoundry_helper/helpers/client_helper.rb

@@ -5,7 +5,15 @@ module CFoundryHelper::Helpers
     @@scim_client = nil
     @@cloud_controller_client = nil
     @@auth_token = nil
+    @@current_target_url = nil
 
+    def self.current_target_url=(url)
+      @@current_target_url = url
+    end
+    
+    def self.current_target_url
+      return @@current_target_url
+    end
 
     def self.get_cc_target_url
       return self.cloud_controller_client.target
@@ -25,37 +33,42 @@ module CFoundryHelper::Helpers
     # see http://www.simplecloud.info/
     def self.scim_client
       # just return the already initialized client if present
+      raise CFoundryHelper::Errors::ConfigurationError, "The ClientHelper's current target url is not defined in the configuration yaml file!" if CFoundryHelper.config[@@current_target_url].nil?
+      
       return @@scim_client unless @@scim_client.nil?
 
       token_issuer = CF::UAA::TokenIssuer.new(
-          CFoundryHelper.config['uaa']['site'],
-          CFoundryHelper.config['uaa']['client_id'],
-          CFoundryHelper.config['uaa']['client_secret'])
+          CFoundryHelper.config[@@current_target_url]['uaa']['site'],
+          CFoundryHelper.config[@@current_target_url]['uaa']['client_id'],
+          CFoundryHelper.config[@@current_target_url]['uaa']['client_secret'])
 
       token_info = token_issuer.client_credentials_grant
       access_token = token_info.info["access_token"]
-      @@scim_client = CF::UAA::Scim.new(CFoundryHelper.config['uaa']['site'], "bEareR #{access_token}")
+      @@scim_client = CF::UAA::Scim.new(CFoundryHelper.config[@@current_target_url]['uaa']['site'], "bEareR #{access_token}")
     end
 
     ##
     # Use this client to connect to the cloudcontroller
     # and register a new user.
     def self.cloud_controller_client
+      # just return the already initialized client if present
+      raise CFoundryHelper::Errors::ConfigurationError, "The ClientHelper's current target url is not defined in the configuration yaml file!" if CFoundryHelper.config[@@current_target_url].nil?
+      
+      
       # just return the already initialized client if it was explicit setted.
       # Don't cache the client in this method because long running apps will
       # have some trouble with expired auth tokens.
       # TODO: Refresh the token with the uaa refresh method.
       return @@cloud_controller_client if @@cloud_controller_client
 
-      token_issuer = CF::UAA::TokenIssuer.new(CFoundryHelper.config['uaa']['site'], "cf")
-      token_info = token_issuer.implicit_grant_with_creds(CFoundryHelper.config['cloud_controller'])
+      token_issuer = CF::UAA::TokenIssuer.new(CFoundryHelper.config[@@current_target_url]['uaa']['site'], "cf")
+      token_info = token_issuer.implicit_grant_with_creds(CFoundryHelper.config[@@current_target_url]['cloud_controller'])
       access_token = token_info.info["access_token"]
       token = CFoundry::AuthToken.from_hash({:token => "bearer #{access_token}"})
       @@auth_token = token
-      CFoundry::V2::Client.new(CFoundryHelper.config['cloud_controller']['site'], token)
+      CFoundry::V2::Client.new(CFoundryHelper.config[@@current_target_url]['cloud_controller']['site'], token)
     end
 
-
     def self.set_scim_client(client)
       @@scim_client = client
     end
@@ -63,8 +76,5 @@ module CFoundryHelper::Helpers
     def self.set_cc_client(client)
       @@cloud_controller_client = client
     end
-
-
-
   end
 end

data/lib/cfoundry_helper/version.rb

@@ -1,3 +1,3 @@
 module CFoundryHelper
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/cfoundry_helper.rb

@@ -7,6 +7,7 @@ Bundler.require
 module CFoundryHelper
   autoload :Helpers, File.expand_path('../cfoundry_helper/helpers', __FILE__)
   autoload :Models, File.expand_path('../cfoundry_helper/models', __FILE__)
+  autoload :Errors, File.expand_path('../cfoundry_helper/errors', __FILE__)
   
   @@config = nil
   @@config_file_path = nil
@@ -23,7 +24,7 @@ module CFoundryHelper
     self.read_config_file
   end
   
-  def self.set_config_file_path(path)
+  def self.config_file_path=(path)
     @@config_file_path = path
   end
 
@@ -31,6 +32,17 @@ module CFoundryHelper
     return @@config_file_path
   end
   
+  # Returns an array of target available target urls defined in the configuration file as strings.
+  # @returns [Array] 
+  def self.available_targets
+    self.config.keys
+  end
+  
+  # Returns the config hash for the given target url as defined in the configuration file.
+  # Returns nil if the given target url is not defined within the config file.
+  def self.config_for_target(url)
+    self.config[url]
+  end
   
   protected
 
@@ -47,7 +59,7 @@ module CFoundryHelper
   end
 
   def self.check_config_file_path
-    raise "No configuration file path has been set! Please call ClientHelper.set_config_file_path first or set a valid CFOUNDRY_HELPER_CONFIG env variable!" if @@config_file_path.nil?
+    raise "No configuration file path has been set! Please call ClientHelper.config_file_path= first or set a valid CFOUNDRY_HELPER_CONFIG env variable!" if @@config_file_path.nil?
     raise "There's no configuration file on #{@@config_file_path}!" if !File.exists? @@config_file_path
   end
 
@@ -55,7 +67,7 @@ module CFoundryHelper
   def self.set_config_file_path_from_env
     config_file_path = ENV["CFOUNDRY_HELPER_CONFIG"]
     unless config_file_path.nil?
-      self.set_config_file_path config_file_path
+      self.config_file_path = config_file_path
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfoundry_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Julian Weber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -203,6 +203,7 @@ files:
 - cfoundry_helper.gemspec
 - config/services.yml.example
 - lib/cfoundry_helper.rb
+- lib/cfoundry_helper/errors.rb
 - lib/cfoundry_helper/helpers.rb
 - lib/cfoundry_helper/helpers/client_helper.rb
 - lib/cfoundry_helper/helpers/organization_helper.rb