aws_clim 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 464aaeca6985ddf65ea4a3c072f44aa7561b52e2815ef66d8eda598d2c455259
-  data.tar.gz: 38c760109126b5fa42ab730e2b9d770c66af761180a32366ca23a76ff76fc175
+  metadata.gz: ac0cd640f3b253853487800afc8dce04cfc1792d3322d62099d0d3ec0e6988e4
+  data.tar.gz: 39eeb60f7b3ec2613a7a3c6ef12ff772c437412fa1ebffd2d1c9a3fe4cc59c24
 SHA512:
-  metadata.gz: 4f8b84374a0b5997ca009752cc4cad9308769e4ec4b37f782487e11e0fca612d0a31b2ad6417071aaef61cb77b85e71c481ee90e7f5b2fe850b696d4b0d2918c
-  data.tar.gz: 361d4105ef8ce85e168e996d506c13bff92b3db2f6f071a3201fc5bb82543e94a35c4d012c125523fb93a230a0d418c52c20bfa865ca81f3c09093aa85590e16
+  metadata.gz: 456cda408a13813578cad9b2c777e982e8c95bdb4de14e55503fe0a7cf9124e2e03d34d49a9552d07a5924e9dc2e1d87f5a065794ae3b92ea0b102dac1d168d2
+  data.tar.gz: b054f592c2f7584e8e3ee9facd0e59f1b01b165a5c2ae44fcf1e206e34e6cab1a0c1c9fba978cde57a0fef3bbd3aa264a6a1f6a00af21be32dfded73050561c5

data/README.md

@@ -1,8 +1,14 @@
 # AwsClim
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aws_clim`. To experiment with that code, run `bin/console` for an interactive prompt.
+AwsClim is a light wrapper around `aws cli` tool. it adds some convenience when calling the command and
+dealing with the results.
 
-TODO: Delete this and the text above, and describe your gem
+  - Maps all aws services as a method on AwsClim instance.
+  - Set format as JSON as default.
+  - Deals with arguments as Array, Hash or simply string
+  - Parses all results as JSON
+  - Returns an `OpenStruct.new(error: true, success: false, data: err)` when error happens.
+  - Returns an `OpenStruct.new(error: false, success: true, data: JSON.parse(out, object_class: OpenStruct))` when command returns successfuly.
 
 ## Installation
 
@@ -22,18 +28,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+aws = AwsClim.new()
+```
 
-## Development
+By calling new without parameters AwsClim uses the profile `default`(see https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials_profiles.html to learn about aws profiles).
+To set a different profile use profile argument on new.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+aws = AwsClim.new(profile: 'other-profile')
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+With a instance of AwsClim call aws services by its name and pass subcommands and options:
 
-## Contributing
+Examples:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aws_clim. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/aws_clim/blob/master/CODE_OF_CONDUCT.md).
+```
+# Subcommand
 
+aws.iam('list-users').data.Users
+```
+
+```
+# Subcommand + Arguments
+
+result = aws.apigateway('put-method-response', {
+  'rest-api-id'         => rest_api['id'],
+  'resource-id'         => resource['id'],
+  'http-method'         => 'GET',
+  'status-code'         => '200',
+  'response-parameters' => 'method.response.header.access-control-allow-origin=false'
+})
+
+result.success?
+result.error?
+result.data
+```
 
 ## License
 

data/lib/aws_clim/version.rb

@@ -1,3 +1,3 @@
 module AwsClim
-  VERSION = "1.0.0"
+  VERSION = "1.0.3"
 end

data/lib/aws_clim.rb

@@ -1,63 +1,13 @@
+require 'ostruct'
 require 'json'
 require 'open3'
 
 class AwsClim
-  def initialize(profile = 'default', global_options = {})
+  def initialize(profile: 'default', global_options: {})
     @profile = profile
     @global_options = global_options
   end
 
-  class SimpleResult
-    attr_reader :data
-
-    def initialize(data)
-      @data = data
-    end
-
-    def error?
-      false
-    end
-
-    def success?
-      true
-    end
-  end
-
-  class ItemsResult < SimpleResult
-    include Enumerable
-
-    attr_reader :data, :items
-
-    def initialize(data)
-      super
-      @items = data['items']
-    end
-
-    def each(&block)
-      @data.fetch('items').each(&block)
-    end
-  end
-
-  class ErrorResult
-    attr_reader :message
-
-    def initialize(message)
-      @message = message
-    end
-
-    def to_s
-      "Error: #{@message}"
-    end
-
-    def success?
-      false
-    end
-
-    def error?
-      true
-    end
-  end
-
   %w(
     accessanalyzer
     account
@@ -388,10 +338,9 @@ class AwsClim
     out, err, status = Open3.capture3(cmd)
 
     if status.success?
-      result = JSON.parse(out)
-      result.key?('items') ? ItemsResult.new(result) : SimpleResult.new(result)
+      OpenStruct.new(success?: true, error?: false, data: JSON.parse(out, object_class: OpenStruct))
     else
-      ErrorResult.new(err)
+      OpenStruct.new(success?: false, error?: true, data: err)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_clim
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Andrew S Aguiar
@@ -24,7 +24,6 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
-- aws_clim-0.1.0.gem
 - aws_clim.gemspec
 - bin/console
 - lib/aws_clim.rb