spacialdb 0.0.1

data/README.md

@@ -0,0 +1,23 @@
+SpacialDB API - provision geospatial databases on SpacialDB from the command line
+=================================================================================
+
+This library wraps the SpacialDB's REST API for provisioning and managing geospatial databases in SpacialDB's cloud service.
+
+Sample Workflow
+---------------
+
+Signup and create a new database:
+
+    spacialdb signup
+    spacialdb create
+    spacialdb list
+
+Delete a database:
+
+    spacialdb destroy --db <db name>
+
+Setup
+-----
+
+    gem install spacialdb
+

data/bin/spacialdb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'spacialdb'
+require 'spacialdb/command'
+
+args = ARGV.dup
+ARGV.clear
+command = args.shift.strip rescue 'help'
+
+Spacialdb::Command.load
+Spacialdb::Command.run(command, args)

data/lib/spacialdb/auth.rb

@@ -0,0 +1,189 @@
+require "spacialdb/client"
+require "spacialdb/helpers"
+
+class Spacialdb::Auth
+  class PasswordMismatch < RuntimeError; end
+
+  class << self
+    attr_accessor :credentials
+
+    def default_host
+      "beta.spacialdb.com"
+    end
+
+    def host
+      ENV['SPACIALDB_HOST'] || default_host
+    end
+
+    def client
+      @client ||= begin
+        client = Spacialdb::Client.new(email, private_api_key, host)
+        client
+      end
+    end
+
+    def signup
+      delete_credentials
+      signup_and_save_credentials
+      display "Signed up successfully."
+    end
+
+    def login
+      delete_credentials
+      get_credentials
+      display "Logged in successfully."
+    end
+
+    def logout
+      delete_credentials
+      display "Logged out successfully."
+    end
+
+    def clear
+      @credentials = nil
+      @client = nil
+    end
+
+    def email
+      get_credentials
+      @credentials[0]
+    end
+
+    def private_api_key
+      get_credentials
+      @credentials[1]
+    end
+
+    def get_credentials
+      return if @credentials
+      unless @credentials = read_credentials
+        ask_for_and_save_credentials
+      end
+      @credentials
+    end
+
+    def read_credentials
+      File.exists?(credentials_file) and File.read(credentials_file).split("\n")
+    end
+
+    include Spacialdb::Helpers
+
+    def credentials_file
+      if host == default_host
+        "#{home_directory}/.spacialdb/credentials"
+      else
+        "#{home_directory}/.spacialdb/credentials.#{host}"
+      end
+    end
+
+    def signup_for_credientials
+      puts "Sign up to Spacialdb."
+
+      print "Email: "
+      email = ask
+
+      print "Username: "
+      username = ask
+
+      print "Password: "
+      password = ask_for_password
+
+      print "Password confirmation: "
+      password_confirmation = ask_for_password
+
+      raise PasswordMismatch, "Password doesn't match confirmation." if password != password_confirmation
+
+      signup = Spacialdb::Client.signup(username, email, password, password_confirmation, host)
+      private_api_key = signup['private_api_key']
+      email = signup['email']
+
+      [email, private_api_key]
+    end
+
+    def ask_for_credentials
+      puts "Enter your Spacialdb credentials."
+
+      print "Email or Username: "
+      login = ask
+
+      print "Password: "
+      password = ask_for_password
+
+      auth = Spacialdb::Client.auth(login, password, host)
+      private_api_key = auth['private_api_key']
+      email = auth['email']
+
+      [email, private_api_key]
+    end
+
+    def ask_for_password
+      echo_off
+      password = ask
+      puts
+      echo_on
+      return password
+    end
+
+    def signup_and_save_credentials
+      begin
+        @credentials = signup_for_credientials
+        write_credentials
+      rescue ::RestClient::Unauthorized, ::RestClient::Forbidden => e
+        clear
+        display "Sign up failed:"
+        display e.response
+        exit 1
+      rescue PasswordMismatch => e
+        clear
+        display "Sign up failed:"
+        display e.message
+        exit 1
+      rescue Exception => e
+        delete_credentials
+        clear
+        display "Sign up failed:"
+        display e.message
+        raise e
+      end
+    end
+
+    def ask_for_and_save_credentials
+      begin
+        @credentials = ask_for_credentials
+        write_credentials
+      rescue ::RestClient::Unauthorized, ::RestClient::ResourceNotFound => e
+        delete_credentials
+        clear
+        display "Authentication failed."
+        exit 1
+      rescue Exception => e
+        delete_credentials
+        raise e
+      end
+    end
+
+    def write_credentials
+      FileUtils.mkdir_p(File.dirname(credentials_file))
+      f = File.open(credentials_file, 'w')
+      f.puts self.credentials
+      f.close
+      set_credentials_permissions
+    end
+
+    def set_credentials_permissions
+      FileUtils.chmod 0700, File.dirname(credentials_file)
+      FileUtils.chmod 0600, credentials_file
+    end
+
+    def delete_credentials
+      FileUtils.rm_f(credentials_file)
+      clear
+    end
+
+    def clear
+      @credentials = nil
+      @client = nil
+    end
+
+  end
+end

data/lib/spacialdb/client.rb

@@ -0,0 +1,102 @@
+require 'spacialdb/version'
+require 'spacialdb/auth'
+require 'spacialdb/helpers'
+require 'rest_client'
+
+class Spacialdb::Client
+
+  include Spacialdb::Helpers
+  extend Spacialdb::Helpers
+
+  def self.version
+    Spacialdb::VERSION
+  end
+
+  def self.gem_version_string
+    "spacialdb-gem/#{version}"
+  end
+
+  attr_accessor :host, :login, :password
+
+  def initialize(login, password, host=Spacialdb::Auth.default_host)
+    @login = login
+    @password = password
+    @host = host
+  end
+
+  def self.signup(username, email, password, password_confirmation, host=Spacialdb::Auth.default_host)
+    client = new(email, password, host)
+    json_decode client.post('/api/users',
+                            { :email => email,
+                              :username => username,
+                              :password => password,
+                              :password_confirmation => password_confirmation },
+                            :accept => 'json').to_s
+  end
+
+  def self.auth(login, password, host=Spacialdb::Auth.default_host)
+    client = new(login, password, host)
+    json_decode client.get('/api/users/credentials', :accept => 'json').to_s
+  end
+
+  def list
+    json_decode get('/api/databases', :accept => 'json').to_s
+  end
+
+  def create
+    post('/api/databases', '', :accept => 'json')
+  end
+
+  # Destroy the database permanently.
+  def destroy(name)
+    delete("/api/databases/#{name}", :accept => 'json').to_s
+  end
+
+  def get(uri, extra_headers={})    # :nodoc:
+    process(:get, uri, extra_headers)
+  end
+
+  def post(uri, payload="", extra_headers={})    # :nodoc:
+    process(:post, uri, extra_headers, payload)
+  end
+
+  def delete(uri, extra_headers={})    # :nodoc:
+    process(:delete, uri, extra_headers)
+  end
+
+  def process(method, uri, extra_headers={}, payload=nil)
+    headers  = spacialdb_headers.merge(extra_headers)
+    args     = [method, payload, headers].compact
+    response = resource(uri).send(*args)
+
+    response
+  end
+
+  def spacialdb_headers   # :nodoc:
+    {
+      'X-Spacialdb-API-Version' => '1',
+      'User-Agent'           => self.class.gem_version_string,
+      'X-Ruby-Version'       => RUBY_VERSION,
+      'X-Ruby-Platform'      => RUBY_PLATFORM
+    }
+  end
+
+  def resource(uri)
+    RestClient.proxy = ENV['HTTP_PROXY'] || ENV['http_proxy']
+    resource = RestClient::Resource.new(realize_full_uri(uri),
+      :user => login,
+      :password => password
+    )
+    resource
+  end
+
+  def realize_full_uri(given)
+    full_host = (host =~ /^http/) ? host : "http://#{host}"
+    host = URI.parse(full_host)
+    uri = URI.parse(given)
+    uri.host ||= host.host
+    uri.scheme ||= host.scheme || "http"
+    uri.path = (uri.path[0..0] == "/") ? uri.path : "/#{uri.path}"
+    uri.to_s
+  end
+end

data/lib/spacialdb/command/auth.rb

@@ -0,0 +1,36 @@
+require "spacialdb/command/base"
+
+# authentication (signup, login, logout)
+#
+class Spacialdb::Command::Auth < Spacialdb::Command::Base
+
+  # auth:signup
+  #
+  # sign up for a free plan with Spacialdb
+  #
+  def signup
+    Spacialdb::Auth.signup
+  end
+
+  alias_command "signup", "auth:signup"
+
+  # auth:login
+  #
+  # log in with your Spacialdb credentials
+  #
+  def login
+    Spacialdb::Auth.login
+  end
+
+  alias_command "login", "auth:login"
+
+  # auth:logout
+  #
+  # clear local authentication credentials
+  #
+  def logout
+    Spacialdb::Auth.logout
+  end
+
+  alias_command "logout", "auth:logout"
+end

data/lib/spacialdb/command/base.rb

@@ -0,0 +1,135 @@
+require "fileutils"
+require "spacialdb/client"
+require "spacialdb/command"
+
+class Spacialdb::Command::Base
+  include Spacialdb::Helpers
+
+  def self.namespace
+    self.to_s.split("::").last.downcase
+  end
+
+  attr_reader :args
+  attr_reader :options
+
+  def initialize(args=[], options={})
+    @args = args
+    @options = options
+  end
+
+  def spacialdb
+    Spacialdb::Auth.client
+  end
+
+protected
+
+  def self.inherited(klass)
+    help = extract_help(*(caller.first.split(":")[0..1])).strip
+
+    Spacialdb::Command.register_namespace(
+      :name => klass.namespace,
+      :description => help.split("\n").first
+    )
+  end
+
+  def self.method_added(method)
+    return if self == Spacialdb::Command::Base
+    return if private_method_defined?(method)
+    return if protected_method_defined?(method)
+
+    help = extract_help(*(caller.first.split(":")[0..1]))
+
+    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!("*", "")
+
+    Spacialdb::Command.register_command(
+      :klass       => self,
+      :method      => method,
+      :namespace   => self.namespace,
+      :command     => command,
+      :banner      => banner,
+      :help        => help,
+      :summary     => extract_summary(help),
+      :description => extract_description(help),
+      :options     => extract_options(help),
+      :permute     => permute
+    )
+  end
+
+  def self.alias_command(new, old)
+    raise "no such command: #{old}" unless Spacialdb::Command.commands[old]
+    Spacialdb::Command.command_aliases[new] = old
+  end
+
+  def self.extract_help(file, line)
+    buffer = []
+    lines  = File.read(file).split("\n")
+
+    catch(:done) do
+      (line.to_i-2).downto(1) do |i|
+        case lines[i].strip[0..0]
+          when "", "#" then buffer << lines[i]
+          else throw(:done)
+        end
+      end
+    end
+
+    buffer.map! do |line|
+      line.strip.gsub(/^#/, "")
+    end
+
+    buffer.reverse.join("\n").strip
+  end
+
+  def self.extract_command(help)
+    extract_banner(help).to_s.split(" ").first
+  end
+
+  def self.extract_banner(help)
+    help.split("\n").first
+  end
+
+  def self.extract_summary(help)
+    extract_description(help).split("\n").first
+  end
+
+  def self.extract_description(help)
+    lines = help.split("\n").map(&:strip)
+    lines.shift
+    lines.reject do |line|
+      line =~ /^-(.+)#(.+)/
+    end.join("\n").strip
+  end
+
+  def self.extract_options(help)
+    help.split("\n").map(&:strip).select do |line|
+      line =~ /^-(.+)#(.+)/
+    end.inject({}) do |hash, line|
+      description = line.split("#", 2).last.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
+  end
+
+  def extract_option(name, default=true)
+    key = name.gsub("--", "").to_sym
+    return unless options[key]
+    value = options[key] || default
+    block_given? ? yield(value) : value
+  end
+
+  def extract_db
+    if options[:db].is_a?(String)
+      options[:db]
+    else
+      raise Spacialdb::Command::CommandFailed, "No db specified.\nSpecify which db to use with --db <db name>"
+    end
+  end
+end

data/lib/spacialdb/command/db.rb

@@ -0,0 +1,41 @@
+require "spacialdb/command/base"
+
+# manage databases (create, destroy)
+#
+class Spacialdb::Command::Db < Spacialdb::Command::Base
+
+  # db
+  #
+  # list your databases
+  #
+  def index
+    display spacialdb.list.join("\n")
+  end
+
+  alias_command "list", "db"
+
+  # db:create
+  #
+  # create your databases
+  #
+  def create
+    display spacialdb.create
+  end
+
+  alias_command "create", "db:create"
+
+  # db:destroy
+  #
+  # permanently destroy a database
+  #
+  def destroy
+    db = extract_db
+    if confirm_command(db)
+      redisplay "Destroying #{db} ... "
+      spacialdb.destroy(db)
+      display "done"
+    end
+  end
+
+  alias_command "destroy", "db:destroy"
+end

data/lib/spacialdb/command/help.rb

@@ -0,0 +1,155 @@
+require "spacialdb/command/base"
+
+module Spacialdb::Command
+
+  # show this help
+  #
+  class Help < Base
+
+    class HelpGroup < Array
+      attr_reader :title
+
+      def initialize(title)
+        @title = title
+      end
+
+      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
+
+    def index
+      if command = args.shift
+        help_for_command(command)
+      else
+        help_for_root
+      end
+    end
+
+  private
+
+    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 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_command(command)
+      Spacialdb::Command::Help.groups.each do |group|
+        group.each do |cmd, description|
+          return description if cmd.split(" ").first == command
+        end
+      end
+      nil
+    end
+
+    PRIMARY_NAMESPACES = %w( auth db )
+
+    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 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_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
+      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
+
+      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
+end

data/lib/spacialdb/command/version.rb

@@ -0,0 +1,16 @@
+require "spacialdb/command/base"
+
+# display version
+#
+module Spacialdb::Command
+
+  # version
+  #
+  # show the spacialdb gem version
+  #
+  class Version < Base
+    def index
+      display Spacialdb::Client.gem_version_string
+    end
+  end
+end