vault-tools 0.4.10 → 0.4.11

data/.travis.yml

@@ -3,4 +3,3 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-2.1.1

data/lib/vault-tools.rb

@@ -66,3 +66,4 @@ require 'vault-tools/web'
 require 'vault-tools/pipeline'
 require 'vault-tools/text_processor'
 require 'vault-tools/time'
+require 'vault-tools/s3'

data/lib/vault-tools/s3.rb

@@ -0,0 +1,35 @@
+module S3
+  extend self
+
+  # Write value to key in S3 bucket, with logging.
+  #
+  # @param bucket [String]
+  # @param key [String]
+  # @param value [String]
+  def write(bucket, key, value)
+    Vault::Log.log(:fn => __method__, :key => key) do
+      s3.buckets[bucket].objects[key].write(value)
+    end
+  end
+
+  # Read value from key in S3 bucket, with logging.
+  #
+  # @param bucket [String]
+  # @param key [String]
+  def read(bucket, key)
+    Vault::Log.log(:fn => __method__, :key => key) do
+      s3.buckets[bucket].objects[key].read
+    end
+  end
+
+  # Get the underlying AWS::S3 instance, creating it using environment vars
+  # if necessary.
+  def s3
+    @s3 ||= AWS::S3.new(
+      :access_key_id => Config.env('AWS_ACCESS_KEY_ID'),
+      :secret_access_key => Config.env('AWS_SECRET_ACCESS_KEY'),
+      :use_ssl => true
+    )
+  end
+
+end

data/lib/vault-tools/version.rb

@@ -1,5 +1,5 @@
 module Vault
   module Tools
-    VERSION = '0.4.10'
+    VERSION = '0.4.11'
   end
 end

data/test/helper.rb

@@ -1,5 +1,7 @@
 require 'vault-test-tools'
 require 'vault-tools'
+require 'aws-sdk'
+require 'rr'
 
 ENV['RACK_ENV'] = 'test'
 

data/test/log_test.rb

@@ -1,7 +1,6 @@
 require 'helper'
 
 class LogTest < Vault::TestCase
-  include Vault::Test::EnvironmentHelpers
   include LoggedDataHelper
 
   def setup

data/test/s3_test.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+class SomeS3Consumer
+  include S3
+end
+
+class S3Test < Vault::TestCase
+  include LoggedDataHelper
+
+  def setup
+    super
+    set_env 'APP_DEPLOY', 'test'
+    set_env 'AWS_ACCESS_KEY_ID', 'fake access key id'
+    set_env 'AWS_SECRET_ACCESS_KEY', 'fake secret access key'
+    AWS.stub!
+    @consumer = SomeS3Consumer.new
+  end
+
+  def log_output
+    Scrolls.stream.string
+  end
+
+  # S3 writes should be logged.
+  def test_write_logs
+    @consumer.write('fake bucket', 'fake key', 'fake value')
+    assert_match /fake key/, log_output
+  end
+
+  # S3 reads should be logged.
+  def test_read_logs
+    @consumer.read('fake bucket', 'fake key')
+    assert_match /fake key/, log_output
+  end
+
+  # Should use S3 to write to bucket
+  def test_writes_to_s3_bucket
+    mock(@consumer).s3.mock!.buckets.
+      mock!.[]('fake bucket').
+      mock!.objects.
+      mock!.[]('fake key').
+      mock!.write('fake value')
+    @consumer.write('fake bucket', 'fake key', 'fake value')
+  end
+
+  # Should use S3 to read from bucket
+  def test_reads_from_s3_bucket
+      #s3.buckets[bucket].objects[key].read
+    mock(@consumer).s3.mock!.buckets.
+      mock!.[]('fake bucket').
+      mock!.objects.
+      mock!.[]('fake key').
+      mock!.read
+    @consumer.read('fake bucket', 'fake key')
+  end
+end

data/vault-tools.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'honeybadger'
   gem.add_dependency 'rdoc'
   gem.add_dependency 'yard'
+  gem.add_dependency 'aws-sdk'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vault-tools
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.4.11
   prerelease: 
 platform: ruby
 authors:
@@ -156,6 +156,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Basic tools for Heroku Vault's Ruby projects
 email:
 - christopher.continanza@gmail.com
@@ -185,6 +201,7 @@ files:
 - lib/vault-tools/payments_db_tasks.rb
 - lib/vault-tools/pipeline.rb
 - lib/vault-tools/product.rb
+- lib/vault-tools/s3.rb
 - lib/vault-tools/sinatra_helpers/html_serializer.rb
 - lib/vault-tools/text_processor.rb
 - lib/vault-tools/time.rb
@@ -200,6 +217,7 @@ files:
 - test/log_test.rb
 - test/pipeline_test.rb
 - test/product_test.rb
+- test/s3_test.rb
 - test/text_processor_test.rb
 - test/time_test.rb
 - test/user_test.rb
@@ -219,7 +237,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3939315679602429457
+      hash: -4329855813357893782
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -228,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3939315679602429457
+      hash: -4329855813357893782
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23