spacialdb 0.0.1 → 0.0.2

data/lib/spacialdb/client.rb

@@ -67,11 +67,32 @@ class Spacialdb::Client
   def process(method, uri, extra_headers={}, payload=nil)
     headers  = spacialdb_headers.merge(extra_headers)
     args     = [method, payload, headers].compact
-    response = resource(uri).send(*args)
 
+    resource_options = default_resource_options_for_uri(uri)
+
+    begin
+      response = resource(uri, resource_options).send(*args)
+    rescue RestClient::SSLCertificateNotVerified => ex
+      host = URI.parse(realize_full_uri(uri)).host
+      error "WARNING: Unable to verify SSL certificate for #{host}\nTo disable SSL verification, run with SPACIALDB_SSL_VERIFY=disable"
+    end
+
+    extract_warning(response)
     response
   end
 
+  def extract_warning(response)
+    return unless response
+    if response.headers[:x_spacialdb_warning] && @warning_callback
+      warning = response.headers[:x_spacialdb_warning]
+      @displayed_warnings ||= {}
+      unless @displayed_warnings[warning]
+        @warning_callback.call(warning)
+        @displayed_warnings[warning] = true
+      end
+    end
+  end
+
   def spacialdb_headers   # :nodoc:
     {
       'X-Spacialdb-API-Version' => '1',
@@ -81,7 +102,7 @@ class Spacialdb::Client
     }
   end
 
-  def resource(uri)
+  def resource(uri, options={})
     RestClient.proxy = ENV['HTTP_PROXY'] || ENV['http_proxy']
     resource = RestClient::Resource.new(realize_full_uri(uri),
       :user => login,
@@ -91,12 +112,27 @@ class Spacialdb::Client
   end
 
   def realize_full_uri(given)
-    full_host = (host =~ /^http/) ? host : "http://#{host}"
+    full_host = (host =~ /^http/) ? host : "https://#{host}"
     host = URI.parse(full_host)
     uri = URI.parse(given)
     uri.host ||= host.host
-    uri.scheme ||= host.scheme || "http"
+    uri.scheme ||= host.scheme || "https"
     uri.path = (uri.path[0..0] == "/") ? uri.path : "/#{uri.path}"
+    uri.port = host.port if full_host =~ /\:\d+/
     uri.to_s
   end
+
+  def default_resource_options_for_uri(uri)
+    if ENV["SPACIALDB_SSL_VERIFY"] == "disable"
+      {}
+    elsif realize_full_uri(uri) =~ %r|^https://beta.spacialdb.com|
+      { :verify_ssl => OpenSSL::SSL::VERIFY_PEER, :ssl_ca_file => local_ca_file }
+    else
+      {}
+    end
+  end
+
+  def local_ca_file
+    File.expand_path("../../../data/cacert.pem", __FILE__)
+  end
 end

data/lib/spacialdb/command.rb

@@ -48,8 +48,9 @@ module Spacialdb
 
     global_option :db,      "--db DB", "-d"
     global_option :confirm, "--confirm DB"
+    global_option :help,    "--help", "-h"
 
-    def self.run(cmd, args=[])
+    def self.prepare_run(cmd, args=[])
 
       command = parse(cmd)
 
@@ -85,31 +86,37 @@ module Spacialdb
         retry
       end
 
-      if opts[:help]
-        run "help", [cmd]
-        return
-      end
+      raise OptionParser::ParseError if opts[:help]
 
       args.concat(invalid_options)
 
-      begin
-        object = command[:klass].new(args.dup, opts.dup)
-        object.send(command[:method])
-      rescue InvalidCommand
-        error "Unknown command. Run 'spacialdb help' for usage information."
-      rescue RestClient::Unauthorized
-        puts "Authentication failure"
-        run "login"
+      [ command[:klass].new(args.dup, opts.dup), command[:method] ]
+    end
+
+    def self.run(cmd, arguments=[])
+      object, method = prepare_run(cmd, arguments)
+      object.send(method)
+    rescue InvalidCommand
+      error "Unknown command. Run 'spacialdb help' for usage information."
+    rescue RestClient::Unauthorized
+      puts "Authentication failure"
+      run "login"
+      retry
+    rescue RestClient::ResourceNotFound => e
+      error extract_not_found(e.http_body)
+    rescue RestClient::Locked => e
+      db = e.response.headers[:x_confirmation_required]
+      message = extract_error(e.response.body)
+      if confirmation_required(db, message)
+        opts[:confirm] = db
         retry
-      rescue RestClient::ResourceNotFound => e
-        error extract_not_found(e.http_body)
-      rescue RestClient::RequestFailed => e
-        error extract_error(e.http_body)
-      rescue RestClient::RequestTimeout
-        error "API request timed out. Please try again, or contact support@spacialdb.com if this issue persists."
-      rescue CommandFailed => e
-        error e.message
       end
+    rescue RestClient::RequestFailed => e
+      error extract_error(e.http_body)
+    rescue RestClient::RequestTimeout
+      error "API request timed out. Please try again, or contact support@spacialdb.com if this issue persists."
+    rescue CommandFailed => e
+      error e.message
     rescue OptionParser::ParseError => ex
       commands[cmd] ? run("help", [cmd]) : run("help")
     rescue Interrupt => e
@@ -128,7 +135,7 @@ module Spacialdb
       msg = parse_error_json(body) || parse_error_plain(body) || 'Internal server error'
       msg.split("\n").map { |line| ' !   ' + line }.join("\n")
     end
-    
+
     def self.parse_error_json(body)
       json = json_decode(body.to_s)
       json ? json['error'] : nil
@@ -138,5 +145,20 @@ module Spacialdb
       return unless body.respond_to?(:headers) && body.headers[:content_type].to_s.include?("text/plain")
       body.to_s
     end
+
+    def self.confirmation_required(db, message)
+      display
+      display
+      display message
+      display " !    To proceed, type \"#{db}\" or re-run this command with --confirm #{db}"
+      display
+      display "> ", false
+      if ask.downcase != app
+        display " !    Input did not match #{db}. Aborted."
+        false
+      else
+        true
+      end
+    end
   end
 end

data/lib/spacialdb/command/base.rb

@@ -24,7 +24,7 @@ class Spacialdb::Command::Base
 protected
 
   def self.inherited(klass)
-    help = extract_help(*(caller.first.split(":")[0..1])).strip
+    help = extract_help_from_caller(caller.first)
 
     Spacialdb::Command.register_namespace(
       :name => klass.namespace,
@@ -37,13 +37,10 @@ protected
     return if private_method_defined?(method)
     return if protected_method_defined?(method)
 
-    help = extract_help(*(caller.first.split(":")[0..1]))
-
+    help = extract_help_from_caller(caller.first)
     resolved_method = (method.to_s == "index") ? nil : method.to_s
-
     default_command = [ self.namespace, resolved_method ].compact.join(":")
     command     = extract_command(help) || default_command
-
     banner = extract_banner(help) || command
     permute = !banner.index("*")
     banner.gsub!("*", "")
@@ -67,6 +64,14 @@ protected
     Spacialdb::Command.command_aliases[new] = old
   end
 
+  def self.extract_help_from_caller(line)
+    # pull out of the caller the information for the file path and line number
+    if line =~ /^(.+?):(\d+)/
+      return extract_help($1, $2)
+    end
+    raise "unable to extract help from caller: #{line}"
+  end
+
   def self.extract_help(file, line)
     buffer = []
     lines  = File.read(file).split("\n")
@@ -100,7 +105,7 @@ protected
   end
 
   def self.extract_description(help)
-    lines = help.split("\n").map(&:strip)
+    lines = help.split("\n").map { |l| l.strip }
     lines.shift
     lines.reject do |line|
       line =~ /^-(.+)#(.+)/
@@ -108,11 +113,11 @@ protected
   end
 
   def self.extract_options(help)
-    help.split("\n").map(&:strip).select do |line|
+    help.split("\n").map { |l| l.strip }.select do |line|
       line =~ /^-(.+)#(.+)/
     end.inject({}) do |hash, line|
       description = line.split("#", 2).last.strip
-      long  = line.match(/--([A-Za-z ]+)/)[1].strip
+      long  = line.match(/--([A-Za-z\- ]+)/)[1].strip
       short = line.match(/-([A-Za-z ])/)[1].strip
       hash.update(long.split(" ").first => { :desc => description, :short => short, :long => long })
     end

data/lib/spacialdb/command/db.rb

@@ -16,7 +16,7 @@ class Spacialdb::Command::Db < Spacialdb::Command::Base
 
   # db:create
   #
-  # create your databases
+  # create a new database
   #
   def create
     display spacialdb.create

data/lib/spacialdb/command/help.rb

@@ -1,155 +1,131 @@
 require "spacialdb/command/base"
+require "spacialdb/deprecated/help"
 
-module Spacialdb::Command
+# list commands and display help
+#
+class Spacialdb::Command::Help < Spacialdb::Command::Base
 
-  # show this help
-  #
-  class Help < Base
-
-    class HelpGroup < Array
-      attr_reader :title
-
-      def initialize(title)
-        @title = title
-      end
+  PRIMARY_NAMESPACES = %w( auth db )
 
-      def command(name, description)
-        self << [name, description]
-      end
-
-      def space
-        self << ['', '']
-      end
-    end
-
-    def self.groups
-      @groups ||= []
-    end
-
-    def self.group(title, &block)
-      groups << begin
-        group = HelpGroup.new(title)
-        yield group
-        group
-      end
-    end
+  include Spacialdb::Deprecated::Help
 
-    def index
-      if command = args.shift
-        help_for_command(command)
-      else
-        help_for_root
-      end
+  # help [COMMAND]
+  #
+  # list available commands or display help for a specific command
+  #
+  def index
+    if command = args.shift
+      help_for_command(command)
+    else
+      help_for_root
     end
+  end
 
-  private
+private
 
-    def commands_for_namespace(name)
-      Spacialdb::Command.commands.values.select do |command|
-        command[:namespace] == name && command[:method] != :index
-      end
+  def commands_for_namespace(name)
+    Spacialdb::Command.commands.values.select do |command|
+      command[:namespace] == name && command[:method] != :index
     end
+  end
 
-    def namespaces
-      namespaces = Spacialdb::Command.namespaces
-    end
+  def namespaces
+    namespaces = Spacialdb::Command.namespaces
+  end
 
-    def commands
-      commands = Spacialdb::Command.commands
-      Spacialdb::Command.command_aliases.each do |new, old|
-        commands[new] = commands[old].dup
-        commands[new][:banner] = "#{new} #{commands[new][:banner].split(" ", 2)[1]}"
-        commands[new][:command] = new
-        commands[new][:namespace] = nil
-      end
-      commands
+  def commands
+    commands = Spacialdb::Command.commands
+    Spacialdb::Command.command_aliases.each do |new, old|
+      commands[new] = commands[old].dup
+      commands[new][:banner] = "#{new} #{commands[new][:banner].split(" ", 2)[1]}"
+      commands[new][:command] = new
+      commands[new][:namespace] = nil
     end
+    commands
+  end
 
-    def legacy_help_for_namespace(namespace)
-      instance = Spacialdb::Command::Help.groups.map do |group|
-        [ group.title, group.select { |c| c.first =~ /^#{namespace}/ }.length ]
-      end.sort_by(&:last).last
-      return nil unless instance
-      return nil if instance.last.zero?
-      instance.first
-    end
+  def legacy_help_for_namespace(namespace)
+    instance = Spacialdb::Command::Help.groups.map do |group|
+      [ group.title, group.select { |c| c.first =~ /^#{namespace}/ }.length ]
+    end.sort_by { |l| l.last }.last
+    return nil unless instance
+    return nil if instance.last.zero?
+    instance.first
+  end
 
-    def legacy_help_for_command(command)
-      Spacialdb::Command::Help.groups.each do |group|
-        group.each do |cmd, description|
-          return description if cmd.split(" ").first == command
-        end
+  def legacy_help_for_command(command)
+    Spacialdb::Command::Help.groups.each do |group|
+      group.each do |cmd, description|
+        return description if cmd.split(" ").first == command
       end
-      nil
     end
+    nil
+  end
 
-    PRIMARY_NAMESPACES = %w( auth db )
-
-    def primary_namespaces
-      PRIMARY_NAMESPACES.map { |name| namespaces[name] }.compact
-    end
+  def primary_namespaces
+    PRIMARY_NAMESPACES.map { |name| namespaces[name] }.compact
+  end
 
-    def additional_namespaces
-      (namespaces.values - primary_namespaces).sort_by { |n| n[:name] }
-    end
+  def additional_namespaces
+    (namespaces.values - primary_namespaces).sort_by { |n| n[:name] }
+  end
 
-    def summary_for_namespaces(namespaces)
-      size = longest(namespaces.map { |n| n[:name] })
-      namespaces.each do |namespace|
-        name = namespace[:name]
-        namespace[:description] ||= legacy_help_for_namespace(name)
-        puts "  %-#{size}s  # %s" % [ name, namespace[:description] ]
-      end
+  def summary_for_namespaces(namespaces)
+    size = longest(namespaces.map { |n| n[:name] })
+    namespaces.each do |namespace|
+      name = namespace[:name]
+      namespace[:description] ||= legacy_help_for_namespace(name)
+      puts "  %-#{size}s  # %s" % [ name, namespace[:description] ]
     end
+  end
 
-    def help_for_root
-      puts "Usage: spacialdb COMMAND [command-specific-options]"
-      puts
-      puts "Primary help topics, type \"spacialdb help TOPIC\" for more details:"
-      puts
-      summary_for_namespaces(primary_namespaces)
-      puts
-      puts "Additional topics:"
-      puts
-      summary_for_namespaces(additional_namespaces)
-      puts
-    end
+  def help_for_root
+    puts "Usage: spacialdb COMMAND [command-specific-options]"
+    puts
+    puts "Primary help topics, type \"spacialdb help TOPIC\" for more details:"
+    puts
+    summary_for_namespaces(primary_namespaces)
+    puts
+    puts "Additional topics:"
+    puts
+    summary_for_namespaces(additional_namespaces)
+    puts
+  end
 
-    def help_for_namespace(name)
-      namespace_commands = commands_for_namespace(name)
+  def help_for_namespace(name)
+    namespace_commands = commands_for_namespace(name)
 
-      unless namespace_commands.empty?
-        size = longest(namespace_commands.map { |c| c[:banner] })
-        namespace_commands.sort_by { |c| c[:method].to_s }.each do |command|
-          next if command[:help] =~ /DEPRECATED/
-          command[:summary] ||= legacy_help_for_command(command[:command])
-          puts "  %-#{size}s  # %s" % [ command[:banner], command[:summary] ]
-        end
+    unless namespace_commands.empty?
+      size = longest(namespace_commands.map { |c| c[:banner] })
+      namespace_commands.sort_by { |c| c[:method].to_s }.each do |command|
+        next if command[:help] =~ /DEPRECATED/
+        command[:summary] ||= legacy_help_for_command(command[:command])
+        puts "  %-#{size}s  # %s" % [ command[:banner], command[:summary] ]
       end
     end
+  end
 
-    def help_for_command(name)
-      command = commands[name]
-
-      if command
-        if command[:help].strip.length > 0
-          print "Usage: spacialdb #{command[:banner]}"
-          puts command[:help].split("\n")[1..-1].join("\n")
-          puts
-        else
-          puts "Usage: spacialdb #{command[:banner]}"
-          puts
-          puts " " + legacy_help_for_command(name).to_s
-          puts
-        end
-      end
+  def help_for_command(name)
+    command = commands[name]
 
-      unless commands_for_namespace(name).empty?
-        puts "Additional commands, type \"spacialdb help COMMAND\" for more details:"
+    if command
+      if command[:help].strip.length > 0
+        print "Usage: spacialdb #{command[:banner]}"
+        puts command[:help].split("\n")[1..-1].join("\n")
         puts
-        help_for_namespace(name)
+      else
+        puts "Usage: spacialdb #{command[:banner]}"
+        puts
+        puts " " + legacy_help_for_command(name).to_s
         puts
       end
     end
+
+    unless commands_for_namespace(name).empty?
+      puts "Additional commands, type \"spacialdb help COMMAND\" for more details:"
+      puts
+      help_for_namespace(name)
+      puts
+    end
   end
 end