s3_loggable 0.1.3 → 0.1.4

data/lib/s3_loggable.rb

@@ -1,26 +1,31 @@
 require "fog"
 require "s3_loggable/exceptions"
 require "s3_loggable/logger"
+require "s3_loggable/configuration"
 
 module S3Loggable
 
   RequiredCredentials = [:aws_access_key_id, :aws_secret_access_key]
 
   def self.credentials?
-     set_credentials unless (Fog.credentials.keys & RequiredCredentials).count == RequiredCredentials.count
-     true
+    set_credentials unless (Fog.credentials.keys & RequiredCredentials).count == RequiredCredentials.count
+    true
   end
 
   def self.set_credentials
-    if ENV["AWS_ACCESS_KEY_ID"] and ENV["AWS_SECRET_ACCESS_KEY"]
-      Fog.credentials[:aws_access_key_id] = ENV["AWS_ACCESS_KEY_ID"]
-      Fog.credentials[:aws_secret_access_key] = ENV["AWS_SECRET_ACCESS_KEY"]
+    key = (S3Loggable.configuration.aws_access_key_id || ENV["AWS_ACCESS_KEY_ID"])
+    secret = (S3Loggable.configuration.aws_secret_access_key || ENV["AWS_SECRET_ACCESS_KEY"])
+
+    if key and secret
+      Fog.credentials[:aws_access_key_id] = key
+      Fog.credentials[:aws_secret_access_key] = secret
     else
       raise ConfigurationError, "Set AWS access key id and secret access key"
     end
   end
 
-  def log_to_s3(bucket, message, id = self.id.to_s, folder = self.class.to_s, date_time = DateTime.now)
+  def log_to_s3(message, bucket = S3Loggable.configuration.default_bucket, id = self.id.to_s,
+		folder = self.class.to_s, date_time = DateTime.now)
     S3Loggable::Logger.new(bucket).log_to_s3(message, id, folder, date_time)
   end
 

data/lib/s3_loggable/configuration.rb

@@ -0,0 +1,21 @@
+module S3Loggable
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+    
+    def configure
+      yield(self.configuration)
+    end
+  end
+  
+  class Configuration
+    attr_accessor \
+      :aws_access_key_id,
+      :aws_secret_access_key,
+      :default_bucket
+
+  end
+end

data/lib/s3_loggable/logger.rb

@@ -5,7 +5,7 @@ module S3Loggable
   class Logger
     attr_reader :bucket, :s3
 
-    def initialize(bucket_name)
+    def initialize(bucket_name = S3Loggable.configuration.default_bucket)
       @s3 = Fog::Storage.new({:provider => 'AWS'}) if S3Loggable.credentials?
       set_s3_bucket(bucket_name)
     end

data/lib/s3_loggable/version.rb

@@ -1,3 +1,3 @@
 module S3Loggable
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/s3_loggable.gemspec

@@ -1,4 +1,3 @@
-#lib = File.expand_path('../lib', __FILE__)
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "s3_loggable/version"

data/test/test_s3_loggable.rb

@@ -5,20 +5,43 @@ require "s3_loggable"
 class TestS3Loggable < Test::Unit::TestCase
   class TestClass; include S3Loggable; def self.initialize(*args); end; end
 
-  def test_credentials_is_false?
+  def test_credentials_are_unset_raises_an_exception
     Fog.expects(:credentials).returns({})
-    ENV.expects(:[]).with("AWS_ACCESS_KEY_ID").returns(nil)
+    ENV.expects(:[]).twice.returns(nil)
     assert_raise(S3Loggable::ConfigurationError) do
       S3Loggable.credentials?
     end
   end
 
-  def test_credentials_is_true?
+  def test_credentials_is_true_when_fog_is_already_used
     Fog.expects(:credentials).returns({:aws_access_key_id => "ABC",
 				       :aws_secret_access_key => "123"})
     assert_equal(S3Loggable.credentials?, true)
   end
 
+  def test_credentials_is_true_when_configuration_is_set
+    Fog.expects(:credentials).times(3).returns({})
+    config = mock('config')
+
+    S3Loggable.expects(:configuration).twice.returns(config)
+    config.expects(:aws_access_key_id).returns('ABC')
+    config.expects(:aws_secret_access_key).returns('123')
+
+    assert_equal(S3Loggable.credentials?, true)
+  end
+
+  def test_credentials_is_true_when_env_variables_are_set
+    Fog.expects(:credentials).times(3).returns({})
+    config = mock('config')
+
+    S3Loggable.expects(:configuration).twice.returns(config)
+    config.expects(:aws_access_key_id).returns(nil)
+    config.expects(:aws_secret_access_key).returns(nil)
+    ENV.expects(:[]).with("AWS_ACCESS_KEY_ID").returns("ABC")
+    ENV.expects(:[]).with("AWS_SECRET_ACCESS_KEY").returns("123")
+
+    assert_equal(S3Loggable.credentials?, true)
+  end
 
   def test_log_to_s3_instance_method
     logger = mock('logger')
@@ -31,6 +54,6 @@ class TestS3Loggable < Test::Unit::TestCase
     S3Loggable::Logger.expects(:new).with(bucket).returns(logger)
     logger.expects(:log_to_s3).returns(s3_file)
 
-    assert_equal(test_object.log_to_s3(bucket, message, id), s3_file)
+    assert_equal(test_object.log_to_s3(message, bucket, id), s3_file)
   end
 end

data/test/test_s3_loggable_configuration.rb

@@ -0,0 +1,29 @@
+require "test/unit"
+require "mocha/setup"
+require "s3_loggable"
+
+class TestS3LoggableConfiguration < Test::Unit::TestCase
+
+  def test_default_configurations_are_nil
+    assert_nil(S3Loggable.configuration.aws_access_key_id) 
+    assert_nil(S3Loggable.configuration.aws_secret_access_key) 
+    assert_nil(S3Loggable.configuration.default_bucket) 
+  end
+
+  def test_paramaters_can_be_set_and_accessed
+    key = "ABC"
+    secret = "123"
+    bucket = "foo-bar"
+
+    S3Loggable.configure do |config|
+      config.aws_access_key_id = key
+      config.aws_secret_access_key = secret
+      config.default_bucket = bucket
+    end
+
+    assert_equal(S3Loggable.configuration.aws_access_key_id, key)
+    assert_equal(S3Loggable.configuration.aws_secret_access_key, secret) 
+    assert_equal(S3Loggable.configuration.default_bucket, bucket)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3_loggable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -72,11 +72,13 @@ files:
 - README.md
 - Rakefile
 - lib/s3_loggable.rb
+- lib/s3_loggable/configuration.rb
 - lib/s3_loggable/exceptions.rb
 - lib/s3_loggable/logger.rb
 - lib/s3_loggable/version.rb
 - s3_loggable.gemspec
 - test/test_s3_loggable.rb
+- test/test_s3_loggable_configuration.rb
 - test/test_s3_loggable_logger.rb
 homepage: http://github.com/adaptly/s3_loggable
 licenses: []