s3mpi 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 750b7484b10dac34808cb7c1cb1c1f2bdfd7eeb0
+  data.tar.gz: e63652c05a474322356d2587ad62dff51f030d25
+SHA512:
+  metadata.gz: ce652479bba4088e04d61aa1565c8f03db7db7839b4525520a34efc36e199a4dd7d32c475e86a354c065bb46b1fba8818ee38f1441f5f30099afa759a958c1b3
+  data.tar.gz: adf00002f3bb1e21a1ec052603fc8f44044b530e4f9e935f8bac9ece01138b22bf58d78fde509acf652e75a926df3ebb6b67f1f9affd57197d52cffbd6363728

data/.gitignore

@@ -0,0 +1,8 @@
+*~
+pkg/*
+doc/*
+Gemfile.lock
+*.gem
+bin
+docs/_build
+coverage

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+# env: CODECLIMATE_REPO_TOKEN=540a9a9dd5d7371276ffd320c85d936726dd362b6b2c0333017c13ff5e133a7d 

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Dependencies in s3mpi.gemspec
+gemspec development_group: :test
+

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2010-2014 Andrew Benton.
+
+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,7 @@
+S3MPI 
+=========
+
+Upload and download files to S3 using a very convenient API.
+
+[![Build Status](https://travis-ci.org/robertzk/s3mpi.svg?branch=master)](https://travis-ci.org/robertzk/s3mpi)
+[![Code Climate](https://codeclimate.com/github/robertzk/s3mpi.png)](https://codeclimate.com/github/robertzk/s3mpi)

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: [:spec]
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../lib/github_api')
+  ARGV.clear
+  IRB.start
+end
+

data/lib/s3mpi/format.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+module S3MPI
+  module Format
+
+    def parse_json_allowing_quirks_mode obj
+      JSON.parse(obj || 'null')
+    rescue JSON::ParserError => e
+      JSON.parse(obj || 'null', quirks_mode: true)
+    end
+
+  end
+end
+

data/lib/s3mpi/interface.rb

@@ -0,0 +1,67 @@
+require 'json'
+require 's3mpi/format'
+require 's3mpi/s3'
+
+module S3MPI
+  class Interface
+    include Format
+    include S3
+
+    # Return S3 bucket under use.
+    #
+    # @return [AWS::S3::Bucket]
+    attr_reader :bucket
+
+    # Return S3 path under use.
+    #
+    # @return [String]
+    attr_reader :path
+    
+    # Create a new S3MPI object that responds to #read and #store.
+    #
+    # @return [S3MPI::Interface]
+    #
+    # @api public
+    def initialize bucket, path = ''
+      @bucket = parse_bucket bucket
+      @path   = path 
+    end
+
+    # Store a Ruby object in an S3 bucket.
+    # 
+    # @param [Object] obj
+    #    Any JSON-serializable Ruby object (usually a hash or array).
+    # @param [String] key
+    #    The key under which to save the object in the S3 bucket.
+    # @param [Integer] try
+    #    The number of times to attempt to store the object.
+    def store(obj, key = SecureRandom.uuid, try = 1)
+      s3_object(key).write(obj.to_json)
+    rescue 
+      (try -= 1) > 0 ? retry : raise
+    end
+
+    # Read a JSON-serialized Ruby object from an S3 bucket.
+    # 
+    # @param [String] key
+    #    The key under which to save the object in the S3 bucket.
+    def read key = nil
+      parse_json_allowing_quirks_mode s3_object(key).read
+    rescue AWS::S3::Errors::NoSuchKey
+      nil
+    end
+
+    # Check whether a key exists for this MPI interface.
+    # 
+    # @param [String] key
+    #    The key under which to save the object in the S3 bucket.
+    #    
+    # @return [TrueClass,FalseClass]
+    def exists?(key)
+      s3_object(key).exists?
+    end
+
+  end
+end
+
+    

data/lib/s3mpi/s3.rb

@@ -0,0 +1,15 @@
+require 'aws-sdk'
+
+module S3MPI
+  module S3
+
+    def parse_bucket(bucket) 
+      AWS::S3.new.buckets[bucket]
+    end
+
+    def s3_object name
+      bucket.objects[[path, name].join('/')]
+    end
+
+  end
+end

data/lib/s3mpi/version.rb

@@ -0,0 +1,10 @@
+module S3MPI
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 2
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');
+  end
+end

data/lib/s3mpi.rb

@@ -0,0 +1,6 @@
+require 's3mpi/version'
+require 's3mpi/interface'
+
+module S3MPI
+
+end

data/s3mpi.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+require './lib/s3mpi/version'
+
+Gem::Specification.new do |s|
+  s.name        = 's3mpi'
+  s.version     = S3MPI::VERSION::STRING.dup
+  s.date        = Date.today.to_s
+  s.summary     = 'Upload and download files to S3 using a very convenient API.'
+  s.description = %(Passing objects between Ruby consoles can be cumbersome if the
+                    user has performed some serialization and deserialization procedure.
+                    S3MPI aims to enable simple reading and writing to S3 buckets
+                    without the typical overhead of the AWS gem.
+  ).strip.gsub(/\s+/, " ")
+  s.authors     = ["Robert Krzyzanowski"]
+  s.email       = 'rkrzyzanowski@gmail.com'
+  s.homepage    = 'http://github.com/robertzk'
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/robertzk/s3mpi-ruby'
+
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = %w[lib]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_dependency 'aws-sdk', '~> 1.3.4'
+
+  s.add_development_dependency 'rake', '~> 10.1.0'
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+end
+

data/spec/s3mpi/s3_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module S3MPI
+
+  describe Format do
+    let(:format_mixin) {
+      klass = Class.new
+      klass.send :include, Format
+      klass.new
+    }
+
+    it 'expects #parse_json_allowing_quirks_mode to parse JSON' do
+      obj = {"a" => 1, "b" => "test"}
+      expect(format_mixin.parse_json_allowing_quirks_mode(obj.to_json)).to eql(obj)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require 's3mpi'
+
+Dir["#{File.dirname(__FILE__)}/{support,shared}/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # Nothing yet...
+end
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: s3mpi
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Robert Krzyzanowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Passing objects between Ruby consoles can be cumbersome if the user has
+  performed some serialization and deserialization procedure. S3MPI aims to enable
+  simple reading and writing to S3 buckets without the typical overhead of the AWS
+  gem.
+email: rkrzyzanowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/s3mpi.rb
+- lib/s3mpi/format.rb
+- lib/s3mpi/interface.rb
+- lib/s3mpi/s3.rb
+- lib/s3mpi/version.rb
+- s3mpi.gemspec
+- spec/s3mpi/s3_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/robertzk/s3mpi-ruby
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Upload and download files to S3 using a very convenient API.
+test_files:
+- spec/s3mpi/s3_spec.rb
+- spec/spec_helper.rb