engineyard-cloud-client 1.0.2 → 1.0.3

data/README.rdoc

@@ -1,7 +1,130 @@
-= engineyard-cloud-client
+= Engine Yard Cloud Client
 
-The API client for awsm. Extracted from the engineyard gem because this piece is often all a project needs for EY Cloud API usage.
+engineyard-cloud-client contains a Ruby api library to the Engine Yard Cloud API. Extracted from the engineyard gem.
 
-See engineyard gem for a usage example. Bother someone if this is released and the documentation is still not updated.
+Setup:
+
+    require 'engineyard-cloud-client'
+    require 'engineyard-cloud-client/test'
+
+    token  = EY::CloudClient.authenticate("your@email.com", "password")
+    ui = EY::CloudClient::Test::VerboseUI.new
+    # Test::VerboseUI is used in this example for simplicity.
+    # You may substitute your own ui object with #debug and #info methods
+
+    ey_api = EY::CloudClient.new(token, ui)
+
+Current User:
+
+    user = ey_api.current_user
+    user.class # => EY::CloudClient::User
+    user.name  # => "Your Name"
+    user.email # => "your@email.com"
+
+Apps:
+
+    apps = ey_api.apps # loads all your app data at once; caches result
+
+    app = apps.find {|app| app.name == 'myapp'}
+    app.class           # => EY::CloudClient::App
+    app.name            # => 'myapp'
+    app.id              # => 123
+    app.repository_uri  # => git@github.com:myaccount/myapp.git
+
+    app.account.class   # => EY::CloudClient::Account
+
+    app.app_environments.first.class # => EY::CloudClient::AppEnvironment
+    app.app_environments.map {|e| e.environment.name} # => ['myapp_production', 'myapp_staging']
+
+Create a new application (to be booted within Environments):
+
+    account = EY::CloudClient::Account.new(ey_api, {:id => 4212, :name => 'drnic'})
+    app = EY::CloudClient::App.create(ey_api,
+      "account"        => account
+      "name"           => "myapp",
+      "repository_uri" => "git@github.com:mycompany/myapp.git",
+      "app_type_id"    => "rails3",
+    })
+
+Valid `app_type_id` are: `rack, rails2, rails3, rails4, sinatra, nodejs`. For some your account may require an early access feature to be enabled.
+
+Accounts:
+
+    account = app.account
+    account.class   # => EY::CloudClient::Account
+    account.id      # => 1234
+    account.name    # => 'myaccount'
+
+Keypairs:
+
+Upload your SSH public keys before you create Environments.
+
+    keypair = EY::CloudClient::Keypair.create(ey_api, {
+      "name"       => 'laptop',
+      "public_key" => "ssh-rsa OTHERKEYPAIR"
+    })
+
+Environments:
+
+    envs = ey_api.environments # loads all your environment data at once; caches result
+
+    env = envs.find {|e| e.name == 'myapp_production'}
+    env.class             # => EY::CloudClient::Environment
+    env.name              # => 'myapp_production'
+    env.id                # => 2345
+    env.framework_env     # => "production"
+    env.app_server_stack_name     # => "nginx_thin"
+    env.deployment_configurations # => {"myapp"=>{"name"=>"myapp", "uri"=>nil, "migrate"=>{"command"=>"rake db:migrate", "perform"=>false}, "repository_uri"=>"git@github.com:myaccount/myapp.git", "id"=>123, "domain_name"=>"_"}}
+    env.load_balancer_ip_address  # => "1.2.3.4"
+
+    # if environment isn't booted
+    env.instances_count     # => 0
+    env.app_master          # => nil
+    env.instances.count     # => []
+
+    # if environment is booted
+    env.instances_count     # => 1
+    env.app_master.class    # => EY::CloudClient::Instance
+    env.instances.first.class # => EY::CloudClient::Instance
+
+Create a new environment (for a given App):
+
+    app = EY::CloudClient::App.new(ey_api, {:id => 4212, :name => 'drnic'})
+    env = EY::CloudClient::Environment.create(ey_api,
+      "app"                   => app,
+      "name"                  => 'myapp_production',
+      "app_server_stack_name" => 'nginx_thin',       # default: nginx_passenger3
+      "region"                => 'us-west-1',        # default: us-east-1
+      "framework_env"         => 'staging'           # default: production
+    })
+
+
+Valid `app_server_stack_name` values: `nginx_unicorn, nginx_passenger3, nginx_nodejs, nginx_thin, nginx_puma`. For some your account may require an early access feature to be enabled.
+
+Instances:
+
+    instance = env.instances.first
+    instance.class        # => EY::CloudClient::Instance
+    instance.id           # => 12345
+    instance.role         # => "solo"
+    instance.status       # => "running"
+    instance.amazon_id    # => "i-abcdefg"
+    instance.hostname     # => "ec2-1-2-3-4.compute-1.amazonaws.com"
+    instance.public_hostname # => "ec2-1-2-3-4.compute-1.amazonaws.com" # alias of hostname
+
+== Debugging:
+
+When $DEBUG is set, display debug information to the ui object using the #debug method. The API commands will print internal request information:
+
+    app = EY::CloudClient::App.create(ey_api, 'account' => account, 'name' => 'myapp2', 'repository_uri' => 'git@github.com:myaccount/myapp2.git', 'app_type_id' => 'rails3')
+           Token  YOURTOKEN
+         Request  POST https://cloud.engineyard.com/api/v2/accounts/1234/apps
+          Params  {"app"=>{"name"=>"myapp2", "app_type_id"=>"rails3", "repository_uri"=>"git@github.com:myaccount/myapp2.git"}}
+        Response
+    {"app"=>
+      {"environments"=>[],
+       "name"=>"myapp2",
+       "repository_uri"=>"git@github.com:myaccount/myapp2.git",
+       "account"=>{"name"=>"myaccount", "id"=>1234},
+       "id"=>12345}}
 
-This is currently unreleased.

data/lib/engineyard-cloud-client.rb

@@ -127,7 +127,7 @@ module EY
         data = ''
       elsif resp.headers[:content_type] =~ /application\/json/
         begin
-          data = MultiJson.decode(resp.body)
+          data = MultiJson.load(resp.body)
           ui.debug("Response", "\n" + data.pretty_inspect)
         rescue MultiJson::DecodeError
           ui.debug("Raw response", resp.body)

data/lib/engineyard-cloud-client/model_registry.rb

@@ -12,8 +12,8 @@ module EY
       end
 
       def set(klass, obj)
-        if obj.respond_to?(:id) && id = obj.id
-          @registry[klass][id] = obj
+        if obj.respond_to?(:id) && obj.id
+          @registry[klass][obj.id] = obj
         end
       end
     end

data/lib/engineyard-cloud-client/models/app.rb

@@ -53,6 +53,16 @@ module EY
         existing_app_env || app_env
       end
 
+      def attributes=(attrs)
+        account_attrs      = attrs.delete('account')
+        environments_attrs = attrs.delete('environments')
+        super
+        set_account      account_attrs      if account_attrs
+        set_environments environments_attrs if environments_attrs
+      end
+
+      protected
+
       def set_account(account_attrs)
         @account = Account.from_hash(api, account_attrs)
         @account.add_app(self)
@@ -64,14 +74,6 @@ module EY
           AppEnvironment.from_hash(api, {'app' => self, 'environment' => env})
         end
       end
-
-      def attributes=(attrs)
-        account_attrs      = attrs.delete('account')
-        environments_attrs = attrs.delete('environments')
-        super
-        set_account      account_attrs      if account_attrs
-        set_environments environments_attrs if environments_attrs
-      end
     end
   end
 end

data/lib/engineyard-cloud-client/models/app_environment.rb

@@ -27,18 +27,6 @@ module EY
         raise ArgumentError, 'AppEnvironment created without environment!' unless environment
       end
 
-      def set_app(app_or_hash)
-        self.app = App.from_hash(api, app_or_hash)
-        app.add_app_environment(self)
-        app
-      end
-
-      def set_environment(env_or_hash)
-        self.environment = Environment.from_hash(api, env_or_hash)
-        environment.add_app_environment(self)
-        environment
-      end
-
       def attributes=(attrs)
         app_attrs         = attrs.delete('app')
         environment_attrs = attrs.delete('environment')
@@ -75,6 +63,20 @@ module EY
         Deployment.from_hash(api, attrs.merge(:app_environment => self))
       end
 
+      protected
+
+      def set_app(app_or_hash)
+        self.app = App.from_hash(api, app_or_hash)
+        app.add_app_environment(self)
+        app
+      end
+
+      def set_environment(env_or_hash)
+        self.environment = Environment.from_hash(api, env_or_hash)
+        environment.add_app_environment(self)
+        environment
+      end
+
     end
   end
 end

data/lib/engineyard-cloud-client/models/environment.rb

@@ -1,6 +1,6 @@
 require 'engineyard-cloud-client/models'
+require 'engineyard-cloud-client/models/recipes'
 require 'engineyard-cloud-client/errors'
-require 'tempfile'
 
 module EY
   class CloudClient
@@ -8,59 +8,6 @@ module EY
                                       :username, :app_server_stack_name,
                                       :load_balancer_ip_address
                                      )
-      attr_accessor :apps, :account
-
-      def attributes=(attrs)
-        account_attrs    = attrs.delete('account')
-        apps_attrs       = attrs.delete('apps')
-        instances_attrs  = attrs.delete('instances')
-
-        super
-
-        set_account   account_attrs   if account_attrs
-        set_apps      apps_attrs      if apps_attrs
-        set_instances instances_attrs if instances_attrs
-      end
-
-      def add_app_environment(app_env)
-        @app_environments ||= []
-        existing_app_env = @app_environments.detect { |ae| app_env.environment == ae.environment }
-        unless existing_app_env
-          @app_environments << app_env
-        end
-        existing_app_env || app_env
-      end
-
-      def app_environments
-        @app_environments ||= []
-      end
-
-      def set_account(account_attrs)
-        @account = Account.from_hash(api, account_attrs)
-        @account.add_environment(self)
-        @account
-      end
-
-      # Creating an AppEnvironment will come back and call add_app_environment
-      # (above) to associate this model with the AppEnvironment. (that's why we
-      # don't save anything here.)
-      def set_apps(apps_attrs)
-        (apps_attrs || []).each do |app|
-          AppEnvironment.from_hash(api, {'app' => app, 'environment' => self})
-        end
-      end
-
-      def apps
-        app_environments.map { |app_env| app_env.app }
-      end
-
-      def set_instances(instances_attrs)
-        @instances = load_instances(instances_attrs)
-      end
-
-      def instances
-        @instances ||= request_instances
-      end
 
       # Return list of all Environments linked to all current user's accounts
       def self.all(api)
@@ -108,6 +55,40 @@ module EY
         response = api.request("/apps/#{app.id}/environments", :method => :post, :params => params)
         self.from_hash(api, response['environment'])
       end
+      attr_accessor :apps, :account
+
+      def attributes=(attrs)
+        account_attrs    = attrs.delete('account')
+        apps_attrs       = attrs.delete('apps')
+        instances_attrs  = attrs.delete('instances')
+
+        super
+
+        set_account   account_attrs   if account_attrs
+        set_apps      apps_attrs      if apps_attrs
+        set_instances instances_attrs if instances_attrs
+      end
+
+      def add_app_environment(app_env)
+        @app_environments ||= []
+        existing_app_env = @app_environments.detect { |ae| app_env.environment == ae.environment }
+        unless existing_app_env
+          @app_environments << app_env
+        end
+        existing_app_env || app_env
+      end
+
+      def app_environments
+        @app_environments ||= []
+      end
+
+      def apps
+        app_environments.map { |app_env| app_env.app }
+      end
+
+      def instances
+        @instances ||= request_instances
+      end
 
       def account_name
         account && account.name
@@ -144,51 +125,61 @@ module EY
       end
       alias rebuild update
 
+      def recipes
+        Recipes.new(api, self)
+      end
+
+      # See Recipes#run
       def run_custom_recipes
-        api.request("/environments/#{id}/run_custom_recipes", :method => :put)
-        true
+        recipes.run
       end
 
+      # See Recipes#download
       def download_recipes
-        tmp = Tempfile.new("recipes")
-        data = api.request("/environments/#{id}/recipes")
-        tmp.write(data)
-        tmp.flush
-        tmp.close
-        tmp
+        recipes.download
       end
 
+      # See Recipes#upload_path
       def upload_recipes_at_path(recipes_path)
-        recipes_path = Pathname.new(recipes_path)
-        if recipes_path.exist?
-          upload_recipes recipes_path.open('rb')
-        else
-          raise EY::CloudClient::Error, "Recipes file not found: #{recipes_path}"
-        end
+        recipes.upload_path(recipes_path)
       end
 
-      # Expects a File object opened for binary reading.
-      # i.e. File.open(path, 'rb')
+      # See Recipes#upload
       def upload_recipes(file_to_upload)
-        api.request("/environments/#{id}/recipes", {
-          :method => :post,
-          :params => {:file => file_to_upload}
-        })
-        true
+        recipes.upload(file_to_upload)
       end
 
       def shorten_name_for(app)
         name.gsub(/^#{Regexp.quote(app.name)}_/, '')
       end
 
-      private
+      protected
+
+      def set_account(account_attrs)
+        @account = Account.from_hash(api, account_attrs)
+        @account.add_environment(self)
+        @account
+      end
+
+      # Creating an AppEnvironment will come back and call add_app_environment
+      # (above) to associate this model with the AppEnvironment. (that's why we
+      # don't save anything here.)
+      def set_apps(apps_attrs)
+        (apps_attrs || []).each do |app|
+          AppEnvironment.from_hash(api, {'app' => app, 'environment' => self})
+        end
+      end
+
+      def set_instances(instances_attrs)
+        @instances = load_instances(instances_attrs)
+      end
 
       def request_instances
-        if instances_count > 0
+        if instances_count.zero?
+          []
+        else
           instances_attrs = api.request("/environments/#{id}/instances")["instances"]
           load_instances(instances_attrs)
-        else
-          []
         end
       end
 

data/lib/engineyard-cloud-client/models/recipes.rb

@@ -0,0 +1,49 @@
+require 'tempfile'
+require 'engineyard-cloud-client/errors'
+
+module EY
+  class CloudClient
+    class Recipes
+      attr_reader :api, :environment
+
+      def initialize(api, environment)
+        @api = api
+        @environment = environment
+      end
+
+      def run
+        api.request("/environments/#{environment.id}/run_custom_recipes", :method => :put)
+        true
+      end
+
+      def download
+        tmp = Tempfile.new("recipes")
+        data = api.request("/environments/#{environment.id}/recipes")
+        tmp.write(data)
+        tmp.flush
+        tmp.close
+        tmp
+      end
+
+      def upload_path(recipes_path)
+        recipes_path = Pathname.new(recipes_path)
+        if recipes_path.exist?
+          upload recipes_path.open('rb')
+        else
+          raise EY::CloudClient::Error, "Recipes file not found: #{recipes_path}"
+        end
+      end
+
+      # Expects a File object opened for binary reading.
+      # i.e. upload(File.open(recipes_path, 'rb'))
+      def upload(file_to_upload)
+        api.request("/environments/#{environment.id}/recipes", {
+          :method => :post,
+          :params => {:file => file_to_upload}
+        })
+        true
+      end
+
+    end
+  end
+end

data/lib/engineyard-cloud-client/test/scenario.rb

@@ -16,7 +16,7 @@ module EY::CloudClient::Test
 
     def self.load_scenarios
       response = ::RestClient.get(EY::CloudClient::Test::FakeAwsm.uri.sub(/\/?$/,'/scenarios'))
-      data = MultiJson.decode(response)
+      data = MultiJson.load(response)
       data['scenarios'].inject({}) do |hsh, scenario|
         hsh[scenario['name']] = new(scenario)
         hsh

data/lib/engineyard-cloud-client/version.rb

@@ -1,7 +1,7 @@
 # This file is maintained by a herd of rabid monkeys with Rakes.
 module EY
   class CloudClient
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 end
 # Please be aware that the monkeys like tho throw poo sometimes.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: engineyard-cloud-client
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000 Z
+date: 2012-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -284,6 +284,7 @@ files:
 - lib/engineyard-cloud-client/models/instance.rb
 - lib/engineyard-cloud-client/models/keypair.rb
 - lib/engineyard-cloud-client/models/log.rb
+- lib/engineyard-cloud-client/models/recipes.rb
 - lib/engineyard-cloud-client/models/user.rb
 - lib/engineyard-cloud-client/models.rb
 - lib/engineyard-cloud-client/resolver_result.rb
@@ -347,7 +348,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 551294076899789604
+      hash: -4133734354650536829
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -356,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 551294076899789604
+      hash: -4133734354650536829
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24