s3gzip 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f96eceb22fcda8291c2ee384e276f511569ef939
+  data.tar.gz: 12a52d1a7761e41cb3152d2f3b6fc2e99800db97
+SHA512:
+  metadata.gz: 2ae8d1fc3a880b8190bb76517d359adcec9fa4974ddffac3bcda7aa865b7dafe557116849236da843a1863c4c9874b2b6367e4bba54c73053ea03316514f79de
+  data.tar.gz: a187ac97a02ccdc6ee9e3853e43eefa27b5b4b551518590a1cfe98d7cab661b7b141e3fd9687012f4ec88296c62132b21bf19127f1492005f332d3e5c4386473

data/LICENSE

@@ -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 @@
+s3gzip
+======
+
+Read and write gziped content in S3 without hitting disk.
+
+## Example
+
+```ruby
+require 's3gzip'
+
+id='S3_ACCESS_KEY_ID'
+secret='S3_SECRET_ACCESS_KEY'
+
+bucket='MY_BUCKET'
+filename='a/folder/with/filename.gz'
+
+S3Gzip::Writer.open(id, secret, bucket, filename) do |writer|
+  writer.write 'some content, gzipped, then stored in s3.'
+end
+
+result = S3Gzip::Reader.read(id, secret, bucket, filename)
+
+puts result
+# Output:
+# some content, gzipped, then stored in s3.
+```
+
+### Methods
+
+You can use `S3Gzip::Writer` in a variety of ways from a one-liner to many-liner. These three examples do the same thing:
+
+```
+require 's3gzip'
+
+id = 'S3_ACCESS_KEY_ID'
+secret = 'S3_SECRET_ACCESS_KEY'
+
+bucket = 'MY_BUCKET'
+filename = 'a/folder/with/filename.gz'
+content = 'some content, gzipped, then stored in s3.'
+
+writer = S3Gzip::Writer.new(id, secret, bucket, filename)
+writer.write content
+writer.close_and_send
+
+S3Gzip::Writer.open(id, secret, bucket, filename) do |writer|
+  writer.write content
+end
+
+S3Gzip::Writer.write(id, secret, bucket, filename, content)
+``` 
+
+When using the first method, `close_and_send` must be called. This is done automatically when using `open` or `write` class methods. 
+
+Also, please note that every time you write to the file on S3, it will overwrite the previous value. This is generally true with S3, but can be a bit confusing given S3's eventual consistency model. Read more about that in the [AWS S3 FAQ](http://aws.amazon.com/s3/faqs/).
+
+
+## Requirements/Dependencies
+
+* [aws-s3](https://github.com/marcel/aws-s3) (0.6.3ish)
+
+## Copyright
+
+Copyright © 2014 Troy Howard. See LICENSE for details.

data/lib/s3gzip/reader.rb

@@ -0,0 +1,14 @@
+require 'zlib'
+require 'aws/s3'
+
+module S3Gzip
+  class Reader
+    def self.read(access_key_id, secret_access_key, bucket, filename)
+      AWS::S3::Base.establish_connection!(
+        :access_key_id     => access_key_id,
+        :secret_access_key => secret_access_key
+      )
+      Zlib::GzipReader.new(StringIO.new(AWS::S3::S3Object.value(filename, bucket))).read
+    end
+  end
+end

data/lib/s3gzip/version.rb

@@ -0,0 +1,3 @@
+module S3Gzip
+  Version = '1.0.0'.freeze
+end

data/lib/s3gzip/writer.rb

@@ -0,0 +1,54 @@
+require 'zlib'
+require 'aws/s3'
+
+module S3Gzip
+  class Writer
+    attr_reader :bucket
+    attr_reader :filename
+
+    def initialize(access_key_id, secret_access_key, bucket, filename)
+
+      @access_key_id = access_key_id
+      @secret_access_key = secret_access_key
+      @bucket = bucket
+      @filename = filename
+
+      AWS::S3::Base.establish_connection!(
+        :access_key_id     => @access_key_id,
+        :secret_access_key => @secret_access_key
+      )
+
+      @io = StringIO.new()
+      @gzip_writer = Zlib::GzipWriter.new(@io)
+    end
+
+    def closed?
+      not @gzip_writer.nil? and @gzip_writer.closed?
+    end
+
+    def write(*args)
+      @gzip_writer.write(*args)
+    end
+
+    def close_and_send
+      unless self.closed?
+        @gzip_writer.close
+        AWS::S3::S3Object.store(@filename, @io.string, @bucket)
+      end
+    end
+
+    def self.open(*args)
+      writer = new(*args)
+      return writer unless block_given?
+      yield writer
+    ensure
+      writer.close_and_send if block_given?
+    end
+
+    def self.write(access_key_id, secret_access_key, bucket, filename, value)
+      writer = new(access_key_id, secret_access_key, bucket, filename)
+      writer.write(value)
+      writer.close_and_send
+    end
+  end
+end

data/lib/s3gzip.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 's3gzip/writer'
+require 's3gzip/reader'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: s3gzip
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Troy Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: ''
+email: thoward37@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/s3gzip/reader.rb
+- lib/s3gzip/version.rb
+- lib/s3gzip/writer.rb
+- lib/s3gzip.rb
+homepage: http://github.com/thoward/s3gzip
+licenses:
+- Apache 2.0
+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.1.10
+signing_key: 
+specification_version: 3
+summary: Read and write gziped content in S3 without hitting disk.
+test_files: []