ec2l 0.0.1 → 0.0.2

data/.travis.yml

@@ -2,5 +2,7 @@ language: ruby
 rvm:
   - 2.1.0
   - jruby-19mode
-  - rbx-2
   - jruby-head
+addons:
+  code_climate:
+    repo_token: b8d2d2e6c25619ddc2efa605b020bf716623bc65c08bd7bc044d90c264def66d

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ec2l.gemspec
 gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,8 +1,13 @@
 # Ec2l
 
 [![Build Status](https://travis-ci.org/yazgoo/ec2l.svg?branch=master)](https://travis-ci.org/yazgoo/ec2l)
+[![Test Coverage](https://codeclimate.com/github/yazgoo/ec2l/coverage.png)](https://codeclimate.com/github/yazgoo/ec2l)
+[![Code Climate](https://codeclimate.com/github/yazgoo/ec2l.png)](https://codeclimate.com/github/yazgoo/ec2l)
+[![Inline docs](http://inch-ci.org/github/yazgoo/ec2l.png?branch=master)](http://inch-ci.org/github/yazgoo/ec2l)
+[![Gem Version](https://badge.fury.io/rb/ec2l.svg)](http://badge.fury.io/rb/ec2l)
 
-TODO: Write a gem description
+
+Ec2l aims to provide an efficient ruby developer oriented UI to EC2.
 
 ## Installation
 
@@ -20,7 +25,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You can call public client methods directly from the ec2l command line,
+though a better way is to use the shell, which relies on pry:
+
+    $ ec2l shell
+
+
+```ruby
+...
+[2] pry(#<Ec2l::Client>)> h # print help
+Usage: action parameters...
+available actions:
+[
+    [0]            associate(address, id) Ec2l::Client
+    [1]                  ins()            Ec2l::Client
+...
+[2] pry(#<Ec2l::Client>)> show-doc ins # print documentation on ins method
+...
+Public: return virtual machines instances with few details
+
+Examples
+
+  ins[0]
+      => {:instanceId=>"i-deadbeef", :instanceState=>
+                      {"code"=>"16", "name"=>"running"},
+           :ipAddress=>"10.1.1.2", :tagSet=>{:k=>"v"}}
+
+Returns an array with instanceId, ipAddress, tagSet, instanceState in a hash
+[7] pry(#<Ec2l::Client>)> ins # launch ins method
+```
 
 ## Contributing
 

data/lib/ec2l.rb

@@ -2,30 +2,137 @@ require "ec2l/version"
 require 'base64'
 require 'awesome_print'
 require 'pry'
+# Public: Utilities to facilitate amazon EC2 administration
+#
+# Examples
+#
+#   Ec2l::Client.new.i
+#       => {:instanceId=>"i-deadbeef", :instanceState=>
+#                       {"code"=>"16", "name"=>"running"},
+#            :ipAddress=>"10.1.1.2", :tagSet=>{:k=>"v"}
+#           ...
 module Ec2l
+    # Public: Client to use amazon EC2 apis
+    #
+    # Examples
+    #
+    #   Client.new.instances(["ipAddress"])[0..1]
+    #       => [{:ipAddress=>"10.1.1.2"}, {:ipAddress=>"10.1.1.1"}]
     class Client
+        # Public: return virtual machines instances
+        #
+        # keep  -   what field you want to extract.
+        #           valid fields names are documented in ec2 apis
+        #           groups is an arranged shortcut for groupSet
+        #           tagSet is also rearranged
+        #
+        # Examples
+        #
+        #   instances(["ipAddress"])[0..1]
+        #       => [{:ipAddress=>"10.1.1.2"}, {:ipAddress=>"10.1.1.1"}]
+        #
+        # Returns an array with all fields requested for each VM in a hash
         def instances keep = ["instanceId", "ipAddress", "groups",
                               "launchType", "instanceType", "tagSet"]
             @ec2.describe_instances.reservationSet.item.collect do |item|
-                group = item.groupSet if keep.include? "groups"
+                rearrange_fields item, keep
                 item = item.instancesSet.item[0].reject{|k, v| not keep.include? k}
-                item["groups"] = group.item.map{|x| x.groupId } if not group.nil?
-                item["tagSet"] = to_hash(item["tagSet"].item) if item["tagSet"]
                 Hash[item.map { |k, v| [k.to_sym, v] }]
             end
         end
+        # Public: displays inforation about a VM instance
+        #
+        # id  -   the VM instance id
+        #
+        # Examples
+        #
+        #   instance "i-deadbeef"
+        #       => {"xmlns"=>"http://ec2.amazonaws.com/doc/2010-08-31/",
+        #        "requestId"=>"89375055-16de-4ab7-84b5-5651670e7e3b",
+        #        "reservationSet"=>
+        #         {"item"=>
+        #          ...
+        #
+        # Returns a hash with description of the instance
         def instance(id) @ec2.describe_instances(instance_id: id) end
+        # Public: associate an elastic address with a VM instance
+        #
+        # address   -   the elastic IP address
+        # id        -   the VM instance id
+        #
+        # Examples
+        #
+        #   associate '10.1.1.2', 'i-deadbeef'
+        #
+        # Returns info about the association
+        def associate address, id
+            @ec2.associate_address public_ip: address, instance_id: id
+        end
+        # Public: return a list of inforation about declared security groups
+        #
+        # Examples
+        #
+        #   sgs[0..1]
+        #       => [{"ownerId"=>"424242", "groupName"=>"sg1"},
+        #            {"ownerId"=>"424242", "groupName"=>"sg2"}]
+        #
+        # Returns an array with for each SG, the ownerID and the groupName
         def sgs
             @ec2.describe_security_groups.securityGroupInfo.item.collect do |item|
                 item.reject { |k, v| not ["groupName", "ownerId"].include? k }
             end
         end
-        def i() instances ["instanceId", "ipAddress", "tagSet", "instanceState"] end
+        # Public: return virtual machines instances with few details
+        #
+        # Examples
+        #
+        #   ins[0]
+        #       => {:instanceId=>"i-deadbeef", :instanceState=>
+        #                       {"code"=>"16", "name"=>"running"},
+        #            :ipAddress=>"10.1.1.2", :tagSet=>{:k=>"v"}}
+        #
+        # Returns an array with instanceId, ipAddress, tagSet, instanceState in a hash
+        def ins() instances ["instanceId", "ipAddress", "tagSet", "instanceState"] end
+        # Public: get system log
+        #
+        # id - VM instance id
+        #
+        # Examples
+        #
+        #   log("i-deadbeef")[0..1]
+        #       => ["Initializing cgroup subsys cpuset", "Initializing cgroup subsys cpu"]
+        #
+        # Returns an array containing the lines of the system log
         def log id
-            puts Base64.decode64 @ec2.get_console_output(instance_id: id)["output"]
+            Base64.decode64(@ec2.get_console_output(instance_id: id)["output"]).split("\r\n")
         end
+        # Public: terminates a VM instance
+        #
+        # id - the VM instance id
+        #
+        # Examples
+        #
+        #   terminate "i-deadbeef"
+        #
+        # Returns information about the termination status
         def terminate(id) @ec2.terminate_instances(instance_id: id) end
+        # Public: opens up a pry shell
         def shell() binding.pry end
+        # Public: update the credentials configuration
+        #
+        # creds - current credentials
+        #
+        # Examples
+        #   update_configuration
+        #   Will try and update configuration in /home/yazgoo/.awssecret
+        #   access key (foo): 
+        #   secret access key (bar): 
+        #   entry point (default being https://aws.amazon.com if blank)
+        #        (http://ec2.aws.com): 
+        #       => ["access key", "secret access key", 
+        #           "entry point ..."]
+        #
+        # Returns the description of the updated fields
         def update_configuration creds = nil
             puts "Will try and update configuration in #{@conf}"
             creds = read_credentials if creds.nil?
@@ -33,19 +140,30 @@ module Ec2l
                 ["access key", "secret access key",
                  "entry point (default being https://aws.amazon.com if blank)"
                 ].each_with_index do |prompt, i|
-                    printf "#{prompt} (#{creds.size > i ? creds[i]:""}): "
-                    line = $stdin.gets.chomp
-                    line = creds[i] if line.empty? and creds.size > i
+                    line = prompt_line prompt, creds[i]
                     f.puts line if not line.empty?
                 end
             end
         end
+        # Public: reads credentials from configuration file
+        #
+        # Examples
+        #
+        #   read_credentials
+        #       => ["accesskey", "scretkey", "https://entry.com"]
+        #
+        # Return a list with the credentials and entrypoint if defined
         def read_credentials
             creds = []
             File.open(@conf) { |f| f.each_line { |l| creds << l.chomp } } if File.exists?(@conf)
             creds
         end
 private
+        def prompt_line prompt, cred
+            printf "#{prompt} (#{creds? creds:""}): "
+            line = $stdin.gets.chomp
+            if line.empty? and creds.size > i then creds else line end
+        end
         def to_hash array
             Hash[array.collect { |i| [i["key"].to_sym, i["value"]] }]
         end
@@ -55,18 +173,64 @@ private
             update_configuration credentials
             read_credentials
         end
-        def initialize
-            @conf = ENV['awssecret'] || "#{ENV['HOME']}/.awssecret"
-            credentials = load_credentials
+        def build_underlying_client credentials
             ENV['EC2_URL'] = credentials[2] if credentials.size >= 3
             require 'AWS' # *must* load AWS after setting EC2_URL
-            @ec2 = AWS::EC2::Base.new access_key_id: credentials[0],
+            AWS::EC2::Base.new access_key_id: credentials[0],
                 secret_access_key: credentials[1]
         end
+        def initialize
+            @conf = ENV['awssecret'] || "#{ENV['HOME']}/.awssecret"
+            @ec2 = build_underlying_client load_credentials
+        end
+        # Internal: try and find/launch the method on the 
+        #   underlying client called by the method name
+        #   or by describe_#{name}
+        #
+        # Examples
+        #
+        #  method_missing_ec2 :addresses
+        #    => {"xmlns"=>"http://ec2.amazonaws.com/doc/2010-08-31/",
+        #           ...
+        #
+        # Return the result of the underlying method call
+        def method_missing_ec2 method, *args, &block
+            [method, "describe_#{method.to_s}".to_sym].each do |meth|
+                if @ec2.public_methods.include? meth
+                    return @ec2.send meth, *args, &block
+                end
+            end
+            nil
+        end
+        # Internal: try and call method_missing_ec2
+        #   if its result is nil, display a list of the class
+        #   public methods
+        #
+        # Examples
+        #
+        #  h
+        #  =>Usage: action parameters...
+        #    available actions:
+        #    [
+        #        [0]            associate(address, id) Ec2l::Client
+        #        [1]                    i()            Ec2l::Client
+        #    
+        # Return the result of method_missing_ec2 or nil
         def method_missing method, *args, &block
+            result = method_missing_ec2(method, *args, &block)
+            return result if not result.nil?
             puts "Usage: action parameters...", "available actions:"
             awesome_print (public_methods - "".public_methods)
             nil
         end
+        def rearrange_fields item, keep
+            it = item.instancesSet.item[0]
+            if keep.include? "groups" and item.groupSet
+                it["groups"] = item.groupSet.item.map{|x| x.groupId }
+            end
+            if keep.include? "tagSet" and it.tagSet
+                it["tagSet"] = to_hash(it.tagSet.item)
+            end
+        end
     end
 end

data/lib/ec2l/version.rb

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

data/test/test_ec2l.rb

@@ -1,20 +1,97 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
 require 'test/unit'
 require 'tempfile'
+require 'base64'
 require 'ec2l'
+class Hash
+    def method_missing method, *args, &block
+        method = method.to_s
+        if method.end_with? "="
+            self[method.to_s[0..-2]] = args[0]
+        else
+            self[method]
+        end
+    end
+end
+class Client < Ec2l::Client
+    def build_underlying_client credentials
+        if credentials.size == 3 and credentials[2] == 'through'
+            super credentials
+        else
+            MockEc2.new
+        end
+    end
+end
+$instance_set = {"reservationSet" => {"item" => [{"instancesSet" => {
+            "item" => [{"instanceId" => "lol"}]}}]}}
+class MockEc2
+    def method_missing method, *args, &block
+        nil
+    end
+    def describe_instances stuff = nil
+        $instance_set
+    end
+    def describe_security_groups
+        {"securityGroupInfo" => {"item" => [{'groupName' => 'test'}] }}
+    end
+    def get_console_output stuff
+        {"output" => Base64.encode64("hello")}
+    end
+end
 class EC2lTest < Test::Unit::TestCase
-    def test_initialize
+    def create_conf creds
         conf = Tempfile.new "a"
-        conf.write "a\nb\n"
+        conf.write creds.join "\n"
         conf.close
-        ENV['awssecret'] = conf.path
-        client = Ec2l::Client.new
+        conf.path
+    end
+    def setup
+        ENV['awssecret'] = create_conf ['a', 'b']
+        @cli = Client.new
     end
     def test_configuration
-        client = test_initialize
         def $stdin.gets() 'same_old' end
-        client.update_configuration
-        creds = client.read_credentials
-        assert creds.size == 3
+        @cli.update_configuration
+        creds = @cli.read_credentials
+        assert creds.size == 3, creds.to_s
         creds.each { |cred| assert cred == 'same_old' }
+        ENV['awssecret'] = create_conf([])
+        Client.new.send :load_credentials
+    end
+    def test_method_missing
+        assert @cli.h.nil?
+        assert @cli.send(:method_missing_ec2, :h).nil?
+    end
+    def test_utilities
+        result = @cli.send :to_hash, [{"key" => "hello", "value" => "world"}]
+        assert result == {hello: "world"}
+    end
+    def test_basic_underlying_calls
+        assert @cli.associate(nil, nil).nil?
+        assert @cli.instance(nil) == $instance_set
+        assert @cli.log(nil) == ["hello"]
+        assert @cli.terminate(nil).nil?
+    end
+    def test_rearrange_fields
+        item = {"instancesSet" => {"item" => [{"tagSet" => {"item" => []}}]},
+                "groupSet" => {"item" => [{}] } }
+        @cli.send :rearrange_fields, item, ["groups", "tagSet"]
+    end
+    def test_complex_calls
+        assert @cli.describe_instances == $instance_set
+        instances = [{:instanceId=>"lol"}]
+        assert @cli.instances == instances
+        assert @cli.ins == instances
+        assert @cli.sgs == [{"groupName"=>"test"}]
+    end
+    def test_underlying_client_initialization
+        x = nil
+        begin
+            @cli.build_underlying_client ['a', 'b', 'through']
+        rescue Exception => e
+            x = e
+        end
+        assert not(x.nil?)
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ec2l
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3534822186710217201
+      hash: 4414468867736333160
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3534822186710217201
+      hash: 4414468867736333160
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23