cfoundry_helper 0.2.1

data/cfoundry_helper.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cfoundry_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cfoundry_helper"
+  spec.version       = CFoundryHelper::VERSION
+  spec.authors       = ["Julian Weber"]
+  spec.email         = ["jweber@anynines.com"]
+  spec.description   = %q{This gem provides additional helper classes and scripts for the cfoundry gem.}
+  spec.summary       = %q{This gem provides additional helper classes and scripts for the cfoundry gem.}
+  spec.homepage      = "http://www.anynines.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  # cf integration-test-support dependencies
+  spec.add_development_dependency "nats"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "cf-uaa-lib"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "httpclient"
+  spec.add_development_dependency "yajl-ruby"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-debugger"
+
+  spec.add_dependency "cfoundry"
+  spec.add_dependency "activesupport"
+end

data/config/services.yml.example

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

data/lib/cfoundry_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+require 'cfoundry'
+require 'active_support/core_ext/object/try'
+
+Bundler.require
+
+module CFoundryHelper
+  autoload :Helpers, File.expand_path('../cfoundry_helper/helpers', __FILE__)
+  autoload :Models, File.expand_path('../cfoundry_helper/models', __FILE__)
+
+  def self.env
+    unless ENV['RAILS_ENV']
+      return :development
+    else
+      ENV['RAILS_ENV'].to_sym
+    end
+  end
+end

data/lib/cfoundry_helper/helpers.rb

@@ -0,0 +1,6 @@
+module CFoundryHelper::Helpers
+  autoload :OrganizationHelper, File.expand_path('../helpers/organization_helper', __FILE__)
+  autoload :ClientHelper, File.expand_path('../helpers/client_helper', __FILE__)
+  autoload :UserHelper, File.expand_path('../helpers/user_helper', __FILE__)
+  autoload :SpaceHelper, File.expand_path('../helpers/space_helper', __FILE__)
+end

data/lib/cfoundry_helper/helpers/client_helper.rb

@@ -0,0 +1,106 @@
+require 'yaml'
+
+module CFoundryHelper::Helpers
+  module ClientHelper
+    @@config = nil
+    @@scim_client = nil
+    @@cloud_controller_client = nil
+    @@config_file_path = nil
+    @@auth_token = nil
+
+    def self.set_config_file_path(path)
+      @@config_file_path = path
+    end
+
+    def self.config_file_path
+      return @@config_file_path
+    end
+
+    def self.get_cc_target_url
+      return self.cloud_controller_client.target
+    end
+
+    def self.get_auth_token
+      self.cloud_controller_client if @@auth_token.nil?
+      return @@auth_token
+    end
+
+    ##
+    # Use this client to connect to the uaa-service and
+    # check wether a user alredy exists.
+    #
+    # scim is a "System for Cross-domain Identity Management" and
+    # it is uesd by the uaa service.
+    # see http://www.simplecloud.info/
+    def self.scim_client
+      # just return the already initialized client if present
+      return @@scim_client unless @@scim_client.nil?
+
+      self.read_config_file
+      token_issuer = CF::UAA::TokenIssuer.new(
+          @@config['uaa']['site'],
+          @@config['uaa']['client_id'],
+          @@config['uaa']['client_secret'])
+
+      token_info = token_issuer.client_credentials_grant
+      access_token = token_info.info["access_token"]
+      @@scim_client = CF::UAA::Scim.new(@@config['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 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
+
+      self.read_config_file
+      token_issuer = CF::UAA::TokenIssuer.new(@@config['uaa']['site'], "cf")
+      token_info = token_issuer.implicit_grant_with_creds(@@config['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(@@config['cloud_controller']['site'], token)
+    end
+
+
+    def self.set_scim_client(client)
+      @@scim_client = client
+    end
+
+    def self.set_cc_client(client)
+      @@cloud_controller_client = client
+    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.set_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.set_config_file_path config_file_path
+      end
+    end
+
+  end
+end

data/lib/cfoundry_helper/helpers/organization_helper.rb

@@ -0,0 +1,148 @@
+module CFoundryHelper::Helpers
+    module OrganizationHelper
+
+        # returns an array of all CFoundry::V2::Organizations
+        def self.get_organizations
+          self.cc_client.organizations
+        end
+
+        def self.exists?(org_name)
+          self.cc_client.organizations.each do |o|
+            return true if o.name.eql? org_name
+          end
+          return false
+        end
+
+        # creates an CFoundry::V2::Organization with the given attributes contained in the hash
+        # returns the created organization
+        # throws an exception when an error occures during creating the organization
+        def self.create_organization(attributes)
+          raise "The given attributes hash is nil!" if attributes.nil?
+          raise "No organization name given!" if attributes[:name].nil?
+          raise "No billing_enabled attribute given!" if attributes[:billing_enabled].nil?
+
+          org = self.cc_client.organization
+          org.name = attributes[:name]
+          org.billing_enabled = attributes[:billing_enabled]
+          org.create!
+          org
+        end
+
+        # deletes an organization recursively (all spaces and their contents)
+        # returns true if the organization was deleted
+        def self.delete_organization_recursive(org)
+          raise "The given organization is nil!" if org.nil?
+
+          org.delete!(recursive: true)
+        end
+
+        # returns the organization with the given name if it exists
+        # throws an exception when the given organization doesn't exist
+        def self.get_organization_by_name(name)
+          cc_client.organization_by_name name
+        end
+
+        # returns an array of Cfoundry::V2::Users registered within the given organization
+        def self.get_users(org)
+          org.users
+        end
+
+        # adds the given user to the given organization
+        # returns the organization
+        def self.add_user(org, user)
+          org.add_user user
+          org.update!
+          org
+        end
+
+        # adds the user with the given email to the given organization
+        # returns the organization
+        def self.add_user_by_email(org, email)
+          user = CFoundryHelper::Helpers::UserHelper.get_user_by_email email
+          self.add_user org, user
+          org
+        end
+
+        # removes the given user from the given organization
+        # returns the user
+        def self.remove_user(org, user)
+          # remove user from all sub-arrays
+          org.remove_auditor user
+          org.remove_manager user
+          org.remove_billing_manager user
+          org.remove_user user
+          org.update!
+          user
+        end
+
+        # takes an array of roles and adds the given user to the according organizations role lists
+        # throws an exception if any of the given arguments is nil or empty
+        # returns the organization
+        def self.add_roles(org, user, roles)
+          raise "No roles given!" if roles.nil? || roles.empty?
+          raise "The given organization is nil!" if org.nil?
+          raise "The given user is nil!" if user.nil?
+
+          roles.each do |r|
+            if r == CFoundryHelper::Models::OrganizationRole::AUDITOR
+              org.add_manager user
+            elsif r == CFoundryHelper::Models::OrganizationRole::MANAGER
+              org.add_auditor user
+            elsif r == CFoundryHelper::Models::OrganizationRole::BILLINGMANAGER
+              org.add_billing_manager user
+            end
+          end
+          org.update!
+          org
+        end
+
+        # takes an array of roles and removes the given user from the according organizations role lists
+        # throws an exception if any of the given arguments is nil or empty
+        # returns the organization
+        def self.remove_roles(org, user, roles)
+          raise "No roles given!" if roles.nil? || roles.empty?
+          raise "The given organization is nil!" if org.nil?
+          raise "The given user is nil!" if user.nil?
+
+          roles.each do |r|
+            if r == CFoundryHelper::Models::OrganizationRole::AUDITOR
+              org.remove_manager user
+            elsif r == CFoundryHelper::Models::OrganizationRole::MANAGER
+              org.remove_auditor user
+            elsif r == CFoundryHelper::Models::OrganizationRole::BILLINGMANAGER
+              org.remove_billing_manager user
+            end
+          end
+          org.update!
+          org
+        end
+
+        # returns an array of space names for the given organization
+        def self.get_space_names(org)
+          return [] if org.nil?
+          names = Array.new
+          org.spaces.each do |s|
+            names << s.name
+          end
+          names
+        end
+
+        # returns an array of all organization names present in the system
+        # use with caution (large dataset)
+        def self.get_all_org_names
+          arr = []
+          orgs = cc_client.organizations
+          orgs.each do |o|
+            arr << o.name
+          end
+          arr.sort!
+        end
+
+        private
+
+        # gets the current cloud controller client from the ClientHelper module
+        def self.cc_client
+          CFoundryHelper::Helpers::ClientHelper.cloud_controller_client
+        end
+    end
+end

data/lib/cfoundry_helper/helpers/space_helper.rb

@@ -0,0 +1,125 @@
+module CFoundryHelper::Helpers
+  module SpaceHelper
+
+    # creates a space with the given name within the given organization
+    # throws an exception if the given spacename is nil or empty
+    # throws an exception if the given organization is nil
+    # throws an exception if a space with the given name already exists within the given organization
+    def self.create_space(org, spacename)
+      raise "The given organization is nil!" if org.nil?
+      raise "The given spacename is nil!" if spacename.nil?
+      raise "The given spacename is empty!" if spacename.eql?('')
+      raise "The #{spacename} space already exists within #{org.name}!" if self.exists?(org, spacename)
+
+      space = self.cc_client.space
+      space.name = spacename
+      space.organization = org
+      space.create!
+      space
+    end
+
+    # deletes a space
+    # throws an exception if the given space is nil
+    # throws an exception if the given space is not empty
+    # returns true on deletion
+    def self.delete_space(space)
+      raise "The given space is nil!" if space.nil?
+      unless is_empty? space
+        raise "The given space is not empty!"
+      end
+      space.delete!
+      return true
+    end
+
+    # deletes a given space recursively (all apps, services, ....)
+    # returns true if the space was deleted
+    def self.delete_space_recursive(space)
+      raise "The given space is nil!" if space.nil?
+      space.delete!(:recursive => true)
+    end
+    
+    # returns true if no apps, service_instances, routes,
+    def self.is_empty?(space)
+      return true if space.nil?
+      if space.apps.count > 0 || space.service_instances.count > 0 || space.domains.count > 0
+        return false
+      else
+        return true
+      end
+    end
+
+    # returns the given the space with the given name within the given organization
+    # returns nil of no space has been found
+    def self.get_space(org, spacename)
+      org.space_by_name spacename
+    end
+
+    # returns the space with the given name in the organization with the given name
+    # returns nil if no space has been found
+    def self.get_space_by_name(org_name, space_name)
+      org = CFoundryHelper::Helpers::OrganizationHelper.get_organization_by_name org_name
+      return nil if org.nil?
+      return self.get_space(org, space_name)
+    end
+
+    # returns true if a space with the given name exists within the given organization
+    # returns false if no space with the given name exists within the given organization
+    def self.exists?(org, spacename)
+      return !org.space_by_name(spacename).nil?
+    end
+
+    def self.exists_by_name?(org_name, space_name)
+      return !self.get_space_by_name(org_name, space_name).nil?
+    end
+
+    # takes an array of roles and adds the given user to the according space's role lists
+    # throws an exception if any of the given arguments is nil or empty
+    # throws an exception if the given user is not registered with the space's organization
+    # returns the space
+    def self.add_roles(space, user, roles)
+      raise "No roles given!" if roles.nil? || roles.empty?
+      raise "The given space is nil!" if space.nil?
+      raise "The given user is nil!" if user.nil?
+
+      roles.each do |r|
+        if r == CFoundryHelper::Models::SpaceRole::MANAGER
+          space.add_manager user
+        elsif r == CFoundryHelper::Models::SpaceRole::AUDITOR
+          space.add_auditor user
+        elsif r == CFoundryHelper::Models::SpaceRole::DEVELOPER
+          space.add_developer user
+        end
+      end
+      space.update!
+      space
+    end
+
+    # takes an array of roles and removes the given user from the according space role lists
+    # throws an exception if any of the given arguments is nil or empty
+    # returns the space
+    def self.remove_roles(space, user, roles)
+      raise "No roles given!" if roles.nil? || roles.empty?
+      raise "The given space is nil!" if space.nil?
+      raise "The given user is nil!" if user.nil?
+
+      roles.each do |r|
+        if r == CFoundryHelper::Models::SpaceRole::MANAGER
+          space.remove_manager user
+        elsif r == CFoundryHelper::Models::SpaceRole::AUDITOR
+          space.remove_auditor user
+        elsif r == CFoundryHelper::Models::SpaceRole::DEVELOPER
+          space.remove_developer user
+        end
+      end
+      space.update!
+      space
+    end
+
+    private
+
+    # gets the current cloud controller client from the ClientHelper module
+    def self.cc_client
+      CFoundryHelper::Helpers::ClientHelper.cloud_controller_client
+    end
+  end
+end