cloudfoundry-client 0.1.0

data/lib/cloudfoundry/client/info.rb

@@ -0,0 +1,29 @@
+module CloudFoundry
+  class Client
+    # CloudFoundry API Info methods.
+    module Info
+      # Returns information about the target cloud and, if logged, information about the user account.
+      #
+      # @return [Hash] Information about the target cloud and, if logged, information about the user account.
+      def cloud_info()
+        get(CloudFoundry::Client::CLOUD_INFO_PATH)
+      end
+
+      # Returns information about system runtimes that are available on the target cloud.
+      #
+      # @return [Hash] System Runtimes available on the target cloud.
+      def cloud_runtimes_info()
+        get(CloudFoundry::Client::CLOUD_RUNTIMES_INFO_PATH)
+      end
+
+      # Returns information about system services that are available on the target cloud.
+      #
+      # @return [Hash] System Services available on the target cloud.
+      # @authenticated True
+      def cloud_services_info()
+        require_login
+        get(CloudFoundry::Client::CLOUD_SERVICES_INFO_PATH)
+      end
+    end
+  end
+end

data/lib/cloudfoundry/client/request.rb

@@ -0,0 +1,89 @@
+module CloudFoundry
+  class Client
+    # CloudFoundry API Request Methods.
+    module Request
+
+      # Performs an HTTP GET request to the target cloud.
+      #
+      # @param [String] path Path to request at target cloud.
+      # @param [Hash] options
+      # @option options [Boolean] :raw true if response must not be parsed.
+      def get(path, options = {})
+        request(:get, path, options)
+      end
+
+      # Performs an HTTP POST request to the target cloud.
+      #
+      # @param [String] path Path to request at target cloud.
+      # @param [Hash] body Body of the request to the target cloud.
+      # @param [Hash] options
+      # @option options [Boolean] :raw true if response must not be parsed.
+      def post(path, body = {}, options = {})
+        request(:post, path, options, body)
+      end
+
+      # Performs an HTTP PUT request to the target cloud.
+      #
+      # @param [String] path Path to request at target cloud.
+      # @param [Hash] body Body of the request to the target cloud.
+      # @param [Hash] options
+      # @option options [Boolean] :raw true if response must not be parsed.
+      def put(path, body = {}, options = {})
+        request(:put, path, options, body)
+      end
+
+      # Performs an HTTP DELETE request to the target cloud.
+      #
+      # @param [String] path Path to request at target cloud.
+      # @param [Hash] options
+      # @option options [Boolean] :raw true if response must not be parsed.
+      def delete(path, options = {})
+        request(:delete, path, options)
+      end
+
+      private
+
+      # Sets a new connection to target cloud.
+      #
+      # @param [Hash] options
+      # @option options [Boolean] :raw true if response must not be parsed.
+      # @return [Faraday::Connection] A Faraday Connection.
+      def connection(options = {})
+        connection_options = {
+          :proxy => @proxy_url,
+          :url => @target_url
+        }
+        connection = Faraday.new(connection_options) do |builder|
+          builder.use Faraday::Request::Multipart
+          builder.use Faraday::Request::UrlEncoded
+          builder.use Faraday::Request::JSON unless options[:raw]
+          builder.adapter @net_adapter
+          builder.use CloudFoundry::Client::Response::ParseJSON unless options[:raw]
+          builder.use CloudFoundry::Client::Response::CloudError
+        end
+      end
+
+      # Performs a request to the target cloud.
+      #
+      # @param [Symbol] method HTTP method to use.
+      # @param [String] path Path to request at target cloud.
+      # @param [Hash] options
+      # @param [Hash] payload Body of the request to the target cloud.
+      # @option options [Boolean] :raw true if response must not be parsed.
+      def request(method, path, options = {}, payload = nil)
+        headers = {}
+        headers["User-Agent"] = "cloudfoundry-client-" + CloudFoundry::Client::VERSION
+        headers["AUTHORIZATION"] = @auth_token if @auth_token
+        headers["PROXY-USER"] = @proxy_user if @proxy_user
+        headers["X-VCAP-Trace"] = @trace_key if @trace_key
+        headers["Accept"] = "application/json" unless options[:raw]
+        headers["Content-Type"] = "application/json" unless options[:raw]
+        response = connection(options).send(method, path) do |request|
+          request.headers = headers
+          request.body = payload unless payload && payload.empty?
+        end
+        options[:raw] ? response : response.body
+      end
+    end
+  end
+end

data/lib/cloudfoundry/client/resources.rb

@@ -0,0 +1,16 @@
+module CloudFoundry
+  class Client
+    # CloudFoundry API Resources methods.
+    module Resources
+      # Checks which resources are needed to send to the target cloud when uploading application bits.
+      #
+      # @param [Array] resources A resources manifest.
+      # @return [Array] A resources manifest.
+      # @authenticated True
+      def check_resources(resources)
+        require_login
+        post(CloudFoundry::Client::RESOURCES_PATH, resources)
+      end
+    end
+  end
+end

data/lib/cloudfoundry/client/response.rb

@@ -0,0 +1,68 @@
+module CloudFoundry
+  class Client
+    # CloudFoundry Faraday Response Middleware.
+    module Response
+      # Faraday Response Middleware to parse cloud JSON responses.
+      class ParseJSON < Faraday::Response::Middleware
+        # Parses a JSON response.
+        #
+        # @param [String] body HTTP body response.
+        # @return [Hash] Parsed body response with symbolized names (keys).
+        # @raise [CloudFoundry::Client::Exception::BadResponse] when body can not be parsed.
+        def parse(body)
+          case body
+            when " " then nil
+            else JSON.parse(body, :symbolize_names => true)
+          end
+        rescue JSON::ParserError
+          raise CloudFoundry::Client::Exception::BadResponse, "Can't parse response into JSON:" + body
+        end
+      end
+
+      # Faraday Response Middleware to parse cloud errors.
+      class CloudError < Faraday::Response::Middleware
+        # Checks if an error is returned by target cloud.
+        #
+        # @param [Hash] env Faraday environment.
+        # @raise [CloudFoundry::Client::Exception::BadRequest] when HTTP status is 400.
+        # @raise [CloudFoundry::Client::Exception::Forbidden] when HTTP status is 403.
+        # @raise [CloudFoundry::Client::Exception::NotFound] when HTTP status is 404.
+        # @raise [CloudFoundry::Client::Exception::ServerError] when HTTP status is 500.
+        # @raise [CloudFoundry::Client::Exception::BadGateway] when HTTP status is 502.
+        def on_complete(env)
+          if env[:status].to_i >= 400
+            err = case env[:status].to_i
+              when 400 then CloudFoundry::Client::Exception::BadRequest
+              when 403 then CloudFoundry::Client::Exception::Forbidden
+              when 404 then CloudFoundry::Client::Exception::NotFound
+              when 500 then CloudFoundry::Client::Exception::ServerError
+              when 502 then CloudFoundry::Client::Exception::BadGateway
+            end
+            raise err, parse_cloud_error_message(env[:status], env[:body])
+          end
+        end
+
+        # Parses a CloudFoundry error message.
+        #
+        # @param [String] status Faraday HTTP response status.
+        # @param [String] body Faraday HTTP response body.
+        # @return [String] CloudFoundry error message.
+        def parse_cloud_error_message(status, body)
+          parsed_body = JSON.parse(body, :symbolize_names => true)
+          if parsed_body && parsed_body[:code] && parsed_body[:description]
+            description = parsed_body[:description].gsub("\"","'")
+            "Error #{parsed_body[:code]}: #{description}"
+          else
+            "Error (HTTP #{status}): #{body}"
+          end
+        rescue JSON::ParserError
+          if body.nil? || body.empty?
+            "Error (#{status}): No Response Received"
+          else
+            "Error (JSON #{status}): #{body}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cloudfoundry/client/services.rb

@@ -0,0 +1,122 @@
+module CloudFoundry
+  class Client
+    # CloudFoundry API Provisioned Services methods.
+    module Services
+      # Returns a list of provisioned services that are available on the target cloud.
+      #
+      # @return [Hash] List of provisioned services available on the target cloud.
+      # @authenticated True
+      def list_services
+        require_login
+        get(CloudFoundry::Client::SERVICES_PATH)
+      end
+
+      # Returns information about a provisioned service on the target cloud.
+      #
+      # @param [String] name The provisioned service name.
+      # @return [Hash] Provisioned service information on the target cloud.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when provisioned service name is blank.
+      # @authenticated True
+      def service_info(name)
+        require_login
+        raise CloudFoundry::Client::Exception::BadParams, "Name cannot be blank" if name.nil? || name.empty?
+        get("#{CloudFoundry::Client::SERVICES_PATH}/#{name}")
+      end
+
+      # Creates a new provisioned service on the target cloud.
+      #
+      # @param [String] service The system service to provision.
+      # @param [String] name The provisioned service name.
+      # @return [Boolean] Returns true if provisioned service is created.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when system service is blank.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when system service is not a valid service at target cloud.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when provisioned service name is blank.
+      # @authenticated True
+      def create_service(service, name)
+        require_login
+        raise CloudFoundry::Client::Exception::BadParams, "Service cannot be blank" if service.nil? || service.empty?
+        raise CloudFoundry::Client::Exception::BadParams, "Name cannot be blank" if name.nil? || name.empty?
+        service_hash = nil
+        services = cloud_services_info() || []
+        services.each do |service_type, service_value|
+          service_value.each do |vendor, vendor_value|
+            vendor_value.each do |version, service_info|
+              if service == service_info[:vendor]
+                service_hash = {
+                  :type => service_info[:type],
+                  :vendor => vendor,
+                  :version => version,
+                  :tier => "free"
+                }
+                break
+              end
+            end
+          end
+        end
+        raise CloudFoundry::Client::Exception::BadParams, "Service [#{service}] is not a valid service" unless service_hash
+        service_hash[:name] = name
+        post(CloudFoundry::Client::SERVICES_PATH, service_hash)
+        true
+      end
+
+      # Deletes a provisioned service on the target cloud.
+      #
+      # @param [String] name The provisioned service name.
+      # @return [Boolean] Returns true if provisioned service is deleted.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when provisioned service name is blank.
+      # @authenticated True
+      def delete_service(name)
+        require_login
+        raise CloudFoundry::Client::Exception::BadParams, "Name cannot be blank" if name.nil? || name.empty?
+        delete("#{CloudFoundry::Client::SERVICES_PATH}/#{name}", :raw => true)
+        true
+      end
+
+      # Binds a provisioned service to an application on the target cloud.
+      #
+      # @param [String] name The provisioned service name.
+      # @param [String] appname The application name.
+      # @return [Boolean] Returns true if provisioned service is binded to application.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when provisioned service name is blank.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when provisioned service is already binded to application.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when application name is blank.
+      # @authenticated True
+      def bind_service(name, appname)
+        require_login
+        raise CloudFoundry::Client::Exception::BadParams, "Service Name cannot be blank" if name.nil? || name.empty?
+        raise CloudFoundry::Client::Exception::BadParams, "Application Name cannot be blank" if appname.nil? || appname.empty?
+        service = service_info(name)
+        app = app_info(appname)
+        services = app[:services] || []
+        service_exists = services.index(name)
+        raise CloudFoundry::Client::Exception::BadParams, "Service [#{name}] is already binded to [#{appname}]" if service_exists
+        app[:services] = services << name
+        update_app(appname, app)
+        true
+      end
+
+      # Unbinds a provisioned service from an application on the target cloud.
+      #
+      # @param [String] name The provisioned service name.
+      # @param [String] appname The application name.
+      # @return [Boolean] Returns true if provisioned service is unbinded from application.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when provisioned service name is blank.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when provisioned service is not binded to application.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when application name is blank.
+      # @authenticated True
+      def unbind_service(name, appname)
+        require_login
+        raise CloudFoundry::Client::Exception::BadParams, "Service Name cannot be blank" if name.nil? || name.empty?
+        raise CloudFoundry::Client::Exception::BadParams, "Application Name cannot be blank" if appname.nil? || appname.empty?
+        service = service_info(name)
+        app = app_info(appname)
+        services = app[:services] || []
+        service_deleted = services.delete(name)
+        raise CloudFoundry::Client::Exception::BadParams, "Service [#{name}] is not binded to [#{name}]" unless service_deleted
+        app[:services] = services
+        update_app(appname, app)
+        true
+      end
+    end
+  end
+end

data/lib/cloudfoundry/client/users.rb

@@ -0,0 +1,121 @@
+module CloudFoundry
+  class Client
+    # CloudFoundry API Users methods.
+    module Users
+      # Logs the user in and returns the auth_token provided by the target cloud.
+      #
+      # @param [String] email The user's email.
+      # @param [String] password The user's password.
+      # @return [String] CloudFoundry API Authorization Token.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when email is blank.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when password is blank.
+      # @raise [CloudFoundry::Client::Exception::Forbidden] when login fails.
+      def login(email, password)
+        raise CloudFoundry::Client::Exception::BadParams, "Email cannot be blank" if email.nil? || email.empty?
+        raise CloudFoundry::Client::Exception::BadParams, "Password cannot be blank" if password.nil? || password.empty?
+        response_info = post("#{CloudFoundry::Client::USERS_PATH}/#{email}/tokens", {:password => password})
+        raise CloudFoundry::Client::Exception::Forbidden, "Login failed" unless response_info &&  response_info[:token]
+        @user = email
+        @proxy_user = nil
+        @auth_token = response_info[:token]
+      end
+
+      # Checks if the user is logged in at the cloud target.
+      #
+      # @return [Boolean] Returns true if user is logged in, false otherwise.
+      def logged_in?
+        return false unless cloud_info = cloud_info()
+        return false unless cloud_info[:user]
+        return false unless cloud_info[:usage]
+        @user = cloud_info[:user]
+        true
+      end
+
+      # Sets a user proxied access
+      #
+      # @param [String] email The user's email to be proxied.
+      # @return [String] Proxied user.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when email is blank.
+      # @admin True
+      def set_proxy_user(email)
+        raise CloudFoundry::Client::Exception::BadParams, "Email cannot be blank" if email.nil? || email.empty?
+        @proxy_user = email
+      end
+
+      # Unsets a user proxied access
+      #
+      # @return [nil]
+      def unset_proxy_user()
+        @proxy_user = nil
+      end
+
+      # Returns the list of users on the target cloud.
+      #
+      # @return [Hash] List of users on the target cloud.
+      # @admin True
+      def list_users()
+        require_login
+        get(CloudFoundry::Client::USERS_PATH)
+      end
+
+      # Returns information about a user on the target cloud.
+      #
+      # @param [String] email The user's email.
+      # @return [Hash] User information on the target cloud.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when email is blank.
+      # @authenticated True
+      # @admin Only when retrieving information about others users.
+      def user_info(email)
+        require_login
+        raise CloudFoundry::Client::Exception::BadParams, "Email cannot be blank" if email.nil? || email.empty?
+        get("#{CloudFoundry::Client::USERS_PATH}/#{email}")
+      end
+
+      # Creates a new user on the target cloud.
+      #
+      # @param [String] email The user's email.
+      # @param [String] password The user's password.
+      # @return [Boolean] Returns true if user is created.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when email is blank.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when password is blank.
+      def create_user(email, password)
+        raise CloudFoundry::Client::Exception::BadParams, "Email cannot be blank" if email.nil? || email.empty?
+        raise CloudFoundry::Client::Exception::BadParams, "Password cannot be blank" if password.nil? || password.empty?
+        post(CloudFoundry::Client::USERS_PATH, {:email => email, :password => password})
+        true
+      end
+
+      # Updates the user's password  on the target cloud.
+      #
+      # @param [String] email The user's email.
+      # @param [String] password The user's password.
+      # @return [Boolean] Returns true if user is updated.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when email is blank.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when password is blank.
+      # @authenticated True
+      # @admin Only when updating password for others users.
+      def update_user(email, password)
+        require_login
+        raise CloudFoundry::Client::Exception::BadParams, "Email cannot be blank" if email.nil? || email.empty?
+        raise CloudFoundry::Client::Exception::BadParams, "Password cannot be blank" if password.nil? || password.empty?
+        user_info = user_info(email)
+        user_info[:password] = password
+        put("#{CloudFoundry::Client::USERS_PATH}/#{email}", user_info)
+        true
+      end
+
+      # Deletes a user on the target cloud.
+      #
+      # @param [String] email The user's email.
+      # @return [Boolean] Returns true if user is deleted.
+      # @raise [CloudFoundry::Client::Exception::BadParams] when email is blank.
+      # @admin True
+      def delete_user(email)
+        require_login
+        raise CloudFoundry::Client::Exception::BadParams, "Email cannot be blank" if email.nil? || email.empty?
+        delete("#{CloudFoundry::Client::USERS_PATH}/#{email}", :raw => true)
+        true
+      end
+    end
+  end
+end