cloudster 2.13.1 → 2.14.0

data/README.md

@@ -49,6 +49,10 @@ Create AWS resources :
         :multi_az => true
     )
 
+    storage = Cloudster::S3.new(
+        :name => 'MyBucket'
+    )
+
 Make a cloud :
 
     cloud = Cloudster::Cloud.new(:access_key_id => 'accesskeyid', :secret_access_key => 'topsecretaccesskey', :region => 'us-west-1')
@@ -132,10 +136,9 @@ helpful.
 
 ## Need help?
 
-You can use the [Issues](https://github.com/emilsoman/cloudster/issues) page to ask a new question. This is how you do it:
-1. Click on New Issue
-2. Type in your question
-3. Add a "question" label to the issue
+You can use the [Issues](https://github.com/emilsoman/cloudster/issues) page to ask a new question for now. This is how you do it:
+1. Click on New Issue.
+2. Type in your question and submit.
 
 ## Have a patch?
 

data/VERSION

@@ -1 +1 @@
-2.13.1
+2.14.0

data/cloudster.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cloudster"
-  s.version = "2.13.1"
+  s.version = "2.14.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emil Soman"]
-  s.date = "2012-12-18"
+  s.date = "2012-12-27"
   s.description = "Cloudster is a Ruby gem that was born to cut the learning curve involved \n    in writing your own CloudFormation templates. If you don't know what a CloudFormation template is, \n    but know about the AWS Cloud offerings, you can still use cloudster to provision your stack. \n    Still in infancy , cloudster can create a very basic stack like a breeze. All kinds of contribution welcome !"
   s.email = "emil.soman@gmail.com"
   s.extra_rdoc_files = [
@@ -35,11 +35,13 @@ Gem::Specification.new do |s|
     "lib/cloudster/elb.rb",
     "lib/cloudster/options_manager.rb",
     "lib/cloudster/rds.rb",
+    "lib/cloudster/s3.rb",
     "spec/chef_client_spec.rb",
     "spec/cloud_spec.rb",
     "spec/ec2_spec.rb",
     "spec/elb_spec.rb",
     "spec/rds_spec.rb",
+    "spec/s3_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/emilsoman/cloudster"

data/lib/cloudster.rb

@@ -8,5 +8,6 @@ include OptionsManager
 require 'cloudster/ec2'
 require 'cloudster/elb'
 require 'cloudster/rds'
+require 'cloudster/s3'
 require 'cloudster/cloud'
 require 'cloudster/chef_client'

data/lib/cloudster/s3.rb

@@ -0,0 +1,75 @@
+module Cloudster
+ #S3 Resource
+ class S3
+ 
+   attr_accessor :name, :template
+   # Initialize a s3 bucket
+   #
+   # ==== Notes
+   # options parameter must include values for the :name
+   #
+   # ==== Parameters
+   # * options<~Hash>
+   #   * :name : String representing the bucket name (Required)
+   #   * :access_control : String consisting of one of the predefined permission value. ( Example: PublicRead )
+   #   * :website_configuration : A hash containing the name of the index document and name of the error document. ( Example: {"index_document" => "index.html", "error_document" => "error.html"} )
+   #             
+   # ==== Examples
+   #   bucket = Cloudster::S3.new(
+   #    :name => 'unique_bucket_name'
+   #   )
+    
+   def initialize(options = {})
+     require_options(options, [:name])
+     @name = options[:name]
+     @access_control = options[:access_control]
+     @website_configuration = options[:website_configuration]
+   end
+
+   # Returns a Ruby hash version of the Cloud Formation template for the s3 resource
+   #
+   # ==== Examples
+   #   s3 = Cloudster::S3.new(
+   #    :name => 'unique_bucket_name'
+   #   )
+   #   s3.template
+   #
+   # ==== Returns
+   # * Ruby hash version of the Cloud Formation template for the s3 resource
+    def template
+      @template ||= S3.template({:name => @name, :access_control => @access_control, :website_configuration => @website_configuration})
+    end
+
+    # Class method that returns a Ruby hash version of the Cloud Formation template
+    #
+    # ==== Examples
+    #   template = Cloudster::S3.template(
+    #    :name => 'myBucket'
+    #   )
+    #
+    # ==== Parameters
+    # * options<~Hash>
+    #   * :name : String representing the bucket name (Required)
+    #   * :access_control : String consisting of one of the predefined permission value. ( Example: PublicRead )
+    #   * :website_configuration : A hash containing the name of the index document and name of the error document. ( Example: {"index_document" => "index.html", "error_document" => "error.html"} )
+    #             
+    # ==== Returns
+    # * Ruby hash version of the Cloud Formation template for S3
+    def self.template(options = {})
+      require_options(options, [:name])
+      properties = {}
+      properties.merge!({"AccessControl" => options[:access_control]}) unless options[:access_control].nil?
+      unless options[:website_configuration].nil?
+        properties.merge!({"WebsiteConfiguration" => {"IndexDocument" => options[:website_configuration]["index_document"], "ErrorDocument" => options[:website_configuration]["error_document"]}})
+      end
+      template = {'Resources' => {
+                        options[:name] => {
+                          'Type' => 'AWS::S3::Bucket',
+                          'Properties' => properties
+                       }
+                  }
+      }
+      return template
+    end
+ end
+end

data/spec/s3_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Cloudster::S3 do
+  describe 'initialize' do
+    it "should raise argument error if no argument is provided" do
+      expect { Cloudster::S3.new() }.to raise_error(ArgumentError, 'Missing required argument: name')
+    end
+    it "should not raise argument error if all arguments are provided" do
+      expect { Cloudster::S3.new(:name => 'mybucket') }.to_not raise_error
+    end
+  end
+
+  describe '#template' do
+    it "should return a ruby hash for the resource cloudformation template with only mandatory fields" do
+      s3 = Cloudster::S3.new(:name => 'bucket_name')
+      s3.template.should == {'Resources' => {'bucket_name' => {'Type' => 'AWS::S3::Bucket', 'Properties' => {}}}}
+    end
+    it "should return a ruby hash for the resource cloudformation template" do
+      s3 = Cloudster::S3.new(:name => 'bucket_name', :access_control => "PublicRead", :website_configuration => {"index_document" => "index.html", "error_document" => "error.html"} )
+      s3.template.should == {'Resources' => {'bucket_name' => {'Type' => 'AWS::S3::Bucket', 'Properties' => {"AccessControl" => "PublicRead", "WebsiteConfiguration" => { "IndexDocument" => "index.html", "ErrorDocument" => "error.html" } }}}}
+    end
+  end
+
+  describe '.template' do
+    it "should raise argument error if no argument is provided" do
+      expect { Cloudster::S3.template() }.to raise_error(ArgumentError, 'Missing required argument: name')
+    end
+    it "should return a ruby hash for the resource cloudformation template" do
+      hash = Cloudster::S3.template(:name => 'bucket_name', :access_control => "PublicRead", :website_configuration => {"index_document" => "index.html", "error_document" => "error.html"} )
+      hash.should == {'Resources' => {'bucket_name' => {'Type' => 'AWS::S3::Bucket', 'Properties' => {"AccessControl" => "PublicRead", "WebsiteConfiguration" => { "IndexDocument" => "index.html", "ErrorDocument" => "error.html" } }}}}
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudster
 version: !ruby/object:Gem::Version
-  version: 2.13.1
+  version: 2.14.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-18 00:00:00.000000000 Z
+date: 2012-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -137,11 +137,13 @@ files:
 - lib/cloudster/elb.rb
 - lib/cloudster/options_manager.rb
 - lib/cloudster/rds.rb
+- lib/cloudster/s3.rb
 - spec/chef_client_spec.rb
 - spec/cloud_spec.rb
 - spec/ec2_spec.rb
 - spec/elb_spec.rb
 - spec/rds_spec.rb
+- spec/s3_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/emilsoman/cloudster
 licenses:
@@ -158,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 907847761
+      hash: 667254191
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: