sluice 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sluice.gemspec
+gemspec

data/LICENSE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,64 @@
+# Sluice
+
+Sluice is a Ruby gem (built with [Bundler] [bundler]) to help you build cloud-friendly ETL (extract, transform, load) processes.
+
+Sluice has been extracted from a pair of Ruby ETL applications built by the [SnowPlow Analytics] [snowplow-analytics] team, specifically:
+
+1. [EmrEtlRunner] [emr-etl-runner], a Ruby application to run the SnowPlow ETL process on Elastic MapReduce
+2. [StorageLoader] [storage-loader], a Ruby application to load SnowPlow event files from Amazon S3 into databases such as Infobright
+
+## Installation 
+
+    $ gem install sluice
+
+Or in your Gemfile:
+
+    gem 'sluice', '~> 0.0.1'
+
+## Usage
+
+Rubydoc and usage examples to come.
+
+## Hacking and contributing
+
+To hack on Sluice locally:
+
+    $ gem build sluice.gemspec
+    $ sudo gem install sluice-0.0.1.gem
+
+To contribute:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits and thanks
+
+Sluice was developed by [Alex Dean] [alexanderdean] ([SnowPlow Analytics] [snowplow-analytics]) and [Michael Tibben] [mtibben] ([99designs] [99designs]).
+
+## Copyright and license
+
+Sluice is copyright 2012 SnowPlow Analytics Ltd.
+
+Licensed under the [Apache License, Version 2.0] [license] (the "License");
+you may not use this software except in compliance with the License.
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+[bundler]: http://gembundler.com/
+
+[snowplow-analytics]: http://snowplowanalytics.com
+[alexanderdean]: https://github.com/alexanderdean
+[mtibben]: https://github.com/mtibben
+[99designs]: http://99designs.com
+
+[emr-etl-runner]: https://github.com/snowplow/snowplow/tree/master/3-etl/emr-etl-runner
+[storage-loader]: https://github.com/snowplow/snowplow/tree/master/4-storage/storage-loader
+
+[license]: http://www.apache.org/licenses/LICENSE-2.0

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/sluice.rb

@@ -0,0 +1,23 @@
+# Copyright (c) 2012 SnowPlow Analytics Ltd. All rights reserved.
+#
+# This program is licensed to you under the Apache License Version 2.0,
+# and you may not use this file except in compliance with the Apache License Version 2.0.
+# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the Apache License Version 2.0 is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+
+# Author::    Alex Dean (mailto:support@snowplowanalytics.com)
+# Copyright:: Copyright (c) 2012 SnowPlow Analytics Ltd
+# License::   Apache License Version 2.0
+
+require 'sluice/errors'
+require 'sluice/storage/storage'
+require 'sluice/storage/s3'
+
+module Sluice
+  NAME    = "sluice"
+  VERSION = "0.0.1"
+end

data/lib/sluice/errors.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2012 SnowPlow Analytics Ltd. All rights reserved.
+#
+# This program is licensed to you under the Apache License Version 2.0,
+# and you may not use this file except in compliance with the Apache License Version 2.0.
+# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the Apache License Version 2.0 is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+
+# Author::    Alex Dean (mailto:support@snowplowanalytics.com)
+# Copyright:: Copyright (c) 2012 SnowPlow Analytics Ltd
+# License::   Apache License Version 2.0
+
+# All errors
+module Sluice
+
+  # The base error class for all <tt>Sluice</tt> error classes.
+  class Error < StandardError
+  end
+
+  # If a storage operation is not supported or incorrect
+  class StorageOperationError < Error
+  end
+end

data/lib/sluice/storage/s3.rb

@@ -0,0 +1,281 @@
+# Copyright (c) 2012 SnowPlow Analytics Ltd. All rights reserved.
+#
+# This program is licensed to you under the Apache License Version 2.0,
+# and you may not use this file except in compliance with the Apache License Version 2.0.
+# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the Apache License Version 2.0 is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+
+# Authors::    Alex Dean (mailto:support@snowplowanalytics.com), Michael Tibben
+# Copyright:: Copyright (c) 2012 SnowPlow Analytics Ltd
+# License::   Apache License Version 2.0
+
+require 'fog'
+require 'thread'
+
+module Sluice
+  module Storage
+    module S3
+
+      # TODO: figure out logging instead of puts (https://github.com/snowplow/sluice/issues/2)
+      # TODO: consider moving to OO structure (https://github.com/snowplow/sluice/issues/3)
+
+      # Constants
+      CONCURRENCY = 10 # Threads
+      RETRIES = 3      # Attempts
+      RETRY_WAIT = 10  # Seconds
+
+      # Class to describe an S3 location
+      # TODO: if we are going to impose trailing line-breaks on
+      # buckets, maybe we should make that clearer?
+      class Location
+        attr_reader :bucket, :dir, :s3location
+
+        # Parameters:
+        # +s3location+:: the s3 location config string e.g. "bucket/directory"
+        def initialize(s3_location)
+          @s3_location = s3_location
+
+          s3_location_match = s3_location.match('^s3n?://([^/]+)/?(.*)/$')
+          raise ArgumentError, 'Bad S3 location %s' % s3_location unless s3_location_match
+
+          @bucket = s3_location_match[1]
+          @dir = s3_location_match[2]
+        end
+
+        def dir_as_path
+          if @dir.length > 0
+            return @dir+'/'
+          else
+            return ''
+          end
+        end
+
+        def to_s
+          @s3_location
+        end
+      end
+
+      # Helper function to instantiate a new Fog::Storage
+      # for S3 based on our config options
+      #
+      # Parameters:
+      # +region+:: Amazon S3 region we will be working with
+      # +access_key_id+:: AWS access key ID
+      # +secret_access_key+:: AWS secret access key
+      def new_fog_s3_from(region, access_key_id, secret_access_key)
+        Fog::Storage.new({
+          :provider => 'AWS',
+          :region => region,
+          :aws_access_key_id => access_key_id,
+          :aws_secret_access_key => secret_access_key
+        })
+      end
+      module_function :new_fog_s3_from
+
+      # Determine if a bucket is empty
+      #
+      # Parameters:
+      # +s3+:: A Fog::Storage s3 connection
+      # +location+:: The location to check
+      def is_empty?(s3, location)
+        s3.directories.get(location.bucket, :prefix => location.dir).files().length > 1
+      end
+      module_function :is_empty?
+
+      # Delete files from S3 locations concurrently
+      #
+      # Parameters:
+      # +s3+:: A Fog::Storage s3 connection
+      # +from+:: S3Location to delete files from
+      # +match_regex+:: a regex string to match the files to delete
+      def delete_files(s3, from_location, match_regex='.+')
+
+        puts "  deleting files from #{from_location}"
+        process_files(:delete, s3, from_location, match_regex)
+      end
+      module_function :delete_files
+
+      # Copies files between S3 locations concurrently
+      #
+      # Parameters:
+      # +s3+:: A Fog::Storage s3 connection
+      # +from+:: S3Location to copy files from
+      # +to+:: S3Location to copy files to
+      # +match_regex+:: a regex string to match the files to copy
+      # +alter_filename_lambda+:: lambda to alter the written filename
+      def copy_files(s3, from_location, to_location, match_regex='.+', alter_filename_lambda=false)
+
+        puts "  copying files from #{from_location} to #{to_location}"
+        process_files(:copy, s3, from_location, match_regex, to_location, alter_filename_lambda)
+      end
+      module_function :copy_files
+
+      # Moves files between S3 locations concurrently
+      #
+      # Parameters:
+      # +s3+:: A Fog::Storage s3 connection
+      # +from+:: S3Location to move files from
+      # +to+:: S3Location to move files to
+      # +match_regex+:: a regex string to match the files to move
+      # +alter_filename_lambda+:: lambda to alter the written filename
+      def move_files(s3, from_location, to_location, match_regex='.+', alter_filename_lambda=false)
+
+        puts "  moving files from #{from_location} to #{to_location}"
+        process_files(:move, s3, from_location, match_regex, to_location, alter_filename_lambda)
+      end
+      module_function :move_files
+
+      private
+
+      # Concurrent file operations between S3 locations. Supports:
+      # - Copy
+      # - Delete
+      # - Move (= Copy + Delete)
+      #
+      # Parameters:
+      # +operation+:: Operation to perform. :copy, :delete, :move supported
+      # +s3+:: A Fog::Storage s3 connection
+      # +from+:: S3Location to process files from
+      # +match_regex+:: a regex string to match the files to process
+      # +to+:: S3Location to process files to
+      # +alter_filename_lambda+:: lambda to alter the written filename
+      def process_files(operation, s3, from_location, match_regex='.+', to_location=nil, alter_filename_lambda=false)
+
+        # Validate that the file operation makes sense
+        case operation
+        when :copy, :move
+          if to_location.nil?
+            raise StorageOperationError "File operation %s requires a to_location to be set" % operation
+          end
+        when :delete
+          unless to_location.nil?
+            raise StorageOperationError "File operation %s does not support the to_location argument" % operation
+          end
+          if alter_filename_lambda.class == Proc
+            raise StorageOperationError "File operation %s does not support the alter_filename_lambda argument" % operation
+          end
+        else
+          raise StorageOperationError "File operation %s is unsupported. Try :copy, :delete or :move" % operation
+        end
+
+        files_to_process = []
+        threads = []
+        mutex = Mutex.new
+        complete = false
+        marker_opts = {}
+
+        # If an exception is thrown in a thread that isn't handled, die quickly
+        Thread.abort_on_exception = true
+
+        # Create ruby threads to concurrently execute s3 operations
+        for i in (0...CONCURRENCY)
+
+          # Each thread pops a file off the files_to_process array, and moves it.
+          # We loop until there are no more files
+          threads << Thread.new do
+            loop do
+              file = false
+              match = false
+
+              # Critical section:
+              # only allow one thread to modify the array at any time
+              mutex.synchronize do
+
+                while !complete && !match do
+                  if files_to_process.size == 0
+                    # s3 batches 1000 files per request
+                    # we load up our array with the files to move
+                    files_to_process = s3.directories.get(from_location.bucket, :prefix => from_location.dir).files.all(marker_opts)
+                    # if we don't have any files after the s3 request, we're complete
+                    if files_to_process.size == 0
+                      complete = true
+                      next
+                    else
+                      marker_opts['marker'] = files_to_process.last.key
+
+                      # By reversing the array we can use pop and get FIFO behaviour
+                      # instead of the performance penalty incurred by unshift
+                      files_to_process = files_to_process.reverse
+                    end
+                  end
+
+                  file = files_to_process.pop
+                  match = if match_regex.is_a? NegativeRegex
+                            !file.key.match(match_regex.regex)
+                          else
+                            file.key.match(match_regex)
+                          end
+                end
+              end
+
+              # If we don't have a match, then we must be complete
+              break unless match # exit the thread
+
+              # Match the filename, ignoring directory
+              file_match = file.key.match('([^/]+)$')
+
+              # Silently skip any sub-directories in the list
+              break unless file_match
+
+              if alter_filename_lambda.class == Proc
+                filename = alter_filename_lambda.call(file_match[1])
+              else
+                filename = file_match[1]
+              end
+
+              # What are we doing?
+              case operation
+              when :move
+                puts "    MOVE #{from_location.bucket}/#{file.key} -> #{to_location.bucket}/#{to_location.dir_as_path}#{filename}"            
+              when :copy
+                puts "    COPY #{from_location.bucket}/#{file.key} +-> #{to_location.bucket}/#{to_location.dir_as_path}#{filename}"  
+              when :delete
+                puts "    DELETE x #{from_location.bucket}/#{file.key}" 
+              end
+
+              # A move or copy starts with a copy file
+              if [:move, :copy].include? operation
+                i = 0
+                begin
+                  file.copy(to_location.bucket, to_location.dir_as_path + filename)
+                  puts "      +-> #{to_location.bucket}/#{to_location.dir_as_path}#{filename}"
+                rescue
+                  raise unless i < RETRIES
+                  puts "Problem copying #{file.key}. Retrying.", $!, $@
+                  sleep(RETRY_WAIT)  # give us a bit of time before retrying
+                  i += 1
+                  retry
+                end
+              end
+
+              # A move or delete ends with a delete
+              if [:move, :delete].include? operation
+                i = 0
+                begin
+                  file.destroy()
+                  puts "      x #{from_location.bucket}/#{file.key}"
+                rescue
+                  raise unless i < RETRIES
+                  puts "Problem destroying #{file.key}. Retrying.", $!, $@
+                  sleep(RETRY_WAIT) # Give us a bit of time before retrying
+                  i += 1
+                  retry
+                end
+              end
+            end
+          end
+        end
+
+        # Wait for threads to finish
+        threads.each { |aThread|  aThread.join }
+
+      end
+      module_function :process_files
+
+    end
+  end
+end

data/lib/sluice/storage/storage.rb

@@ -0,0 +1,103 @@
+# Copyright (c) 2012 SnowPlow Analytics Ltd. All rights reserved.
+#
+# This program is licensed to you under the Apache License Version 2.0,
+# and you may not use this file except in compliance with the Apache License Version 2.0.
+# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the Apache License Version 2.0 is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+
+# Author::    Alex Dean (mailto:support@snowplowanalytics.com), Michael Tibben
+# Copyright:: Copyright (c) 2012 SnowPlow Analytics Ltd
+# License::   Apache License Version 2.0
+
+module Sluice
+  module Storage
+
+    # To handle negative file matching
+    NegativeRegex = Struct.new(:regex)  
+
+    # Find files within the given date range
+    # (inclusive).
+    #
+    # Parameters:
+    # +start_date+:: start date
+    # +end_date+:: end date
+    # +date_format:: format of date in filenames
+    # +file_ext:: extension on files (if any)   
+    def files_between(start_date, end_date, date_format, file_ext=nil)
+
+      dates = []
+      Date.parse(start_date).upto(Date.parse(end_date)) do |day|
+        dates << day.strftime(date_format)
+      end
+
+      '(' + dates.join('|') + ')[^/]+%s$' % regexify.call(file_ext)
+    end
+    module_function :files_between
+
+    # Add a trailing slash to a path if missing
+    #
+    # Parameters:
+    # +path+:: path to add a trailing slash to
+    def trail_slash(path)
+
+      path[-1].chr != '/' ? path << '/' : path
+    end
+    module_function :trail_slash
+
+    # Find files up to (and including) the given date.
+    #
+    # Returns a regex in a NegativeRegex so that the
+    # matcher can negate the match.
+    #
+    # Parameters:
+    # +end_date+:: end date
+    # +date_format:: format of date in filenames
+    # +file_ext:: extension on files (if any)  
+    def files_up_to(end_date, date_format, file_ext=nil)
+
+      # Let's create a black list from the day
+      # after the end_date up to today
+      day_after = Date.parse(end_date) + 1
+      today = Date.today
+
+      dates = []
+      day_after.upto(today) do |day|
+        dates << day.strftime(date_format) # Black list
+      end
+
+      NegativeRegex.new('(' + dates.join('|') + ')[^/]+%s$') % regexify.call(file_ext)
+    end
+    module_function :files_up_to
+
+    # Find files starting from the given date.
+    #
+    # Parameters:
+    # +start_date+:: start date
+    # +date_format:: format of date in filenames
+    # +file_ext:: extension on files (if any); include period    
+    def files_from(start_date, date_format, file_ext=nil)
+
+      # Let's create a white list from the start_date to today
+      today = Date.today
+
+      dates = []
+      Date.parse(start_date).upto(today) do |day|
+        dates << day.strftime(date_format)
+      end
+
+      '(' + dates.join('|') + ')[^/]+%s$' % regexify.call(file_ext)
+    end
+    module_function :files_from
+
+    private
+
+    # Make a file extension regular expression friendly,
+    # adding a starting period (.) if missing 
+    regexify = lambda {|fe| return fe.nil? ? nil : fe[0].chr != '.' ? '\\.' << fe : '\\' << fe}
+
+  end
+end

data/sluice.gemspec

@@ -0,0 +1,38 @@
+# Copyright (c) 2012 SnowPlow Analytics Ltd. All rights reserved.
+#
+# This program is licensed to you under the Apache License Version 2.0,
+# and you may not use this file except in compliance with the Apache License Version 2.0.
+# You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the Apache License Version 2.0 is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
+
+# Author::    Alex Dean (mailto:support@snowplowanalytics.com)
+# Copyright:: Copyright (c) 2012 SnowPlow Analytics Ltd
+# License::   Apache License Version 2.0
+
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sluice'
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alex Dean", "Michael Tibben"]
+  gem.email         = ["support@snowplowanalytics.com"]
+  gem.summary       = %q{Ruby toolkit for cloud-friendly ETL}
+  gem.description   = %q{A Ruby gem to help you build ETL processes involving Amazon S3. Uses Fog}
+  gem.homepage      = "http://snowplowanalytics.com"
+
+  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          = Sluice::NAME
+  gem.version       = Sluice::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.require_paths = ["lib"]
+
+  # Dependencies
+  gem.add_dependency 'fog', '~> 1.6.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: sluice
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alex Dean
+- Michael Tibben
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fog
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :runtime
+  version_requirements: *id001
+description: A Ruby gem to help you build ETL processes involving Amazon S3. Uses Fog
+email: 
+- support@snowplowanalytics.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE-2.0.txt
+- README.md
+- Rakefile
+- lib/sluice.rb
+- lib/sluice/errors.rb
+- lib/sluice/storage/s3.rb
+- lib/sluice/storage/storage.rb
+- sluice.gemspec
+homepage: http://snowplowanalytics.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby toolkit for cloud-friendly ETL
+test_files: []
+