s3_log 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWM3NzM1NmY4YzRiMTFmZGU5MDYyMGM1MGU1M2VmNWU1MWIxNjc4Mg==
+    MDY5NTI2NWJlOTFmMTk1YjlmZjVlYWNlNTg5ZjQyODRiNmM2MzI5Yw==
   data.tar.gz: !binary |-
-    OWYzOTZkM2ZiMWE2MTljODU0MDczYzJkNjMwNzg1NzhmNDczMWU3ZA==
+    MTE3MDQ5OTUyNzE4NzdkZjUxYzIwOTBiZTg3MGMxZTA4MjZlOTZlYQ==
 SHA512:
   metadata.gz: !binary |-
-    ZGM1OGY5M2RmM2UxMmI4YTAxZjg1MzFjOWVkNjJiN2UyZWY1MjJjZmY1NzU3
-    ZGNmOTE4OGFmYTgzNGM4NjI3MjI1OTI0MmI3MDUyZjVhYWU4MTU1N2NkMmI3
-    MTU2MjU5MjAxYjk2MDk3YTVhMTc5ZGRiZGI4ZTE1YjhkMDYzOTA=
+    N2I1Mzk5Yzc5N2U2ZDRlNmRjNWEzYjUxYTFjYmIyYmMyZWQ3OWU4NWNmN2E2
+    NDdlMWQzMmVkN2ZhMzFmYmIwN2ZmNjJmODBhMWNjOTFhNDZhM2Y2NmI1N2Mz
+    ZjA1NTA3MTM1MmQ1MzI4MjU5MmVmM2ZjYmQ2ZGQyZTE5NDZlNjI=
   data.tar.gz: !binary |-
-    YjcyZjc3NzYxOTNlOWFmMDQyYjE2M2FiNmEwYzdhNjFkZTc5MmViNzgzOTU4
-    MmYyN2Q5NjhiNTdkNmJmN2FjODYyY2FjYTQxMThkZTRjMjY2NGUwZDU5MDY2
-    ZjUzZmE4YzJhNjllYWNmMzA4MzAwMWFlNTNmZDJiZTlhZjM3ZTg=
+    NTM5Yzg1NzUwNmQ2MmQ4ZTE0N2MzNDEwOGY1YjUzZjQ2YzAzMGUyMmYwZmIx
+    NDViMGY4OWNhODNjNzVjYjYwYzhiYTFlYTIzYTBiODFiYjI4ZDg4NzZmOTUw
+    MzQ0M2NhYzNlZmY0MmI4MDJhYTc0YzlmYTk4YTE5YjQyYzZjZTg=

data/HISTORY.md

@@ -1,5 +1,6 @@
 ## History ##
 
+* 0.0.5 - Added formal API docs
 * 0.0.4 - Even more README reference fixes
 * 0.0.3 - Fixed README to remove s3_logger references
 * 0.0.2 - Renamed to S3Log to avoid conflict with an existing gem

data/lib/s3_log.rb

@@ -1,21 +1,49 @@
 require 'fog/aws/storage'
 require 's3_log/exceptions'
 
+# This module is a singleton that implements an append-style S3 file writer.
+
 module S3Log
   RequiredOptions = [:access_key_id, :secret_access_key, :bucket]
 
+  # Return the singleton's S3 Storage object
+  #
+  # @return [Fog::Storage::AWS] if the logger is configured
+  #
+  # @return [BilClass] if the logger is not configured
+
   def self.storage
     @storage
   end
 
+  # Return the singleton's S3 bucket
+  #
+  # @return [Fog::Storage::AWS::Directory] if the logger is configured
+  #
+  # @return [NilClass] if the logger is not configured
+
   def self.bucket
     @bucket
   end
 
+  # Is the logger configured?
+  #
+  # @return [Boolean] true if the logger is configured, false otherwise
+
   def self.configured?
     storage && bucket
   end
 
+  # Configure the logger so it can be used to write logs
+  #
+  # @param options [Hash] The :access_key_id, :secret_access_key, and :bucket
+  #   keys are required
+  #
+  # @return [S3Log] the singleton logger
+  #
+  # @raise [S3Log::InvalidConfigError] if not provided all required
+  #   configuration options
+
   def self.configure(options = {})
     missing = RequiredOptions - options.keys
     raise InvalidConfigError.new(missing) unless missing.empty?
@@ -34,8 +62,14 @@ module S3Log
     self
   end
 
+  # Append the given content to the given S3 path
+  #
+  # @return [S3Log] the singleton logger
+  #
+  # @raise [S3Log::Unconfigured] if the logger has not been configured
+
   def self.write(path, content)
-    unless storage && bucket
+    unless configured?
       raise Unconfigured
     end
 
@@ -48,8 +82,16 @@ module S3Log
     self
   end
 
+  # Read the given path
+  #
+  # @return [String] the content of the requested S3 file if present
+  #
+  # @return [String] the empty string if the requested S3 file is not present
+  #
+  # @raise [S3Log::Unconfigured] if the logger has not been configured
+
   def self.read(path)
-    unless storage && bucket
+    unless configured?
       raise Unconfigured
     end
 
@@ -57,6 +99,10 @@ module S3Log
     file.nil? ? '' : file.body.to_s
   end
 
+  # Clear the singleton logger's configuration
+  #
+  # @return [NilClass]
+
   def self.clear_configuration
     @bucket = @storage = nil
   end

data/lib/s3_log/version.rb

@@ -1,3 +1,3 @@
 module S3Log
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_log
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Dennis Walters
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws