joyent-cloud-pricing 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d837beb7e94cad2015118a5b5cdeae6c30bb1dd3
-  data.tar.gz: 3f0c8b423292be9202add92080f0434051f0499c
+  metadata.gz: 7222aa546480d563b40f139b9678c17b6855780a
+  data.tar.gz: 5100b881cfc5e2cf42c3862a121049d53a71b8db
 SHA512:
-  metadata.gz: 5c434d8ed96ceb0c1344f19bd70378105782558e57963a5c7392e9a8ab26a1f953ef30fbe7943649879e0c281176c89c2aeb21a8758c21bd2a4d1c9a7c111250
-  data.tar.gz: 0cf755a9ad4dad85a32ed5c67a9dbd7b63bb767cfd29e080c791545cd915a2e28b5f1efa8648da7130559e4d0e68e88f6992b846f907acd6a1a0fecd9f4da410
+  metadata.gz: 446c0daa3bfd9431ea8bbf61400ea0f269352901abe21194dfd6968cde81e540b21bb936b0534e946d61f4fcb73d5fc6b52387b85f86d04a3e9374b28c4a05e3
+  data.tar.gz: b5d4beb509476cbcd89671043bb7cf7fa03262d1a7d6a7117b4d75caf7e3faf4720ea8ba123d3b9cb5cc1158fee1d1d0745bb3ba6dca3796b82440eb0dcd955e

data/README.md

@@ -114,7 +114,50 @@ commit   = Joyent::Cloud::Pricing::Commit.from_yaml 'my_company/config/joyent-co
 analyzer = Joyent::Cloud::Pricing::Analyzer.new(commit, flavors)
 
 analyzer.excess_monthly_price     # => monthly $$ for instances in excess of reserve
-analyzer.over_committed_zone_list # => list of zones in reserve, but not in reality
+analyzer.over_reserved_zone_list  # => list of zones in reserve, but not in reality
+```
+
+## Reporter
+
+This module is used by ```knife joyent server price``` plugin to calculate pricing with and without
+reserve discounts.
+
+```ruby
+current_zone_list = %w(g3-highcpu-8-smartos g3-highcpu-8-smartos ... )
+reporter = Joyent::Cloud::Pricing::Reporter.new('config/reserve-commit.yml', current_zone_list)
+puts reporter.render```
+
+Output (prices are arbitrary in this sample output):
+
+```bash
+
+SUMMARY:
+  Total # of zones                         :                  123
+  Total # of reserved zones                :                   98
+  Total # of reserved but WASTED zones     :                    0
+  Reserve Pricing Term/Duration (years)    :                    1
+
+ONE TIME:
+  Reserve Pricing Upfront Payments         :          $211,717.18
+
+MONTHLY:
+  Monthly Cost of Reserve Pricing Zones    :           $12,457.51
+  On Demand Resources Cost                 :           $23,679.68
+  Total Monthly (reserve + on demand)      :           $41,087.19
+
+YEARLY TOTALS:
+  With reserve discounts                   :          $331,607.30
+  Without reserve discounts                :          $926,224.00
+  Savings %                                :                  41%
+
+UNRESERVED FLAVORS MONTHLY COST
+  9 x g3-highmemory-68.375-smartos         :           $10,562.40
+  1 x g3-highmemory-256-smartos-cc         :            $4,393.44
+  6 x g3-standard-7.5-smartos              :            $1,036.80
+  1 x g3-highmemory-34.25-smartos          :              $588.24
+  4 x g3-highcpu-1.75-kvm                  :              $365.76
+  4 x g3-standard-0.5-smartos              :               $46.08
+  1 x g3-standard-0.625-smartos            :               $14.40
 ```
 
 ## Command Line Tools

data/config/joyent_pricing.yml

@@ -1,5 +1,5 @@
 ---
-:date: '2014-03-27 01:09:02 -0700'
+:date: '2014-03-28 22:06:51 -0700'
 :pricing:
   :g3-standard-0.625-smartos: 0.02
   :g3-standard-1.75-smartos: 0.056

data/config/legacy_prices.yml

@@ -0,0 +1,3 @@
+:g3-standard-8-smartos: 0.26
+:g3-highcpu-8-smartos: 0.58
+:g3-standard-0.5-smartos: 0.016

data/joyent-cloud-pricing.gemspec

@@ -19,12 +19,13 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "nokogiri"
+  spec.add_dependency 'nokogiri'
   spec.add_dependency 'mixlib-cli'
+  spec.add_dependency 'colored'
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
 
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-mocks'
 end

data/lib/pricing.rb

@@ -6,6 +6,7 @@ module Joyent
     module Pricing
 
       PRICING_FILENAME  = File.expand_path('../../config/joyent_pricing.yml', __FILE__)
+      LEGACY_FILENAME   = File.expand_path('../../config/legacy_prices.yml', __FILE__)
       COMMIT_FILENAME   = 'config/commit_pricing.yml'
       JOYENT_URL        = 'http://www.joyent.com/products/compute-service/pricing'
       HOURS_PER_MONTH   = 720
@@ -20,5 +21,6 @@ require "pricing/scraper"
 require "pricing/formatter"
 require "pricing/commit"
 require "pricing/analyzer"
+require "pricing/reporter"
 
 require "pricing/cli"

data/lib/pricing/analyzer.rb

@@ -18,7 +18,7 @@ module Joyent::Cloud::Pricing
     end
 
     # Zones that are committed, but do not exist
-    def over_committed_zone_list
+    def over_reserved_zone_list
       h = {}
       zone_list.each_pair { |flavor, count| diff = count - quantity_for(flavor); h[flavor] = -diff if diff < 0 }
       h
@@ -44,8 +44,10 @@ module Joyent::Cloud::Pricing
       excess_monthly_price + commit_monthly_price
     end
 
+    def upfront
+      commit.upfront
+    end
 
-    private
 
     def monthly_full_price_for zones
       total_price_for zones do |flavor|
@@ -53,6 +55,8 @@ module Joyent::Cloud::Pricing
       end
     end
 
+    private
+
     def total_price_for zones, &block
       zones.keys.inject(0) do |sum, flavor|
         sum += zones[flavor] * yield(flavor); sum

data/lib/pricing/cli.rb

@@ -8,9 +8,9 @@ module Joyent
 
         banner 'Usage: joyent-price-helper [--commit <path-to-commit.yml] '
 
-        option :config_file,
-               short: '-c COMMIT_FILE',
-               long: '--commit COMMIT_FILE',
+        option :commit_config,
+               short: '-c COMMIT_CONFIG',
+               long: '--commit COMMIT_CONFIG',
                description: 'Path to the config file for commit pricing (YML), default is "config/commit_pricing.yml"',
                required: false
 
@@ -27,7 +27,6 @@ module Joyent
 
         def run argv = ARGV
           parse_options(argv)
-          raise "Not implemented just yet"
         end
 
       end

data/lib/pricing/commit.rb

@@ -25,8 +25,30 @@ module Joyent::Cloud::Pricing
     end
 
     def monthly_price
+      sum_of &->(reserve) {reserve.monthly }
+    end
+
+    def upfront_price
+      sum_of &->(reserve) {reserve.prepay}
+    end
+
+    def total_zones
+      sum_of &->(reserve) {1}
+    end
+
+    def yearly_price
+      upfront_price + 12 * monthly_price
+    end
+
+    def years
+      reserves.empty? ? 0 : reserves.values.first.years
+    end
+
+    private
+
+    def sum_of
       reserves.values.inject(0) do |sum, reserve|
-        sum += reserve.monthly * reserve.quantity; sum
+        sum += (yield(reserve)) * reserve.quantity; sum
       end
     end
 

data/lib/pricing/configuration.rb

@@ -12,7 +12,10 @@ module Joyent::Cloud::Pricing
       end
 
       def from_yaml(filename = PRICING_FILENAME)
-        set_instance(new(YAML.load(File.read(filename))[:pricing]))
+        legacy_prices = YAML.load(File.read(LEGACY_FILENAME)) rescue nil
+        legacy_prices ||= {}
+        current_prices = YAML.load(File.read(filename))[:pricing]
+        set_instance(new(current_prices.merge(legacy_prices)))
       end
 
       def from_url(url = JOYENT_URL)

data/lib/pricing/reporter.rb

@@ -0,0 +1,89 @@
+require_relative 'commit'
+require 'erb'
+require 'colored'
+
+module Joyent::Cloud::Pricing
+  class Reporter
+
+    attr_accessor :commit, :zones_in_use, :analyzer, :formatter
+
+    def initialize(commit = COMMIT, zones_in_use = [])
+      @commit = case commit
+                  when String
+                    Joyent::Cloud::Pricing::Commit.from_yaml(commit)
+                  when Joyent::Cloud::Pricing::Commit
+                    commit
+                  when nil
+                    Joyent::Cloud::Pricing::Commit.new
+                  else
+                    raise NotImplementedError, "Unknown type of commit passed: #{commit.inspect}"
+                end
+
+      @zones_in_use = zones_in_use
+      @analyzer = Analyzer.new(@commit, @zones_in_use)
+      @formatter = Formatter.new(pricing.config)
+    end
+
+    def render
+      @r = self
+      @f = formatter
+      ERB.new(REPORT_ASCII).result(binding)
+    end
+
+    def reserve?
+      commit.reserves.size > 0
+    end
+
+    def zones
+      zones_in_use.size
+    end
+
+    def pricing
+      Configuration.instance
+    end
+
+    def monthly_without_commit_discount
+      analyzer.monthly_full_price_for(analyzer.zone_list)
+    end
+
+    def excess_zones
+      zones = analyzer.excess_zone_list.each_pair.map{|flavor, count| [ flavor, count, pricing.monthly(flavor) * count ]}.sort{|x,y| y[2] <=> x[2]}
+      zones
+    end
+
+    def excess_zone_list
+      excess_zones.map do |tuple|
+        flavor, count, monthly = tuple
+        sprintf(" %2d x %-36s : %20s",
+          count, flavor, formatter.format_price(monthly, 20).red)
+      end.join("\n")
+    end
+
+    REPORT_ASCII = <<ASCII
+SUMMARY:
+  Total # of zones                         : <%= sprintf("%20d", @r.zones).blue %>
+<% if @r.reserve? %>  Total # of reserved zones                : <%= sprintf("%20d", @r.commit.total_zones).green %>
+  Total # of reserved but WASTED zones     : <%= sprintf("%20d", @r.analyzer.over_reserved_zone_list.size || 0).red %>
+  Reserve Pricing Term/Duration (years)    : <%= sprintf("%20d", @r.commit.years || 0).green %>
+
+ONE TIME:
+  Reserve Pricing Upfront Payments         : <%= @f.format_price(@r.commit.upfront_price, 20).green %>
+<% end %>
+MONTHLY:
+<% if @r.reserve? %>  Monthly Cost of Reserve Pricing Zones    : <%= @f.format_price(@r.commit.monthly_price, 20).green %>
+<% end %>  On Demand Resources Cost                 : <%= @f.format_price(@r.analyzer.excess_monthly_price, 20).red %>
+<% if @r.reserve? %>  Total Monthly (reserve + on demand)      : <%= @f.format_price(@r.analyzer.total_monthly_price, 20).blue %><% end %>
+
+YEARLY TOTALS:
+<% if @r.reserve? %>  With reserve discounts                   : <%= @f.format_price(@r.commit.yearly_price, 20).green %>
+<% end %>  Without reserve discounts                : <%= @f.format_price(@r.monthly_without_commit_discount * 12, 20).red %>
+<% if @r.reserve? %>  Savings %                                : <%= (sprintf "%19d", (100 * (@r.monthly_without_commit_discount * 12 - @r.commit.yearly_price) / (@r.monthly_without_commit_discount * 12))).green %>%<% end %>
+
+UNRESERVED FLAVORS MONTHLY COST
+<%= @r.excess_zone_list %>
+
+ASCII
+
+  end
+
+end

data/lib/pricing/version.rb

@@ -1,7 +1,7 @@
 module Joyent
   module Cloud
     module Pricing
-      VERSION = "1.0.1"
+      VERSION = "1.0.2"
     end
   end
 end

data/spec/pricing/analyze_spec.rb

@@ -74,8 +74,8 @@ describe 'Joyent::Cloud::Pricing::Analyze' do
     expect(analyzer.excess_monthly_price).to eql( 6432.48 )
   end
 
-  it '#over_committed_zone_list' do
-    expect(analyzer.over_committed_zone_list).to eql( {:"g3-highio-60.5-smartos" => 1 })
+  it '#over_reserved_zone_list' do
+    expect(analyzer.over_reserved_zone_list).to eql( {:"g3-highio-60.5-smartos" => 1 })
   end
 
 

data/spec/pricing/configuration_spec.rb

@@ -1,15 +1,24 @@
 require 'spec_helper'
 
-describe ' Joyent::Cloud::Pricing::Configuration' do
-  let(:expected_prices) { {
+describe 'Joyent::Cloud::Pricing::Configuration' do
+  expected_prices = {
       "g3-standard-48-smartos" => 1.536,
       "g3-standard-0.625-smartos" => 0.02,
-      "g3-standard-30-kvm" => 0.960} }
+      "g3-standard-30-kvm" => 0.960,
+      "g3-standard-8-smartos" => 0.26,
+      "g3-highcpu-8-smartos" => 0.58,
+      "g3-standard-0.5-smartos" => 0.016
+  }
 
-  it "should load pricing configuration hash from YAML" do
-    config = Joyent::Cloud::Pricing::Configuration.from_yaml 'spec/fixtures/pricing.yml'
+  let(:config) {
+    Joyent::Cloud::Pricing::Configuration.from_yaml 'spec/fixtures/pricing.yml'
+  }
+
+  context "#from_yaml" do
     expected_prices.keys.each do |flavor|
-      expect(config[flavor]).to eql(expected_prices[flavor])
+      it "should load pricing for #{flavor}" do
+        expect(config[flavor]).to eql(expected_prices[flavor])
+      end
     end
   end
 

data/spec/pricing/reporter_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe 'Joyent::Cloud::Pricing::Reporter' do
+
+  let(:flavors) { %w(
+    g3-highcpu-16-smartos
+    g3-highcpu-16-smartos
+    g3-standard-30-smartos
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-32-smartos-cc
+    g3-highcpu-7-smartos
+    g3-highcpu-7-smartos
+    g3-highio-60.5-smartos
+    g3-highio-60.5-smartos
+    g3-highio-60.5-smartos
+    g3-highio-60.5-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+    g3-highmemory-17.125-smartos
+  ) }
+  let(:commit) { Joyent::Cloud::Pricing::Commit.from_yaml 'spec/fixtures/commit.yml' }
+  let(:reporter) { Joyent::Cloud::Pricing::Reporter.new(commit, flavors) }
+
+  before do
+    Joyent::Cloud::Pricing::Configuration.instance(true)
+  end
+
+  context "#initialize" do
+    it "should not be empty when created" do
+      expect(reporter).to_not be_nil
+      expect(reporter.analyzer).to_not be_nil
+      expect(reporter.zones_in_use.size).to eql(flavors.size)
+    end
+  end
+
+  context "#render" do
+    it "should propertly render an ERB template" do
+      output = reporter.render
+      expect(output).to_not be_nil
+    end
+
+    context "blank commit configuration" do
+      let(:commit) { Joyent::Cloud::Pricing::Commit.new }
+      it "should still properly render an ERB template" do
+        expect(commit.reserves.size).to eql(0)
+        output = reporter.render
+        expect(output).to_not be_nil
+      end
+    end
+
+  end
+
+end

data/spec/pricing/scraper_spec.rb

@@ -6,7 +6,8 @@ describe 'Joyent::Cloud::Pricing::Scraper' do
 
   let(:prices) { {"g3-standard-48-smartos" => 1.536,
                   "g3-standard-0.625-smartos" => 0.02,
-                  "g3-standard-30-kvm" => 0.960} }
+                  "g3-standard-30-kvm" => 0.960
+               } }
 
   before do
     @config = scraper.scrape

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joyent-cloud-pricing
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +127,7 @@ files:
 - bin/joyent-price-helper
 - config/commit_pricing.yml.example
 - config/joyent_pricing.yml
+- config/legacy_prices.yml
 - joyent-cloud-pricing.gemspec
 - lib/pricing.rb
 - lib/pricing/analyzer.rb
@@ -121,6 +136,7 @@ files:
 - lib/pricing/configuration.rb
 - lib/pricing/formatter.rb
 - lib/pricing/helpers.rb
+- lib/pricing/reporter.rb
 - lib/pricing/reserve.rb
 - lib/pricing/scraper.rb
 - lib/pricing/symbolize_keys.rb
@@ -132,6 +148,7 @@ files:
 - spec/pricing/commit_spec.rb
 - spec/pricing/configuration_spec.rb
 - spec/pricing/formatter_spec.rb
+- spec/pricing/reporter_spec.rb
 - spec/pricing/reserve_spec.rb
 - spec/pricing/scraper_spec.rb
 - spec/spec_helper.rb
@@ -167,6 +184,7 @@ test_files:
 - spec/pricing/commit_spec.rb
 - spec/pricing/configuration_spec.rb
 - spec/pricing/formatter_spec.rb
+- spec/pricing/reporter_spec.rb
 - spec/pricing/reserve_spec.rb
 - spec/pricing/scraper_spec.rb
 - spec/spec_helper.rb