cfoundry_helper 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adb8f6ca8a613c1c8b2cf30c86414353bd05a5cb
-  data.tar.gz: 0dc73d74b5abb77ca19a35de693fa90d5b53ad77
+  metadata.gz: 537df23f74bd2092dbf4e29f0c81002251763424
+  data.tar.gz: 0fc6be2168d5bd780a557dcfaae57d3534285e62
 SHA512:
-  metadata.gz: c9dd54b554659eaa2e78a54fb2cc98a956a9e6d7d8d5594dd250cdab1ccc66b966dd3ca5fb8ed7c2f9d1f1174cfdfa59b334b0556b4810830af1687634f6f752
-  data.tar.gz: 392f7e4c848e3463a6045baedb9a3f1921e74c6172972421696696243cb15e9059fe40507ea6699b49e2d93deb10a33eb2342772f139def65bd2c0de33877e09
+  metadata.gz: f8ca889bf78357bfc20032681b658f15c92f76ae961bbe86e041ffa46d0d61e9f8999f908258c3451b0d40ff07cb8fc53da5e24eccb6b2a831f146d49433acd9
+  data.tar.gz: eb658526e019a09b72161ea95b993170ff5061fc2e31c2e78a76076d473d520a8498136e36076f08229c5c4f81dc4792dc402389ce810674ee78e1f85163970d

data/CHANGELOG.textile

@@ -1,10 +1,18 @@
-h1. v0.1.0
-* OrganizationHelper implementation
-* ClientHelper implementation
-* UserHelper implementation
+h2. v0.3.1
+* removes env
+* removes necessary configuration file
+* adds the possibility to load configuration either from a file or from a hash
 
-h2. v0.2.0
-* add users to org script
+h2. v0.3.0 
+* multiple target support
 
 h2. v0.2.1
 * Bugfix: Don't cache the cloud controller client since the access token expires in long running apps.
+
+h2. v0.2.0
+* add users to org script
+
+h2. v0.1.0
+* OrganizationHelper implementation
+* ClientHelper implementation
+* UserHelper implementation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cfoundry_helper (0.3.0)
+    cfoundry_helper (0.3.1)
       activesupport
       cfoundry
 

data/README.textile

@@ -5,12 +5,22 @@ API. It implements common use cases when administrating a Cloud Foundry installa
 
 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.
+a) You can configure multiple targets within a configuration file. Please execute the following code to load the file's contents into the configuration:
+    CFoundryHelper.load_config_from_file file_location
 
-h2. Usage
+b) You can also configure the targets by passing in a configuration hash:
+	CfoundryHelper.load_config_from_hash config_hash
+	
+!!! It is important to load a configuration using one of the methods above before executing any helper functions.
+     
 
+h2. Target Selection
 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.
+CFoundryHelper::Helpers::ClientHelper.current_target_url= method for selecting a target from your service configuration file. 
+You can list all configured targets using the CFoundryHelper.available_targets method.
+
+!!! It is important to select a target before executing any helper functions, e.g:
+    CFoundryHelper::Helpers::ClientHelper.current_target_url = CFoundryHelper.available_targets.first
 
 h2. Organization management
 
@@ -40,25 +50,18 @@ 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 current_target_url has to point to your desired endpoint as defined in the config yaml file.
+The CFoundryHelper::Helpers::ClientHelper is a factory for uaa and cloud controller clients. The current_target_url has to point to your desired endpoint. (see Target Selection)
 
 
 h2. Scripts
 
 * bin/add_users_to_org : adds users to an organization
-    ** usage : RAILS_ENV=<test / production / development> bundle exec bin/add_users_to_org <org name> <users_email_list_file_location> <services_config_file_location>
+    ** usage : bundle exec bin/add_users_to_org <org name> <users_email_list_file_location> <services_config_file_location>
 * bin/create_space_for_org : creates a space to an organization and assigns all organization members to it
-    ** usage : RAILS_ENV=<test / production / development> bundle exec bin/create_space_for_org <org name> <space name> <services_config_file_location>
-
-h2. Important environment variables
+    ** usage : bundle exec bin/create_space_for_org <org name> <space name> <services_config_file_location>
 
-* RAILS_ENV : The helper is reading the target environment on which to execute commands using the RAILS_ENV environment variable. (e.g. production, test)
-
-* CFOUNDRY_HELPER_CONFIG This variable has to point to your services.yml file.
 
 h2. Console Usage
 
 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
+    bundle exec rake c

data/config/services.yml.example

@@ -1,25 +1,18 @@
-production: &defaults
-  "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:
-  <<: *defaults
+"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"

data/lib/cfoundry_helper.rb

@@ -1,6 +1,7 @@
 require 'bundler'
 require 'cfoundry'
 require 'active_support/core_ext/object/try'
+require 'active_support/hash_with_indifferent_access'
 
 Bundler.require
 
@@ -10,26 +11,26 @@ module CFoundryHelper
   autoload :Errors, File.expand_path('../cfoundry_helper/errors', __FILE__)
   
   @@config = nil
-  @@config_file_path = nil
-
-  def self.env
-    unless ENV['RAILS_ENV']
-      return :development
-    else
-      ENV['RAILS_ENV'].to_sym
-    end
-  end
   
-  def self.config
-    self.read_config_file
+  # Loads the configuration from the specified hash.
+  def self.load_config_from_hash(hash)
+    config = hash
+    check_config! config
+    @@config = config
+    @@config
   end
   
-  def self.config_file_path=(path)
-    @@config_file_path = path
+  # Loads the configuration from the specified yaml file.
+  def self.load_config_from_file(file_location)
+    raise "There's no configuration file on #{file_location}!" unless File.exists? file_location
+    config = YAML.load_file(file_location)
+    check_config! config
+    @@config = config
+    @@config
   end
-
-  def self.config_file_path
-    return @@config_file_path
+  
+  def self.config
+    @@config
   end
   
   # Returns an array of target available target urls defined in the configuration file as strings.
@@ -38,38 +39,29 @@ module CFoundryHelper
     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.
+  # Returns the config hash for the given target url as defined in the configuration.
+  # Returns nil if the given target url is not defined within the configuration.
   def self.config_for_target(url)
     self.config[url]
   end
   
-  protected
-
-  # reads the uaa and cc configuration from a config file
-  def self.read_config_file
-    # try to set the config file path from the env if not set already
-    self.set_config_file_path_from_env if @@config_file_path.nil?
-
-    if @@config.nil?
-      self.check_config_file_path
-      @@config = YAML.load_file(@@config_file_path)[CFoundryHelper.env.to_s]
-    end
-    @@config
-  end
-
-  def self.check_config_file_path
-    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
-
-  # sets the configuration file path from reading the CFOUNDRY_HELPER_CONFIG env variable
-  def self.set_config_file_path_from_env
-    config_file_path = ENV["CFOUNDRY_HELPER_CONFIG"]
-    unless config_file_path.nil?
-      self.config_file_path = config_file_path
+  private 
+  
+  def self.check_config!(config)
+    raise "No target hashes are defined within the configuration!" if config.count == 0
+    
+    config.each do |target,hash|
+      # check uaa config
+      raise "No uaa section is specified within the target #{target} !" if hash["uaa"].nil?
+      raise "No uaa:site is specifed within the target #{target} !" if hash["uaa"]["site"].nil?
+      raise "No uaa:client_id is specifed within the target #{target} !" if hash["uaa"]["client_id"].nil?
+      raise "No uaa:client_secret is specifed within the target #{target} !" if hash["uaa"]["client_secret"].nil?      
+      
+      # check cc config
+      raise "No cloud_controller section is specified within the target #{target} !" if hash["cloud_controller"].nil?
+      raise "No cloud_controller:site is specifed within the target #{target} !" if hash["cloud_controller"]["site"].nil?
+      raise "No cloud_controller:username is specifed within the target #{target} !" if hash["cloud_controller"]["username"].nil?
+      raise "No cloud_controller:password is specifed within the target #{target} !" if hash["cloud_controller"]["password"].nil?
     end
   end
-end
-
-CFoundryHelper.config
+end

data/lib/cfoundry_helper/helpers/client_helper.rb

@@ -52,7 +52,7 @@ module CFoundryHelper::Helpers
     # 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?
+      raise CFoundryHelper::Errors::ConfigurationError, "The ClientHelper's current target url is not defined in the configuration!" if CFoundryHelper.config[@@current_target_url].nil?
       
       
       # just return the already initialized client if it was explicit setted.

data/lib/cfoundry_helper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfoundry_helper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Julian Weber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler