s3_loggable 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rake"
+gem "mocha", "~> 0.14"
+gem "fog", "~> 1.12"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    s3_loggable (0.0.3)
+      fog (~> 1.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    excon (0.23.0)
+    fog (1.12.1)
+      builder
+      excon (~> 0.23.0)
+      formatador (~> 0.2.0)
+      mime-types
+      multi_json (~> 1.0)
+      net-scp (~> 1.1)
+      net-ssh (>= 2.1.3)
+      nokogiri (~> 1.5.0)
+      ruby-hmac
+    formatador (0.2.4)
+    metaclass (0.0.1)
+    mime-types (1.23)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.7)
+    net-scp (1.1.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.7)
+    nokogiri (1.5.10)
+    rake (10.1.0)
+    ruby-hmac (0.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fog (~> 1.12)
+  mocha (~> 0.14)
+  rake
+  s3_loggable!

data/README.md

@@ -0,0 +1,3 @@
+S3Loggable
+==========
+Documentation to come...

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/s3_loggable/exceptions.rb

@@ -0,0 +1,3 @@
+module S3Loggable
+  class ConfigurationError < StandardError; end
+end

data/lib/s3_loggable/logger.rb

@@ -0,0 +1,58 @@
+require "date"
+require "zlib"
+
+module S3Loggable
+  class Logger
+    attr_reader :bucket, :s3
+
+    def initialize(bucket_name)
+      @s3 = Fog::Storage.new({:provider => 'AWS'}) if S3Loggable.credentials?
+      set_s3_bucket(bucket_name)
+    end
+
+    def set_s3_bucket(bucket_name)
+      @bucket = @s3.directories.get(bucket_name)
+      @bucket = @s3.directories.create(:key => bucket_name) unless @bucket
+    end
+
+    def log_to_s3(message, folder, id, date_time = DateTime.now)
+      filename = "%s/%s/%04d/%02d/%02d%s" % [folder, id, date_time.year, date_time.month, date_time.day, ".rb.gz"]
+      temp_filename = "tmp/#{filename}"
+      file = get_log(filename)
+      file = create_log(filename, temp_filename) unless file
+      write_to_log(filename, message, date_time, file, temp_filename)
+    end
+
+    def write_to_log(filename, message, date_time, file, temp_filename)
+      local_file = File.open(temp_filename, 'w')
+      local_file.write(file.body)
+      local_file.close
+      File.open(temp_filename, "a+") do |file_gz_io|
+       	Zlib::GzipWriter.wrap(file_gz_io) do |file_gz|
+	  file_gz.puts date_time.to_s
+	  file_gz.puts message.to_s
+	  file_gz.puts
+	end
+      end
+      file.body = File.open(temp_filename)
+      file.save
+      File.delete(local_file)
+      file
+    end
+
+    def get_log(filename)
+      file = @bucket.files.get(filename)
+      file
+    end
+
+    def create_log(filename, temp_filename)
+      file = @bucket.files.create(:key => filename,
+				  :content_type => "application/gzip")
+      FileUtils.mkdir_p(File.dirname(temp_filename))
+      temp_file = File.new(temp_filename, 'w')
+      temp_file.close
+      file
+    end
+
+  end
+end

data/lib/s3_loggable/version.rb

@@ -0,0 +1,3 @@
+module S3Loggable
+  VERSION = "0.1.0"
+end

data/lib/s3_loggable.rb

@@ -0,0 +1,23 @@
+require "fog"
+require "s3_loggable/exceptions"
+require "s3_loggable/logger"
+
+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
+  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"]
+    else
+      raise ConfigurationError, "Set AWS access key id and secret access key"
+    end
+  end
+
+end

data/s3_loggable.gemspec

@@ -0,0 +1,25 @@
+#lib = File.expand_path('../lib', __FILE__)
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "s3_loggable/version"
+
+Gem::Specification.new do |s|
+  s.name          = "s3_loggable"
+  s.version       = S3Loggable::VERSION
+  s.authors       = ["Will Highducheck"]
+  s.email         = ["will.highducheck@gmail.com"]
+  s.summary       = "S3Loggable"
+  s.description   = "Simple logging to S3"
+  s.homepage      = "http://github.com/adaptly/s3_loggable"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "mocha", "~> 0.14"
+
+  s.add_dependency "fog", "~> 1.12"
+
+  s.post_install_message = "Something clever about logs.  Hahahaha..."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+end

data/test/test_s3_loggable.rb

@@ -0,0 +1,21 @@
+require "test/unit"
+require "mocha/setup"
+require "s3_loggable"
+
+class TestS3Loggable < Test::Unit::TestCase
+
+  def test_credentials_is_false?
+    Fog.expects(:credentials).returns({})
+    ENV.expects(:[]).with("AWS_ACCESS_KEY_ID").returns(nil)
+    assert_raise(S3Loggable::ConfigurationError) do
+      S3Loggable.credentials?
+    end
+  end
+
+  def test_credentials_is_true?
+    Fog.expects(:credentials).returns({:aws_access_key_id => "ABC",
+				       :aws_secret_access_key => "123"})
+    assert_equal(S3Loggable.credentials?, true)
+  end
+
+end

data/test/test_s3_loggable_logger.rb

@@ -0,0 +1,80 @@
+require "test/unit"
+require "mocha/setup"
+require "s3_loggable"
+
+class TestS3LoggableLogger < Test::Unit::TestCase
+
+  def test_initialize_existing_bucket
+    bucket_name = "test-bucket-name"
+    fog_storage = mock("fog_storage")
+    bucket = mock("bucket")
+    fog_storage_directories = mock("fog_storage_directories")
+
+    fog_storage.expects(:directories).returns(fog_storage_directories)
+    fog_storage_directories.expects(:get).with(bucket_name).returns(bucket)
+    Fog::Storage.expects(:new).with({:provider => 'AWS'}).returns(fog_storage)
+    S3Loggable.expects(:credentials?).returns(true)
+
+    logger = S3Loggable::Logger.new(bucket_name)
+
+    assert_equal(logger.s3, fog_storage) 
+    assert_equal(logger.bucket, bucket) 
+
+    logger
+  end
+
+  def test_initialize_new_bucket
+    bucket_name = "test-bucket-name"
+    fog_storage = mock("fog_storage")
+    bucket = mock("bucket")
+    fog_storage_directories = mock("fog_storage_directories")
+
+    fog_storage.expects(:directories).twice.returns(fog_storage_directories)
+    fog_storage_directories.expects(:get).with(bucket_name).returns(nil)
+    fog_storage_directories.expects(:create).with(:key => bucket_name).returns(bucket)
+    Fog::Storage.expects(:new).with({:provider => 'AWS'}).returns(fog_storage)
+    S3Loggable.expects(:credentials?).returns(true)
+
+    logger = S3Loggable::Logger.new(bucket_name)
+
+    assert_equal(logger.s3, fog_storage) 
+    assert_equal(logger.bucket, bucket) 
+
+    logger
+  end
+
+  def test_log_to_s3_new_log
+    logger = test_initialize_existing_bucket
+    message = {'foo' => 'bar'}
+    test_object = 'test-object'
+    id = 123
+    s3_file = mock('s3_file')
+    s3_files = mock('s3_files')
+
+    logger.bucket.expects(:files).twice.returns(s3_files)
+    s3_files.expects(:get).returns(nil)
+    s3_files.expects(:create).returns(s3_file)
+    s3_file.expects(:body)
+    s3_file.expects(:body=)
+    s3_file.expects(:save)
+    assert_equal(logger.log_to_s3(message, test_object, id), s3_file)
+  end
+
+  def test_log_to_s3_existing_log
+    logger = test_initialize_existing_bucket
+    message = {'foo' => 'bar'}
+    test_object = 'test-object'
+    id = 123
+    deflated_string = Zlib::Deflate.deflate(message.to_s)
+    s3_file = mock('s3_file')
+    s3_files = mock('s3_files')
+
+    logger.bucket.expects(:files).returns(s3_files)
+    s3_files.expects(:get).returns(s3_file)
+    s3_file.expects(:body).returns(deflated_string)
+    s3_file.expects(:body=)
+    s3_file.expects(:save)
+    assert_equal(logger.log_to_s3(message, test_object, id), s3_file)
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: s3_loggable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Will Highducheck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: Simple logging to S3
+email:
+- will.highducheck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/s3_loggable.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_logger.rb
+homepage: http://github.com/adaptly/s3_loggable
+licenses: []
+post_install_message: Something clever about logs.  Hahahaha...
+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: 1.8.23
+signing_key: 
+specification_version: 3
+summary: S3Loggable
+test_files: []