aws_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb9f2d7d1282f3fa8fff4efee7c147769e4ca528
-  data.tar.gz: f918751ee5ee64bc06ebc258c2c9cce6e1e99072
+  metadata.gz: 9a68ecc8d49db232b896160d304946501e56072b
+  data.tar.gz: 9be7f394a8ac196d416fb6fd6b67670470bdfc91
 SHA512:
-  metadata.gz: b2eb460108a486dc98ee0434e767204bac1948b25d867b09f5270de038d66b1a5dc1ff22defbe3601f9abf3b09217286e7cb95251d62051559b396776d99f557
-  data.tar.gz: dfa5c5959e58e8807fad8f865253bcfed5a739c6b0c3fa9262e277e97c48d464817b7b5daf86272c49fe9f21efb0d9f6d8b20643c9114ad2963c98600bc89e9f
+  metadata.gz: c26ba01a0b5dd0d559c00604acb8734958fa9791cbe9c2a40597057a9e7fc6b40d262e5234c7a59eafc56a62e361aa7ec66c2235e7d421b261984d60f07bb9a4
+  data.tar.gz: 58b1225923c91e4ebe0e4726d78c635373624fd2712badcf6d9b2f0669897eea42afc122274856d879c47067987ce4c94107836d6f9580c6300514b79d3058f7

data/README.md

@@ -1,4 +1,73 @@
 # AwsClient
 
-Very light-weight wrapper for AWS interactions
+This gem wraps access to various AWS APIs under one umbrella.  The following are configured:
 
+* RDS
+* Cloudformation
+* S3
+* EC2
+
+It exposes access to the above APIs from a single flex-point.
+
+## Rationale
+
+The use cases covered are in no way exhaustive - this aids in solving very specific problems.
+
+## Installation
+
+### Assumptions
+
+You will need a file named .fog in your home directory. The format is as follows:
+
+```
+  ORG_KEY:
+    aws_access_key_id: ACCESS_KEY
+    aws_secret_access_key: SECRET_ACCESS_KEY
+```
+
+then you will need to
+
+```
+  gem install aws_client
+```
+
+Then include it in your project
+
+```
+  require 'aws_client'
+```
+
+### Usage
+
+#### Connnecting
+
+```
+  # ::AwsClient::Container.new(ORG_KEY, AWS_REGION, PROVISIONING_REGION) e.g.
+  aws_clients = ::AwsClient::Container.new(ORG_KEY, "eu-west", "eu-west-1")
+
+  # Rds client wrapper
+  rds_client = aws_clients.rds
+
+  # Cloudformation client wrapper
+  cf_client = aws_clients.cloudformation
+
+  # S3 client wrapper
+  s3_client = aws_clients.s3
+
+  # EC2 client wrapper
+  ec2_client = ec2_client.ec2
+```
+
+Each client wrapper above is merely a wrapper for the underlying AWS client, from which the underlying client may be exposed, e.g.
+
+```
+  aws_clients = ::AwsClient::Container.new("My organisation", "eu-west", "eu-west-1")
+ 
+  # Wrapper
+  rds_client = aws_clients.rds
+
+  # Underlying client
+  underlying_client = rds_client.client 
+```
+
+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).

data/aws_client.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Light-weight AWS wrapper.}
   spec.description   = %q{A very light-weight wrapper for my most commonly used AWS functions}
-  spec.homepage      = "http://webzakimbo.com"
+  spec.homepage      = "https://github.com/webzakimbo/aws_client"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/aws_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Webzakimbo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -64,6 +64,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- aws_client-0.0.1.gem
 - aws_client.gemspec
 - bin/console
 - bin/setup
@@ -74,7 +75,7 @@ files:
 - lib/rds_wrapper.rb
 - lib/s3_wrapper.rb
 - lib/wrapper.rb
-homepage: http://webzakimbo.com
+homepage: https://github.com/webzakimbo/aws_client
 licenses:
 - MIT
 metadata: {}