aws_instance_list 0.1.0 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4accfdc3e9e42fd65adf25830f1a458592e2d5b6
-  data.tar.gz: b2324a9500396b09d2186bf76284925956753dda
+  metadata.gz: 3a88a496e99edde8c7d285a465cfe304c38fbf82
+  data.tar.gz: c5db25fd4d65f23a849fd817636f180e5e65f676
 SHA512:
-  metadata.gz: 5f49bf99a394d3f3b685d1ddbee029ee9f189d4a254a86b29484d507639b799458f72e8b1a079a08efdf3f02c61426bec8e16d50f10e4c74f79768c90a1c500f
-  data.tar.gz: 0d8dd2b7261fe378152f157ef56769ac82274d8797fb324b4efc2107727d12ac9307e81f2cbe3449734f3f0da877e3e095fb0b14b66a5b29ad7a73393a81ef7c
+  metadata.gz: 9f2bff084b04f818baafcddd07bd24ed8635bcb48d43b473da90e2e8c26cf7acb063a1d532e85a8af6298dc372c36de1e621a9562e75bd8ccd6890926e20c52d
+  data.tar.gz: '02487fda68e8e17d02758a7e384f586d8f42e9b7be6c90d783facff877f3d11d855ec0173e2a5dd8133efbe82ddbd0a68eacce935ed708ebb7e41b926a5b726b'

data/.gitignore

@@ -10,3 +10,6 @@
 # rspec failure tracking
 .rspec_status
 *.sw*
+.env
+test.env
+.byebug_history

data/Gemfile.lock

@@ -1,12 +1,36 @@
 PATH
   remote: .
   specs:
-    aws_instance_list (0.1.0)
+    aws_instance_list (1.2.6)
+      aws-sdk-cloudwatch (~> 1.6)
+      aws-sdk-ec2 (~> 1.37)
+      aws-sdk-rds (~> 1.23)
+      dotenv (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    aws-eventstream (1.0.1)
+    aws-partitions (1.95.0)
+    aws-sdk-cloudwatch (1.6.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-core (3.22.1)
+      aws-eventstream (~> 1.0)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.38.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-rds (1.23.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sigv4 (1.0.3)
+    byebug (10.0.2)
     diff-lcs (1.3)
+    dotenv (2.5.0)
+    jmespath (1.4.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -28,6 +52,7 @@ PLATFORMS
 DEPENDENCIES
   aws_instance_list!
   bundler (~> 1.16)
+  byebug (~> 10.0)
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -2,7 +2,10 @@
 
 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_instance_list`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+This gem is an easy way to get AWS instance list in all regions.
+The class AwsIntanceList::List runs one Thread by region to get the data in each one. Finally join all in one Array.
+
+Using the AWS describe instance we can get the instances but the metrics are not available.
 
 ## Installation
 
@@ -22,7 +25,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+As a library you need require it after install the gem.
+
+```ruby
+
+require 'aws_instance_list'
+
+list= AwsInstanceList::List.new
+
+# sample to get all rds instances
+
+list.db_list # will return an array like this
+
+# db_instance_identifier, engine, storage (GBytes), status, free storage available, region
+
+#\>
+[
+["db1", "mysql", 50, "available", 45.3829460144043, "eu-west-1"],
+["db2", "mysql", 50, "available", 44.111881256103516, "eu-west-1"],
+["db3", "mysql", 20, "available", 15.590309143066406, "eu-west-2"],
+["db4", "mysql", 100, "available", 94.48283767700195, "eu-west-2"]
+]
+
+```
+
+
+
+## Test
+Add a test.env file with:
+
+```bash
+DB_INSTANCE_IDENTIFIER=identifier_name_db
+REGION=aws_region_to_test # sample: eu-central-1
+LONG_REGION=aws_region_with_pagination_to_test # sample: eu-west-1
+
+```
+
+And run
+
+```bash
+rspec
+```
 
 ## Development
 

data/aws_instance_list.gemspec

@@ -34,5 +34,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "byebug", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "aws-sdk-rds", "~> 1.23"
+  spec.add_dependency "aws-sdk-ec2", "~> 1.37"
+  spec.add_dependency "aws-sdk-cloudwatch", "~> 1.6"
+  spec.add_dependency "dotenv", "~> 2.5"
 end

data/lib/aws_instance_list/list.rb

@@ -0,0 +1,43 @@
+module AwsInstanceList
+
+  class List
+
+    attr_accessor :regions
+
+    def initialize
+      @regions=AwsInstanceList::Region.list
+      @db_list={}
+    end
+
+    def db_list
+
+      if @db_list.empty?
+
+        threads = []
+
+        regions.each do |region|
+
+          threads << Thread.new do
+            @db_list[region]=rds_db_list region: region
+          end
+
+        end
+
+        loop do
+          break if threads.count { |th| th.alive? } == 0
+        end
+
+      end
+
+      @db_list.values.flatten(1)
+
+    end
+
+    def rds_db_list region:
+      rds=AwsInstanceList::RDS.new region: region
+      rds.db_instances
+      rds.db_list
+    end
+
+  end
+end

data/lib/aws_instance_list/metric.rb

@@ -0,0 +1,43 @@
+require 'aws-sdk-cloudwatch'
+
+module AwsInstanceList
+
+  class Metric
+
+    attr_accessor :client
+
+    def initialize region: 'eu-west-1'
+      @client=Aws::CloudWatch::Client.new region: region
+    end
+
+    def statistics options
+      client.get_metric_statistics options
+    end
+
+    def list options
+      client.list_metrics options
+    end
+
+    def free_storage_space db_instance_identifier
+      resp=statistics( {
+        namespace: "AWS/RDS",
+        metric_name: "FreeStorageSpace",
+        dimensions: [
+          {
+            name: "DBInstanceIdentifier",
+            value: db_instance_identifier,
+          },
+        ],
+        start_time: Time.now - 600,
+        end_time: Time.now ,
+        period: 60,
+        statistics: ["Minimum"]
+      })
+
+      resp.datapoints.last.minimum / ( 1024.0 ** 3)
+
+    end
+
+  end
+end
+

data/lib/aws_instance_list/rds.rb

@@ -0,0 +1,71 @@
+require 'aws-sdk-rds'
+require 'yaml'
+
+module AwsInstanceList
+
+  class RDS
+
+    attr_accessor :client, :region
+
+    def initialize region: 'eu-west-1'
+
+      @region=region
+
+      @client=Aws::RDS::Client.new region: region
+
+      @db_instances = []
+
+    end
+
+    def db_descriptions options={}
+      client.describe_db_instances(options)
+    end
+
+    def db_instances options={}
+      descriptions=db_descriptions(options)
+      @db_instances+=descriptions.db_instances
+      if descriptions.marker
+        options[:marker]=descriptions.marker
+        db_instances(options)
+      else
+        @db_instances
+      end
+    end
+
+    def db_list options: {}, fields: nil
+
+      fields||=load_db_fields
+
+      db_instances(options).map do |i|
+        fields.map { |f| i.send(f) } << free_storage_space(i.db_instance_identifier) << region
+      end
+    end
+
+    def load_db_fields
+      yaml['db']['fields']
+    end
+
+    def yaml
+      @yaml||=yaml_default.merge(yaml_file)[demodulize]
+    end
+
+    def yaml_default
+      YAML.load_file AwsInstanceList::DEFAULT_SETTINGS
+    end
+
+    def yaml_file
+      ENV.has_key?('AWS_INSTANCE_LIST_YAML') ? YAML.load_file(ENV['AWS_INSTANCE_LIST_YAML']) : {}
+    end
+
+    def demodulize
+      self.class.name.split('::').last
+    end
+
+    def free_storage_space db_instance_identifier
+      metric = AwsInstanceList::Metric.new region: region
+      metric.free_storage_space db_instance_identifier
+    end
+
+  end
+
+end

data/lib/aws_instance_list/region.rb

@@ -0,0 +1,26 @@
+require 'aws-sdk-ec2'
+
+module AwsInstanceList
+
+  class Region
+
+    class << self
+
+      def ec2
+        @ec2||=Aws::EC2::Client.new
+      end
+
+      def descriptions
+        @descriptions||=ec2.describe_regions
+      end
+
+      def list
+        descriptions.regions.map do |description|
+          description.region_name
+        end
+      end
+
+    end
+
+  end
+end

data/lib/aws_instance_list/version.rb

@@ -1,3 +1,3 @@
 module AwsInstanceList
-  VERSION = "0.1.0"
+  VERSION = "1.2.6"
 end

data/lib/aws_instance_list.rb

@@ -1,5 +1,15 @@
-require "aws_instance_list/version"
+require 'aws_instance_list/list'
+require 'aws_instance_list/region'
+require 'aws_instance_list/metric'
+require 'aws_instance_list/rds'
+require 'aws_instance_list/version'
+
+require 'dotenv/load'
+
+Dotenv.load
 
 module AwsInstanceList
-  # Your code goes here...
+
+  DEFAULT_SETTINGS= File.join(File.dirname(__FILE__),%w(config default_settings.yaml))
+
 end

data/lib/config/default_settings.yaml

@@ -0,0 +1,8 @@
+---
+RDS:
+  db:
+    fields:
+      - db_instance_identifier
+      - engine
+      - allocated_storage
+      - db_instance_status

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws_instance_list
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.2.6
 platform: ruby
 authors:
 - Diego PL
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2018-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-rds
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudwatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: The target is get the instance lists of AWS accounts. Return array of
   data.
 email:
@@ -74,7 +144,12 @@ files:
 - bin/console
 - bin/setup
 - lib/aws_instance_list.rb
+- lib/aws_instance_list/list.rb
+- lib/aws_instance_list/metric.rb
+- lib/aws_instance_list/rds.rb
+- lib/aws_instance_list/region.rb
 - lib/aws_instance_list/version.rb
+- lib/config/default_settings.yaml
 homepage: https://github.com/diegopiccinini/aws_instance_list
 licenses:
 - MIT