ey_instance_api_client 0.1.1

data/lib/ey_instance_api_client/backup.rb

@@ -0,0 +1,56 @@
+module EY
+  module InstanceAPIClient
+    class Backup
+      def initialize(connection, attributes)
+        @connection = connection
+        @attributes = attributes
+      end
+
+      def upload_urls
+        @attributes['upload_urls']
+      end
+
+      def download_urls
+        @attributes['download_urls']
+      end
+
+      def finish_url
+        @attributes['finish_url']
+      end
+
+      def extension
+        @attributes["extension"]
+      end
+
+      def started_at
+        if started_at = @attributes['started_at']
+          Time.at(started_at)
+        end
+      end
+
+      def finished_at
+        if finished_at = @attributes['finished_at']
+          Time.at(finished_at)
+        end
+      end
+
+      def pending?
+        status == "pending"
+      end
+
+      def status
+        if finished_at
+          "finished"
+        elsif started_at
+          "pending"
+        else
+          "unknown"
+        end
+      end
+
+      def finish!
+        @connection.finish_backup(finish_url)
+      end
+    end
+  end
+end

data/lib/ey_instance_api_client/config.rb

@@ -0,0 +1,28 @@
+module EY
+  module InstanceAPIClient
+    class Config
+      def self.default_config
+        Config.from_file("/etc/engineyard/instance_api.yml")
+      end
+
+      class MissingConfig < StandardError; end
+
+      def self.from_file(file)
+        config = YAML::load_file(file)
+        base_url = config['base_url'] || (raise MissingConfig.new("couldn't find base_url in #{file.inspect}"))
+        instance_id = config['instance_id'] || (raise MissingConfig.new("couldn't find instance_id in #{file.inspect}"))
+        token = config['token'] || (raise MissingConfig.new("couldn't find token in #{file.inspect}"))
+        new(base_url, instance_id, token)
+      end
+
+      def initialize(base_url, instance_id, token)
+        @base_url = base_url
+        @instance_id = instance_id
+        @token = token
+      end
+
+      attr_reader :base_url, :instance_id, :token
+
+    end
+  end
+end

data/lib/ey_instance_api_client/connection.rb

@@ -0,0 +1,81 @@
+module EY
+  module InstanceAPIClient
+    class Connection
+      def initialize(base_url, instance_id, token)
+        unless base_url.match(/\/$/)
+          base_url += '/'
+        end
+        @base_url = base_url
+        @instance_id = instance_id
+        @token = token
+      end
+      attr_reader :base_url
+
+#PUBLIC API:
+
+      def list_snapshots
+        r = api_call(snapshots_url, 200)
+        data = r.get(:params => params, :accept => "application/json")
+        data["snapshots"].collect{ |s| Snapshot.new(s) }
+      end
+
+      def request_snapshot
+        r = api_call(snapshots_url, 201)
+        r.post(params, :accept => "application/json")
+      end
+
+      def list_backups(database_id)
+        r = api_call(database_url(database_id), 200)
+        data = r.get(:params => params, :accept => "application/json")
+        data["backups"].collect{ |b| Backup.new(self, b) }
+      end
+
+      def start_backup(database_id, extension, part_count)
+        r = api_call(database_url(database_id), 201)
+        data = r.post(params.merge(:extension => extension, :part_count => part_count), :accept => "application/json")
+        Backup.new(self, data["backup"])
+      end
+
+#SORTA-PRIVATE stuff:
+
+      def snapshots_url
+        URI.join(@base_url, "volumes/all/snapshots").to_s
+      end
+
+      def database_url(database_id)
+        URI.join(@base_url, "databases/#{database_id}/backups").to_s
+      end
+
+      def finish_backup(finished_url)
+        r = api_call(finished_url, 200)
+        r.put(params, :accept => "application/json")
+      end
+
+      def params
+        {:token => @token, :instance_id => @instance_id}
+      end
+
+      class InvalidCredentials < StandardError; end
+      class UnexpectedStatus < StandardError; end
+      class AlreadyFinished < StandardError; end
+      class NotFound < StandardError; end
+
+      def api_call(full_url, expects)
+        RestClient::Resource.new(full_url.to_s) do |response, request, raw|
+          case response.code
+          when 403
+            raise InvalidCredentials
+          when 404
+            raise NotFound
+          when 409
+            raise AlreadyFinished
+          when expects
+            JSON.parse(response)
+          else
+            raise UnexpectedStatus, "request to #{full_url} failed with #{response.code}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ey_instance_api_client/snapshot.rb

@@ -0,0 +1,29 @@
+module EY
+  module InstanceAPIClient
+    class Snapshot
+      def initialize(attributes)
+        @attributes = attributes
+      end
+
+      def state
+        @attributes['state']
+      end
+
+      def progress
+        @attributes['progress']
+      end
+
+      def volume
+        @attributes['volume_type']
+      end
+
+      def id
+        @attributes['snapshot_id']
+      end
+
+      def created_at
+        Time.parse(@attributes['created_at'])
+      end
+    end
+  end
+end

data/lib/ey_instance_api_client/version.rb

@@ -0,0 +1,5 @@
+module EY
+  module InstanceAPIClient
+    VERSION = "0.1.1"
+  end
+end

data/lib/ey_instance_api_client.rb

@@ -0,0 +1,43 @@
+# $:.shift(File.expand_path(__FILE__))
+require 'json'
+require 'rest-client'
+require 'ey_instance_api_client/snapshot'
+require 'ey_instance_api_client/backup'
+require 'ey_instance_api_client/connection'
+require 'ey_instance_api_client/config'
+
+module EY
+  module InstanceAPIClient
+
+    class Client
+      def initialize(config = Config.default_config)
+        @backend = Connection.new(config.base_url, config.instance_id, config.token)
+      end
+      attr_reader :backend
+      def base_url
+        @backend.base_url
+      end
+    end
+
+    class Snapshots < Client
+      def list
+        @backend.list_snapshots
+      end
+
+      def request
+        @backend.request_snapshot
+      end
+    end
+
+    class Backups < Client
+      def list(database_id)
+        @backend.list_backups(database_id)
+      end
+
+      def start(database_id, extension, part_count)
+        @backend.start_backup(database_id, extension, part_count)
+      end
+    end
+
+  end
+end

data/spec/backup_client_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe "Backups" do
+  before do
+    start_server("backup_base_config")
+  end
+
+  after do
+    stop_server
+  end
+
+  describe "with an invalid creds" do
+    it "returns 403 when the token is invalid" do
+      client = EY::InstanceAPIClient::Backups.new(EY::InstanceAPIClient::Config.new(base_url, "my-instance", "invalid-creds"))
+      lambda { client.list("doesntmatter") }.
+        should raise_error(EY::InstanceAPIClient::Connection::InvalidCredentials)
+    end
+  end
+
+  describe "starting a backup for non-existant database" do
+    it "return 404" do
+      client = EY::InstanceAPIClient::Backups.new(EY::InstanceAPIClient::Config.new(base_url, "my-instance", "token-for-my-instance"))
+      lambda { client.list("nonexistant") }.
+        should raise_error(EY::InstanceAPIClient::Connection::NotFound)
+    end
+  end
+
+  context "with an database that exists" do
+    before do
+      @database_id = "database-1"
+      @client = EY::InstanceAPIClient::Backups.new(EY::InstanceAPIClient::Config.new(base_url, "my-instance", "token-for-my-instance"))
+    end
+
+    describe "listing backups" do
+      it "Makes a request and Gets an empty list" do
+        list = @client.list(@database_id)
+        list.should == []
+      end
+
+    end
+
+    describe "starting a backup" do
+      before do
+        @backup = @client.start(@database_id, ".gz", 1)
+      end
+
+      it "returns the upload and finished url" do
+        @backup.should have(1).upload_urls
+        @backup.upload_urls.first.should =~ %r{^http://s3/PUT}
+        @backup.finish_url.should =~ %r{#{base_url}}
+        @backup.status.should == "pending"
+      end
+
+      it "should show started_at in the listing" do
+        list = @client.list(@database_id)
+        list.size.should == 1
+        backup = list.first
+        backup.status.should == "pending"
+        backup.started_at.should_not be_nil
+        backup.download_urls.should be_nil
+        backup.upload_urls.should be_nil
+        backup.finished_at.should be_nil
+      end
+
+      describe "finishing that backup" do
+        before do
+          @backup.finish!
+        end
+
+        it "should show finished_at in the listing" do
+          list = @client.list(@database_id)
+          list.size.should == 1
+          backup = list.first
+          backup.should have(1).download_urls
+          backup.download_urls.first.should =~ %r{^http://s3/GET}
+          backup.upload_urls.should be_nil
+          backup.started_at.should_not be_nil
+          backup.finished_at.should_not be_nil
+        end
+
+        it "should return 409 if you attempt to finish it again" do
+          lambda { @backup.finish! }.
+            should raise_error(EY::InstanceAPIClient::Connection::AlreadyFinished)
+        end
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe "Config" do
+
+  describe "default_config" do
+    before(:each) do
+      YAML.stub!(:load_file).and_return do |path, *args|
+        if path =~ %r"/etc/engineyard/instance_api\.yml"
+          {
+            "base_url"    => "http://localhost/",
+            "instance_id" => "my-instance",
+            "token"       => "token"
+          }
+        end
+      end
+      EY::InstanceAPIClient::Connection.stub!(:new) do |*args|
+        @connection_called_with = args
+      end
+    end
+
+    it "Backups should load config from /etc/engineyard/instance_api.yml" do
+      EY::InstanceAPIClient::Backups.new
+      @connection_called_with.should == ["http://localhost/", "my-instance", "token"]
+    end
+
+    it "Snapshots should load config from /etc/engineyard/instance_api.yml" do
+      EY::InstanceAPIClient::Snapshots.new
+      @connection_called_with.should == ["http://localhost/", "my-instance", "token"]
+    end
+  end
+
+  it "ensures base_url ends in a slash" do
+    client = EY::InstanceAPIClient::Snapshots.new(EY::InstanceAPIClient::Config.new("http://localhost/end-point-without-a-slash", "some-instance", "some-creds"))
+    client.base_url.should == "http://localhost/end-point-without-a-slash/"
+    client = EY::InstanceAPIClient::Backups.new(EY::InstanceAPIClient::Config.new("http://localhost/end-point-without-a-slash", "some-instance", "some-creds"))
+    client.base_url.should == "http://localhost/end-point-without-a-slash/"
+  end
+
+end

data/spec/fixtures/backup_base_config.ru

@@ -0,0 +1,82 @@
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../../../server/lib')
+require 'ey_instance_api_server'
+require 'ey_instance_api_server/backups/example_callback'
+
+class MyCallback < EY::InstanceAPIServer::Backups::ExampleCallback
+  def initialize(base_url, s3_base_url, automatic_databases, real_s3)
+    super(base_url)
+    @s3_base_url = s3_base_url
+    @automatic_databases = automatic_databases
+    @real_s3 = real_s3
+  end
+
+  def download_url_for(backup_id, part)
+    if @real_s3
+      URI.join(@s3_base_url, "files/#{backup_id}.part#{part}").to_s
+    else
+      super
+    end
+  end
+
+  def upload_url_for(backup_id, part)
+    if @real_s3
+      download_url_for(backup_id, part)
+    else
+      super
+    end
+  end
+
+  def backups_for(instance_id, database_id)
+    if @automatic_databases
+      add_database(instance_id, database_id)
+    end
+    super
+  end
+end
+
+base_url = ENV["BASE_URL"] || abort("Provide a base url")
+automatic_databases = ENV["AUTO_DATABASES"] == "true"
+real_s3 = ENV["REAL_S3"] == "true"
+
+callback = MyCallback.new(URI.join(base_url, "api/").to_s, URI.join(base_url, "s3/").to_s, automatic_databases, real_s3)
+callback.add_instance("my-instance")
+callback.add_database("my-instance", "database-1")
+EY::InstanceAPIServer.callback_module = callback
+
+class S3Fake < Sinatra::Base
+  enable :raise_errors
+  disable :dump_errors
+  disable :show_exceptions
+
+  def files
+    @@files ||= {}
+  end
+
+  get "/files/:id" do |id|
+    puts "downloading file from #{id.inspect}"
+    files[id] || not_found
+  end
+
+  put "/files/:id" do |id|
+    unless request.content_type == "application/octet-stream"
+      raise "Incorrect content type: #{request.content_type}"
+    end
+    puts "uploading file to #{id.inspect}"
+    files[id] = request.body.read
+  end
+end
+
+map "/s3" do
+  run S3Fake
+end
+
+map "/api" do
+  run EY::InstanceAPIServer.app
+end
+
+map "/" do
+  run lambda {
+    Rack::Response.new("hello").finish
+  }
+end

data/spec/fixtures/snapshot_base_config.ru

@@ -0,0 +1,45 @@
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../../../server/lib')
+require 'ey_instance_api_server'
+require 'ey_instance_api_server/snapshots/example_callback'
+
+class MyCallback < EY::InstanceAPIServer::Snapshots::ExampleCallback
+  def initialize(base_url)
+    super(base_url)
+  end
+
+  def perform_all
+    @instances.each do |instance_id, instance|
+      instance[:volumes].each do |volume_id, volume|
+        volume[:snapshots].each do |snapshot_id, snapshot|
+          perform_snapshots_for(instance_id, volume_id, snapshot_id)
+        end
+      end
+    end
+  end
+
+end
+
+base_url = ENV["BASE_URL"] || abort("Provide a base url")
+
+callback = MyCallback.new(URI.join(base_url, "api/"))
+callback.add_instance("my-instance")
+callback.add_volume("my-instance", "volume-1", "db")
+EY::InstanceAPIServer.callback_module = callback
+
+map "/api/peform_all" do
+  run lambda {
+    callback.perform_all
+    Rack::Response.new("{}").finish
+  }
+end
+
+map "/api" do
+  run EY::InstanceAPIServer.app
+end
+
+map "/" do
+  run lambda {
+    Rack::Response.new("hello").finish
+  }
+end

data/spec/snapshot_client_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe "Snapshots" do
+  before do
+    start_server("snapshot_base_config")
+  end
+
+  after do
+    stop_server
+  end
+
+  describe "with an invalid creds" do
+    it "returns 403 when the token is invalid" do
+      client = EY::InstanceAPIClient::Snapshots.new(EY::InstanceAPIClient::Config.new(base_url, "my-instance", "invalid-creds"))
+      lambda { client.list }.
+        should raise_error(EY::InstanceAPIClient::Connection::InvalidCredentials)
+    end
+  end
+
+  context "with an instance that exists" do
+    before do
+      @instance_id = 'my-instance'
+      @volume_id   = 'volume-1'
+      @client = EY::InstanceAPIClient::Snapshots.new(EY::InstanceAPIClient::Config.new(base_url, "my-instance", "token-for-my-instance"))
+    end
+
+    describe "listing snapshots" do
+      it "Makes a request and Gets an empty list" do
+        list = @client.list
+        list.should == []
+      end
+    end
+
+     describe "requesting a snapshot" do
+       before do
+         @client.request
+       end
+
+       it "should show a requested snapshot in the list" do
+         list = @client.list
+         list.size.should == 1
+         snapshot = list.first
+         snapshot.state.should == "requested"
+         snapshot.progress.should be_nil
+         snapshot.volume.should == 'db' #should be one of 'util', 'data', 'db' 
+         snapshot.id.should_not be_nil
+         snapshot.created_at.should be_within(4).of(Time.now)
+       end
+
+       describe "when the snapshot is performed" do
+         before do
+           @client.backend.api_call(URI.join(base_url, "peform_all").to_s, 200).post({})
+         end
+
+         it "should show in the listing" do
+           list = @client.list
+           list.size.should == 1
+           snapshot = list.first
+           snapshot.state.should == "in progress"
+           snapshot.progress.should == "0%"
+           snapshot.volume.should == 'db' #should be one of 'util', 'data', 'db' 
+           snapshot.id.should_not be_nil
+           snapshot.created_at.should be_within(4).of(Time.now)
+         end
+
+       end
+     end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+Bundler.require(:test)
+
+require 'ey_instance_api_client'
+
+module Helpers
+  def start_server(config)
+    config_ru = File.dirname(__FILE__) + "/fixtures/#{config}.ru"
+    @server = RealWeb.start_server(config_ru, Proc.new do |server|
+      ENV["BASE_URL"] = server_url_for(server.port)
+    end)
+  end
+
+  def stop_server
+    @server.stop
+  end
+
+  def server_url
+    server_url_for(@server.port)
+  end
+
+  def server_url_for(port)
+    "http://127.0.0.1:#{port}/"
+  end
+
+  def base_url
+    URI.join(server_url, "api/").to_s
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification 
+name: ey_instance_api_client
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Engine Yard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-23 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: realweb
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 1
+        - 6
+        version: 0.1.6
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: fog
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: Used by backups and snapshots
+email: 
+- gems@engineyard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ey_instance_api_client/backup.rb
+- lib/ey_instance_api_client/config.rb
+- lib/ey_instance_api_client/connection.rb
+- lib/ey_instance_api_client/snapshot.rb
+- lib/ey_instance_api_client/version.rb
+- lib/ey_instance_api_client.rb
+- spec/backup_client_spec.rb
+- spec/config_spec.rb
+- spec/fixtures/backup_base_config.ru
+- spec/fixtures/snapshot_base_config.ru
+- spec/snapshot_client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/engineyard/ey_instance_api_client
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Client libraries used to consume instance api exposed by AWSM.
+test_files: 
+- spec/backup_client_spec.rb
+- spec/config_spec.rb
+- spec/fixtures/backup_base_config.ru
+- spec/fixtures/snapshot_base_config.ru
+- spec/snapshot_client_spec.rb
+- spec/spec_helper.rb