instance_accountant 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 659797969092d787410c4789f8379c33b9b10ccb
-  data.tar.gz: 0c858e6a0c0a6ae6f7bec5877cbbf450f6de665c
+  metadata.gz: 19a81626ec5302f9c0ae2bdd455c7aa70c2384f3
+  data.tar.gz: 611a5db14d5b5284b16d5935e72df9df4148381d
 SHA512:
-  metadata.gz: a442d471310a881effe735f4b7d6ff5118af02e238e20e908178e5e845409cc51a4c123e08e9f0acebac655badec7cc0fbd4278a7e8a21d20c95d03132015af6
-  data.tar.gz: cb5df07e2c58e9905134bf3d1683846f1ddeaa41cffb503b68e6dc6c99d5fb36a7119693c31e86553cf64a0e2b71ac3093636bf527a796528a68c17e0141f872
+  metadata.gz: 948d6d0a669a3fa5ed8e6543cb93063e3ced2e46e875ab06c85169c034cfe196be66598cbe28cc0504d436951923299091cb380c6810f03d8708b8c3312690e5
+  data.tar.gz: ff0797c01fb181fe887300fd8740a29ac0196882c51fc7f3c6a51cc96118585c11782afb742151cb97141eb60b476773473448ac72b688b7a26eb941a4917d06

data/README.md

@@ -10,13 +10,12 @@ Gemfile:
 
 The gem provides an executable that can be invoked two ways:
 
-If you want to account for the hourly cost of instances, use this form:
+1) you want to account for the hourly cost of instances:
+
+    #!/bin/bash
 
     instance_accountant account                                          \
-      --description       'instance usage for: %s'                       \
-      --reference         'http://test.com/journal_entry'                \
       --cost              0.1                                            \
-      --cost_description  'cost for: %s'                                 \
       --cost_reference    'http://test.com/cost'                         \
       --expense_acct      subledger_account_id                           \
       --payable_acct      subledger_account_id                           \
@@ -24,30 +23,24 @@ If you want to account for the hourly cost of instances, use this form:
       --secret            subledger_secret                               \
       --org_id            subledger_org_id                               \
       --book_id           subledger_book_id                              \
-      --daemon
+      --daemon 2>&1 >> instance_accountant.log
+
+2) you want to account for both the hourly cost and income:
 
-If you want to account for both the hourly cost of instances, and hourly income instances, use this form:
+    #!/bin/bash
 
     instance_accountant account                                          \
-      --description       'instance usage for: %s'                       \
-      --reference         'http://test.com/journal_entry'                \
       --cost              0.1                                            \
-      --cost_description  'cost for: %s'                                 \
-      --cost_reference    'http://test.com/cost'                         \
       --expense_acct      subledger_account_id                           \
       --payable_acct      subledger_account_id                           \
       --price             0.2                                            \
-      --price_description 'price for: %s'                                \
-      --price_reference   'http://test.com/price'                        \
       --receivable_acct   subledger_account_id                           \
       --income_acct       subledger_account_id                           \
       --key_id            subledger_key_id                               \
       --secret            subledger_secret                               \
       --org_id            subledger_org_id                               \
       --book_id           subledger_book_id                              \
-      --daemon
-
-Note: %s in descriptions will be replaced by the ISO 8601 of the hour in UTC
+      --daemon 2>&1 >> instance_accountant.log
 
 Here's a complete set of options:
 
@@ -55,17 +48,17 @@ Here's a complete set of options:
       f, [--filepath=FILEPATH]
                                                    # Default: ~/.instance_accountant
       d, --description=DESCRIPTION
-                                                   # Default: instance usage for
+                                                   # Default: instance usage for: %
           [--reference=REFERENCE]
       c, --cost=COST
           [--cost-description=COST_DESCRIPTION]
-                                                   # Default: cost for
+                                                   # Default: instance cost for: %
           [--cost-reference=COST_REFERENCE]
       e, --expense-acct=EXPENSE_ACCT
       p, --payable-acct=PAYABLE_ACCT
       p, [--price=PRICE]
           [--price-description=PRICE_DESCRIPTION]
-                                                   # Default: price for
+                                                   # Default: instance price for %
           [--price-reference=PRICE_REFERENCE]
       i, [--income-acct=INCOME_ACCT]
       r, [--receivable-acct=RECEIVABLE_ACCT]
@@ -74,3 +67,6 @@ Here's a complete set of options:
       o, --org-id=ORG_ID
       b, --book-id=BOOK_ID
           [--daemon], [--no-daemon]
+
+Note: %s in descriptions will be replaced by the ISO 8601 of the hour in UTC
+Note: instance_accountant captures errors and does its best to keep running

data/instance_accountant.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = Dir.glob( 'spec/**/*.rb' )
 
   gem.name          = 'instance_accountant'
-  gem.description   = 'account for hourly instance usage using Subledger'
+  gem.description   = File.read 'README.md'
   gem.summary       = 'account for hourly instance usage using Subledger'
   gem.version       = InstanceAccountant::VERSION
   gem.email         = 'admin@subledger.com'

data/lib/instance_accountant/cli.rb

@@ -14,7 +14,7 @@ module InstanceAccountant
     method_option :description,
                   aliases:  :d,
                   required: true,
-                  default:  'instance usage for'
+                  default:  'instance usage for: %'
 
     method_option :reference
 
@@ -22,7 +22,7 @@ module InstanceAccountant
                   aliases:  :c,
                   required: true
     method_option :cost_description,
-                  default: 'cost for'
+                  default: 'instance cost for: %'
 
     method_option :cost_reference
 
@@ -38,7 +38,7 @@ module InstanceAccountant
                   aliases: :p
 
     method_option :price_description,
-                  default: 'price for'
+                  default: 'instnace price for: %'
 
     method_option :price_reference
 
@@ -68,7 +68,7 @@ module InstanceAccountant
 
     SIGNALS = []
 
-    TWENTY_MINUTES = 20 * 60
+    SECONDS_BETWEEN_ATTEMPTS = 10
 
     %w(ABRT ALRM HUP INT STOP TERM QUIT).each do |signal|
       Signal.trap signal do
@@ -96,10 +96,12 @@ module InstanceAccountant
 
     def consider_posting i, options
       Poster.new(options).post(Hour.new, Time.now) if posting_required? i
+    rescue Exception => e
+      STDERR.puts e
     end
 
     def posting_required? i
-      (i % TWENTY_MINUTES).zero? or signal?
+      (i % SECONDS_BETWEEN_ATTEMPTS).zero? or signal?
     end
 
     def consider_exiting

data/lib/instance_accountant/filer.rb

@@ -10,24 +10,26 @@ module InstanceAccountant
     end
 
     def read
-      @time_klass.parse @file_klass.open( @filepath,
-                                          File::RDWR | File::CREAT,
-                                          0644 ) do |file|
+      hour_string = nil
+
+      @file_klass.open( @filepath, 'r' ) do |file|
         file.flock File::LOCK_EX
-        file.read
+        hour_string = file.read
       end
+
+      @time_klass.parse hour_string
     rescue
       nil
     end
 
     def write hour
-      hour_string = hour.to_s
+      hour_string = hour.hour_string
 
       @file_klass.open( @filepath,
                         File::RDWR | File::CREAT,
                         0644 ) do |file|
         file.flock File::LOCK_EX
-        file.rewind
+        file.truncate 0
         file.write hour_string
       end
 

data/lib/instance_accountant.rb

@@ -4,5 +4,5 @@ require 'instance_accountant/hour'
 require 'instance_accountant/poster'
 
 module InstanceAccountant
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/instance_accountant/filer_spec.rb

@@ -4,15 +4,15 @@ require 'helpers'
 require 'instance_accountant/filer'
 
 module InstanceAccountant
-  Class File do
+  Class Filer do
     Instance do
       subject { Filer.new options }
 
       let(:options) do
         {
-          filepath:   filepath,
           file_klass: file_klass,
-          time_klass: time_klass
+          time_klass: time_klass,
+          filepath:   filepath
         }
       end
 
@@ -22,10 +22,28 @@ module InstanceAccountant
       let(:time_klass)        { double 'time_klass'        }
       let(:time_inst)         { double 'time_inst'         }
 
-      let(:time_string)       { double 'time_string' }
+      let(:hour_string)       { double 'hour_string' }
       let(:hour)              { double 'hour'        }
 
+      let(:file) { double 'file' }
+
       RespondsTo :read do
+        When 'it has not been written before' do
+          ByReturning nil do
+            expect(file_klass)
+              .to receive(:expand_path)
+              .with(filepath)
+              .and_return(expanded_filepath)
+
+            expect(file_klass)
+              .to receive(:open)
+              .with(expanded_filepath, 'r')
+              .and_raise(Errno::ENOENT)
+
+            subject.read.must_be_nil
+          end
+        end
+
         When 'it has been written before' do
           ByReturning 'a Time' do
             expect(file_klass)
@@ -35,12 +53,20 @@ module InstanceAccountant
 
             expect(file_klass)
               .to receive(:open)
-              .with(expanded_filepath, File::RDWR | File::CREAT, 0644)
-              .and_return(time_string)
+              .with(expanded_filepath, 'r')
+              .and_yield(file)
+
+            expect(file)
+              .to receive(:flock)
+              .with(File::LOCK_EX)
+
+            expect(file)
+              .to receive(:read)
+              .and_return(hour_string)
 
             expect(time_klass)
               .to receive(:parse)
-              .with(time_string)
+              .with(hour_string)
               .and_return(time_inst)
 
             subject.read.must_be_same_as time_inst
@@ -56,15 +82,27 @@ module InstanceAccountant
             .and_return(expanded_filepath)
 
           expect(hour)
-            .to receive(:to_s)
-            .and_return(time_string)
+            .to receive(:hour_string)
+            .and_return(hour_string)
 
           expect(file_klass)
             .to receive(:open)
             .with(expanded_filepath, File::RDWR | File::CREAT, 0644)
-            .and_return(time_string)
+            .and_yield(file)
+
+          expect(file)
+            .to receive(:flock)
+            .with(File::LOCK_EX)
+
+          expect(file)
+            .to receive(:truncate)
+            .with(0)
+
+          expect(file)
+            .to receive(:write)
+            .with(hour_string)
 
-          subject.write(hour).must_be_same_as time_string
+          subject.write(hour).must_be_same_as hour_string
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instance_accountant
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tom Mornini
@@ -165,7 +165,79 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.27'
-description: account for hourly instance usage using Subledger
+description: |
+  Subledger instance accountant Ruby gem
+
+  Installation:
+
+      gem install instance_accountant
+
+  Gemfile:
+
+      gem 'instance_accountant'
+
+  The gem provides an executable that can be invoked two ways:
+
+  1) you want to account for the hourly cost of instances:
+
+      #!/bin/bash
+
+      instance_accountant account                                          \
+        --cost              0.1                                            \
+        --cost_reference    'http://test.com/cost'                         \
+        --expense_acct      subledger_account_id                           \
+        --payable_acct      subledger_account_id                           \
+        --key_id            subledger_key_id                               \
+        --secret            subledger_secret                               \
+        --org_id            subledger_org_id                               \
+        --book_id           subledger_book_id                              \
+        --daemon 2>&1 >> instance_accountant.log
+
+  2) you want to account for both the hourly cost and income:
+
+      #!/bin/bash
+
+      instance_accountant account                                          \
+        --cost              0.1                                            \
+        --expense_acct      subledger_account_id                           \
+        --payable_acct      subledger_account_id                           \
+        --price             0.2                                            \
+        --receivable_acct   subledger_account_id                           \
+        --income_acct       subledger_account_id                           \
+        --key_id            subledger_key_id                               \
+        --secret            subledger_secret                               \
+        --org_id            subledger_org_id                               \
+        --book_id           subledger_book_id                              \
+        --daemon 2>&1 >> instance_accountant.log
+
+  Here's a complete set of options:
+
+      Options:
+        f, [--filepath=FILEPATH]
+                                                     # Default: ~/.instance_accountant
+        d, --description=DESCRIPTION
+                                                     # Default: instance usage for: %
+            [--reference=REFERENCE]
+        c, --cost=COST
+            [--cost-description=COST_DESCRIPTION]
+                                                     # Default: instance cost for: %
+            [--cost-reference=COST_REFERENCE]
+        e, --expense-acct=EXPENSE_ACCT
+        p, --payable-acct=PAYABLE_ACCT
+        p, [--price=PRICE]
+            [--price-description=PRICE_DESCRIPTION]
+                                                     # Default: instance price for %
+            [--price-reference=PRICE_REFERENCE]
+        i, [--income-acct=INCOME_ACCT]
+        r, [--receivable-acct=RECEIVABLE_ACCT]
+        k, --key-id=KEY_ID
+        s, --secret=SECRET
+        o, --org-id=ORG_ID
+        b, --book-id=BOOK_ID
+            [--daemon], [--no-daemon]
+
+  Note: %s in descriptions will be replaced by the ISO 8601 of the hour in UTC
+  Note: instance_accountant captures errors and does its best to keep running
 email: admin@subledger.com
 executables:
 - instance_accountant