sluice-jason 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef7cdefd76978f74c442905a921edc5bdb7907fa
+  data.tar.gz: c85047b8a7ae99f8300ad43e00f0d8e60bd8b408
+SHA512:
+  metadata.gz: bc198f2d19afb6ace66d00020b2e3e759da2c74e2f097fc366b87f1385988d4773d09218da2e0f554db144f6ae3edf9e29d2d9cf3f3dbecdfacdbeb1c9b30783
+  data.tar.gz: ae3342875377593b4edba1f85d75d19fd387d3e5e5b329a0da5b3aa96a3ad1477f12161e93a44ddafc5d0e227bfee11a1f148d4fe3156b9c95ed80e8573fd8c8

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 1.9.3
+  - jruby
+  - 2.0.0
+  - 2.1.0
+
+script: 'bundle exec rspec spec'

data/CHANGELOG

@@ -0,0 +1,94 @@
+Version 0.2.2 (2015-04-08)
+--------------------------
+Stuck Fog dependency to version 1.24 to prevent AWS Regions issue, thanks @epantera! (#33)
+Now tolerates nil passed to trail_slash (#38)
+Added License button to README (#34)
+Added Vagrant quickstart to README (#36)
+Added dedicated Vagrant setup (#35)
+
+Version 0.2.1 (2014-05-20)
+--------------------------
+Renamed lambda and alter_filename_lambda in rename_file (#27)
+Fixed move_files for use in JRuby (#28)
+
+Version 0.2.0 (2014-05-16)
+--------------------------
+Bumped Contracts to 0.4 (#22)
+Bumped Fog to 1.22.0 (#24)
+Added gem button to README (#18)
+Added Coveralls code coverage to project (#17)
+Added Code Climate button to README (#23)
+Added Travis support to project (#16)
+Added initial unit tests (#15)
+Added in FogFile = Fog::Storage::AWS::File-based contracts (#12)
+Added additional contracts (#20)
+Broke up s3.rb into separate files (#21)
+Updated alter_filename_lambda to accept original filepath as 2nd arg (#19)
+Overrode equality operator for S3::Location to support tests (#10)
+Fixed break bugs in core Sluice process flow (#6)
+Made is_empty? work if another folder starts with the same name as this one (#5)
+
+Version 0.1.5 (2013-10-13)
+--------------------------
+Fixed is_empty? returns true if folder contains 1 file (#9)
+
+Version 0.1.4 (2013-10-02)
+--------------------------
+Timeout now bumped to 30 mins - much less likely to cause issues with large files
+
+Version 0.1.3 (2013-10-02)
+--------------------------
+Added Ruby thread timeout monitoring (#4)
+
+Version 0.1.2 (2013-09-10)
+--------------------------
+Fixed bug in manifest copy code
+
+Version 0.1.1 (2013-09-10)
+--------------------------
+Fixed warning from Fog::Storage::AWS::File alias
+
+Version 0.1.0 (2013-09-09)
+--------------------------
+Added ability to copy using a manifest
+Added thread index to file operation puts
+Added Contracts for some initial contract assertions
+
+Version 0.0.9 (2013-08-14)
+--------------------------
+Added ability to move and copy files between two different AWS accounts
+
+Version 0.0.8 (2013-08-14)
+--------------------------
+Added in ability to process a list of files rather than an S3 location
+
+Version 0.0.7 (2013-07-12)
+--------------------------
+Added in upload capability
+
+Version 0.0.6 (2012-12-31)
+--------------------------
+Fixed is_empty? (was actually is_not_empty?)
+
+Version 0.0.5 (2012-12-30)
+--------------------------
+Added option to flatten recursive paths
+
+Version 0.0.4 (2012-11-09)
+--------------------------
+Fixed nasty bug where the retry code wasn't working
+
+Version 0.0.3 (2012-11-07)
+--------------------------
+Added parallel file download
+Some simplification of existing code
+Fixed a couple of bugs in the file move code (around S3 file keys versus local filepaths)
+
+Version 0.0.2 (2012-11-06)
+--------------------------
+Added trail_slash
+Bug fixing in regexify and files_up_to
+
+Version 0.0.1
+-------------
+Initial release of Sluice

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

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,83 @@
+# Sluice
+[![Gem Version](https://badge.fury.io/rb/sluice.svg)](http://badge.fury.io/rb/sluice)
+[![Build Status](https://travis-ci.org/snowplow/sluice.png)](https://travis-ci.org/snowplow/sluice)
+[![Code Climate](https://codeclimate.com/github/snowplow/sluice.png)](https://codeclimate.com/github/snowplow/sluice)
+[![Coverage Status](https://coveralls.io/repos/snowplow/sluice/badge.png?branch=master)](https://coveralls.io/r/snowplow/sluice?branch=master)
+[![License][license-image]][license]
+
+Sluice is a Ruby gem (built with [Bundler] [bundler]) to help you build cloud-friendly ETL (extract, transform, load) processes.
+
+Currently Sluice provides the following very robust, very parallel S3 operations:
+
+* File upload to S3
+* File download from S3
+* File delete from S3
+* File move within S3 (from/to the same or different AWS accounts)
+* File copy within S3 (from/to the same or different AWS accounts; optionally using a manifest)
+
+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 Redshift and Postgres
+
+## Installation 
+
+    $ gem install sluice
+
+Or in your Gemfile:
+
+    gem 'sluice', '~> 0.2.2'
+
+## Usage
+
+Rubydoc and usage examples to come.
+
+## Developer quickstart
+
+Assuming git, **[Vagrant] [vagrant-install]** and **[VirtualBox] [virtualbox-install]** installed:
+
+```bash
+ host$ git clone https://github.com/snowplow/sluice.git
+ host$ cd sluice
+ host$ vagrant up && vagrant ssh
+guest$ cd /vagrant
+guest$ gem install bundler
+guest$ rspec
+```
+
+## Publishing
+
+```bash
+ host$ vagrant push
+```
+
+## Copyright and license
+
+Sluice is copyright 2012-2015 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/
+
+[license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
+[license]: http://www.apache.org/licenses/LICENSE-2.0
+
+[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-enrich/emr-etl-runner
+[storage-loader]: https://github.com/snowplow/snowplow/tree/master/4-storage/storage-loader
+
+[vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
+[virtualbox-install]: https://www.virtualbox.org/wiki/Downloads
+
+[license]: http://www.apache.org/licenses/LICENSE-2.0

data/Vagrantfile

@@ -0,0 +1,23 @@
+Vagrant.configure("2") do |config|
+
+  config.vm.box = "ubuntu/trusty64"
+  config.vm.hostname = "sluice"
+  config.ssh.forward_agent = true
+
+  config.vm.provider :virtualbox do |vb|
+    vb.name = Dir.pwd().split("/")[-1] + "-" + Time.now.to_f.to_i.to_s
+    vb.customize ["modifyvm", :id, "--natdnshostresolver1", "on"]
+    vb.customize [ "guestproperty", "set", :id, "--timesync-threshold", 10000 ]
+    vb.memory = 2048
+  end
+
+  config.vm.provision :shell do |sh|
+    sh.path = "vagrant/up.bash"
+  end
+
+  # Requires Vagrant 1.7.0+
+  config.push.define "gem", strategy: "local-exec" do |push|
+    push.script = "vagrant/push.bash"
+  end
+
+end

data/lib/sluice/errors.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2012-2014 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-2014 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/contracts.rb

@@ -0,0 +1,32 @@
+# Copyright (c) 2012-2014 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-2014 Snowplow Analytics Ltd
+# License::   Apache License Version 2.0
+
+require 'fog'
+require 'fog/aws/models/storage/file'
+
+require 'contracts'
+include Contracts
+
+module Sluice
+  module Storage
+    module S3
+
+      # Aliases for Contracts
+      FogStorage = Fog::Storage::AWS::Real
+      FogFile = Fog::Storage::AWS::File
+
+    end
+  end
+end

data/lib/sluice/storage/s3/location.rb

@@ -0,0 +1,77 @@
+# Copyright (c) 2012-2014 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-2014 Snowplow Analytics Ltd
+# License::   Apache License Version 2.0
+
+require 'contracts'
+include Contracts
+
+module Sluice
+  module Storage
+    module S3
+
+      # Class to describe an S3 location
+      # TODO: if we are going to require trailing line-breaks on
+      # buckets, maybe we should make that clearer?
+      class Location
+        
+        attr_reader :bucket, :dir
+
+        # Location constructor
+        #
+        # Parameters:
+        # +s3location+:: the s3 location config string e.g. "bucket/directory"
+        Contract String => Location
+        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]
+          self
+        end
+
+        Contract nil => String
+        def dir_as_path
+          if @dir.length > 0
+            return @dir+'/'
+          else
+            return ''
+          end
+        end
+
+        Contract nil => String
+        def to_s
+          @s3_location
+        end
+
+        Contract Any => Bool
+        def ==(o)
+          o.class == self.class && o.state == state
+        end
+        alias_method :eql?, :==
+
+      protected
+
+        Contract nil => [String, String, String]
+        def state
+          [@s3_location, @bucket, @dir]
+        end
+
+      end
+
+    end
+  end
+end