bearclaws 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc85649f90c991b4233aa6c09992693339c55fc9
+  data.tar.gz: 1977a2eb8e0985d759b6683f3266424b8b71c5a6
+SHA512:
+  metadata.gz: 5bcc74bdeaaeaa87f36ee0428697ddd2e42778dabfd40fb54ab476e5e4b6792cba195adc0c5dace1210b4ac10969679943c175540b9047af781b42f23e434a09
+  data.tar.gz: 10b350d20dcfba74a6cfb831fd97fc2284679d5629ae533eef69203fbb6d8579d51bf2dbd7b54e18fc9636d66445c4c771651ffafb31d6d0dde643ce12d212b0

data/bin/bearclaws

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'bearclaws'
+require 'optparse'
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Bearclaws"
+  opt.separator  "Analyze the output of you AWS cost allocation report. Group your costs by an arbitrary tag"
+  opt.separator  ""
+  opt.separator  "bearclaws [CSV_FILE] [TAG_COLUMN] [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "[CSV_FILE]   --- Path to an AWS cost allocation report (e.g. 93795-aws-cost-allocation-2013-09.csv)"
+  opt.separator  "[TAG_COLUMN] --- The (zero-indexed) column in the report that holds your tag"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  opt.on("-o","--output OUTPUT","where do you want the results to be written?") do |o|
+    options[:output] = o
+  end
+
+  opt.on("-h","--help","help")
+end
+
+opt_parser.parse!
+
+case ARGV[0]
+
+when "help", nil
+  puts opt_parser
+else
+  output = "bearclaws.csv"
+  output = options[:output] unless options[:output].nil?
+  groups = Bearclaws.analyze File.open(ARGV[0]), ARGV[1].to_i
+
+  CSV.open(output.to_s, "wb") do |csv|
+    groups.each do |group|
+      csv << [group.name, nil]
+      group.subtotals.each do |key, subtotal|
+        csv << [key, ('%.2f' % subtotal)]
+      end
+      csv << ['Total', ('%.2f' %  group.total)]
+      csv << [nil, nil]
+    end
+  end
+end

data/lib/bearclaws.rb

@@ -0,0 +1,35 @@
+require 'csv'
+require 'bearclaws/group'
+require 'bearclaws/charge'
+
+module Bearclaws
+
+  # Analyze the output of you AWS cost allocation report. Group your costs by an arbitrary tag, like 'client'
+  #
+  # http://aws.amazon.com/about-aws/whats-new/2012/08/21/aws-billing-enables-cost-allocation-reports/
+  #
+  # @param file [File] a CSV of allocated AWS charges (i.e., 937951391671-aws-cost-allocation-2013-09.csv)
+  # @param tag_column [Integer] The zero-indexed column number in the CSV that holds the tag you want to group by
+  # @return [Array] A set of Bearclaws::Group objects grouped by tag
+  def self.analyze(file = nil, tag_column = nil)
+
+    raise "No file supplied!" unless file
+    raise "No CSV group column supplied!" unless tag_column
+    raise "Group column must be an integer!" unless tag_column.is_a? Integer
+
+    groups = { default: Bearclaws::Group.new(:default) }
+
+    rows = CSV.parse file.read
+
+    rows.shift(2) # remove instructions, column labels
+    rows.pop(3)   # remove subtotal, total, footer
+
+    rows.each do |row|
+      name = (row[tag_column].nil?) ? :default : row[tag_column]
+      groups[name] ||= Bearclaws::Group.new(name.to_sym)
+      groups[name].charges << Bearclaws::Charge.new(row)
+    end
+
+    return groups.collect { |k, v| v }
+  end
+end

data/lib/bearclaws/charge.rb

@@ -0,0 +1,17 @@
+require 'bearclaws/mapping'
+
+module Bearclaws
+
+  # A representation of a charge
+  class Charge
+
+    Bearclaws::AWSMAP.each { |k, v| attr_accessor k }
+
+    # @param charge [Array] a CSV row from an AWS cost allocation report
+    def initialize(charge = [])
+      Bearclaws::AWSMAP.each { |k, v|
+        send "#{k}=", charge[v]
+      }
+    end
+  end
+end

data/lib/bearclaws/group.rb

@@ -0,0 +1,37 @@
+module Bearclaws
+
+  # A grouped representation of AWS charges
+  #
+  # @attr name [String] The tag by which the charges are grouped
+  # @attr charges [Array] An array of Bearclaws::Charge objects
+  class Group
+    attr_accessor :name
+    attr_accessor :charges
+
+    # @param name [String] The tag by which the charges are grouped
+    # @param charges [Array] An array of Bearclaws::Charge objects
+    def initialize(name, charges = [])
+      self.name    = name.to_sym
+      self.charges = charges
+    end
+
+    # The total cost of all the charges with group's tag
+    #
+    # @return [Float]
+    def total
+      charges.map { |x| x.total_cost.to_f }.inject(:+)
+    end
+
+    # The total costs for the tag broken out by :product_code
+    #
+    # @return [Float]
+    def subtotals
+      x = {}
+      charges.each do |r|
+        x[r.product_code] ||= 0.to_f
+        x[r.product_code]  += r.total_cost.to_f
+      end
+      return x
+    end
+  end
+end

data/lib/bearclaws/mapping.rb

@@ -0,0 +1,36 @@
+module Bearclaws
+
+  # The mappings for a nomal AWS cost allocation report
+  AWSMAP = {
+    :invoice_id => 0,
+    :payer_account_id => 1,
+    :linked_account_id => 2,
+    :charge_type => 3,
+    :charge_id => 4,
+    :billing_period_start_date => 5,
+    :billing_period_end_date => 6,
+    :invoice_date => 7,
+    :payer_account_name => 8,
+    :linked_account_name => 9,
+    :taxation_address => 10,
+    :payer_po_number => 11,
+    :product_code => 12,
+    :product_name => 13,
+    :seller_of_charge => 14,
+    :usage_type => 15,
+    :operation => 16,
+    :availability_zone => 17,
+    :rate_id => 18,
+    :item_description => 19,
+    :usage_start_date => 20,
+    :usage_end_date => 21,
+    :usage_quantity => 22,
+    :blended_rate => 23,
+    :currency_code => 24,
+    :cost_before_tax => 25,
+    :credits => 26,
+    :tax_amount => 27,
+    :tax_type => 28,
+    :total_cost => 29
+  }
+end

data/lib/bearclaws/version.rb

@@ -0,0 +1,3 @@
+module Bearclaws
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: bearclaws
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kyle Truscott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Analyze the output of you AWS cost allocation report. Group your costs
+  by an arbitrary tag, like `client`
+email:
+- keighl@keighl.com
+executables:
+- bearclaws
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bearclaws.rb
+- lib/bearclaws/version.rb
+- lib/bearclaws/charge.rb
+- lib/bearclaws/group.rb
+- lib/bearclaws/mapping.rb
+- bin/bearclaws
+homepage: https://github.com/keighl/bearclaws
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Analyze the output of you AWS cost allocation report. Group your costs by
+  an arbitrary tag, like `client`
+test_files: []
+has_rdoc: