storage 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4d8b072280f92e4e745df2bb3180fd1e8640f75
-  data.tar.gz: 3f88505cdc2bbdcf4af9f727caab88014a226d7a
+  metadata.gz: 184a2c065d267a1a8c69ea2b28cb10029ed87386
+  data.tar.gz: 92487bed7cda01963ec791f9a97be0c7aabf0cf4
 SHA512:
-  metadata.gz: 8045b230b182476fb49ec5491a3a03a36454bb8f268a735b4cd935bd562b0de93b27239d5b62e324bc7b591108282a4a87ce51068f1e01078ea7d98af8eadc85
-  data.tar.gz: a91613e6bcc193464ca5b1f19ec8a820ee08f61419480e9a3cfd99b59081fb51234235863c0e65168b2d14bdc065733c432356eec34d98b3b38a6776c4a494e8
+  metadata.gz: 690d4ab3a737bd1d4d4cdbdefc6837604af4f7776ce9fb76cbd8243e3cec6d3c88fa4b81e621337af72d6fb930eab0cbc783c1385af58f4149e18c2e4935c461
+  data.tar.gz: b0b17efdf1edfa68fb8ed89daf2ddfdcf0d2478d9194c8a5ffe654f9569e95a990d676577fdaa8e265a5f753f801c5f773f97a8a57c6b4b2f5eb4da51c264ea5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    storage (0.3.0)
+    storage (0.3.1)
       fog
       mime-types
 
@@ -130,7 +130,9 @@ GEM
     inflecto (0.0.2)
     ipaddress (0.8.3)
     method_source (0.8.2)
-    mime-types (2.99.1)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
     mini_portile2 (2.0.0)
     multi_json (1.11.2)
     nokogiri (1.6.7.2)

data/README.md

@@ -0,0 +1,76 @@
+# Storage
+
+This gem provides a simple API for multiple storage backends. Supported storages: Amazon S3 and FileSystem (it uses Fog under the hood).
+
+The storage provides only 3 methods, one for each operation: `Storage::get`, `Storage::store` and `Storage::remove`.
+
+## Installation
+
+    gem install storage
+
+You can get source code at http://github.com/fnando/storage
+
+## Usage
+
+```ruby
+require "storage"
+```
+
+You basically use the same method no matter what storage strategy you're using.
+
+### Amazon S3
+
+```ruby
+Storage.setup do |config|
+  config.strategy    = :s3
+  config.access_key  = "abcdef"
+  config.secret_key  = "123456"
+end
+
+# Store a local file on S3.
+# You can easily switch from S3 to FileSystem; 
+# keys that are not used by one strategy is simply ignored.
+Storage.store "some/file.rb", name: "file.rb", bucket: "sample"
+Storage.store File.open("some/file.rb"), name: "file.rb", bucket: "sample", public: true
+
+# Retrieve the public url for that file
+Storage.get "file.rb"
+#=> http://s3.amazon.com/sample-files/file.rb
+
+# Remove a file.
+Storage.remove "file.rb"
+```
+
+### FileSystem
+
+```ruby
+Storage.setup do |config|
+  config.strategy   = :file
+  config.path       = "some/directory"
+end
+
+# Store a file.
+Storage.store "some/file.rb", name: "file.rb"
+Storage.store File.open("some/file.rb"), name: "file.rb"
+
+# Retrieve that file's path.
+Storage.get "file.rb"
+#=> some/directory/file.rb
+
+# Remove a file.
+Storage.remove "file.rb"
+```
+
+## License
+
+(The MIT License)
+
+Copyright © 2010:
+
+* Nando Vieira (http://nandovieira.com)
+
+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/lib/storage/strategies/s3.rb

@@ -6,12 +6,12 @@ module Storage
       MissingBucket = Class.new(StandardError)
 
       def connection
-        @connection ||= Fog::Storage.new({
-          :provider                 => 'AWS',
-          :aws_access_key_id        => Storage::Config.access_key,
-          :aws_secret_access_key    => Storage::Config.secret_key,
-          :region                   => Storage::Config.region
-        })
+        @connection ||= Fog::Storage.new(
+          provider: "AWS",
+          aws_access_key_id: Storage::Config.access_key,
+          aws_secret_access_key: Storage::Config.secret_key,
+          region: Storage::Config.region
+        )
       end
 
       def prepare!
@@ -33,7 +33,7 @@ module Storage
 
       def store(file, options = {})
         object = find_object(file, options) rescue nil
-        raise FileAlreadyExistsError if object
+        fail FileAlreadyExistsError if object
 
         bucket = find_bucket_or_create(options.fetch(:bucket))
         file = File.open(file, "rb") unless file.respond_to?(:read) && !file.kind_of?(Pathname)
@@ -51,28 +51,28 @@ module Storage
       end
 
       def find_bucket!(name)
-        find_bucket(name) || raise(MissingBucket)
+        find_bucket(name) || fail(MissingBucket)
       end
 
       def create_bucket(name)
         connection.directories.create(
-          :key    => name,
-          :public => false
+          key: name,
+          public: false
         )
       end
 
       def create_object(bucket, file, options)
-        bucket.files.create({
-          :key => options.fetch(:name),
-          :body => file,
-          :public => (options[:public] || options[:access] != :public_read)
-        })
+        bucket.files.create(
+          key: options.fetch(:name),
+          body: file,
+          public: (options[:public] || options[:access] == :public_read)
+        )
       end
 
       def find_object(file, options = {})
         path = options.fetch(:name, file)
         bucket = find_bucket!(options.fetch(:bucket))
-        bucket.files.get(path) || raise(MissingFileError)
+        bucket.files.get(path) || fail(MissingFileError)
       rescue MissingBucket
         raise MissingFileError
       end

data/lib/storage/version.rb

@@ -2,7 +2,7 @@ module Storage
   module Version
     MAJOR = 0
     MINOR = 3
-    PATCH = 0
+    PATCH = 1
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/storage/strategies/s3_spec.rb

@@ -22,14 +22,14 @@ describe Storage::Strategies::S3 do
   end
 
   context "general" do
-    before do
-      @adapter = Storage::Strategies::S3
-      @source = RESOURCES.join("file.txt")
-      @destiny = TMP.join("lorem.txt")
-      @connection = double("connection")
-      @bucket = double("bucket")
+    let(:adapter) { Storage::Strategies::S3 }
+    let(:source) { RESOURCES.join("file.txt") }
+    let(:destiny) { TMP.join("lorem.txt") }
+    let(:connection) { double("connection") }
+    let(:bucket) { double("bucket") }
 
-      allow(@adapter).to receive(:connection).and_return(@connection)
+    before do
+      allow(adapter).to receive(:connection).and_return(connection)
 
       Storage.setup do |c|
         c.strategy = :s3
@@ -40,95 +40,141 @@ describe Storage::Strategies::S3 do
     end
 
     it "should save a file using file handler" do
-      handler = File.open(@source)
+      handler = File.open(source)
 
-      expect(@connection).to receive_message_chain('directories.get').with('files').and_return(@bucket)
-      expect(@adapter).to receive_message_chain('find_object').and_return(nil)
-      expect(@bucket).to receive_message_chain('files.create').with(:key => 'lorem.txt', :body => handler, :public => true)
+      setup_expectations
 
-      Storage.store(handler, :name => "lorem.txt", :bucket => "files")
+      Storage.store(handler, name: "lorem.txt", bucket: "files")
     end
 
     it "should save a file using a path" do
-      expect(@connection).to receive_message_chain('directories.get').with('files').and_return(@bucket)
-      expect(@adapter).to receive_message_chain('find_object').and_return(nil)
-      expect(@bucket).to receive_message_chain('files.create').with(:key => 'lorem.txt', :body => kind_of(File), :public => true)
+      setup_expectations
 
-      Storage.store(@source, :name => "lorem.txt", :bucket => "files")
+      Storage.store(source, name: "lorem.txt", bucket: "files")
     end
 
     it "should remove an existing file" do
       object = double("object")
-      expect(@connection).to receive_message_chain('directories.get').with('files').and_return(@bucket)
-      expect(@bucket).to receive_message_chain('files.get').with('lorem.txt').and_return(object)
+
+      setup_bucket(bucket)
+      setup_object(object)
       expect(object).to receive(:destroy).and_return(true)
 
-      expect(Storage.remove("lorem.txt", :bucket => "files")).to be_truthy
+      expect(Storage.remove("lorem.txt", bucket: "files")).to be_truthy
     end
 
-    it "should raise when trying to removing an unexesting file" do
-      expect(@connection).to receive_message_chain('directories.get').with('files').and_return(@bucket)
-      expect(@bucket).to receive_message_chain('files.get').with('lorem.txt').and_return(nil)
+    it "should raise when trying to removing an nonexisting file" do
+      setup_bucket(bucket)
+      setup_get(nil)
 
       expect {
-        Storage.remove("lorem.txt", :bucket => "files")
+        Storage.remove("lorem.txt", bucket: "files")
       }.to raise_error(Storage::MissingFileError)
     end
 
     it "should retrieve an existing file (public url)" do
-      object = double("object", public_url: 'PUBLIC_URL')
-      expect(@connection).to receive_message_chain('directories.get').with('files').and_return(@bucket)
-      expect(@bucket).to receive_message_chain('files.get').with('lorem.txt').and_return(object)
+      object = double("object", public_url: "PUBLIC_URL")
+
+      setup_bucket(bucket)
+      setup_object(object)
 
-      expect(Storage.get("lorem.txt", :bucket => "files")).to eq('PUBLIC_URL')
+      expect(Storage.get("lorem.txt", bucket: "files")).to eq("PUBLIC_URL")
     end
 
     it "should retrieve an existing file (private url)" do
       object = double("object", public_url: nil)
 
-      expect(object).to receive_message_chain('url').with(Time.now.to_i + 3600).and_return('PRIVATE_URL')
-      expect(@connection).to receive_message_chain('directories.get').with('files').and_return(@bucket)
-      expect(@bucket).to receive_message_chain('files.get').with('lorem.txt').and_return(object)
+      expect(object).to receive_message_chain("url").with(Time.now.to_i + 3600).and_return("PRIVATE_URL")
+      setup_bucket(bucket)
+      setup_object(object)
 
-      expect(Storage.get("lorem.txt", :bucket => "files")).to eq('PRIVATE_URL')
+      expect(Storage.get("lorem.txt", :bucket => "files")).to eq("PRIVATE_URL")
     end
 
     it "should raise when trying to retrieve an missing file" do
-      expect(@connection).to receive_message_chain('directories.get').with('files').and_return(@bucket)
-      expect(@bucket).to receive_message_chain('files.get').with('lorem.txt').and_return(nil)
+      setup_bucket(bucket)
+      setup_get(nil)
 
       expect {
-        Storage.get("lorem.txt", :bucket => "files")
+        Storage.get("lorem.txt", bucket: "files")
       }.to raise_error(Storage::MissingFileError)
     end
 
     it "should raise when trying to retrieve an missing bucket" do
-      expect(@connection).to receive_message_chain('directories.get').with('files').and_return(nil)
+      setup_bucket(nil)
 
       expect {
-        Storage.get("lorem.txt", :bucket => "files")
+        Storage.get("lorem.txt", bucket: "files")
       }.to raise_error(Storage::MissingFileError)
     end
 
     it "should create a bucket and trying to store a file on a missing bucket" do
-      expect(@adapter).to receive_message_chain('find_object').and_return(nil)
-      allow(@connection).to receive_message_chain('directories.get').and_return(nil)
-      expect(@connection).to receive_message_chain('directories.create').with(key: 'files', public: false).and_return(@bucket)
+      setup_object
+      setup_bucket(nil)
 
-      @bucket.as_null_object
+      expect(connection).to receive_message_chain("directories.create").with(key: "files", public: false).and_return(bucket)
 
-      Storage.store(@source, :name => 'lorem.txt', :bucket => "files")
+      bucket.as_null_object
+
+      Storage.store(source, name: "lorem.txt", bucket: "files")
     end
 
     it "should raise when saving a file that already exists" do
       object = double("object")
 
-      expect(@connection).to receive_message_chain('directories.get').with('files').and_return(@bucket)
-      expect(@bucket).to receive_message_chain('files.get').with('lorem.txt').and_return(object)
+      setup_bucket(bucket)
+      setup_get(object)
 
       expect {
-        Storage.store(@source, :name => 'lorem.txt', :bucket => 'files')
+        Storage.store(source, name: "lorem.txt", bucket: "files")
       }.to raise_error(Storage::FileAlreadyExistsError)
     end
+
+    it "should set file permission to public" do
+      setup_expectations public_access: true
+      Storage.store(source, name: "lorem.txt", bucket: "files", public: true)
+    end
+
+    it "should set file permission to private (default)" do
+      setup_expectations public_access: false
+      Storage.store(source, name: "lorem.txt", bucket: "files")
+    end
+
+    it "should set file permission to private" do
+      setup_expectations public_access: false
+      Storage.store(source, name: "lorem.txt", bucket: "files", public: false)
+    end
+
+    it "should set file permission to private (access option)" do
+      setup_expectations public_access: false
+      Storage.store(source, name: "lorem.txt", bucket: "files", access: :private)
+    end
+
+    it "should set file permission to public (access option)" do
+      setup_expectations public_access: true
+      Storage.store(source, name: "lorem.txt", bucket: "files", access: :public_read)
+    end
+
+    def setup_bucket(bucket)
+      allow(connection).to receive_message_chain("directories.get").with("files").and_return(bucket)
+    end
+
+    def setup_object(object = nil)
+      expect(adapter).to receive_message_chain("find_object").and_return(object)
+    end
+
+    def setup_create(public_access)
+      expect(bucket).to receive_message_chain("files.create").with(key: "lorem.txt", body: kind_of(File), public: public_access)
+    end
+
+    def setup_get(object)
+      expect(bucket).to receive_message_chain("files.get").with("lorem.txt").and_return(object)
+    end
+
+    def setup_expectations(the_bucket: bucket, object: nil, public_access: false)
+      setup_bucket(the_bucket)
+      setup_object(object)
+      setup_create(public_access)
+    end
   end
 end

data/storage.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_dependency "fog"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storage
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -78,7 +78,7 @@ files:
 - ".rspec"
 - Gemfile
 - Gemfile.lock
-- README.rdoc
+- README.md
 - Rakefile
 - lib/storage.rb
 - lib/storage/config.rb

data/README.rdoc

@@ -1,71 +0,0 @@
-= Storage
-
-This gem provides a simple API for multiple storage backends. Supported storages: Amazon S3 and FileSystem.
-
-The storage provides only 3 methods, one for each operation: <tt>Storage::get</tt>, <tt>Storage::store</tt> and <tt>Storage::remove</tt>.
-
-== Installation
-
-  sudo gem install storage
-
-You can get source code at http://github.com/fnando/storage
-
-== Usage
-
-  require "rubygems"
-  require "storage"
-
-You basically use the same method no matter what storage strategy you're using.
-
-=== Amazon S3
-
-  Storage.setup do |config|
-    config.strategy    = :s3
-    config.access_key  = "abcdef"
-    config.secret_key  = "123456"
-  end
-
-  # Store a local file on S3.
-  # You can easily switch from S3 to FileSystem; keys that are not used by one strategy is
-  # simply ignored.
-  Storage.store "some/file.rb", :name => "file.rb", :bucket => "sample"
-  Storage.store File.open("some/file.rb"), :name => "file.rb", :bucket => "sample"
-
-  # Retrieve the public url for that file
-  Storage.get "file.rb"
-  #=> http://s3.amazon.com/sample-files/file.rb
-
-  # Remove a file.
-  Storage.remove "file.rb"
-
-=== FileSystem
-
-  Storage.setup do |config|
-    config.strategy   = :file
-    config.path       = "some/directory"
-  end
-
-  # Store a file.
-  Storage.store "some/file.rb", :name => "file.rb"
-  Storage.store File.open("some/file.rb"), :name => "file.rb"
-
-  # Retrieve that file's path.
-  Storage.get "file.rb"
-  #=> some/directory/file.rb
-
-  # Remove a file.
-  Storage.remove "file.rb"
-
-== License
-
-(The MIT License)
-
-Copyright © 2010:
-
-* Nando Vieira (http://simplesideias.com.br)
-
-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.