cfoundry_helper 0.2.1

data/lib/cfoundry_helper/helpers/user_helper.rb

@@ -0,0 +1,148 @@
+module CFoundryHelper::Helpers
+  module UserHelper
+
+    # returns the associated email address for the given cc user
+    def self.get_email_for_user(user)
+      guid = user.guid
+
+      # fetch the data from the uaa
+      scim_cl = CFoundryHelper::Helpers::ClientHelper.scim_client
+      query_result = scim_cl.query(:user, {:filter => "id eq '#{guid}'"})
+
+      if query_result["resources"].nil? || query_result["resources"].empty?
+        raise "No user with the guid: #{guid} could be found on the uaa!"
+      end
+
+      query_result["resources"].first["emails"].first["value"]
+    end
+
+    # creates a user with the given email and password
+    def self.create_user(attributes)
+      raise "The given attributes hash is nil!" if attributes.nil?
+      raise "No user email given!" if attributes[:email].nil?
+      raise "No password attribute given!" if attributes[:password].nil?
+
+      # no admin user is created as a default
+      admin = false
+      unless attributes[:admin].nil?
+        admin = attributes[:admin]
+      end
+
+      user = CFoundryHelper::Helpers::ClientHelper.cloud_controller_client.register(attributes[:email], attributes[:password])
+
+      if admin
+        user.admin = true
+        user.update!
+      end
+
+      user
+    end
+
+    # deletes a user from the cc and the uaa
+    # returns true if the user was deleted
+    # throws an exception on errors
+    def self.delete_user(user)
+      self.delete_user_from_uaa user
+      self.delete_user_from_cc  user
+      return true
+    end
+
+    def self.delete_user_by_email(email)
+      user = self.get_user_by_email email
+      self.delete_user user
+    end
+
+    # returns an array of CFoundry::V2::User registered within the cloud controller
+    def self.get_cc_users
+      CFoundryHelper::Helpers::ClientHelper.cloud_controller_client.users
+    end
+
+    # returns an array of all user emails registered within the uaa
+    def self.get_user_emails
+      scim_cl = CFoundryHelper::Helpers::ClientHelper.scim_client
+      query_result = scim_cl.query(:user)
+
+      if query_result["resources"].nil? || query_result["resources"].empty?
+        raise "No user emails could be found in the uaa!"
+      end
+
+      res_array = Array.new
+      user_guid = query_result["resources"].each do |r|
+        res_array << r["emails"].first["value"]
+        res_array.sort!
+      end
+
+      res_array
+    end
+
+    # checks whether a user with the given email address exists
+    def self.email_exists?(email)
+      begin
+        u = self.get_user_by_email email
+          return true
+      rescue
+        return false
+      end
+    end
+
+    # returns the CFoundry::V2::User with the given email address if present
+    # throws an exception if the given user is not present in the system
+    def self.get_user_by_email(email)
+
+      # fetch the data from the uaa
+      scim_cl = CFoundryHelper::Helpers::ClientHelper.scim_client
+      query_result = scim_cl.query(:user, {:filter => "email eq '#{email.strip}'"})
+
+      if query_result["resources"].nil? || query_result["resources"].empty?
+        raise "No user with the email address: #{email} could be found!"
+      end
+
+      user_guid = query_result["resources"].first["id"]
+
+      # retrieve the user from the CC
+      user = nil
+      cc_cl = CFoundryHelper::Helpers::ClientHelper.cloud_controller_client
+      cc_cl.users.each do |u|
+        if u.guid.eql? user_guid
+          user = u
+          break
+        end
+      end
+
+      if user.nil?
+        raise "Could not find the user with the email address: #{email} in the Cloud Controller!"
+      end
+      user
+    end
+
+    # sets a new password for the given user
+    # returns the user
+    def self.set_user_password(user, newpass)
+      scim_cl = CFoundryHelper::Helpers::ClientHelper.scim_client
+      scim_cl.change_password user.guid, newpass, nil
+      return user
+    end
+
+
+
+    private
+
+    # deletes a user from the uaa
+    # returns true if the user was deleted
+    def self.delete_user_from_uaa(user)
+      raise "The given user is nil!" if user.nil?
+      user_id = user.guid
+
+      scim_cl = CFoundryHelper::Helpers::ClientHelper.scim_client
+      result = scim_cl.delete(:user, user_id)
+      return true
+    end
+
+    # deletes a user from the cloud controller
+    def self.delete_user_from_cc(user)
+      raise "The given user is nil!" if user.nil?
+      user.delete!
+    end
+
+  end
+end

data/lib/cfoundry_helper/models.rb

@@ -0,0 +1,4 @@
+module CFoundryHelper::Models
+  autoload :OrganizationRole, File.expand_path('../models/organization_role', __FILE__)
+  autoload :SpaceRole, File.expand_path('../models/space_role', __FILE__)
+end

data/lib/cfoundry_helper/models/organization_role.rb

@@ -0,0 +1,18 @@
+module CFoundryHelper::Models
+
+  # This module lists the Roles available for organizations
+  # There are 3 basic roles for organizations:
+  # Manager: Can invite/manage users, select/change the plan, establish spending limits
+  # Billing Manager: Can edit/change the billing account info, payment info
+  # Auditor: View only access to all org and space info, settings, reports
+  module OrganizationRole
+    MANAGER = :manager
+    BILLINGMANAGER = :billing_manager
+    AUDITOR = :auditor
+
+    def self.get_roles
+      return [MANAGER, BILLINGMANAGER, AUDITOR]
+    end
+
+  end
+end

data/lib/cfoundry_helper/models/space_role.rb

@@ -0,0 +1,18 @@
+module CFoundryHelper::Models
+
+  # This module lists the Roles available for spaces
+  # There are 3 basic roles for spaces:
+  # Manager: Can invite/manage users, enable features for a given space
+  # Developer: Can create, delete, manage applications and services, full access to all usage reports and logs
+  # Auditor: View only access to all space information, settings, reports, logs
+  module SpaceRole
+    MANAGER = :manager
+    DEVELOPER = :developer
+    AUDITOR = :auditor
+
+    def self.get_roles
+      return [MANAGER, DEVELOPER, AUDITOR]
+    end
+
+  end
+end

data/lib/cfoundry_helper/version.rb

@@ -0,0 +1,3 @@
+module CFoundryHelper
+  VERSION = "0.2.1"
+end

data/spec/integration_test.rb

@@ -0,0 +1,11 @@
+require_relative 'spec_helper'
+
+describe 'This is my test that requires nats uaa and ccng', type: :integration, :components => [:nats, :ccng, :uaa] do
+    # This is a helper module for accessing the cloud controller ng
+    include CcngClient
+
+    it 'start nats and ccng as required' do
+      component(:nats).should be
+      ccng_get('/v2/services').should be
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+lib = File.expand_path("../..", __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'vendor/integration-test-support/support/integration_example_group.rb'
+
+IntegrationExampleGroup.tmp_dir = '/tmp'
+
+RSpec.configure do |config|
+   config.include IntegrationExampleGroup, type: :integration
+end

metadata

@@ -0,0 +1,273 @@
+--- !ruby/object:Gem::Specification
+name: cfoundry_helper
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- Julian Weber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nats
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cf-uaa-lib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cfoundry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides additional helper classes and scripts for the cfoundry
+  gem.
+email:
+- jweber@anynines.com
+executables:
+- add_users_to_org
+- create_space_for_org
+- delete_orgs_and_users
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gitmodules
+- CHANGELOG.textile
+- Gemfile
+- Gemfile.lock
+- README.textile
+- Rakefile
+- VERSION
+- bin/add_users_to_org
+- bin/create_space_for_org
+- bin/delete_orgs_and_users
+- cfoundry_helper.gemspec
+- config/services.yml.example
+- lib/cfoundry_helper.rb
+- lib/cfoundry_helper/helpers.rb
+- lib/cfoundry_helper/helpers/client_helper.rb
+- lib/cfoundry_helper/helpers/organization_helper.rb
+- lib/cfoundry_helper/helpers/space_helper.rb
+- lib/cfoundry_helper/helpers/user_helper.rb
+- lib/cfoundry_helper/models.rb
+- lib/cfoundry_helper/models/organization_role.rb
+- lib/cfoundry_helper/models/space_role.rb
+- lib/cfoundry_helper/version.rb
+- spec/integration_test.rb
+- spec/spec_helper.rb
+homepage: http://www.anynines.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3457547663060522280
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: This gem provides additional helper classes and scripts for the cfoundry
+  gem.
+test_files:
+- spec/integration_test.rb
+- spec/spec_helper.rb