ncfoundry 4.9.2

data/lib/cfoundry/v2/base.rb

@@ -0,0 +1,112 @@
+require "multi_json"
+
+require "cfoundry/baseclient"
+require "cfoundry/uaaclient"
+
+require "cfoundry/errors"
+
+module CFoundry::V2
+  class Base < CFoundry::BaseClient
+    include BaseClientMethods
+
+    def resource_match(fingerprints)
+      put("v2", "resource_match", :content => :json, :accept => :json, :payload => fingerprints)
+    end
+
+    def upload_app(guid, zipfile = nil, resources = [])
+      payload = {}
+      payload[:resources] = MultiJson.dump(resources)
+
+      if zipfile
+        payload[:application] =
+          UploadIO.new(
+            if zipfile.is_a? File
+              zipfile
+            elsif zipfile.is_a? String
+              File.new(zipfile, "rb")
+            end,
+            "application/zip")
+      end
+
+      response = put("v2", "apps", guid, "bits",
+        :payload => payload,
+        :params => {"async" => "true"})
+
+      if response.present?
+        response_json = JSON.parse(response)
+        poll_upload_until_finished(response_json['metadata']['guid'])
+      end
+    rescue EOFError
+      retry
+    end
+
+    def poll_upload_until_finished(guid)
+      while true
+        response = get("v2", "jobs", guid, :accept => :json)
+        break if response[:entity][:status] == "finished"
+
+        if response[:entity][:status] == "failed"
+          raise CFoundry::BadResponse
+        end
+        sleep 0.2
+      end
+    end
+
+    def files(guid, instance, *path)
+      get("v2", "apps", guid, "instances", instance, "files", *path)
+    end
+
+    alias :file :files
+
+    def stream_file(guid, instance, *path, &blk)
+      path_and_options = path + [{:return_response => true, :follow_redirects => false}]
+      redirect = get("v2", "apps", guid, "instances", instance, "files", *path_and_options)
+
+      if location = redirect[:headers]["location"]
+        stream_url(location + "&tail", &blk)
+      else
+        yield redirect[:body]
+      end
+    end
+
+    def instances(guid)
+      get("v2", "apps", guid, "instances", :accept => :json)
+    end
+
+    def crashes(guid)
+      get("v2", "apps", guid, "crashes", :accept => :json)
+    end
+
+    def stats(guid)
+      get("v2", "apps", guid, "stats", :accept => :json)
+    end
+
+    def env(guid)
+      get("v2", "apps", guid, "env", :accept => :json)
+    end
+
+    def update_app(guid, diff)
+      put("v2", "apps", guid,
+          :content => :json,
+          :payload => diff,
+          :return_response => true)
+    end
+
+    def for_each(paginated, &block)
+      paginated[:resources].each &block
+
+      while (next_page = paginated[:next_url])
+        paginated = get(next_page, :accept => :json)
+        paginated[:resources].each &block
+      end
+    end
+
+    def all_pages(paginated)
+      payload = []
+      for_each(paginated) do |resource|
+        payload << resource
+      end
+      payload
+    end
+  end
+end

data/lib/cfoundry/v2/client.rb

@@ -0,0 +1,104 @@
+require File.expand_path("../../concerns/login_helpers", __FILE__)
+require "forwardable"
+
+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
+    include ClientMethods, CFoundry::LoginHelpers
+    extend Forwardable
+
+    # 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
+
+    def_delegators :@base, :target, :target=, :token, :token=,
+      :trace, :trace=, :log, :log=, :info
+
+    # Create a new Client for interfacing with the given target.
+    #
+    # A token may also be provided to skip the login step.
+    def initialize(target, token = nil, options = {})
+      @base = Base.new(target, token, options)
+    end
+
+    def version
+      2
+    end
+
+    # The currently authenticated user.
+    def current_user
+      return unless token
+
+      token_data = @base.token.token_data
+      if guid = token_data[:user_id]
+        user = user(guid)
+        user.emails = [{ :value => token_data[:email] }]
+        user
+      end
+    end
+
+    def login(credentials)
+      @current_organization = nil
+      @current_space = nil
+      super
+    end
+
+    def register(email, password, options = {})
+      uaa_user = @base.uaa.add_user(email, password, options)
+      cc_user = user
+      cc_user.guid = uaa_user[:id]
+      cc_user.create!
+      cc_user
+    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
+
+    def query_target(klass)
+      if klass.scoped_space && space = current_space
+        space
+      elsif klass.scoped_organization && org = current_organization
+        org
+      else
+        self
+      end
+    end
+
+    def stream_url(url, &blk)
+      @base.stream_url(url, &blk)
+    end
+
+    def service_instances(opts={})
+      opts[:user_provided] = true
+      super(opts)
+    end
+
+    def service_instances_from(path, *args)
+      opts = args.first || {}
+      opts[:user_provided] = true
+      super(path, opts, *args)
+    end
+
+    def make_service_instance(json)
+      klass = "CFoundry::V2::#{json[:entity][:type].camelize}".constantize
+      klass.new(
+        json[:metadata][:guid],
+        self,
+        json)
+    end
+  end
+end

data/lib/cfoundry/v2/domain.rb

@@ -0,0 +1,20 @@
+require "cfoundry/v2/model"
+
+module CFoundry::V2
+  class Domain < Model
+    validates_presence_of :name
+    validates_format_of :name, :with => /\A([^\.]+\.)+[^\.]+\Z/
+    validates_presence_of :owning_organization
+
+    attribute :name, :string
+    attribute :wildcard, :boolean
+    to_one    :owning_organization, :as => :organization, :default => nil
+    to_many   :spaces
+
+    queryable_by :name, :owning_organization_guid, :space_guid
+
+    def system?
+      guid.present? && !owning_organization.present?
+    end
+  end
+end

data/lib/cfoundry/v2/event.rb

@@ -0,0 +1,17 @@
+require "cfoundry/v2/model"
+
+module CFoundry::V2
+  class Event < Model
+    attribute :actee, :string
+    attribute :actee_type, :string
+    attribute :actor, :string
+    attribute :actor_type, :string
+    attribute :organization_guid, :string
+    attribute :space_guid, :string
+    attribute :timestamp, :string
+    attribute :type, :string
+    attribute :metadata, Hash
+
+    queryable_by :type, :timestamp
+  end
+end

data/lib/cfoundry/v2/helper.rb

@@ -0,0 +1,11 @@
+module CFoundry::V2::Helper
+  def to_many_support(plural)
+    singular = plural.to_s.sub(/s$/, "").to_sym
+
+    alias_method :"remove_#{singular}_without_support", :"remove_#{singular}"
+    define_method(:"remove_#{singular}") do |x|
+      result = self.__send__("remove_#{singular}_without_support", x)
+      result.nil?
+    end
+  end
+end

data/lib/cfoundry/v2/managed_service_instance.rb

@@ -0,0 +1,13 @@
+require "cfoundry/v2/service_instance"
+
+module CFoundry::V2
+  class ManagedServiceInstance < ServiceInstance
+    attribute :credentials, :hash
+    attribute :parameters, :hash
+    to_one    :service_plan
+
+    def self.object_name
+      'service_instance'
+    end
+  end
+end

data/lib/cfoundry/v2/model.rb

@@ -0,0 +1,213 @@
+require "multi_json"
+require "cfoundry/v2/model_magic"
+
+module CFoundry::V2
+  class Model
+    include ActiveModel::Validations
+
+    @@objects = {}
+
+    extend ModelMagic
+
+    class << self
+      def objects
+        @@objects
+      end
+
+      def inherited(klass)
+        @@objects[klass.object_name] = klass
+        super
+      end
+    end
+
+    attr_accessor :guid, :cache, :changes
+    attr_reader :created_at, :updated_at
+    attr_reader :diff
+
+    def initialize(guid, client, manifest = nil, partial = false)
+      @guid = guid
+      @client = client
+      @manifest = manifest
+      @partial = partial
+      @cache = {}
+      @diff = {}
+      @changes = {}
+    end
+
+    def created_at
+      timestamp = @manifest.try(:[], :metadata).try(:[], :created_at)
+      DateTime.parse(timestamp) if timestamp.present?
+    end
+
+    def updated_at
+      timestamp = @manifest.try(:[], :metadata).try(:[], :updated_at)
+      DateTime.parse(timestamp) if timestamp.present?
+    end
+
+    def manifest
+      @manifest ||= @client.base.send(object_name, @guid)
+    end
+
+    def partial?
+      @partial
+    end
+
+    def changed?
+      !@changes.empty?
+    end
+
+    def inspect
+      "\#<#{self.class.name} '#@guid'>"
+    end
+
+    def object_name
+      @object_name ||= self.class.object_name
+    end
+
+    def plural_object_name
+      @plural_object_name ||= self.class.plural_object_name
+    end
+
+    def invalidate!
+      @manifest = nil
+      @partial = false
+      @cache = {}
+      @diff = {}
+      @changes = {}
+    end
+
+    def create(options = {})
+      create!(options)
+      true
+    rescue CFoundry::APIError => e
+      if e.instance_of? CFoundry::APIError
+        errors.add(:base, :cc_client)
+      else
+        errors.add(attribute_for_error(e), e.message)
+      end
+      false
+    end
+
+    def attribute_for_error(error)
+      :base
+    end
+
+    # this does a bit of extra processing to allow for
+    # `delete!' followed by `create!'
+    def create!(options = {})
+      payload = {}
+
+      @manifest ||= {}
+      @manifest[:entity] ||= {}
+
+      @manifest[:entity].each do |k, v|
+        if v.is_a?(Hash) && v.key?(:metadata)
+          # skip; there's a _guid attribute already
+        elsif v.is_a?(Array) && !v.empty? && v.all? { |x|
+          x.is_a?(Hash) && x.key?(:metadata)
+        }
+          singular = k.to_s.sub(/s$/, "")
+
+          payload[:"#{singular}_guids"] = v.collect do |x|
+            if x.is_a?(Hash) && x.key?(:metadata)
+              x[:metadata][:guid]
+            else
+              x
+            end
+          end
+        else
+          payload[k] = v
+        end
+      end
+
+      @manifest = @client.base.post("v2", create_endpoint_name,
+        :content => :json,
+        :accept => :json,
+        :payload => payload,
+        :params => options
+      )
+
+      @guid = @manifest[:metadata][:guid]
+
+      @diff.clear
+
+      true
+    end
+
+    def create_endpoint_name
+      plural_object_name
+    end
+
+    def update!(options ={})
+      @manifest = @client.base.put("v2", plural_object_name, guid,
+        :content => :json,
+        :accept => :json,
+        :payload => @diff,
+        :params => options
+      )
+
+      @diff.clear
+
+      true
+    end
+
+    def delete(options = {})
+      delete!(options)
+    rescue CFoundry::APIError => e
+      if e.instance_of? CFoundry::APIError
+        errors.add(:base, :cc_client)
+      else
+        errors.add(attribute_for_error(e), e.message)
+      end
+      false
+    end
+
+    def delete!(options = {})
+      @client.base.delete("v2", plural_object_name, guid, :params => options)
+
+      @deleted = true
+
+      @diff.clear
+
+      if @manifest
+        @manifest.delete :metadata
+      end
+
+      true
+    end
+
+    def to_param
+      persisted? ? @guid.to_s : nil
+    end
+
+    def to_key
+      persisted? ? [@guid] : nil
+    end
+
+    def persisted?
+      @guid && !@deleted
+    end
+
+    def exists?
+      invalidate!
+      manifest
+      true
+    rescue CFoundry::NotFound
+      false
+    end
+
+    def query_target(klass)
+      self
+    end
+
+    def eql?(other)
+      other.is_a?(self.class) && @guid == other.guid
+    end
+
+    alias :== :eql?
+
+    def hash
+      @guid.hash
+    end
+  end
+end

data/lib/cfoundry/v2/model_magic/attribute.rb

@@ -0,0 +1,49 @@
+module CFoundry::V2::ModelMagic
+  module Attribute
+    def attribute(name, type, opts = {})
+      attributes[name] = opts
+      json_name = opts[:at] || name
+
+      default = opts[:default]
+
+      if has_default = opts.key?(:default)
+        defaults[name] = default
+      end
+
+      #
+      # def ATTRIBUTE
+      #
+      define_method(name) do
+        return @cache[name] if @cache.key?(name)
+        return nil unless persisted?
+
+        @cache[name] =
+          if manifest[:entity].key?(json_name)
+            manifest[:entity][json_name]
+          else
+            default
+          end
+      end
+
+      #
+      # def ATTRIBUTE=
+      #
+      define_method(:"#{name}=") do |val|
+        unless has_default && val == default
+          CFoundry::Validator.validate_type(val, type)
+        end
+
+        @cache[name] = val
+
+        @manifest ||= {}
+        @manifest[:entity] ||= {}
+
+        old = @manifest[:entity][json_name]
+        @changes[name] = [old, val] if old != val
+        @manifest[:entity][json_name] = val
+
+        @diff[json_name] = val
+      end
+    end
+  end
+end

data/lib/cfoundry/v2/model_magic/client_extensions.rb

@@ -0,0 +1,170 @@
+module CFoundry
+  module V2
+    module ModelMagic
+      module ClientExtensions
+        def add_client_methods(klass)
+          singular = klass.object_name
+          plural = klass.plural_object_name
+
+          define_base_client_methods do
+            #
+            # def client.MODEL
+            #
+            define_method(singular) do |guid, *args|
+              get("v2", plural, guid,
+                :accept => :json,
+                :params => ModelMagic.params_from(args)
+              )
+            end
+
+            #
+            # def client.MODELs
+            #
+            define_method(plural) do |*args|
+              all_pages(
+                get("v2", plural,
+                  :accept => :json,
+                  :params => ModelMagic.params_from(args)
+                )
+              )
+            end
+
+            #
+            # def client.MODELs_first_page
+            #
+            define_method(:"#{plural}_first_page") do |*args|
+              get("v2", plural,
+                :accept => :json,
+                :params => ModelMagic.params_from(args)
+              )
+            end
+
+            #
+            # def client.MODELs_for_each
+            #
+            define_method(:"#{plural}_for_each") do |*args, &block|
+              for_each(get("v2", plural,
+                  :accept => :json,
+                  :params => ModelMagic.params_from(args)
+                ),
+                &block
+              )
+            end
+          end
+
+
+          define_client_methods do
+            #
+            # def client.MODEL
+            #
+            define_method(singular) do |*args|
+              guid, partial, _ = args
+
+              x = klass.new(guid, self, nil, partial)
+
+              # when creating an object, automatically set the org/space
+              unless guid
+                if klass.scoped_organization && current_organization
+                  x.send(:"#{klass.scoped_organization}=", current_organization)
+                end
+
+                if klass.scoped_space && current_space
+                  x.send(:"#{klass.scoped_space}=", current_space)
+                end
+              end
+
+              x
+            end
+
+            #
+            # def client.MODELs
+            #
+            define_method(plural) do |*args|
+              # use current org/space
+              if klass.scoped_space && current_space
+                current_space.send(plural, *args)
+              elsif klass.scoped_organization && current_organization
+                current_organization.send(plural, *args)
+              else
+                @base.send(plural, *args).collect do |json|
+                  send(:"make_#{singular}", json)
+                end
+              end
+            end
+
+            #
+            # def client.MODELs_first_page
+            #
+            define_method(:"#{plural}_first_page") do |*args|
+              response = @base.send(:"#{plural}_first_page", *args)
+              results = response[:resources].collect do |json|
+                send(:"make_#{singular}", json)
+              end
+              {
+                  :next_page => !!response[:next_url],
+                  :results => results
+              }
+            end
+
+            #
+            # def client.MODELs_for_each
+            #
+            define_method(:"#{plural}_for_each") do |*args, &block|
+              @base.send(:"#{plural}_for_each", *args) do |json|
+                result = send(:"make_#{singular}", json)
+                block.call(result)
+              end
+            end
+
+            #
+            # def client.MODEL_from
+            #
+            define_method(:"#{singular}_from") do |path, *args|
+              send(
+                :"make_#{singular}",
+                @base.get(
+                  path,
+                  :accept => :json,
+                  :params => ModelMagic.params_from(args)))
+            end
+
+            #
+            # def client.MODELs_from
+            #
+            define_method(:"#{plural}_from") do |path, *args|
+              objs = @base.all_pages(
+                @base.get(
+                  path,
+                  :accept => :json,
+                  :params => ModelMagic.params_from(args)))
+
+              objs.collect do |json|
+                send(:"make_#{singular}", json)
+              end
+            end
+
+            #
+            # def client.make_MODEL
+            #
+            define_method(:"make_#{singular}") do |json|
+              klass.new(
+                json[:metadata][:guid],
+                self,
+                json)
+            end
+          end
+        end
+
+        private
+
+        def define_client_methods(&blk)
+          ClientMethods.module_eval(&blk)
+        end
+
+        def define_base_client_methods(&blk)
+          BaseClientMethods.module_eval(&blk)
+        end
+      end
+    end
+  end
+end