vault-tools 0.5.8 → 0.5.9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vault-tools (0.5.7)
+    vault-tools (0.5.9)
       aws-sdk
       fernet (= 2.0.rc2)
       heroku-api
@@ -17,20 +17,20 @@ GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.4.3)
-    aws-sdk (1.53.0)
-      aws-sdk-v1 (= 1.53.0)
-    aws-sdk-v1 (1.53.0)
+    aws-sdk (1.57.0)
+      aws-sdk-v1 (= 1.57.0)
+    aws-sdk-v1 (1.57.0)
       json (~> 1.4)
       nokogiri (>= 1.4.4)
     celluloid (0.16.0)
       timers (~> 4.0.0)
     coderay (1.1.0)
-    excon (0.39.6)
+    excon (0.41.0)
     fernet (2.0.rc2)
       valcro (= 0.1)
-    ffi (1.9.3)
+    ffi (1.9.6)
     formatador (0.2.5)
-    guard (2.6.1)
+    guard (2.8.1)
       formatador (>= 0.2.4)
       listen (~> 2.7)
       lumberjack (~> 1.0)
@@ -46,18 +46,18 @@ GEM
     honeybadger (1.16.5)
       json
     json (1.8.1)
-    listen (2.7.9)
+    listen (2.7.11)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
-    logfmt (0.0.6)
+    logfmt (0.0.7)
     lumberjack (1.0.9)
     method_source (0.8.2)
-    mini_portile (0.6.0)
+    mini_portile (0.6.1)
     minitest (4.7.5)
     multi_json (1.10.1)
-    nokogiri (1.6.3.1)
-      mini_portile (= 0.6.0)
+    nokogiri (1.6.4)
+      mini_portile (~> 0.6.0)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -68,7 +68,7 @@ GEM
     rack-ssl-enforcer (0.2.8)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (10.1.0)
+    rake (10.3.2)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
@@ -85,14 +85,14 @@ GEM
     slop (3.6.0)
     thor (0.19.1)
     tilt (1.4.1)
-    timers (4.0.0)
+    timers (4.0.1)
       hitimes
     turn (0.9.7)
       ansi
       minitest (~> 4)
     uuidtools (2.1.5)
     valcro (0.1)
-    vault-test-tools (0.3.8)
+    vault-test-tools (0.3.9)
       guard-minitest
       logfmt
       minitest (~> 4.7.4)
@@ -101,7 +101,7 @@ GEM
       rr
       scrolls
       turn
-    yard (0.8.7.3)
+    yard (0.8.7.6)
     yard-sinatra (1.0.0)
       yard (~> 0.7)
 

data/lib/vault-tools.rb

@@ -82,3 +82,4 @@ require 'vault-tools/pipeline'
 require 'vault-tools/text_processor'
 require 'vault-tools/time'
 require 'vault-tools/s3'
+require 'vault-tools/statement_store'

data/lib/vault-tools/statement_store.rb

@@ -0,0 +1,81 @@
+module Vault
+  # The StatementStore knows how to save and retrieve invoices from S3
+  class StatementStore
+    def initialize(opts = {})
+      @key_id = opts.fetch(:key_id, ENV['AWS_ACCESS_KEY_ID'])
+      @key = opts.fetch(:key, ENV['AWS_SECRET_ACCESS_KEY'])
+    end
+
+    # Retrieve invoice JSON from S3
+    def get_json(opts)
+      contents = retrieve(:json, opts)
+      begin
+        JSON.parse(contents)
+      rescue
+        contents
+      end
+    end
+
+    # Write as JSON to S3
+    def write_json(opts)
+      write(:json, opts)
+    end
+
+    # Retrieve invoice HTML from S3
+    def get_html(opts)
+      retrieve(:html, opts)
+    end
+
+    # Write contents as is to HTML bucket on S3
+    def write_html(opts)
+      write(:html, opts)
+    end
+
+    # Retrieve the contents in a given format of a given file from S3
+    def retrieve(format, opts)
+      s3.buckets[bucket_for(format, opts)].objects[path_for(opts)].read
+    end
+
+    # Write the contents in the given format to S3
+    def write(format, opts)
+      obj = s3.buckets[bucket_for(format, opts)].objects[path_for(opts)]
+      obj.write(opts[:contents])
+    end
+
+    # Get an instance of the S3 client to work with
+    def s3
+      @s3 ||= AWS::S3.new(access_key_id: @key_id, secret_access_key: @key,
+                          use_ssl: true)
+    end
+
+    # Determine which bucket an invoice should live in
+    def bucket_for(format, opts)
+      version = opts[:version]
+      invoice_bucket = ENV['INVOICE_BUCKET_NAME'] || 'invoice-test'
+      if format == :html
+        "vault-v#{version}-#{invoice_bucket}"
+      else
+        "vault-v#{version}-json-#{invoice_bucket}"
+      end
+    end
+
+    # Determine the path on S3 for the given invoice
+    def path_for(opts = {})
+      validate_path_opts(opts)
+      start = DateTime.parse(opts[:start_time].to_s)
+      stop = DateTime.parse(opts[:stop_time].to_s)
+      user_hid = opts[:user_hid] || "user#{opts[:user_id]}@heroku.com"
+      sprintf('%s/%s/%s_v%s', start, stop, user_hid, opts[:version])
+    end
+
+    private
+
+    def validate_path_opts(opts)
+      fail(ArgumentError, 'start_time required!') unless opts[:start_time]
+      fail(ArgumentError, 'stop_time required!') unless opts[:stop_time]
+      fail(ArgumentError, 'version required!') unless opts[:version]
+      user = opts[:user_hid] || opts[:user_id]
+      fail(ArgumentError, 'user_hid or or user_id required!') unless user
+    end
+  end
+end

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = '0.5.8'
+    VERSION = '0.5.9'
   end
 end

data/test/helper.rb

@@ -38,4 +38,72 @@ class Vault::TestCase
   include HoneybadgerHelper
 end
 
+module StubbedS3
+  class FakeFile
+    def initialize(contents=nil)
+      @contents = contents
+    end
+
+    def write(contents)
+      @contents = contents
+    end
+
+    def read
+      @contents
+    end
+  end
+
+  class FakeBucket
+    def initialize
+      @files = {}
+    end
+
+    def [](file_name)
+      @files[file_name] ||= FakeFile.new
+    end
+
+    def write(file_name, contents)
+      @files[file_name].write(contents)
+    end
+
+    def objects
+      self
+    end
+  end
+
+  class FakeClient
+    def initialize
+      @buckets = {}
+    end
+
+    def [](bucket_name)
+      @buckets[bucket_name] ||= FakeBucket.new
+    end
+
+    def buckets
+      self
+    end
+  end
+
+  class << self
+    def seed(bucket, file, contents)
+      fake_client.buckets[bucket].objects[file].write(contents)
+    end
+
+    def fake_client
+      @client ||= FakeClient.new
+    end
+
+    def enable!(env, opts={})
+      AWS.stub!
+      expected_aws_args = {
+        access_key_id: opts.fetch(:access_key_id, 'FAKE_ID'),
+        secret_access_key: opts.fetch(:secret_access_key, 'FAKE_KEY'),
+        use_ssl: opts.fetch(:use_ssl, true)
+      }
+      env.stub(AWS::S3).new(expected_aws_args) { fake_client }
+    end
+  end
+end
+
 Vault.setup

data/test/statement_store_test.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+class StatementStoreTest < Vault::TestCase
+  def setup
+    super
+    StubbedS3.enable!(self)
+    StubbedS3.seed('vault-v2-json-invoice-test',
+                   '2014-10-01T00:00:00+00:00/2014-11-01T00:00:00+00:00/user8@heroku.com_v2',
+                   '{"foo": 1}')
+
+  end
+
+  def test_invoice_path_with_user_id
+    inv = Vault::StatementStore.new(key_id: 'FAKE_ID', key: 'FAKE_KEY')
+    path = inv.path_for(start_time: '2014-10-01', stop_time: '2014-11-01',
+                        user_id: 7, version: 2)
+    assert_equal '2014-10-01T00:00:00+00:00/2014-11-01T00:00:00+00:00/user7@heroku.com_v2', path
+  end
+
+  def test_invoice_path_with_user_hid
+    inv = Vault::StatementStore.new(key_id: 'FAKE_ID', key: 'FAKE_KEY')
+    path = inv.path_for(start_time: '2014-10-01', stop_time: '2014-11-01',
+                        user_hid: 'user8@heroku.com', version: 2)
+    assert_equal '2014-10-01T00:00:00+00:00/2014-11-01T00:00:00+00:00/user8@heroku.com_v2', path
+  end
+
+  def test_retrieve_invoice_json
+    inv = Vault::StatementStore.new(key_id: 'FAKE_ID', key: 'FAKE_KEY')
+    doc = inv.get_json(start_time: '2014-10-01', stop_time: '2014-11-01',
+                       user_hid: 'user8@heroku.com', version: 2)
+    expected = {"foo" => 1}
+    assert_equal expected, doc
+  end
+
+  def test_write_invoice_json
+    inv = Vault::StatementStore.new(key_id: 'FAKE_ID', key: 'FAKE_KEY')
+    # Nothing Before Write
+    doc = inv.get_json(start_time: '2014-10-01', stop_time: '2014-11-01',
+                       user_hid: 'user9@heroku.com', version: 2)
+    expected = nil
+    assert_equal expected, doc
+
+    # Write to S3 updating expectation
+    expected = {"bar" => 3}
+    inv.write_json(start_time: '2014-10-01', stop_time: '2014-11-01',
+                   user_hid: 'user9@heroku.com', version: 2,
+                   contents: expected)
+
+    # There after write
+    doc = inv.get_json(start_time: '2014-10-01', stop_time: '2014-11-01',
+                       user_hid: 'user9@heroku.com', version: 2)
+    assert_equal expected, doc
+  end
+end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.5.9
+  prerelease: 
 platform: ruby
 authors:
 - Chris Continanza
@@ -9,11 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrolls
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -21,6 +23,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -28,6 +31,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -35,6 +39,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -42,6 +47,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: uuidtools
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -49,6 +55,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -56,6 +63,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-ssl-enforcer
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -63,6 +71,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,6 +79,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: heroku-api
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -77,6 +87,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -84,6 +95,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: fernet
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -91,6 +103,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -98,6 +111,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: honeybadger
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -105,6 +119,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -112,6 +127,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -119,6 +135,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -126,6 +143,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -133,6 +151,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -140,6 +159,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -147,6 +167,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -184,6 +205,7 @@ files:
 - lib/vault-tools/product.rb
 - lib/vault-tools/s3.rb
 - lib/vault-tools/sinatra_helpers/html_serializer.rb
+- lib/vault-tools/statement_store.rb
 - lib/vault-tools/tasks.rb
 - lib/vault-tools/text_processor.rb
 - lib/vault-tools/time.rb
@@ -201,6 +223,7 @@ files:
 - test/pipeline_test.rb
 - test/product_test.rb
 - test/s3_test.rb
+- test/statement_store_test.rb
 - test/text_processor_test.rb
 - test/time_test.rb
 - test/user_test.rb
@@ -208,26 +231,27 @@ files:
 - vault-tools.gemspec
 homepage: ''
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Test classes, base web classes, and helpers - oh my!
 test_files: []
 has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTA5MzFhZjViMjA3ODU3NDBmMjdmMzNkYzk4NzU3MjlmMDhkMTBjOQ==
-  data.tar.gz: !binary |-
-    ZDlkZGQ5NjRhNDUwNGExMGQ2Y2NkODU2M2I5ZjYyMzczY2U2YTQyMQ==
-SHA512:
-  metadata.gz: !binary |-
-    NGQ2MDYwNDk1NmMyMTIyYTAyZTA4MGVmZjI2ZjYxODZjZGEzZTBmMTZiOThk
-    ZDY5MTM2NDQyZGFmNjNkMzE3MDZjMWQxYWIwYTVhOTY0N2I5MGMxYzRiYmEw
-    YjZkMjA0NzJlY2I1ZDBmY2FiYjM0MGQyMDFhZTNmNjc3MzAyNTU=
-  data.tar.gz: !binary |-
-    YjcxZTY5NzMwZDg5NDFmY2ZiNTVlNGE0ZjRjMGQ3MGUzZTlkOGE2MjY5NjRj
-    ZWI2ODJmNGM1NWI1NWM5ZDRhMzZjZmJkOWNlZjI5MmFkYWE4MmQzZTI3ZDg4
-    M2Y3ZmYwYmVhYzI2NjMzNjhlYWJmMzg0ZWQ1N2EyZTQ5NTdlNzg=