ec2spec 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35066b282c5961b31b00bf8a976e97731c3706b2
-  data.tar.gz: 80caf94e7fdf60f3b5c71fc74eab364fa46b2fac
+  metadata.gz: f654ed96111dcd1d53c9518fbf643b443d3ff727
+  data.tar.gz: 21342c52833a9f060f19de8318ad1f6cd5a35d2c
 SHA512:
-  metadata.gz: e9695d9a7d836f44b13e18fec1dc517a77db27c3414beb23027674d47156b8f7d89e501423607414ef9fbed825675e6bd3dad4fd2c5ec828a04bc1fecb577b31
-  data.tar.gz: dd1688082ec9690f45c837c3e0dc918e14efb4099f994c2a18cecf6a1d4264a5a0d3bcae078188df76d7b95abbd35c55a591c0b9710a685f4fcecaa7d155aafb
+  metadata.gz: 56b4f3e02cd6b46d652cafdc9ea549bb82bc6d265ac339fd65c6d6d115e877f1510c2b0eda5a31becd75f727c29953e70e3f02c2de0fd07cbbfc5f549c8959c1
+  data.tar.gz: 04fde02c25dbebf9faa24036bb02fe14a9cce4d94f0b0e7de66f6590981ea5f49261811364afd6aeda4944a8a620d8c94c51ca818bb002f17347ba2815344554

data/.travis.yml

@@ -1,5 +1,12 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.5
-before_install: gem install bundler -v 1.16.1
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+before_install: 
+  - gem install bundler -v 1.16.1
+  - gem install rubocop
+script:
+  - rubocop --fail-level=W
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+## 0.1.2
+
+### Added
+  * Add `--region` option
+  * Add `--debug` option
+  * Add `--format` option
+  * Add vCPU
+  * Add downloading logs
+
+### Changed
+  * Memory value getting from API
+
+## 0.1.1
+
+- First Release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ec2spec (0.1.1)
+    ec2spec (0.1.2)
       faraday
       specinfra
       terminal-table

data/README.md

@@ -1,34 +1,102 @@
 # ec2spec
 
-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/ec2spec`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/ec2spec.svg)](https://badge.fury.io/rb/ec2spec)
+[![Build Status](https://travis-ci.org/kyoshidajp/ec2spec.svg?branch=master)](https://travis-ci.org/kyoshidajp/ec2spec)
+[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]
 
-TODO: Delete this and the text above, and describe your gem
+[license]: https://github.com/kyoshidajp/ec2spec/blob/master/LICENSE
+
+ec2spec is a simple comparison tool for Amazon EC2 Instances you can access.
+
+Supports the following items.
+
+| item     | from    |
+| :------- | :------ |
+| instance type | host |
+| instance id | host |
+| vCPU | AWS Price List API |
+| memory | AWS Price List API |
+| price | AWS Price List API |
+
+The target host must be accessible from the machine. Also, only On-Demand way and Linux machine.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```
+$ gem install ec2spec
+```
 
-```ruby
-gem 'ec2spec'
+## Usage
+
+```
+$ ec2spec ssh -h host1 ... [options]
 ```
 
-And then execute:
+### Options
+
+```
+-h, --host    Target hosts name.
 
-    $ bundle
+--days        How many days per one month.
 
-Or install it yourself as:
+--format      Output format (default: plain_text).
+              plain_text, json, hash
 
-    $ gem install ec2spec
+--region      Region of EC2 (default: ap-northeast-1).
 
-## Usage
+--debug       Output logs as DEBUG level.
+```
+
+### Example
+
+```
+$ ec2spec ssh -h host1 host2 host3
+```
+
+```
+I, [2018-08-12T20:54:25.814752 #64341]  INFO -- : Started: host1
+I, [2018-08-12T20:54:25.814835 #64341]  INFO -- : Started: host2
+I, [2018-08-12T20:54:25.814867 #64341]  INFO -- : Started: host3
+I, [2018-08-12T20:54:25.826113 #64341]  INFO -- : Finished: host3
+I, [2018-08-12T20:54:29.385848 #64341]  INFO -- : Finished: host1
+I, [2018-08-12T20:54:37.560003 #64341]  INFO -- : Finished: host2
++---------------+-------------+-------------+-------+
+|               | host1       | host2       | host3 |
++---------------+-------------+-------------|-------+
+| instance_type |    t2.micro |  c4.2xlarge |   N/A |
+|   instance_id |  i-xxxxxxxx |  i-yyyyyyyy |   N/A |
+|          vCPU |           1 |           8 |   N/A |
+|        memory |       1 GiB |      15 GiB |   N/A |
+| price (USD/H) |      0.0152 |       0.504 |   N/A |
+| price (USD/M) |     11.3088 |     374.976 |   N/A |
++---------------+-------------+---------------------+
+```
+
+The data of `host3` could not be acquired due to some error.
+
+## As a library
+
+```
+> require 'ec2spec'
+> hosts = %w[host1 host2]
+> client = Ec2spec::Client.new(hosts, 30, 'hash')
+> result_json = client.run
+> puts result_json
+I, [2018-08-12T20:54:25.814752 #64341]  INFO -- : Started: host1
+I, [2018-08-12T20:54:25.814835 #64341]  INFO -- : Started: host2
+I, [2018-08-12T20:54:29.385848 #64341]  INFO -- : Finished: host1
+I, [2018-08-12T20:54:37.560003 #64341]  INFO -- : Finished: host2
+=> {"host1":{"instance_type":"t2.micro","instance_id":"i-xxxxxxxx","vCPU":"1","memory":"1 GiB","price (USD/H)":0.152,"price (USD/M)":11.3088},"host2":{"instance_type":"c4.2xlarge","instance_id":"i-yyyyyyyy","vCPU":"8","memory":"15 GiB","price (USD/H)":0.504,"price (USD/M)":374.976}}
+```
 
-TODO: Write usage instructions here
+## Requirement
 
-## Development
+- Ruby(MRI) 2.3.0 or higher
 
-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.
+## Competitors
 
-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).
+- [Amazon Web Services Simple Monthly Calculator](https://calculator.s3.amazonaws.com/index.html)
+- [Amazon EC2 Instance Comparison](https://www.ec2instances.info/)
 
 ## Contributing
 

data/ec2spec.gemspec

@@ -1,8 +1,6 @@
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ec2spec/version'
-
-# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = 'ec2spec'
   spec.version       = Ec2spec::VERSION
@@ -31,4 +29,3 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
 end
-# rubocop:enable Metrics/BlockLength

data/lib/ec2spec/cli.rb

@@ -2,14 +2,24 @@ require 'thor'
 
 module Ec2spec
   class CLI < Thor
-    desc 'ssh host ...', ''
+    desc 'ssh -h host1 ...', 'Compare the specifications of EC2 instances.'
     option 'host', aliases: 'h', type: :array, equired: true
     option 'days', type: :numeric
+    option 'format'
+    option 'region'
+    option 'debug', type: :boolean
+
+    # rubocop:disable Metrics/AbcSize
     def ssh
       hosts = options['host']
       days = options['days']
-      client = Ec2spec::Client.new(hosts, days)
-      client.run
+      format = options['format'] || :plain_text
+      region = options['region'] || 'ap-northeast-1'
+
+      Ec2spec.logger.level = Logger::DEBUG if options['debug']
+      client = Ec2spec::Client.new(hosts, days, format, region)
+      puts client.run
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/ec2spec/client.rb

@@ -1,25 +1,30 @@
-require 'logger'
+require 'ec2spec/json_formatter'
+require 'ec2spec/plain_text_formatter'
+require 'ec2spec/hash_formatter'
 
 module Ec2spec
+  class UndefineFormatterError < StandardError; end
+
   class Client
     META_DATA_URL_BASE = 'http://169.254.169.254/latest/meta-data/'
     META_DATA_INSTANCE_TYPE_PATH = '/instance-type'
     META_DATA_INSTANCE_ID_PATH   = '/instance-id'
+    DEFAULT_REGION = 'ap-northeast-1'
 
-    TABLE_LABEL_WITH_METHODS = {
-      'instance_type' => :instance_type,
-      'instance_id'   => :instance_id,
-      'memory'        => :memory,
-      'price (USD/H)' => :price_per_unit,
-      'price (USD/M)' => :price_per_month,
+    OUTPUT_FORMATTERS = {
+      plain_text: PlainTextFormatter,
+      json: JsonFormatter,
+      hash: HashFormatter,
     }
 
-    def initialize(hosts, days)
-      @log = Logger.new(STDOUT)
-      @log.level = Logger::INFO
-
+    def initialize(hosts, days, format, region = DEFAULT_REGION)
       @hosts = hosts
       @days = days
+      @format = format
+      @region = region
+
+      extend_formatter
+      OfferFile.instance.prepare(@region)
     end
 
     def run
@@ -29,24 +34,34 @@ module Ec2spec
           exec_host_result(host, backend)
         end
       end
-      @results = threads.each(&:join)
-      output
+      results = threads.each(&:join).map(&:value)
+      output(results, @hosts)
     end
 
     private
 
+    def extend_formatter
+      format_sym = begin
+        @format.to_sym
+      rescue NoMethodError
+        raise UndefineFormatterError
+      end
+
+      raise UndefineFormatterError unless OUTPUT_FORMATTERS.key?(format_sym)
+      extend OUTPUT_FORMATTERS[format_sym]
+    end
+
     def exec_host_result(host, backend)
-      @log.info("Started: #{host.host}")
+      Ec2spec.logger.info("Started: #{host.host}")
 
       begin
         host.instance_type = instance_type(backend)
         host.instance_id   = instance_id(backend)
-        host.memory = memory(backend)
       rescue Errno::ECONNREFUSED
         host.na_values
       end
 
-      @log.info("Finished: #{host.host}")
+      Ec2spec.logger.info("Finished: #{host.host}")
       host
     end
 
@@ -72,39 +87,15 @@ module Ec2spec
       "curl -s #{metadata_url(META_DATA_INSTANCE_ID_PATH)}"
     end
 
-    def memory(backend)
-      Specinfra::HostInventory::Memory.new(backend.host_inventory).get['total']
-    end
-
     def target(host_name)
       ssh_options = Net::SSH::Config.for(host_name)
       backend = Specinfra::Backend::Ssh.new(
         host: ssh_options[:host_name],
         ssh_options: ssh_options,
       )
-      host = Ec2spec::HostResult.new(host_name, @days)
+      host = Ec2spec::HostResult.new(@region, host_name, @days)
       host.backend = backend
       host
     end
-
-    def output
-      results = @results.map(&:value)
-      table = Terminal::Table.new
-      table.headings = table_header(results)
-      table.rows = table_rows(results)
-      column_count = @hosts.size + 1
-      column_count.times { |i| table.align_column(i, :right) }
-      puts table
-    end
-
-    def table_header(results)
-      [''].concat(results.map(&:host))
-    end
-
-    def table_rows(results)
-      TABLE_LABEL_WITH_METHODS.each_with_object([]) do |(k, v), row|
-        row << [k].concat(results.map(&v))
-      end
-    end
   end
 end

data/lib/ec2spec/const.rb

@@ -0,0 +1,5 @@
+module Ec2spec
+  module Const
+    PROJECT_DIR = '.ec2spec'
+  end
+end

data/lib/ec2spec/hash_formatter.rb

@@ -0,0 +1,11 @@
+require 'json'
+
+module Ec2spec
+  module HashFormatter
+    def output(results, _hosts)
+      results.each_with_object({}) do |result, hash|
+        hash[result.host] = result.to_hash
+      end
+    end
+  end
+end

data/lib/ec2spec/host_result.rb

@@ -3,11 +3,21 @@ module Ec2spec
     MONTH_OF_DAYS = 31
     NA_VALUE = 'N/A'
 
-    attr_accessor :host, :backend, :instance_id, :memory, :cpu
+    LABEL_WITH_METHODS = {
+      'instance_type' => :instance_type,
+      'instance_id'   => :instance_id,
+      'vCPU'          => :vcpu,
+      'memory'        => :memory,
+      'price (USD/H)' => :price_per_unit,
+      'price (USD/M)' => :price_per_month,
+    }
+
+    attr_accessor :host, :backend, :instance_id, :cpu
     attr_reader :instance_type
     attr_writer :price_per_unit
 
-    def initialize(host, days = nil)
+    def initialize(region, host, days = nil)
+      @region = region
       @host = host
       @backend = nil
       @days = days || MONTH_OF_DAYS
@@ -25,17 +35,39 @@ module Ec2spec
       @instance_type = value
 
       return if value == NA_VALUE
-      @offer_file = Ec2spec::OfferFile.new(value)
       price_per_unit
     end
 
+    def vcpu
+      @vcpu ||=
+        Ec2spec::OfferFile.instance.vcpu(@instance_type)
+    end
+
+    def memory
+      @memory ||=
+        Ec2spec::OfferFile.instance.memory(@instance_type)
+    end
+
     def price_per_unit
-      @price_per_unit ||= @offer_file.price_per_unit
+      @price_per_unit ||=
+        Ec2spec::OfferFile.instance.price_per_unit(@instance_type)
     end
 
     def price_per_month
       return NA_VALUE if @price_per_unit == NA_VALUE
       @price_per_unit * 24 * @days
     end
+
+    def to_hash
+      host_values
+    end
+
+    private
+
+    def host_values
+      LABEL_WITH_METHODS.each_with_object({}) do |(k, v), hash|
+        hash[k] = public_send(v)
+      end
+    end
   end
 end

data/lib/ec2spec/json_formatter.rb

@@ -0,0 +1,12 @@
+require 'json'
+
+module Ec2spec
+  module JsonFormatter
+    def output(results, _hosts)
+      result_hash = results.each_with_object({}) do |result, hash|
+        hash[result.host] = result.to_hash
+      end
+      result_hash.to_json
+    end
+  end
+end

data/lib/ec2spec/logger.rb

@@ -0,0 +1,10 @@
+require 'logger'
+
+module Ec2spec
+  @logger = ::Logger.new($stdout)
+  @logger.level = Logger::INFO
+
+  class << self
+    attr_accessor :logger
+  end
+end

data/lib/ec2spec/offer_file.rb

@@ -1,19 +1,41 @@
-require 'json'
-require 'faraday'
+require 'singleton'
 
 module Ec2spec
   class OfferFile
-    OFFER_FILE_URL  = 'https://pricing.us-east-1.amazonaws.com/offers/v1.0/aws/AmazonEC2/20180802021534/ap-northeast-1/index.json'
+    include Singleton
+
     OFFER_FILE_NAME = 'price_list.json'
-    OFFER_FILE_DIR  = '.ec2spec'
 
-    def initialize(instance_type)
-      @instance_type = instance_type
-      @offer_file_json = nil
+    def prepare(region)
+      @region = region
+
+      if File.exist?(offer_file_path)
+        Ec2spec.logger.debug('Read from cached offer file')
+      else
+        Ec2spec.logger.info('Downloading: offer file')
+        download
+        Ec2spec.logger.info("Downloaded: offer file (#{offer_file_path})")
+      end
+    end
+
+    def products
+      offer_file_json['products']
+    end
+
+    def vcpu(instance_type)
+      sku_instance_type = sku(instance_type)
+      product = products[sku_instance_type]['attributes']
+      product['vcpu']
+    end
+
+    def memory(instance_type)
+      sku_instance_type = sku(instance_type)
+      product = products[sku_instance_type]['attributes']
+      product['memory']
     end
 
-    def price_per_unit
-      sku_instance_type = sku
+    def price_per_unit(instance_type)
+      sku_instance_type = sku(instance_type)
       on_demand = offer_file_json['terms']['OnDemand']
       sku_value = on_demand[sku_instance_type].first[1]
       price_dimensions = sku_value['priceDimensions']
@@ -22,29 +44,29 @@ module Ec2spec
 
     private
 
-    def offer_file_json
-      download unless File.exist?(offer_file_path)
-      @offer_file_json ||= JSON.parse(File.open(offer_file_path).read)
+    def download
+      http_conn = Faraday.new do |builder|
+        builder.adapter Faraday.default_adapter
+      end
+
+      offer_file_url = OfferIndexFile.instance.offer_file_url(@region)
+      response = http_conn.get(offer_file_url)
+      File.open(offer_file_path, 'wb') { |fp| fp.write(response.body) }
     end
 
     def offer_file_path
-      price_list_dir = File.join(ENV['HOME'], OFFER_FILE_DIR)
+      price_list_dir = File.join(ENV['HOME'], Const::PROJECT_DIR)
       Dir.mkdir(price_list_dir) unless Dir.exist?(price_list_dir)
       File.join(price_list_dir, OFFER_FILE_NAME)
     end
 
-    def download
-      http_conn = Faraday.new do |builder|
-        builder.adapter Faraday.default_adapter
-      end
-      response = http_conn.get(OFFER_FILE_URL)
-      File.open(offer_file_path, 'wb') { |fp| fp.write(response.body) }
+    def offer_file_json
+      @offer_file_json ||= JSON.parse(File.open(offer_file_path).read)
     end
 
-    def sku
-      products = offer_file_json['products']
+    def sku(instance_type)
       target_product = products.find do |product|
-        product?(product, @instance_type)
+        product?(product, instance_type)
       end
       target_product[1]['sku']
     end

data/lib/ec2spec/offer_index_file.rb

@@ -0,0 +1,60 @@
+require 'singleton'
+
+module Ec2spec
+  class OfferIndexFile
+    include Singleton
+
+    REGION_INDEX_FILE_URL = 'https://pricing.us-east-1.amazonaws.com/offers/v1.0/aws/AmazonEC2/current/region_index.json'
+
+    def offer_file_url(region)
+      mkdir_project_dir
+      offer_index_file_json
+
+      file_path = @offer_index_file_json['regions'][region]['currentVersionUrl']
+      parsed_url = URI.parse(REGION_INDEX_FILE_URL)
+      parsed_url.path = file_path
+      parsed_url.to_s
+    end
+
+    private
+
+    def project_dir
+      File.join(ENV['HOME'], Const::PROJECT_DIR)
+    end
+
+    def mkdir_project_dir
+      Dir.mkdir(project_dir) unless Dir.exist?(project_dir)
+    end
+
+    def region_index_file_path
+      File.join(project_dir, REGION_INDEX_FILE_URL)
+    end
+
+    def offer_index_file_path
+      file_name = File.basename(REGION_INDEX_FILE_URL)
+      File.join(project_dir, file_name)
+    end
+
+    def offer_index_file_json
+      if File.exist?(offer_index_file_path)
+        Ec2spec.logger.debug('Read from cached offer index file')
+      else
+        Ec2spec.logger.info('Downloading: offer index file')
+        download_region_index_file
+        Ec2spec.logger
+               .info("Downloaded: offer index file (#{offer_index_file_path})")
+      end
+
+      @offer_index_file_json ||=
+        JSON.parse(File.open(offer_index_file_path).read)
+    end
+
+    def download_region_index_file
+      http_conn = Faraday.new do |builder|
+        builder.adapter Faraday.default_adapter
+      end
+      response = http_conn.get(REGION_INDEX_FILE_URL)
+      File.open(offer_index_file_path, 'wb') { |fp| fp.write(response.body) }
+    end
+  end
+end

data/lib/ec2spec/plain_text_formatter.rb

@@ -0,0 +1,23 @@
+module Ec2spec
+  module PlainTextFormatter
+    def output(results, hosts)
+      table = Terminal::Table.new
+      table.headings = table_header(results)
+      table.rows = table_rows(results)
+      column_count = hosts.size + 1
+      column_count.times { |i| table.align_column(i, :right) }
+      table
+    end
+
+    def table_header(results)
+      [''].concat(results.map(&:host))
+    end
+
+    def table_rows(results)
+      Ec2spec::HostResult::LABEL_WITH_METHODS
+        .each_with_object([]) do |(k, v), row|
+        row << [k].concat(results.map(&v))
+      end
+    end
+  end
+end

data/lib/ec2spec/version.rb

@@ -1,3 +1,3 @@
 module Ec2spec
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/ec2spec.rb

@@ -1,8 +1,13 @@
+require 'faraday'
+require 'json'
 require 'specinfra'
 require 'terminal-table'
 require 'ec2spec/cli'
 require 'ec2spec/client'
+require 'ec2spec/const'
 require 'ec2spec/version'
 require 'ec2spec/host_result'
+require 'ec2spec/logger'
 require 'ec2spec/offer_file'
+require 'ec2spec/offer_index_file'
 require 'ec2spec/price_calculator'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ec2spec
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Katsuhiko
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -137,6 +137,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -149,8 +150,14 @@ files:
 - lib/ec2spec.rb
 - lib/ec2spec/cli.rb
 - lib/ec2spec/client.rb
+- lib/ec2spec/const.rb
+- lib/ec2spec/hash_formatter.rb
 - lib/ec2spec/host_result.rb
+- lib/ec2spec/json_formatter.rb
+- lib/ec2spec/logger.rb
 - lib/ec2spec/offer_file.rb
+- lib/ec2spec/offer_index_file.rb
+- lib/ec2spec/plain_text_formatter.rb
 - lib/ec2spec/price_calculator.rb
 - lib/ec2spec/version.rb
 homepage: https://github.com/kyoshidajp/ec2spec