aws_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a68ecc8d49db232b896160d304946501e56072b
-  data.tar.gz: 9be7f394a8ac196d416fb6fd6b67670470bdfc91
+  metadata.gz: 3fddc029999898a6956183916de48acb4fe9372b
+  data.tar.gz: 469c2dbb49038b7cde938b48c67f02f9d3175803
 SHA512:
-  metadata.gz: c26ba01a0b5dd0d559c00604acb8734958fa9791cbe9c2a40597057a9e7fc6b40d262e5234c7a59eafc56a62e361aa7ec66c2235e7d421b261984d60f07bb9a4
-  data.tar.gz: 58b1225923c91e4ebe0e4726d78c635373624fd2712badcf6d9b2f0669897eea42afc122274856d879c47067987ce4c94107836d6f9580c6300514b79d3058f7
+  metadata.gz: 48f0b4124565e85e811c8ecf470544b105fc697d1aea01e3c352fc8387ed69dc0f42c192ec80a0683a0c524b2a9a287387aba79604e381ab583e26c6cbe22007
+  data.tar.gz: 252b43b100bf2b1512057d46668c89a0c74f9f891c991b2c0b07cc61a207f951fc10d3087b2804fae47999077585d2a13b69257dc0d27294810732b6fd1b7f7a

data/README.md

@@ -39,7 +39,7 @@ Then include it in your project
 
 ### Usage
 
-#### Connnecting
+#### Connecting
 
 ```
   # ::AwsClient::Container.new(ORG_KEY, AWS_REGION, PROVISIONING_REGION) e.g.
@@ -71,3 +71,10 @@ Each client wrapper above is merely a wrapper for the underlying AWS client, fro
 ```
 
 Each client wrapper exposes some additional functionality useful to me, but may easily be monkey patched to add functionality  (I find working with AWS APIs often exhausting, especially when working with Cloudformation where orchestration tasks may involve the use of multiple APIs in sequence).
+
+
+#### Specific usage examples
+
+* [S3](documentation/s3.md)
+* [Cloudformation](documentation/cloudformation.md)
+

data/documentation/cloudformation.md

@@ -0,0 +1,55 @@
+### Cloudformation
+
+N.B. This gem solves very specific and limited use cases, and is in no way exhaustive (although it may be easily monkey patched to add in additional functions)
+
+#### Create a cloudformation stack from a public template url
+
+```
+  aws_clients = ::AwsClient::Container.new(ORG_KEY, AWS_REGION, PROVISIONING_REGION)
+
+  cloudformation_client = aws_clients.cloudformation
+
+  cloudformation_client.create_stack(
+    stack_name:  "The name for you stack",
+    template_url: "The URL at which your cloudformation template can be found (in S3)"
+    capabilities: ["List", "of", "capabilities"] # e.g ["CAPABILITY_IAM"],
+    on_failure: "failure action" # e.g. "DO_NOTHING" | "ROLLBACK" | "DELETE"
+    tags = [
+      { key: "value" }, 
+      { secondkey: "secondvalue" }
+    ]  
+  )
+
+```
+
+#### Get stack status
+
+```
+  cloudformation_client.stack_status("STACK NAME")
+```
+
+
+#### Accessing the underlying client
+
+```
+  aws_clients = ::AwsClient::Container.new(ORG_KEY, AWS_REGION, PROVISIONING_REGION)
+  cloudformation_client = aws_clients.cloudformation
+  underlying_client = cloudformation_client.client
+```
+
+#### Extending functionality with a patch:
+
+Extend the following class:
+
+```
+  module AwsClient
+    class CfWrapper < AwsClient::Wrapper
+
+      ...
+    
+    end
+  end
+```
+
+See 'Accessing the underlying client', above, for how to access the underlying cloudformation client.
+

data/documentation/s3.md

@@ -0,0 +1,57 @@
+### S3 Usage examples
+
+N.B. This gem solves very specific and limited use cases, and is in no way exhaustive (although it may be easily monkey patched to add in additional functions)
+
+#### Configuration
+
+Create a file named .aws_buckets in your root home directory.  This file is a simple lookup allowing you to reference S3 buckets by key, e.g.
+
+```
+---
+:bucket_1_key: "name of bucket 1 in S3"
+:bucket_2_key: "name of bucket 2 in S3"
+```
+
+#### Writing to a bucket
+
+```
+aws_clients = ::AwsClient::Container.new(ORG_KEY, AWS_REGION, PROVISIONING_REGION)
+s3_client = aws_clients.s3
+s3_client.write_file_to_bucket(bucket_key, path_to_local_file)
+```
+
+#### Find or create a bucket by bucket key
+
+```
+  aws_clients = ::AwsClient::Container.new(ORG_KEY, AWS_REGION, PROVISIONING_REGION)
+  s3_client = aws_clients.s3
+  s3_client.find_or_create_bucket_for(bucket_key)
+```
+
+Note that when creating an S3 bucket, it will be named in the following format: [bucket key].[aws credentials key].[aws region]
+
+#### Accessing the underlying client
+
+```
+  aws_clients = ::AwsClient::Container.new(ORG_KEY, AWS_REGION, PROVISIONING_REGION)
+  s3_client = aws_clients.s3
+  underlying_client = s3_client.client
+```
+
+#### Extending functionality with a patch:
+
+Extend the following class:
+
+```
+  module AwsClient
+    class S3Wrapper < AwsClient::Wrapper
+
+      ...
+
+    end
+  end
+```
+
+
+See 'Accessing the underlying client', above, for how to access the underlying S3 client.
+

data/lib/aws_client/version.rb

@@ -1,3 +1,3 @@
 module AwsClient
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/cf_wrapper.rb

@@ -2,6 +2,7 @@ module AwsClient
   class CfWrapper < Wrapper
 
     STACK_COMPLETE_STATUS = "CREATE_COMPLETE"
+    STACK_UPDATE_COMPLETE_STATUS = "UPDATE_COMPLETE"
     STACK_ROLLLBACK_STATUS = "ROLLBACK_IN_PROGRESS"
     STACK_WAIT_SLEEP_TIME = 3
 
@@ -11,6 +12,14 @@ module AwsClient
       wait_for_stack(stack_params[:stack_name])
     end
 
+    # http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudFormation/Client.html#update_stack-instance_method
+    def update_stack(stack_params)
+      puts "Updating stack with the following parameters: #{stack_params.inspect}"
+      response = client.update_stack(stack_params)
+      is_update = true
+      wait_for_stack(stack_params[:stack_name], is_update)
+    end
+
     def stack_status_for(stack_name)
       stack_info = stack_info_for(stack_name)
       return stack_info_for(stack_name).stack_status
@@ -49,17 +58,19 @@ module AwsClient
       resource_data_for_resource_name(stack_name, resource_name).physical_resource_id
     end
 
-    def wait_for_stack(stack_name)
-      puts "Waiting for stack to spin up"
+    def wait_for_stack(stack_name, is_update = false)
+      puts "Waiting for stack"
       status = ""
-      while status != STACK_COMPLETE_STATUS
+      end_status = is_update ? STACK_UPDATE_COMPLETE_STATUS : STACK_COMPLETE_STATUS
+
+      while status != end_status
         status = stack_status_for(stack_name)
         puts "'#{stack_name}' stack status: #{status}"
  
         raise "Rollback in progress - CF build failed" if status == STACK_ROLLLBACK_STATUS 
         sleep(STACK_WAIT_SLEEP_TIME)     
       end
-      puts "Stack is up. Ready for bootstrapping"
+      puts "Stack is ready."
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Webzakimbo
@@ -65,9 +65,12 @@ files:
 - README.md
 - Rakefile
 - aws_client-0.0.1.gem
+- aws_client-0.0.2.gem
 - aws_client.gemspec
 - bin/console
 - bin/setup
+- documentation/cloudformation.md
+- documentation/s3.md
 - lib/aws_client.rb
 - lib/aws_client/version.rb
 - lib/cf_wrapper.rb