engineyard-cloud-client 1.0.7 → 1.0.8

data/ChangeLog.md

@@ -0,0 +1,46 @@
+# ChangeLog
+
+## NEXT
+
+  *
+
+## v1.0.8 (2013-02-14)
+
+  * Loosen the multi\_json gem version requirement to allow 1.0 compatible security fixes.
+
+## v1.0.7 (2012-10-25)
+
+  * Send serverside\_version to the deployment API when starting a deploy.
+
+## v1.0.6 (2012-08-20)
+
+  *
+
+## v1.0.5 (2012-08-14)
+
+  *
+
+## v1.0.4 (2012-08-14)
+
+  * Send input\_ref to deployments in the extra config.
+  * Use Connection object to take over for all api communication, simplifying the CloudClient class.
+  * Interface for creating a CloudClient has changed to support new Connection class.
+
+## v1.0.3 (2012-06-13)
+
+  *
+
+## v1.0.2 (2012-05-29)
+
+  *
+
+## v1.0.1 (2012-05-22)
+
+  * Includes fixes for deployment test harness used by this gem and engineyard gem
+
+## v1.0.0 (2012-05-22)
+
+  * First attempt at a real release.
+  * Provides all the functionality that is needed for engineyard gem to operate.
+  * Like Torchwood, The Colbert Report, and The Cleveland Show, start CloudClient's new life as a spin-off.
+

data/{README.rdoc → README.md}

@@ -1,6 +1,29 @@
-= Engine Yard Cloud Client
+# Engine Yard Cloud Client
 
-engineyard-cloud-client contains a Ruby api library to the Engine Yard Cloud API. Extracted from the engineyard gem.
+engineyard-cloud-client contains a Ruby api library to the Engine Yard Cloud API. Extracted from the [engineyard gem](https://github.com/engineyard/engineyard).
+
+## Use at your own risk
+
+At this time, cloud-client is not documented for public use. It was created to
+be used by the engineyard gem with the hopes of eventually providing a public
+api client, but it's still in its infancy.
+
+If you would like to use this gem directly instead of interfacing with the
+engineyard gem, you will likely be on your own. We may be available to answer
+questions about the gem, but the gem itself is not currently a supported public
+interface to Engine Yard Cloud.
+
+This gem accesses API actions that can alter your dashboard and settings. If
+used incorrectly, it could lead to problems. As we work towards making this a
+reliable public client, the interface may change.
+
+If you intend to use this gem, please lock to an exact version and pay close
+attention to newly released versions and changes to the interface.
+
+Please [open github issues](https://github.com/engineyard/engineyard-cloud-client/issues)
+for any problems you encounter.
+
+## Usage
 
 Setup:
 
@@ -112,7 +135,7 @@ Instances:
     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:
+## Debugging:
 
 When $DEBUG is set, display debug information to the ui object using the #debug method. The API commands will print internal request information:
 

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

@@ -62,10 +62,26 @@ module EY
         Deployment.last(api, self)
       end
 
+      # Create a new, unsaved, Deployment record.
+      #
+      # Call start on the return object to indicate to EY Cloud that you
+      # will be starting a deployment using your own connection to your
+      # servers. This is the way that the engineyard gem does deployments.
       def new_deployment(attrs)
         Deployment.from_hash(api, attrs.merge(:app_environment => self))
       end
 
+      # Trigger a deployment on the api side.
+      #
+      # This is like hitting the deploy button on the web interface.
+      #
+      # Returns a started deployment that will run from EY Cloud automatically.
+      # Load the deployment again to see when it finishes. This action returns
+      # immediately before the deployment is complete.
+      def deploy(attrs)
+        Deployment.deploy(api, self, attrs)
+      end
+
       protected
 
       def set_app(app_or_hash)

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

@@ -27,6 +27,10 @@ module EY
         dep
       end
 
+      def self.deploy(api, app_environment, attrs)
+        Deployment.from_hash(api, attrs.merge(:app_environment => app_environment)).deploy
+      end
+
       def app
         app_environment.app
       end
@@ -60,6 +64,10 @@ module EY
         @config ||= {'input_ref' => ref, 'deployed_by' => deployed_by}.merge(extra_config)
       end
 
+      # Tell EY Cloud that you will be starting a deploy yourself.
+      #
+      # The name for this method isn't great. It's a relic of how the deploy
+      # ran before it ever told EY Cloud that is was running a deploy at all.
       def start
         params = {
           :migrate => migrate,
@@ -70,6 +78,21 @@ module EY
         post_to_api(params)
       end
 
+      # Tell EY Cloud to deploy on our behalf.
+      #
+      # Deploy is different from start in that it triggers the deploy remotely.
+      # This is almost exactly equivalent to pressing the deploy button on the
+      # dashboard. No output will be returned.
+      def deploy
+        params = {
+          :migrate => migrate,
+          :ref => ref,
+        }
+        params[:serverside_version] = serverside_version if serverside_version
+        params[:migrate_command] = migrate_command if migrate
+        update_with_response api.post(collection_uri + "/deploy", 'deployment' => params)
+      end
+
       def output
         @output ||= StringIO.new
       end
@@ -95,6 +118,7 @@ module EY
         response['deployment'].each do |key,val|
           send("#{key}=", val) if respond_to?("#{key}=")
         end
+        self
       end
 
       private

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

@@ -114,8 +114,12 @@ module EY
         Log.from_array(api, api.get("/environments/#{id}/logs")["logs"])
       end
 
+      def provisioned_instances
+        instances.select { |inst| inst.provisioned? }
+      end
+
       def deploy_to_instances
-        instances.select { |inst| inst.has_app_code? }
+        provisioned_instances.select { |inst| inst.has_app_code? }
       end
 
       def bridge
@@ -125,7 +129,7 @@ module EY
       def bridge!(ignore_bad_bridge = false)
         if bridge.nil?
           raise NoBridgeError.new(name)
-        elsif !ignore_bad_bridge && bridge.status != "running"
+        elsif !ignore_bad_bridge && !bridge.running?
           raise BadBridgeStatusError.new(bridge.status, api.endpoint)
         end
         bridge

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

@@ -10,6 +10,13 @@ module EY
         !["db_master", "db_slave"].include?(role.to_s)
       end
 
+      def running?
+        status == "running"
+      end
+
+      def provisioned?
+        hostname && role && status != "starting" # not foolproof, but help throw out bad instances
+      end
     end
   end
 end

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

@@ -15,7 +15,7 @@ module EY::CloudClient::Test
       unless system("ruby -c '#{config_ru}' > /dev/null")
         raise SyntaxError, "There is a syntax error in fake_awsm/config.ru! FIX IT!"
       end
-      @server = RealWeb.start_server_in_fork(config_ru)
+      @server = RealWeb.start_server_in_fork(config_ru, :timeout => 5)
       @server.base_uri.to_s
     end
   end

data/lib/engineyard-cloud-client/test/fake_awsm/config.ru

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'sinatra/base'
-require 'json'
+require 'multi_json'
 require 'rabl'
 require 'gitable'
 require 'ey_resolver'
@@ -33,6 +33,12 @@ class FakeAwsm < Sinatra::Base
     @user = Scenario::Base.new.user
   end
 
+  helpers do
+    def json(data)
+      MultiJson.dump(data)
+    end
+  end
+
   before do
     if env['PATH_INFO'] =~ %r#/api/v2#
       user_agent = env['HTTP_USER_AGENT']
@@ -55,32 +61,18 @@ class FakeAwsm < Sinatra::Base
   end
 
   get "/scenario" do
-    new_scenario = SCENARIOS.detect { |scen| scen.user.name == params[:scenario] }
-    unless new_scenario
+    found_scenario = SCENARIOS.detect { |scen| scen.user.name == params[:scenario] }
+    unless found_scenario
       status(404)
-      return {"ok" => "false", "message" => "wtf is the #{params[:scenario]} scenario?"}.to_json
+      return json({"ok" => "false", "message" => "wtf is the #{params[:scenario]} scenario?"})
     end
-    user = new_scenario.user
-    {
-      "scenario" => {
-        "email"     => user.email,
-        "password"  => user.password,
-        "api_token" => user.api_token,
-      }
-    }.to_json
+    @scenario = found_scenario.user
+    render :rabl, :scenario, :format => "json"
   end
 
   get "/scenarios" do
-    scenarios = SCENARIOS.map do |scen|
-      user = scen.user
-      {
-        :name      => user.name,
-        :email     => user.email,
-        :password  => user.password,
-        :api_token => user.api_token,
-      }
-    end
-    {'scenarios' => scenarios}.to_json
+    @scenarios = SCENARIOS.map { |scen| scen.user }
+    render :rabl, :scenarios, :format => "json"
   end
 
   get "/api/v2/current_user" do
@@ -203,6 +195,14 @@ class FakeAwsm < Sinatra::Base
     render :rabl, :deployment, :format => "json"
   end
 
+  post "/api/v2/apps/:app_id/environments/:environment_id/deployments/deploy" do
+    app_env = @user.accounts.apps.get(params[:app_id]).app_environments.first(:environment_id => params[:environment_id])
+    @deployment = app_env.deployments.create(params[:deployment])
+    @deployment.deploy
+    response['Location'] = "/api/v2/apps/#{params[:app_id]}/environments/#{params[:environment_id]}/deployments/#{@deployment.id}"
+    render :rabl, :deployment, :format => "json"
+  end
+
   get "/api/v2/apps/:app_id/environments/:environment_id/deployments/last" do
     app_env = @user.accounts.apps.get(params[:app_id]).app_environments.first(:environment_id => params[:environment_id])
     @deployment = app_env.deployments.last

data/lib/engineyard-cloud-client/test/fake_awsm/models/deployment.rb

@@ -3,6 +3,8 @@ require 'dm-core'
 class Deployment
   include DataMapper::Resource
 
+  AWSM_SERVERSIDE_VERSION = '2.0.0.awsm'
+
   property :id,                 Serial
   property :created_at,         DateTime
   property :finished_at,        DateTime
@@ -29,6 +31,23 @@ class Deployment
     "resolved-#{ref}"
   end
 
+  # pretend to trigger a deploy
+  #
+  # this deploy will be instant, unlike real deploys
+  #
+  def deploy
+    unless serverside_version
+      # only set serverside version if it's not set, to imitate the api
+      # behavior of choosing its own serverside version if one is not
+      # sent
+      update :serverside_version => AWSM_SERVERSIDE_VERSION
+    end
+    finished!(
+      :successful => true,
+      :output => 'Deployment triggered by the API'
+    )
+  end
+
   def finished?
     finished_at != nil
   end

data/lib/engineyard-cloud-client/test/fake_awsm/views/scenario.rabl

@@ -0,0 +1,2 @@
+object @scenario => :scenario
+attributes :name, :email, :password, :api_token

data/lib/engineyard-cloud-client/test/fake_awsm/views/scenarios.rabl

@@ -0,0 +1,2 @@
+collection @scenarios, :root => :scenarios, :object_root => false
+attributes :name, :email, :password, :api_token

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.7'
+    VERSION = '1.0.8'
   end
 end
 # Please be aware that the monkeys like tho throw poo sometimes.

data/spec/engineyard-cloud-client/integration/deployment_spec.rb

@@ -56,6 +56,35 @@ describe EY::CloudClient::AppEnvironment do
     end
   end
 
+  describe "triggering an api deploy" do
+    before do
+      @api = scenario_cloud_client "Multiple Ambiguous Accounts"
+      result = EY::CloudClient::AppEnvironment.resolve(@api, 'app_name' => 'rails232app', 'environment_name' => 'giblets', 'account_name' => 'main')
+      result.should be_one_match
+      @app_env = result.matches.first
+    end
+
+    it "triggers a deployment (assumes that deploys happen instantly, which they don't)" do
+      deployment = @app_env.deploy({
+        :ref             => 'master',
+        :migrate         => true,
+        :migrate_command => 'rake migrate',
+        :extra_config    => {'extra' => 'config'},
+      })
+      deployment.config.should == {'input_ref' => 'master', 'deployed_by' => 'Multiple Ambiguous Accounts', 'extra' => 'config'}
+      deployment.commit.should =~ /[0-9a-f]{40}/
+      deployment.resolved_ref.should_not be_nil
+      deployment.created_at.should_not be_nil
+      deployment.finished_at.should_not be_nil
+      deployment.should be_finished
+
+      found_dep = @app_env.last_deployment
+      found_dep.id.should == deployment.id
+      found_dep.should be_finished
+      found_dep.serverside_version.should == '2.0.0.awsm' # uses the awsm version if one is not sent.
+    end
+  end
+
   describe "last deployment" do
     before do
       @api = scenario_cloud_client "Linked App"

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@ require 'bundler/setup'
 require 'fakeweb'
 require 'fakeweb_matcher'
 
-require 'json'
+require 'multi_json'
 
 # Engineyard gem
 $LOAD_PATH.unshift(File.join(EY_ROOT, "lib"))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: engineyard-cloud-client
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,22 +75,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +130,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 1.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -154,7 +138,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: dm-core
   requirement: !ruby/object:Gem::Requirement
@@ -313,6 +297,8 @@ files:
 - lib/engineyard-cloud-client/test/fake_awsm/views/keypairs.rabl
 - lib/engineyard-cloud-client/test/fake_awsm/views/resolve_app_environments.rabl
 - lib/engineyard-cloud-client/test/fake_awsm/views/resolve_environments.rabl
+- lib/engineyard-cloud-client/test/fake_awsm/views/scenario.rabl
+- lib/engineyard-cloud-client/test/fake_awsm/views/scenarios.rabl
 - lib/engineyard-cloud-client/test/fake_awsm/views/user.rabl
 - lib/engineyard-cloud-client/test/fake_awsm.rb
 - lib/engineyard-cloud-client/test/scenario.rb
@@ -320,7 +306,8 @@ files:
 - lib/engineyard-cloud-client/version.rb
 - lib/engineyard-cloud-client.rb
 - LICENSE
-- README.rdoc
+- README.md
+- ChangeLog.md
 - spec/engineyard-cloud-client/api_spec.rb
 - spec/engineyard-cloud-client/integration/account_spec.rb
 - spec/engineyard-cloud-client/integration/app_environment_spec.rb
@@ -351,7 +338,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3497272709251376043
+      hash: -1071401773858451620
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -360,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3497272709251376043
+      hash: -1071401773858451620
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24