require "cfoundry/v1/base" require "cfoundry/v1/app" require "cfoundry/v1/service" require "cfoundry/v1/service_instance" require "cfoundry/v1/user" module CFoundry::V1 # The primary API entrypoint. Wraps a BaseClient to provide nicer return # values. Initialize with the target and, optionally, an auth token. These # are the only two internal states. class Client attr_reader :base # Create a new Client for interfacing with the given target. # # A token may also be provided to skip the login step. def initialize(target = "http://api.cloudfoundry.com", token = nil) @base = Base.new(target, token) end # The current target URL of the client. def target @base.target end # Current proxy user. Usually nil. def proxy @base.proxy end # Set the proxy user for the client. Must be authorized as an # administrator for this to have any effect. def proxy=(email) @base.proxy = email end # Is the client tracing API requests? def trace @base.trace end # Set the tracing flag; if true, API requests and responses will be # printed out. def trace=(bool) @base.trace = bool end # The currently authenticated user. def current_user if user = info[:user] user(user) end end # Retrieve target metadata. def info @base.info end # Retrieve available services. def services services = [] @base.system_services.each do |type, vendors| vendors.each do |vendor, versions| versions.each do |num, meta| services << Service.new(vendor.to_s, num, meta[:description], type) end end end services end # Retrieve available runtimes. def runtimes runtimes = [] @base.system_runtimes.each do |name, meta| runtimes << Runtime.new(name.to_s, meta[:version], meta[:debug_modes]) end runtimes end # Retrieve available frameworks. def frameworks fs = info[:frameworks] return unless fs frameworks = [] fs.each do |name, meta| runtimes = meta[:runtimes].collect do |r| Runtime.new(r[:name], r[:description]) end frameworks << Framework.new(name.to_s, nil, runtimes, meta[:detection]) end frameworks end # Retrieve user list. Admin-only. def users @base.users.collect do |json| User.new( json[:email], self, { :email => json[:email], :admin => json[:admin] }) end end # Construct a User object. The return value is lazy, and no requests are # made from this alone. # # This should be used for both user creation (after calling User#create!) # and retrieval. def user(email) User.new(email, self) end # Create a user on the target and return a User object representing them. def register(email, password) @base.create_user(:email => email, :password => password) user(email) end # Login prompts def login_prompts if @base.uaa @base.uaa.prompts else { :username => ["text", "Email"], :password => ["password", "Password"] } end end # Authenticate with the target. Sets the client token. # # Credentials is a hash, typically containing :username and :password # keys. # # The values in the hash should mirror the prompts given by # `login_prompts`. def login(credentials) @base.token = if @base.uaa @base.uaa.authorize(credentials) else @base.create_token( { :password => credentials[:password] }, credentials[:username])[:token] end end # Clear client token. No requests are made for this. def logout @base.token = nil end # Is an authentication token set on the client? def logged_in? !!@base.token end # Retreive all of the current user's applications. def apps @base.apps.collect do |json| App.new(json[:name], self, json) end end # Construct an App object. The return value is lazy, and no requests are # made from this method alone. # # This should be used for both app creation (after calling App#create!) # and retrieval. def app(name = nil) App.new(name, self) end # TODO: remove once v2 allows filtering by name # see V2::Client#app_by_name def app_by_name(name) app = app(name) if app.exists? app end end # Retrieve all of the current user's services. def service_instances @base.services.collect do |json| ServiceInstance.new(json[:name], self, json) end end # Construct a Service object. The return value is lazy, and no requests are # made from this method alone. # # This should be used for both service creation (after calling # Service#create!) and retrieval. def service_instance(name = nil) ServiceInstance.new(name, self) end end end