s3_log 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDMwNzBmNzcyYWQ1MDAyZDRkNGMzMmMxYjQ3YzczZDI3NDQ1MjdiNQ==
+  data.tar.gz: !binary |-
+    ZjEyZGI2Y2NhMzNjYTJlODUyYjZmZGI3NTBlYTM2MjM1NDhhMzI3NQ==
+SHA512:
+  metadata.gz: !binary |-
+    OTFlNDY4ZmE2Y2M0MTY0ZDhkNjljNDY3Mzk0NmUxNWIzMTQ3ZWM1ZTY5ZTU3
+    M2IxMDEwZWRmZTk2YmMzNTdlMDcyYTZlZmVjMDI1ZWUxMTZmODQ2YzZlNzRj
+    OWQzYjA2NzI3MzlkOTAyYjc0MjI1NDRkODY1ZGVjZjU5NGJlYjY=
+  data.tar.gz: !binary |-
+    MWZkNjY1Mjg0NDRiYzVhYzZhMjhjNDdhMGVmYjU4NWM3MDJmNzE5ZmVkMWY2
+    OTBkODJiOTVjZTNjM2M4ODFiNTE1MTU4ZGUyMWM0YTU3YjYyMmJiNWI1MDRl
+    NjI4MDM0ZWQ4MTVlN2JhNzQ1ZDQwOTkyZTlkN2E5ZWQyZTcxOWE=

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle
+/log/*.log
+/tmp
+*~
+*.swp
+/pkg
+/bin
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/HISTORY.md

@@ -0,0 +1,4 @@
+## History ##
+
+* 0.0.2 - Renamed to S3Log to avoid conflict with an existing gem
+* 0.0.1 - Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dennis Walters
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+## S3Logger ##
+
+Naively log events to a file on S3
+
+## Gem Setup ##
+
+```ruby
+gem install s3_logger
+
+# Gemfile
+gem 's3_logger'
+```
+
+## Configuration ##
+
+S3Logger requires an AWS access key id, AWS secret access key, and a S3 bucket (preferably created in advance) name to function. It can be configured (in a Rails initializer or what have you) like so:
+
+```ruby
+S3Logger.configure(
+  access_key_id: 'YOUR AWS ACCESS KEY ID',
+  secret_access_key: 'YOUR AWS SECRET ACCESS KEY',
+  bucket: 'YOUR S3 BUCKET'
+)
+```
+
+## Usage ##
+
+Basically, logging an event is a matter of using S3Logger.write to write content to a given file location on S3. The file does not have to exist prior to writing, and a write always appends to an existing file.
+
+```ruby
+S3Logger.write('path/to/file', 'Some content')
+```
+
+## Caveats ##
+
+There is no locking in this process, and an existing file will always be read and appended rather than blindly replaced. That being the case, near-simultaneous writes are won by the most recent write, and you would do well to do one of the following to avoid data loss:
+
+* Ensure that only one process writes to a given file at a time
+* Use a new file path for each write (ie models/user/1/TIMESTAMP.log rather than models/user/1.log)
+
+## Formal Documentation ##
+
+The actual library docs can be read
+[over on rubydoc](http://rubydoc.info/gems/s3_logger/frames).
+
+## Contributing ##
+
+Do you use git-flow? I sure do. Please base anything you do off of
+[the develop branch](https://github.com/ess/s3_logger/tree/develop).
+
+1. Fork it.
+2. Perform some BDD magic. Seriously. Be testing.
+3. Submit a pull request.
+
+## License ##
+
+MIT License. Copyright 2015 Dennis Walters

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"

data/lib/s3_log/exceptions.rb

@@ -0,0 +1,15 @@
+module S3Log
+  class Error < StandardError ; end
+
+  class InvalidConfigError < Error
+    def initialize(missing)
+      super("Missing configuration keys (#{missing.join(', ')})")
+    end
+  end
+
+  class Unconfigured < Error
+    def initialize(garbage = nil)
+      super("You must first run S3Logger.configure")
+    end
+  end
+end

data/lib/s3_log/version.rb

@@ -0,0 +1,3 @@
+module S3Log
+  VERSION = '0.0.2'
+end

data/lib/s3_log.rb

@@ -0,0 +1,63 @@
+require 'fog/aws/storage'
+require 's3_log/exceptions'
+
+module S3Log
+  RequiredOptions = [:access_key_id, :secret_access_key, :bucket]
+
+  def self.storage
+    @storage
+  end
+
+  def self.bucket
+    @bucket
+  end
+
+  def self.configured?
+    storage && bucket
+  end
+
+  def self.configure(options = {})
+    missing = RequiredOptions - options.keys
+    raise InvalidConfigError.new(missing) unless missing.empty?
+
+    clear_configuration
+
+    @storage = Fog::Storage::AWS.new(
+      aws_access_key_id: options[:access_key_id],
+      aws_secret_access_key: options[:secret_access_key]
+    )
+
+    @bucket = @storage.directories.create(
+      key: options[:bucket],
+      public: false
+    )
+    self
+  end
+
+  def self.write(path, content)
+    unless storage && bucket
+      raise Unconfigured
+    end
+
+    bucket.files.create(
+      key: path,
+      body: read(path).split("\n").push(content).join("\n"),
+      public: false
+    )
+
+    self
+  end
+
+  def self.read(path)
+    unless storage && bucket
+      raise Unconfigured
+    end
+
+    file = bucket.files.get(path)
+    file.nil? ? '' : file.body.to_s
+  end
+
+  def self.clear_configuration
+    @bucket = @storage = nil
+  end
+end

data/s3_log.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/s3_log/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dennis Walters"]
+  gem.email         = ["dennis@elevatorup.com"]
+  gem.summary       = %q{Log misc events to Amazon S3}
+  gem.description   = <<-EOD
+    Log misc events to Amazon S3
+  EOD
+  gem.homepage      = "http://github.com/ess/s3_log"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "s3_log"
+  gem.require_paths = ["lib"]
+  gem.version       = S3Log::VERSION
+
+  gem.add_dependency 'fog-aws', '~> 0.1.1'
+  gem.add_development_dependency 'rspec', '~> 3.2.0'
+end

data/spec/s3_log_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+require 's3_log'
+
+describe S3Log do
+  let(:access_key_id) {'ACCESS_KEY_ID'}
+  let(:secret_access_key) {'SECRET_ACCESS_KEY'}
+  let(:bucket) {'bucket'}
+  let(:path) {'path/to/a/file'}
+  let(:content) {'line 1'}
+
+  before(:each) do
+    Fog::Mock.reset
+    Fog.mock!
+  end
+
+  describe '.configure' do
+    let(:good_options) {{
+      access_key_id: access_key_id,
+      secret_access_key: secret_access_key,
+      bucket: bucket
+    }}
+    
+    it 'requires an aws access key id' do
+      expect{described_class.configure(good_options)}.
+        not_to raise_error
+
+      good_options.delete(:access_key_id)
+
+      expect{described_class.configure(good_options)}.
+        to raise_error(S3Log::InvalidConfigError)
+    end
+
+    it 'requires an aws secret access key' do
+      expect{described_class.configure(good_options)}.
+        not_to raise_error
+
+      good_options.delete(:secret_access_key)
+
+      expect{described_class.configure(good_options)}.
+        to raise_error(S3Log::InvalidConfigError)
+
+    end
+
+    it 'requires a bucket name' do
+      expect{described_class.configure(good_options)}.
+        not_to raise_error
+
+      good_options.delete(:bucket)
+
+      expect{described_class.configure(good_options)}.
+        to raise_error(S3Log::InvalidConfigError)
+    end
+  end
+
+  describe '.read' do
+    before(:each) do
+      described_class.configure(
+        access_key_id: 'ACCESS_KEY_ID',
+        secret_access_key: 'SECRET_ACCESS_KEY',
+        bucket: 'bucket'
+      )
+    end
+
+    it 'requires that the module be configured' do
+      described_class.clear_configuration
+      expect {described_class.read(path)}.
+        to raise_error(described_class::Unconfigured)
+    end
+
+    it 'is a string' do
+      expect(described_class.read(path)).to be_a(String)
+    end
+
+    context 'for a non-existent path' do
+      it 'is an empty string' do
+        expect(described_class.read(path)).to eql('')
+      end
+    end
+
+    context 'for an existing path' do
+      it 'is the content of the file' do
+        described_class.write(path, content)
+        expect(described_class.read(path)).to eql(content)
+      end
+    end
+  end
+
+  describe '.write' do
+    before(:each) do
+      described_class.configure(
+        access_key_id: 'ACCESS_KEY_ID',
+        secret_access_key: 'SECRET_ACCESS_KEY',
+        bucket: 'bucket'
+      )
+    end
+
+    it 'requires that the module be configured' do
+      described_class.clear_configuration
+      expect {described_class.write(path, content)}.
+        to raise_error(described_class::Unconfigured)
+    end
+
+    it 'reads the file' do
+      expect(described_class).
+        to receive(:read).with(path).and_call_original
+
+      described_class.write(path, content)
+    end
+
+    it 'creates the file on s3' do
+      expect(described_class.read(path)).to eql('')
+
+      described_class.write(path, content)
+
+      expect(described_class.read(path)).to eql(content)
+    end
+
+    it 'appends to an exsiting s3 file' do
+      more_content = 'more content'
+      described_class.write(path, content)
+      expect(described_class.read(path)).to eql(content)
+
+      described_class.write(path, "more content")
+      expect(described_class.read(path)).to eql("#{content}\n#{more_content}")
+    end
+
+    it 'returns the logger itself' do
+      expect(described_class.write(path, content)).to eql(described_class)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'rspec/mocks'
+require 'rspec/expectations'
+
+$:.unshift File.join(File.dirname(__FILE__), '..')
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: s3_log
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dennis Walters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog-aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: ! '    Log misc events to Amazon S3
+
+'
+email:
+- dennis@elevatorup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/s3_log.rb
+- lib/s3_log/exceptions.rb
+- lib/s3_log/version.rb
+- s3_log.gemspec
+- spec/s3_log_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ess/s3_log
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Log misc events to Amazon S3
+test_files:
+- spec/s3_log_spec.rb
+- spec/spec_helper.rb