aws_tracker 0.0.2 → 0.0.3

data/README.md

@@ -1,118 +1,6 @@
 AWS Tracker
 ================
-Models the state of one or more Amazon Web Services accounts in an ActiveRecord object graph.
 
-  *ALPHA VERSION - not yet fully functional*
-
-
-----------------
-What is it?
-----------------
-The AWS Tracker monitors one or more AWS accounts and the current state of their associated "resources" -- Instances, EBS volumes, RDS servers, and so on. The Tracker periodically polls the Amazon Web Services API for the latest information on each account's resources, and then maintains the corresponding rows in an ActiveRecord-compatible database. Users of the library can thereafter run multiple complex queries on the state of their AWS assets, with no network overhead.
-
-
-----------------
-Why is it?
-----------------
-The AWS Tracker is intended to be a foundation library, on top of which more complex AWS applications can be built. It decouples the process of downloading AWS state information from the process of displaying and/or acting on that information. Although an executable 'tracker' command-line program is included, the library is primarily intended for use from within Rails, or some other ActiveRecord context. An ActiveRecord database connection must be initialized before the aws_tracker library is loaded from within Ruby.
-
-
-----------------
-Installation
-----------------
-1) Install the AWS Tracker gem (use _sudo_ as necessary).
-
-    gem install aws_tracker
-
-2) Install your database adaptor of choice. Sqlite3 is installed with AWS Tracker, so this step may be optional.
-
-
-----------------
-Usage [from the command line]
-----------------
-1) First, generate an ActiveRecord-style configuration file. 
-    
-  Here are the sample contents of `tracker_db.yml`:
-
-    adapter: sqlite3
-    database: aws_tracker.sqlite3
-    pool: 5
-    timeout: 5000    
-
-2) Create the database to contain the data. This is not necessary if using sqlite.
-
-3) The AWS Account information is stored in a (YAML) configuration file. Name this `accounts.yml` and store it alongside the above `tracker_db.yml` file.
-
-    development account:
-      account_id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-      access_key_id: xxxxxxxxxxxxxxxxxxxx
-      secret_access_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-
-    testing account:
-      account_id: yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
-      access_key_id: xxxxxxxxxxxxxxxxxxxx
-      secret_access_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-
-  When the tracker command-line program runs, these accounts are written into the database, but without the secret information. This allows external processes to read the AWS state database safely.
-    
-4) Run the tracker, and point it at the database config file
-
-    tracker tracker_db.yml --migrate
-
-  The `--migrate` argument updates the database to the latest version of the schema, and is only necessary for new databases, or when upgrading to a new version of the Tracker gem.  
-
-
-----------------
-Usage [from within Ruby]
-----------------
-1) Insert the necessary tables into your database.
-  First, `require 'AWSTracker/tasks'` from your Rakefile, then run
-    
-    rake db:migrate:tracker
-
-2) In your Ruby app, first set up an ActiveRecord connection. In Rails, this is done for you automatically, but here's an example for a non-Rails app:
-
-    require 'active_record'
-    ActiveRecord::Base.establish_connection({
-      :adapter => 'sqlite3', :database => 'aws_tracker.sqlite3'
-    })
-
-3) Now `require 'aws_tracker'`. This will load the models and allow you to perform queries on the following AWS resources and their relationships:
-
-  * AWSTracker::AWSAccount
-  * AWSTracker::SecurityGroup
-  * AWSTracker::Instance
-  * AWSTracker::EBSVolume
-
-4) Then load your AWSAccounts from YAML, and use a Tracker object to fetch their status from AWS:
-
-    include AWSTracker            # Load model class names into namespace
-    accounts = AWSAccount.from_yaml_file('config/accounts.yml')
-    accounts.each {|a| a.save!}   # Save them in the database
-    t = Tracker.new               # A Tracker updates all accounts in the DB
-    t.delay = 15                  # Update every 15 seconds
-    t.start                       # Runs in the background. Call 'stop' later
-
-
-----------------
-Development
-----------------
-This project is still in its early stages, but most of the framework is in place. More AWS resources need to be modeled, but the patterns for the code to do so are now laid out. Helping hands are appreciated!
-
-1) Fetch the project code and bundle up...
-
-    git clone https://github.com/benton/aws_tracker.git
-    cd aws_tracker
-    bundle install
-
-2) Create a database config and the necessary tables
-
-    cp config/database.yml.example config/database.yml
-    rake db:migrate:tracker
-
-3) To run the tests, first export the credentials as environment variables, then `rake spec`.
-
-    export AWS_ACCOUNT_NUMBER=[your AWS account number]
-    export AWS_ACCESS_KEY_ID=[your EC2 access key ID]
-    export AWS_ACCESS_KEY_SECRET=[your EC2 access key secret]
-    rake spec
+This project has been closed out - no further updates are forthcoming.
+However, its functionality lives on in the
+[Cloud Cost Tracker](https://github.com/benton/cloud_cost_tracker)

data/lib/aws_tracker/version.rb

@@ -1,3 +1,3 @@
 module AwsTracker
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,116 +1,91 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: aws_tracker
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Benton Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-28 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  type: :runtime
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70164083661540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70164083661540
+- !ruby/object:Gem::Dependency
   name: right_aws
-  type: :runtime
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70164083693060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70164083693060
+- !ruby/object:Gem::Dependency
   name: sqlite3
-  type: :runtime
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70164083691640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70164083691640
+- !ruby/object:Gem::Dependency
   name: rake
-  type: :development
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &70164083689920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70164083689920
+- !ruby/object:Gem::Dependency
   name: rspec
-  type: :development
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70164083688620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70164083688620
+- !ruby/object:Gem::Dependency
   name: bundler
-  type: :development
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &70164083687760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: *id006
-description: This gem peridically queries AWS for information about Instances, SecurityGroups, EBSVolumes, etc., and saves the data as interconnected ActiveRecord objects.aws_tracker
-email: 
+  version_requirements: *70164083687760
+description: This gem peridically queries AWS for information about Instances, SecurityGroups,
+  EBSVolumes, etc., and saves the data as interconnected ActiveRecord objects.aws_tracker
+email:
 - benton@bentonroberts.com
-executables: 
+executables:
 - tracker
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
@@ -150,38 +125,35 @@ files:
 - spec/support/create_testing_objects.rb
 homepage: http://github.com/benton/aws_tracker
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 4487828262727353232
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 4487828262727353232
 requirements: []
-
 rubyforge_project: aws_tracker
-rubygems_version: 1.7.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Models the state of Amazon Web Services accounts in ActiveRecord
-test_files: 
+test_files:
 - spec/lib/aws_tracker/models/aws_account_spec.rb
 - spec/lib/aws_tracker/models/ebs_volume_spec.rb
 - spec/lib/aws_tracker/models/instance_spec.rb