rhc 0.98.16 → 1.0.4

data/lib/rhc/rest/client.rb

@@ -1,14 +1,26 @@
 require 'base64'
 require 'rhc/json'
+require 'rhc/rest/base'
+require 'rhc/helpers'
+require 'uri'
 
 module RHC
   module Rest
-    class Client
-      include Rest
-      def initialize(end_point, username, password, debug=false)
-        # use mydebug for legacy reasons
-        @mydebug = @mydebug || debug
-        logger.debug "Connecting to #{end_point}" if @mydebug
+    class Client < Base
+      include RHC::Helpers
+      
+      attr_reader :server_api_versions, :client_api_versions
+      # Keep the list of supported API versions here
+      # The list may not necessarily be sorted; we will select the last
+      # matching one supported by the server.
+      # See #api_version_negotiated
+      CLIENT_API_VERSIONS = [1.0, 1.1, 1.2]
+      
+      def initialize(end_point, username, password, use_debug=false, preferred_api_versions = CLIENT_API_VERSIONS)
+        @debug = use_debug
+        @end_point = end_point
+        @server_api_versions = []
+        debug "Connecting to #{end_point}"
 
         credentials = nil
         userpass = "#{username}:#{password}"
@@ -21,100 +33,114 @@ module RHC
         # :nocov:
         @@headers["Authorization"] = "Basic #{credentials}"
         @@headers["User-Agent"] = RHC::Helpers.user_agent rescue nil
-        #first get the API
         RestClient.proxy = ENV['http_proxy']
-        request = new_request(:url => end_point, :method => :get, :headers => @@headers)
+        
+        # API version negotiation
         begin
-          response = request.execute
-          result = RHC::Json.decode(response)
-          @links = request(request)
-        rescue => e
-          raise ResourceAccessException.new("Resource could not be accessed:#{e.message}")
+          debug "Client supports API versions #{preferred_api_versions.join(', ')}"
+          @client_api_versions = preferred_api_versions
+          default_request = new_request(:url => @end_point, :method => :get, :headers => @@headers)
+          @server_api_versions, links = api_info(default_request)
+          debug "Server supports API versions #{@server_api_versions.join(', ')}"
+        
+          if api_version_negotiated
+            unless server_api_version_current?
+              debug "Client API version #{api_version_negotiated} is not current. Refetching API"
+              # need to re-fetch API
+              @@headers["Accept"] = "application/json; version=#{api_version_negotiated}"
+              req = new_request(:url => @end_point, :method => :get, :headers => @@headers)
+              @server_api_versions, links = api_info req
+            end
+          else
+            warn_about_api_versions
+          end
+        rescue Exception => e
+          raise ResourceAccessException.new("Failed to access resource: #{e.message}")
         end
+
+        super({:links => links}, use_debug)
       end
 
-      #Add Domain
       def add_domain(id)
-        logger.debug "Adding domain #{id}" if @mydebug
-        url = @links['ADD_DOMAIN']['href']
-        method =  @links['ADD_DOMAIN']['method']
-        payload = {:id => id}
-        request = new_request(:url => url, :method => method, :headers => @@headers, :payload => payload)
-        return request(request)
+        debug "Adding domain #{id}"
+        rest_method "ADD_DOMAIN", :id => id
       end
 
-      #Get all Domain
       def domains
-        logger.debug "Getting all domains" if @mydebug
-        url = @links['LIST_DOMAINS']['href']
-        method =  @links['LIST_DOMAINS']['method']
-        request = new_request(:url => url, :method => method, :headers => @@headers)
-        return request(request)
+        debug "Getting all domains"
+        rest_method "LIST_DOMAINS"
+      end
+
+      def cartridges
+        debug "Getting all cartridges"
+        rest_method "LIST_CARTRIDGES"
+      end
+
+      def user
+        debug "Getting user info"
+        rest_method "GET_USER"
+      end
+
+      def sshkeys
+        debug "Finding all keys for #{user.login}"
+        user.keys
+      end
+
+      def add_key(name, key, content)
+        debug "Adding key #{key} for #{user.login}"
+        user.add_key name, key, content
+      end
+
+      def delete_key(name)
+        debug "Deleting key '#{name}'"
+        key = find_key(name)
+        key.destroy
       end
 
       #Find Domain by namesapce
       def find_domain(id)
-        logger.debug "Finding domain #{id}" if @mydebug
+        debug "Finding domain #{id}"
         domains.each { |domain| return domain if domain.id == id }
 
         raise RHC::DomainNotFoundException.new("Domain #{id} does not exist")
       end
 
-      #Get all Cartridge
-      def cartridges
-        logger.debug "Getting all cartridges" if @mydebug
-        url = @links['LIST_CARTRIDGES']['href']
-        method =  @links['LIST_CARTRIDGES']['method']
-        request = new_request(:url => url, :method => method, :headers => @@headers)
-        return request(request)
-      end
-
       #Find Cartridge by name or regex
       def find_cartridges(name)
-        logger.debug "Finding cartridge #{name}" if @mydebug
-        regex = nil
+        debug "Finding cartridge #{name}"
         if name.is_a?(Hash)
-          name = name[:name] if name[:name]
-          regex = name[:regex] if name[:regex]
+          regex = name[:regex]
+          type = name[:type]
+          name = name[:name]
         end
 
         filtered = Array.new
         cartridges.each do |cart|
           if regex
-            filtered.push(cart) if cart.name.match(regex)
+            filtered.push(cart) if cart.name.match(regex) and (type.nil? or cart.type == type)
           else
-            filtered.push(cart) if cart.name == name
+            filtered.push(cart) if (name.nil? or cart.name == name) and (type.nil? or cart.type == type)
           end
         end
         return filtered
       end
 
-      #Get User info
-      def user
-        url = @links['GET_USER']['href']
-        method =  @links['GET_USER']['method']
-        request = new_request(:url => url, :method => method, :headers => @@headers)
-        return request(request)
-      end
-
       #find Key by name
       def find_key(name)
-        logger.debug "Finding key #{name}" if @mydebug
-        user.keys.each { |key| return key if key.name == name }
-
-        raise RHC::KeyNotFoundException.new("Key #{name} does not exist")
+        debug "Finding key #{name}"
+        user.find_key(name) or raise RHC::KeyNotFoundException.new("Key #{name} does not exist")
       end
-      
+
       def sshkeys
         logger.debug "Finding all keys for #{user.login}" if @mydebug
         user.keys
       end
-      
+
       def add_key(name, key, content)
         logger.debug "Adding key #{key} for #{user.login}" if @mydebug
         user.add_key name, key, content
       end
-      
+
       def delete_key(name)
         logger.debug "Deleting key '#{name}'" if @mydebug
         key = find_key(name)
@@ -123,10 +149,52 @@ module RHC
 
       def logout
         #TODO logout
-        logger.debug "Logout/Close client" if @mydebug
+        debug "Logout/Close client"
       end
       alias :close :logout
+      
+      
+      ### API version related methods
+      def api_version_match?
+        ! api_version_negotiated.nil?
+      end
+      
+      # return the API version that the server and this client can agree on
+      def api_version_negotiated
+        client_api_versions.reverse. # choose the last API version listed
+          detect { |v| @server_api_versions.include? v }
+      end
+      
+      def client_api_version_current?
+        current_client_api_version == api_version_negotiated
+      end
+      
+      def current_client_api_version
+        client_api_versions.last
+      end
+      
+      def server_api_version_current?
+        @server_api_versions && @server_api_versions.max == api_version_negotiated
+      end
+      
+      def warn_about_api_versions
+        if !api_version_match?
+          warn "WARNING: API version mismatch. This client supports #{client_api_versions.join(', ')} but
+server at #{URI.parse(@end_point).host} supports #{@server_api_versions.join(', ')}."
+          warn "The client version may be outdated; please consider updating 'rhc'. We will continue, but you may encounter problems."
+        end
+      end
+      
+      def debug?
+        @debug
+      end
+      
+      private
+      # execute +req+ with RestClient, and return [server_api_versions, links]
+      def api_info(req)
+        json_response = ::RHC::Json.decode(req.execute)
+        [ json_response['supported_api_versions'], json_response['data'] ]
+      end
     end
-
   end
 end

data/lib/rhc/rest/domain.rb

@@ -1,23 +1,19 @@
+require 'rhc/rest/base'
+
 module RHC
   module Rest
-    class Domain
-      include Rest
+    class Domain < Base
       attr_reader :id
-      def initialize(args)
-        @id = args[:id] || args["id"]
-        @links = args[:links] || args["links"]
-      end
 
       #Add Application to this domain
       # options
       # cartrdige
       # template
       # scale
-      # node_profile
+      # gear_profile
       def add_application(name, options)
-        logger.debug "Adding application #{name} to domain #{self.id}" if @mydebug
-        url = @links['ADD_APPLICATION']['href']
-        method =  @links['ADD_APPLICATION']['method']
+        debug "Adding application #{name} to domain #{id}"
+
         payload = {:name => name}
         options.each do |key, value|
           payload[key] = value
@@ -26,48 +22,42 @@ module RHC
         if options[:scale]
           timeout = 300 # 5 minute timeout for scalable app
         end
-        request = new_request(:url => url, :method => method, :headers => @@headers, :payload => payload, :timeout => timeout)
-        return request(request)
-      end
 
-      #Get all Application for this domain
-      def applications
-        logger.debug "Getting all applications for domain #{self.id}" if @mydebug
-        url = @links['LIST_APPLICATIONS']['href']
-        method =  @links['LIST_APPLICATIONS']['method']
-        request = new_request(:url => url, :method => method, :headers => @@headers)
-        return request(request)
+        rest_method "ADD_APPLICATION", payload, timeout
       end
 
-      def find_application(name)
-        logger.debug "Finding application #{name}" if @mydebug
-        applications.each { |app| return app if app.name == name }
-
-        raise RHC::ApplicationNotFoundException.new("Application #{name} does not exist")
+      def applications
+        debug "Getting all applications for domain #{id}"
+        rest_method "LIST_APPLICATIONS"
       end
 
-      #Update Domain
       def update(new_id)
-        logger.debug "Updating domain #{self.id} to #{new_id}" if @mydebug
-        url = @links['UPDATE']['href']
-        method =  @links['UPDATE']['method']
-        payload = {:id => new_id}
+        debug "Updating domain #{id} to #{new_id}"
         # 5 minute timeout as this may take time if there are a lot of apps
-        request = new_request(:url => url, :method => method, :headers => @@headers, :payload => payload, :timeout=> 300)
-        return request(request)
+        rest_method "UPDATE", {:id => new_id}, 300
       end
       alias :save :update
 
-      #Delete Domain
       def destroy(force=false)
-        logger.debug "Deleting domain #{self.id}" if @mydebug
-        url = @links['DELETE']['href']
-        method =  @links['DELETE']['method']
-        payload = {:force => force}
-        request = new_request(:url => url, :method => method, :headers => @@headers, :payload => payload)
-        return request(request)
+        debug "Deleting domain #{id}"
+        rest_method "DELETE", :force => force
       end
       alias :delete :destroy
+
+      def find_application(name, options={})
+        if name.is_a?(Hash)
+          options = name.merge(options)
+          name = options[:name]
+        end
+        framework = options[:framework]
+
+        debug "Finding application :name => #{name}, :framework => #{framework}"
+        applications.each do |app|
+          return app if (name.nil? or app.name == name) and (framework.nil? or app.framework == framework)
+        end
+
+        raise RHC::ApplicationNotFoundException.new("Application #{name} does not exist")
+      end
     end
   end
 end

data/lib/rhc/rest/gear_group.rb

@@ -0,0 +1,10 @@
+require 'rhc/rest/base'
+
+module RHC
+  module Rest
+    class GearGroup < Base
+      include Rest
+      attr_reader :gears, :cartridges
+    end
+  end
+end

data/lib/rhc/rest/key.rb

@@ -1,35 +1,21 @@
+require 'rhc/rest/base'
+
 module RHC
   module Rest
-    class Key
-      include Rest
+    class Key < Base
       attr_reader :name, :type, :content
-      def initialize(args)
-        @name = args[:name] || args["name"]
-        @type = args[:type] || args["type"]
-        @content = args[:content] || args["content"]
-        @links = args[:links] || args["links"]
-      end
 
-      # Update Key
       def update(type, content)
-        logger.debug "Updating key #{self.name}" if @mydebug
-        url = @links['UPDATE']['href']
-        method =  @links['UPDATE']['method']
-        payload = {:type => type, :content => content}
-        request = new_request(:url => url, :method => method, :headers => @@headers, :payload => payload)
-        return request(request)
+        debug "Updating key #{self.name}"
+        rest_method "UPDATE", :type => type, :content => content
       end
 
-      #Delete Key
       def destroy
-        logger.debug "Deleting key #{self.name}" if @mydebug
-        url = @links['DELETE']['href']
-        method =  @links['DELETE']['method']
-        request = new_request(:url => url, :method => method, :headers => @@headers)
-        return request(request)
+        debug "Deleting key #{self.name}"
+        rest_method "DELETE"
       end
       alias :delete :destroy
-      
+
       def fingerprint
         begin
           public_key = Net::SSH::KeyFactory.load_data_public_key("#{type} #{content}")
@@ -37,7 +23,6 @@ module RHC
         rescue NotImplementedError, OpenSSL::PKey::PKeyError => e
           'Invalid key'
         end
-        
       end
     end
   end

data/lib/rhc/rest/user.rb

@@ -1,40 +1,24 @@
+require 'rhc/rest/base'
+
 module RHC
   module Rest
-    class User
-      include Rest
+    class User < Base
       attr_reader :login
-      def initialize(args)
-        @login = args[:login] || args["login"]
-        @links = args[:links] || args["links"]
-      end
 
-      #Add Key for this user
       def add_key(name, content, type)
-        url = @links['ADD_KEY']['href']
-        method =  @links['ADD_KEY']['method']
-        payload = {:name => name, :type => type, :content => content}
-        request = new_request(:url => url, :method => method, :headers => @@headers, :payload => payload)
-        return request(request)
+        debug "Add key #{name} of type #{type} for user #{login}"
+        rest_method "ADD_KEY", :name => name, :type => type, :content => content
       end
 
-      #Get all Key for this user
       def keys
-        url = @links['LIST_KEYS']['href']
-        method =  @links['LIST_KEYS']['method']
-        request = new_request(:url => url, :method => method, :headers => @@headers)
-        return request(request)
+        debug "Getting all keys for user #{login}"
+        rest_method "LIST_KEYS"
       end
 
       #Find Key by name
       def find_key(name)
-        filtered = Array.new
-        keys.each do |key|
         #TODO do a regex caomparison
-          if key.name == name
-          filtered.push(key)
-          end
-        end
-        return filtered
+        keys.detect { |key| key.name == name }
       end
     end
   end

data/lib/rhc/rest.rb

@@ -10,6 +10,7 @@ module RHC
     autoload :Domain,      'rhc/rest/domain'
     autoload :Key,         'rhc/rest/key'
     autoload :User,        'rhc/rest/user'
+    autoload :GearGroup,   'rhc/rest/gear_group'
 
     class Exception < RuntimeError
       attr_reader :code
@@ -100,39 +101,49 @@ module RHC
       when 'domains'
         domains = Array.new
         data.each do |domain_json|
-          domains.push(Domain.new(domain_json))
+          domains.push(Domain.new(domain_json, @debug))
         end
         return domains
       when 'domain'
-        return Domain.new(data)
+        return Domain.new(data, @debug)
       when 'applications'
         apps = Array.new
         data.each do |app_json|
-          apps.push(Application.new(app_json))
+          apps.push(Application.new(app_json, @debug))
         end
         return apps
       when 'application'
-        return Application.new(data)
+        app = Application.new(data, @debug)
+        result['messages'].each do |message|
+          app.add_message(message['text']) if message['field'].nil? or message['field'] == 'result'
+        end
+        return app
       when 'cartridges'
         carts = Array.new
         data.each do |cart_json|
-          carts.push(Cartridge.new(cart_json))
+          carts.push(Cartridge.new(cart_json, @debug))
         end
         return carts
       when 'cartridge'
-        return Cartridge.new(data)
+        return Cartridge.new(data, @debug)
       when 'user'
-        return User.new(data)
+        return User.new(data, @debug)
       when 'keys'
         keys = Array.new
         data.each do |key_json|
-          keys.push(Key.new(key_json))
+          keys.push(Key.new(key_json, @debug))
         end
         return keys
       when 'key'
-        return Key.new(data)
+        return Key.new(data, @debug)
+      when 'gear_groups'
+        gears = Array.new
+        data.each do |gear_json|
+          gears.push(GearGroup.new(gear_json, @debug))
+        end
+        return gears
       else
-      data
+        data
       end
     end
 
@@ -212,7 +223,7 @@ module RHC
       when 500
         messages.each do |message|
           if message['severity'].upcase == "ERROR"
-            raise ServerErrorException, message['text']
+            raise ServerErrorException.new(message['text'], message["exit_code"] ? message["exit_code"].to_i : nil)
           end
         end
       when 503

data/lib/rhc/ssh_key_helpers.rb

@@ -70,6 +70,53 @@ module RHC
       template.result(binding)
     end
 
+
+    # For Net::SSH versions (< 2.0.11) that does not have
+    # Net::SSH::KeyFactory.load_public_key, we drop to shell to get
+    # the key's fingerprint
+    def ssh_keygen_fallback(path)
+      fingerprint = `ssh-keygen -lf #{path} 2>&1`.split(' ')[1]
+
+      if $?.exitstatus != 0
+        error "Unable to compute SSH public key finger print for #{path}"
+      end
+      fingerprint
+    end
+
+    def fingerprint_for_local_key(key)
+      Net::SSH::KeyFactory.load_public_key(key).fingerprint
+    rescue NoMethodError, NotImplementedError => e
+      ssh_keygen_fallback key
+      return nil
+      # :nocov: no reason to cover this case
+    rescue OpenSSL::PKey::PKeyError, Net::SSH::Exception => e
+      error e.message
+      return nil
+      # :nocov:
+    end
+    
+    def fingerprint_for_default_key
+      fingerprint_for_local_key RHC::Config::ssh_pub_key_file_path
+    end
+
+    # for an SSH public key specified by 'key', return a triple
+    # [type, content, comment]
+    # which is basically the space-separated list of the SSH public key content
+    def ssh_key_triple_for(key)
+      begin
+        file = File.open key
+      rescue Errno::ENOENT => e
+        raise ::RHC::KeyFileNotExistentException.new("File '#{key}' does not exist.")
+      rescue Errno::EACCES => e
+        raise ::RHC::KeyFileAccessDeniedException.new("Access denied to '#{key}'.")
+      end
+      file.gets.chomp.split
+    end
+    
+    def ssh_key_triple_for_default_key
+      ssh_key_triple_for RHC::Config::ssh_pub_key_file_path
+    end
+
     private
 
     def ssh_add

data/lib/rhc/usage_templates/help.erb

@@ -2,7 +2,6 @@ Usage: <%= program :name %> (<resource> | --help) [<action>] [<args>]
 <%= program :description %>
 
 List of Commands and Resources
-  app                Manage applications within the OpenShift account.
 <% for name, command in @commands.sort -%>
 	<%- unless alias? name or name == "help" or name.include?(" ") or command.summary.nil? -%>  <%="%-18s %s\n" % [command.name, command.summary || command.description] %><%- end -%>
 <%- end -%>

data/lib/rhc/version.rb

@@ -1,8 +1,8 @@
 module RHC
   module VERSION #:nocov:
-    MAJOR = 0
-    MINOR = 98
-    MICRO = 16
+    MAJOR = 1
+    MINOR = 0
+    MICRO = 4
     #PRE  = ''
     STRING = [MAJOR,MINOR,MICRO].compact.join('.')
   end