easy-s3 0.1.0 → 0.2.0

data/.gitignore

@@ -1,3 +1,4 @@
+.coveralls.yml
 .idea/
 vendor/
 *.gem

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 0.2.0 (03/10/2013)
+
+### Enhancements
+* Added hash options into methods
+
+## 0.1.0 (29/09/2013)
+
+* Initial release
+ 
+

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in easy-s3.gemspec
-gemspec
+gemspec
+
+gem 'coveralls', require: false

data/README.md

@@ -2,6 +2,10 @@
 
 Easy use Amazon S3
 
+[![Build Status](https://travis-ci.org/mgrachev/easy-s3.png?branch=master)](https://travis-ci.org/mgrachev/easy-s3)
+[![Coverage Status](https://coveralls.io/repos/mgrachev/easy-s3/badge.png?branch=master)](https://coveralls.io/r/mgrachev/easy-s3?branch=master)
+[![Dependency Status](https://gemnasium.com/mgrachev/easy-s3.png)](https://gemnasium.com/mgrachev/easy-s3)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,21 +22,15 @@ Or install it yourself as:
 
 ## Usage
 
-First, set the credentials for Fog:
-
-    Fog.credentials = {
-      aws_access_key_id: 'XXX',
-      aws_secret_access_key: 'XXXX'
-    }
-
 Create instance of EasyS3:
 
-    s3 = EasyS3.new('my-bucket')
+    s3 = EasyS3.new('my-bucket', access_key_id: 'XXX', secret_access_key: 'XXXX')
     
 Create private or public file:
 
     file_url = s3.create_file(path_to_file) # private
-    file_url = s3.create_file(path_to_file, true) # public
+    file_url = s3.create_file(path_to_file, public: true) # public
+    file_url = s3.create_file(path_to_file, digest: true) # with digest
     
 Delete file by url:
 

data/lib/easy-s3/version.rb

@@ -1,3 +1,3 @@
 class EasyS3
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/easy-s3.rb

@@ -8,13 +8,20 @@ class EasyS3
 
   attr_reader :fog, :dir
 
-  def initialize(dir_name)
+  def initialize(dir_name, options={})
+    options[:access_key_id]     ||= Fog.credentials[:aws_access_key_id]
+    options[:secret_access_key] ||= Fog.credentials[:aws_secret_access_key]
+
+    Fog.credentials = {
+        aws_access_key_id:      options[:access_key_id],
+        aws_secret_access_key:  options[:secret_access_key]
+    }
+
     begin
-      #Fog.credentials = { aws_access_key_id: 'XXX', aws_secret_access_key: 'XXXX' }
       @fog = Fog::Storage.new(provider: 'AWS')
       @dir = @fog.directories.get(dir_name)
     rescue ArgumentError
-      raise MissingOptions, 'aws_access_key_id or aws_secret_access_key'
+      raise MissingOptions, 'access_key_id or secret_access_key'
     rescue Excon::Errors::MovedPermanently, 'Expected(200) <=> Actual(301 Moved Permanently)'
       raise DirectoryDoesNotExist, dir_name
     end
@@ -24,20 +31,27 @@ class EasyS3
   end
 
   # Create private or public file into directory
-  def create_file(file_path, public = false)
+  def create_file(file_path, options={})
+    options[:digest] ||= false
+    options[:public] ||= false
+
     begin
       file = File.open(file_path)
     rescue
-      raise(FileNotFound, file_path)
+      raise FileNotFound, file_path
     end
 
-    filename = "#{File.basename(file_path)}_#{Digest::SHA1.hexdigest(File.basename(file_path))}"
+    filename = "#{File.basename(file_path)}"
+    filename += "_#{Digest::SHA1.hexdigest(File.basename(file_path))}" if options[:digest]
 
     file = @dir.files.create(
         key:    filename,
         body:   file,
-        public: public
+        public: options[:public]
     )
+
+    return file.public_url if options[:public] && file.public_url
+
     file.url((Time.now + 3600).to_i) # 1 hour
   end
 

data/spec/easy-s3_spec.rb

@@ -22,12 +22,15 @@ describe EasyS3 do
       expect{ EasyS3.new }.to raise_error(ArgumentError, 'wrong number of arguments (0 for 1)')
     end
 
-    it 'should raise exception if missing options aws_access_key_id or aws_secret_access_key' do
-      fog_credentials = Fog.credentials
+    it 'should accept options hash as the second argument' do
       Fog.credentials = {}
+      EasyS3.new(bucket_name, access_key_id: 'XXX', secret_access_key: 'XXXX').should be_an_instance_of EasyS3
+    end
 
-      expect{ s3 }.to raise_error(EasyS3::MissingOptions, 'aws_access_key_id or aws_secret_access_key')
-
+    it 'should raise exception if missing options access_key_id or secret_access_key' do
+      fog_credentials = Fog.credentials
+      Fog.credentials = {}
+      expect{ s3 }.to raise_error(EasyS3::MissingOptions, 'access_key_id or secret_access_key')
       Fog.credentials = fog_credentials
     end
 
@@ -35,7 +38,7 @@ describe EasyS3 do
       expect{ EasyS3.new(bucket_not_exist_name) }.to raise_error(EasyS3::DirectoryDoesNotExist, bucket_not_exist_name)
     end
 
-    it 'should return true and instance of Mercury::S3' do
+    it 'should return true and instance of EasyS3' do
       s3.should be_an_instance_of EasyS3
     end
   end
@@ -45,17 +48,28 @@ describe EasyS3 do
       expect{ s3.create_file(file_not_exist_path) }.to raise_error(EasyS3::FileNotFound, file_not_exist_path)
     end
 
-    it 'should return url of file' do
+    it 'should create file with digest' do
+      url = s3.create_file(file_path, digest: true, public: true)
+      url.should == "https://#{bucket_name}.s3.amazonaws.com/#{File.basename(file_path)}_#{Digest::SHA1.hexdigest(File.basename(file_path))}"
+    end
+
+    it 'should create a public file' do
+      url = s3.create_file(file_path, public: true)
+      url.should be_an_instance_of String
+      url.should_not match /#{bucket_name}.+amazonaws.com.+AWSAccessKeyId=#{Fog.credentials[:aws_access_key_id]}/
+    end
+
+    it 'should create a private file' do
       url = s3.create_file(file_path)
       url.should be_an_instance_of String
-      url.should match /#{bucket_name}.+amazonaws.com/
+      url.should match /#{bucket_name}.+amazonaws.com.+AWSAccessKeyId=#{Fog.credentials[:aws_access_key_id]}/
     end
   end
 
   context '#get_file_name_by_url' do
     it 'should return name of file by url' do
       url = s3.create_file(file_path)
-      s3.send(:get_filename_by_url, url).should eq "#{File.basename(file_path)}_#{Digest::SHA1.hexdigest(File.basename(file_path))}"
+      s3.send(:get_filename_by_url, url).should eq "#{File.basename(file_path)}"
     end
   end
 

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy-s3
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
+date: 2013-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -84,6 +84,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4383353905125523505
+      hash: 2331300128522359285
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -118,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4383353905125523505
+      hash: 2331300128522359285
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23