cloudster 0.0.2 → 1.0.0

data/README.md

@@ -25,7 +25,8 @@ Create AWS EC2 resources as shown here:
 
 Create a stack out of the resources :
 
-    stack = Cloudster::Cloud.new(:resources => [app_server, app_server_2])
+    stack = Cloudster::Cloud.new(:access_key_id => 'accesskeyid',
+                                :secret_access_key => 'topsecretaccesskey')
 Now you can do stuff like :
 
 - Get the CloudFormation template for a resource in Ruby Hash :
@@ -33,16 +34,13 @@ Now you can do stuff like :
         app_server.template
 - Get the CloudFormation template for the stack :
     
-        stack.template(:description => 'Description of the stack')
+        stack.template(:resources => [app_server, app_server_2], :description => 'Description of the stack')
     
 And most importantly :
 
 - Provision the stack :
 
-        stack.provision(:stack_name => 'Shitty stack',
-          :access_key_id => 'accesskeyid',
-          :secret_access_key => 'topsecretaccesskey')
-
+        stack.provision(:resources => [app_server, app_server_2], :stack_name => 'TestStack', :description => 'Description of the stack')
 
 
 ##License

data/VERSION

@@ -1 +1 @@
-0.0.2
+1.0.0

data/cloudster.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "cloudster"
-  s.version = "0.0.2"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emil Soman"]

data/lib/cloudster/cloud.rb

@@ -5,41 +5,52 @@ module Cloudster
     # Initialize a Cloud instance
     #
     # ==== Notes
-    # options parameter must include values for :resources
+    # options parameter must include values for :access_key_id and
+    # :secret_access_key in order to create a connection
+    #
+    # ==== Parameters
+    # * options<~Hash>
+    #   * :access_key_id : A string containing the AWS access key ID.
+    #   * :secret_access_key : A string containing the AWS secret access key.
     #
     # ==== Examples
     #   cloud = Cloudster::Cloud.new(
-    #    :resources => [
-    #       #Cloudster resource instances ..
-    #     ]
+    #    :access_key_id => 'aws_access_key_id'
+    #    :secret_access_key => 'aws_secret_access_key',
     #   )
-    #
-    # ==== Parameters
-    # * options<~Hash> - :resources : An array of Cloudster resource instances.  Defaults to {}.
     def initialize(options = {})
-      require_options(options, [:resources])
-      @resources = options[:resources]
+      require_options(options, [:access_key_id, :secret_access_key])
+      access_key_id = options[:access_key_id]
+      secret_access_key = options[:secret_access_key]
+      @cloud_formation = Fog::AWS::CloudFormation.new(:aws_access_key_id => access_key_id, :aws_secret_access_key => secret_access_key)
     end
 
     # Generates CloudFormation Template for the stack
     #
     # ==== Examples
     #   cloud = Cloudster::Cloud.new(
-    #    :resources => [
-    #       #Cloudster resource instances ..
-    #     ]
+    #    :access_key_id => 'aws_access_key_id'
+    #    :secret_access_key => 'aws_secret_access_key',
     #   )
-    #   cloud.template(:description => 'This is the description for the stack template')
+    #
+    #   cloud.template(:resources => [<AWS RESOURCES ARRAY>], :description => 'This is the description for the stack template')
+    #
+    # ==== Notes
+    # options parameter must include values for :resources
     #
     # ==== Parameters
-    # * options<~Hash> - :description : A string which will be used as the Description of the CloudFormation template.
+    # * options<~Hash> - 
+    #   * :resources : An array of Cloudster resource instances.  Defaults to {}.
+    #   * :description : A string which will be used as the Description of the CloudFormation template.
     #
     # ==== Returns
     # * JSON cloud formation template 
     def template(options = {})
+      require_options(options, [:resources])
+      resources = options[:resources]
       description = options[:description] || 'This stack is created by Cloudster'
       resource_template = {}
-      @resources.each do |resource|
+      resources.each do |resource|
         resource_template.merge!(resource.template['Resources'])
       end
 
@@ -54,27 +65,51 @@ module Cloudster
     #
     # ==== Examples
     #   cloud = Cloudster::Cloud.new(
-    #    :resources => [
-    #       #Cloudster resource instances ..
-    #     ]
+    #    :access_key_id => 'aws_access_key_id'
+    #    :secret_access_key => 'aws_secret_access_key',
     #   )
-    #   cloud.template(:description => 'This is the description for the stack template')
+    #
+    #   cloud.provision(:resources => [<AWS RESOURCES ARRRAY>],
+    #     :stack_name => 'Shitty Stack',
+    #     :description => 'This is the description for the stack template')
     #
     # ==== Notes
-    # options parameter must include values for :stack_name for naming the stack , :access_key_id and
-    # :secret_access_key in order to create a connection
+    # options parameter must include values for :resources and :stack_name
     #
     # ==== Parameters
-    # * options<~Hash> - :description : A string which will be used as the Description of the CloudFormation template.
+    # * options<~Hash>
+    #   * :resources : An array of Cloudster resource instances.  Defaults to {}.
+    #   * :stack_name : A string which will be used to name the CloudFormation stack.
+    #   * :description : A string which will be used as the Description of the CloudFormation template.
     #
     # ==== Returns
     # * response<~Excon::Response>:
     #   * body<~Hash>:
     #     * 'StackId'<~String> - Id of the new stack
     def provision(options = {})
-      require_options(options, [:stack_name, :access_key_id, :secret_access_key])
-      cloud_formation = Fog::AWS::CloudFormation.new(:aws_access_key_id => options[:access_key_id], :aws_secret_access_key => options[:secret_access_key])
-      return cloud_formation.create_stack(options[:stack_name], 'TemplateBody' => template)
+      require_options(options, [:resources, :stack_name])
+      return @cloud_formation.create_stack(options[:stack_name], 'TemplateBody' => template(:resources => options[:resources], 
+                                                                                            :description => options[:description]))
+    end
+
+    # Get events related to a stack
+    #
+    # ==== Examples
+    #   cloud = Cloudster::Cloud.new(
+    #    :access_key_id => 'aws_access_key_id'
+    #    :secret_access_key => 'aws_secret_access_key',
+    #   )
+    #   cloud.events(:stack_name => 'ShittyStack')
+    #
+    # ==== Parameters
+    # * options<~Hash>
+    #   * :stack_name : A string which will contain the name of the stack for which the events will be fetched.
+    #
+    # ==== Returns
+    # * response<~Excon::Response>:
+    #   * body<~Hash>:
+    def self.events(options = {})
+      return @cloud_formation.describe_stack_events(options[:stack_name])
     end
 
   end

data/lib/cloudster/ec2.rb

@@ -16,7 +16,6 @@ module Cloudster
     #
     # ==== Parameters
     # * options<~Hash> - 
-    #   *Keys: 
     #     * :name: String containing the name for the Ec2 resource
     #     * :key_name: String containing the name of the keypair to be used for SSH
     #     * :image_id: String containing the AMI image id to be used while creating the Ec2 resource

data/spec/cloud_spec.rb

@@ -3,34 +3,34 @@ require 'spec_helper'
 describe Cloudster::Cloud do
   describe 'initialize' do
     it "should raise argument error if resources not provided" do
-      expect { Cloudster::Cloud.new() }.to raise_error(ArgumentError, 'Missing required argument: resources')
+      expect { Cloudster::Cloud.new() }.to raise_error(ArgumentError, 'Missing required argument: access_key_id,secret_access_key')
     end
     it "should not raise argument error if all arguments are provided" do
-      expect { Cloudster::Cloud.new(:resources => []) }.to_not raise_error(ArgumentError, 'Missing required argument: name')
+      expect { Cloudster::Cloud.new(:access_key_id => 'test', :secret_access_key => 'test') }.to_not raise_error
     end
   end
   describe '#template' do
     it "should return a ruby hash for the stack cloudformation template" do
       ec2 = Cloudster::Ec2.new(:key_name => 'testkey', :image_id => 'image_id', name: 'name')
       ec2_1 = Cloudster::Ec2.new(:key_name => 'testkey1', :image_id => 'image_id1', name: 'name1')
-      cloud = Cloudster::Cloud.new(:resources => [ec2, ec2_1])
-      cloud.template(:description => 'test template').should == {"AWSTemplateFormatVersion"=>"2010-09-09", "Description"=>"test template", "Resources"=>{"name"=>{"Type"=>"AWS::EC2::Instance", "Properties"=>{"KeyName"=>"testkey", "ImageId"=>"image_id"}}, "name1"=>{"Type"=>"AWS::EC2::Instance", "Properties"=>{"KeyName"=>"testkey1", "ImageId"=>"image_id1"}}}}.to_json
+      cloud = Cloudster::Cloud.new(:access_key_id => 'test', :secret_access_key => 'test')
+      cloud.template(:resources => [ec2, ec2_1], :description => 'test template').should == {"AWSTemplateFormatVersion"=>"2010-09-09", "Description"=>"test template", "Resources"=>{"name"=>{"Type"=>"AWS::EC2::Instance", "Properties"=>{"KeyName"=>"testkey", "ImageId"=>"image_id"}}, "name1"=>{"Type"=>"AWS::EC2::Instance", "Properties"=>{"KeyName"=>"testkey1", "ImageId"=>"image_id1"}}}}.to_json
     end
   end
 
   describe '#provision' do
     it "should raise argument error if resources not provided" do
       ec2 = Cloudster::Ec2.new(:key_name => 'testkey', :image_id => 'image_id', name: 'name')
-      cloud = Cloudster::Cloud.new(:resources => [ec2])
-      expect { cloud.provision() }.to raise_error(ArgumentError, 'Missing required argument: stack_name,access_key_id,secret_access_key' )
+      cloud = Cloudster::Cloud.new(:access_key_id => 'test', :secret_access_key => 'test')
+      expect { cloud.provision(:description => 'test') }.to raise_error(ArgumentError, 'Missing required argument: resources,stack_name' )
     end
     it "should create an instance of cloud formation and trigger stack creation" do
-      ec2 = Cloudster::Ec2.new(:key_name => 'testkey', :image_id => 'image_id', name: 'name')
-      cloud = Cloudster::Cloud.new(:resources => [ec2])
       cloud_formation = double('CloudFormation')
-      cloud_formation.should_receive('create_stack').with('stack_name', 'TemplateBody' => cloud.template)
-      Fog::AWS::CloudFormation.should_receive(:new).with(:aws_access_key_id => 'access_key_id', :aws_secret_access_key => 'secret_access_key').and_return cloud_formation
-      cloud.provision(:stack_name => 'stack_name', :access_key_id => 'access_key_id',  :secret_access_key => 'secret_access_key')
+      Fog::AWS::CloudFormation.should_receive(:new).with(:aws_access_key_id => 'test', :aws_secret_access_key => 'test').and_return cloud_formation
+      ec2 = Cloudster::Ec2.new(:key_name => 'testkey', :image_id => 'image_id', name: 'name')
+      cloud = Cloudster::Cloud.new(:access_key_id => 'test', :secret_access_key => 'test')
+      cloud_formation.should_receive('create_stack').with('stack_name', 'TemplateBody' => cloud.template(:resources => [ec2], :description => 'testDescription'))
+      cloud.provision(:resources => [ec2], :stack_name => 'stack_name', :description => 'testDescription')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudster
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -162,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -963662573
+      hash: 814811471
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: