cfoundry 0.2.2 → 0.3.0

data/lib/cfoundry/v2/base.rb

@@ -0,0 +1,140 @@
+require "json"
+require "base64"
+
+require "cfoundry/baseclient"
+require "cfoundry/uaaclient"
+
+require "cfoundry/errors"
+
+module CFoundry::V2
+  class Base < CFoundry::BaseClient
+    attr_accessor :target, :token, :proxy, :trace
+
+    def initialize(
+        target = "https://api.cloudfoundry.com",
+        token = nil)
+      @target = target
+      @token = token
+    end
+
+
+    # invalidate token data when changing token
+    def token=(t)
+      @token = t
+    end
+
+
+    # The UAA used for this client.
+    #
+    # `false` if no UAA (legacy)
+    def uaa
+      return @uaa unless @uaa.nil?
+
+      endpoint = info[:authorization_endpoint]
+      return @uaa = false unless endpoint
+
+      @uaa = CFoundry::UAAClient.new(endpoint)
+      @uaa.trace = @trace
+      @uaa.token = @token
+      @uaa
+    end
+
+
+    # Cloud metadata
+    def info
+      get("info", nil => :json)
+    end
+
+
+    [:app, :organization, :app_space, :service, :service_instance,
+      :user, :runtime, :framework].each do |obj|
+      plural = "#{obj}s"
+
+      define_method(obj) do |guid, *args|
+        depth, _ = args
+        depth ||= 1
+
+        params = { :"inline-relations-depth" => depth }
+
+        get("v2", plural, guid, nil => :json, :params => params)
+      end
+
+      define_method(:"create_#{obj}") do |payload|
+        post(payload, "v2", plural, :json => :json)
+      end
+
+      define_method(:"delete_#{obj}") do |guid|
+        delete("v2", plural, guid, nil => nil)
+        true
+      end
+
+      define_method(:"update_#{obj}") do |guid, payload|
+        put(payload, "v2", plural, guid, :json => :json)
+      end
+
+      define_method(plural) do |*args|
+        depth, query = args
+        depth ||= 1
+
+        params = { :"inline-relations-depth" => depth }
+
+        if query
+          params[:q] = "#{query.keys.first}:#{query.values.first}"
+        end
+
+        get("v2", plural, nil => :json, :params => params)
+      end
+    end
+
+    alias :spaces :app_spaces
+    alias :space :app_space
+    alias :update_space :update_app_space
+    alias :delete_space :delete_app_space
+    alias :create_space :create_app_space
+
+    private
+
+    def handle_response(response, accept)
+      json = accept == :json
+
+      case response.code
+      when 200, 201, 204, 302
+        if accept == :headers
+          return response.headers
+        end
+
+        if json
+          if response.code == 204
+            raise "Expected JSON response, got 204 No Content"
+          end
+
+          parse_json(response)
+        else
+          response
+        end
+
+      when 400
+        info = parse_json(response)
+        raise CFoundry::APIError.new(info[:code], info[:description])
+
+      when 401
+        info = parse_json(response)
+        raise CFoundry::Denied.new(info[:code], info[:description])
+
+      when 404
+        raise CFoundry::NotFound
+
+      when 411, 500, 504
+        begin
+          info = parse_json(response)
+          raise CFoundry::APIError.new(info[:code], info[:description])
+        rescue JSON::ParserError
+          raise CFoundry::BadResponse.new(response.code, response)
+        end
+
+      else
+        raise CFoundry::BadResponse.new(response.code, response)
+      end
+    end
+  end
+end

data/lib/cfoundry/v2/client.rb

@@ -0,0 +1,184 @@
+require "cfoundry/v2/base"
+
+require "cfoundry/v2/app"
+require "cfoundry/v2/framework"
+require "cfoundry/v2/organization"
+require "cfoundry/v2/runtime"
+require "cfoundry/v2/service"
+require "cfoundry/v2/service_instance"
+require "cfoundry/v2/space"
+require "cfoundry/v2/user"
+
+module CFoundry::V2
+  # 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
+    # Internal BaseClient instance. Normally won't be touching this.
+    attr_reader :base
+
+    # [Organization] Currently targeted organization.
+    attr_accessor :current_organization
+
+    # [Space] Currently targeted space.
+    attr_accessor :current_space
+
+
+    # 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
+
+    # Cloud metadata
+    def info
+      @base.info
+    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)
+      @current_organization = nil
+      @current_space = nil
+
+      @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
+
+
+    [:app, :organization, :app_space, :service, :service_binding,
+      :service_instance, :user, :runtime, :framework].each do |singular|
+      klass = singular.to_s.capitalize.gsub(/(.)_(.)/) do
+        $1 + $2.upcase
+      end
+
+      plural = :"#{singular}s"
+
+      define_method(singular) do |*args|
+        id, _ = args
+        CFoundry::V2.const_get(klass).new(id, self)
+      end
+
+      define_method(plural) do |*args|
+        depth, query = args
+        depth ||= 1
+
+        @base.send(plural, depth, query)[:resources].collect do |json|
+          send(:"make_#{singular}", json)
+        end
+      end
+
+      define_method(:"#{singular}_from") do |path|
+        uri = URI.parse(path)
+
+        if uri.query
+          uri.query += "&inline-relations-depth=1"
+        else
+          uri.query = "inline-relations-depth=1"
+        end
+
+        send(
+          :"make_#{singular}",
+          @base.request_path(
+            :get,
+            uri.to_s,
+            nil => :json))
+      end
+
+      define_method(:"#{plural}_from") do |path|
+        uri = URI.parse(path)
+
+        if uri.query
+          uri.query += "&inline-relations-depth=1"
+        else
+          uri.query = "inline-relations-depth=1"
+        end
+
+        @base.request_path(
+            :get,
+            uri.to_s,
+            nil => :json)[:resources].collect do |json|
+          send(:"make_#{singular}", json)
+        end
+      end
+
+      define_method(:"make_#{singular}") do |json|
+        CFoundry::V2.const_get(klass).new(json[:metadata][:guid], self, json)
+      end
+    end
+
+    alias :spaces :app_spaces
+    alias :space :app_space
+
+    alias :system_frameworks :frameworks
+    alias :system_runtimes :runtimes
+    alias :system_services :services
+  end
+end

data/lib/cfoundry/v2/domain.rb

@@ -0,0 +1,8 @@
+require "cfoundry/v2/model"
+
+module CFoundry::V2
+  class Domain < Model
+    attribute :name
+    to_one    :organization
+  end
+end

data/lib/cfoundry/v2/framework.rb

@@ -0,0 +1,18 @@
+require "cfoundry/v2/model"
+
+module CFoundry::V2
+  class Framework < Model
+    attribute :name
+    attribute :description
+    to_many   :apps
+
+    def detection
+      nil # TODO for v2?
+    end
+
+    def runtimes
+      [] # TODO for v2?
+    end
+  end
+end
+

data/lib/cfoundry/v2/model.rb

@@ -0,0 +1,149 @@
+module CFoundry::V2
+  class Model
+    class << self
+      def defaults
+        @defaults ||= {}
+      end
+
+      def attribute(name, opts = {})
+        default = opts[:default] || nil
+        defaults[name] = default if default
+
+        define_method(name) {
+          manifest[:entity][name] || default
+        }
+
+        define_method(:"#{name}=") { |val|
+          @manifest ||= {}
+          @manifest[:entity] ||= {}
+          @manifest[:entity][name] = val
+        }
+      end
+
+      def to_one(name, opts = {})
+        obj = opts[:as] || name
+
+        define_method(name) {
+          if manifest[:entity].key? name
+            @client.send(:"make_#{obj}", manifest[:entity][name])
+          else
+            @client.send(:"#{name}_from", send("#{obj}_url"))
+          end
+        }
+
+        define_method(:"#{name}_url") {
+          manifest[:entity][:"#{name}_url"]
+        }
+
+        define_method(:"#{name}=") { |x|
+          @manifest ||= {}
+          @manifest[:entity] ||= {}
+          @manifest[:entity][:"#{name}_guid"] = x.id
+        }
+      end
+
+      def to_many(plural, opts = {})
+        singular = plural.to_s.sub(/s$/, "").to_sym
+        object = opts[:as] || singular
+
+        define_method(plural) {
+          if manifest[:entity].key? plural
+            manifest[:entity][plural].collect do |json|
+              @client.send(:"make_#{object}", json)
+            end
+          else
+            @client.send(:"#{plural}_from", send("#{plural}_url"))
+          end
+        }
+
+        define_method(:"#{plural}_url") {
+          manifest[:entity][:"#{plural}_url"]
+        }
+
+        # TODO: these are hacky
+        define_method(:"add_#{singular}") { |x|
+          @client.base.request_path(
+            :put,
+            ["v2", "#{object_name}s", @id, plural, x.id],
+            nil => :json)
+        }
+
+        define_method(:"remove_#{singular}") {
+          @client.base.request_path(
+            :delete,
+            ["v2", "#{object_name}s", @id, plural, x.id],
+            nil => :json)
+        }
+
+        define_method(:"#{plural}=") { |xs|
+          @manifest ||= {}
+          @manifest[:entity] ||= {}
+          @manifest[:entity][:"#{singular}_guids"] = xs.collect(&:id)
+        }
+      end
+    end
+
+    attr_reader :id
+
+    def initialize(id, client, manifest = nil)
+      @id = id
+      @client = client
+      @manifest = manifest
+    end
+
+    def manifest
+      # inline depth of 2 for fewer requests
+      @manifest ||= @client.base.send(object_name, @id, 2)
+    end
+
+    def inspect
+      "\#<#{self.class.name} '#@id'>"
+    end
+
+    def object_name
+      @object_name ||=
+        self.class.name.split("::").last.gsub(
+          /([a-z])([A-Z])/,
+          '\1_\2').downcase
+    end
+
+    def create!
+      @manifest =
+        @client.base.send(
+          :"create_#{object_name}",
+          @manifest[:entity].merge(self.class.defaults))
+
+      @id = @manifest[:metadata][:guid]
+
+      true
+    end
+
+    def update!(diff = nil)
+      @client.base.send(
+        :"update_#{object_name}",
+        @id,
+        diff || manifest[:entity])
+
+      @manifest = nil
+    end
+
+    def delete!
+      @client.base.send(:"delete_#{object_name}", @id)
+
+      if @manifest
+        @manifest.delete :metadata
+      end
+    end
+
+    def exists?
+      @client.base.send(object_name, @id)
+      true
+    rescue CFoundry::APIError # TODO: NotFound would be better
+      false
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && @id == other.id
+    end
+  end
+end