breadbox 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fc8f406d6187e2707ac993a2fd6d5d4e7ad8d56
-  data.tar.gz: 6c05dbdaa8a962b0489350230aa445765913e188
+  metadata.gz: 71100c6034b020a30b7b13ef4250414818b1c418
+  data.tar.gz: 5522044456bb64a338d570764d9fea66e815be9e
 SHA512:
-  metadata.gz: 1104d3d4ea17ccba451682038a59041c9e566960733f52cfae89c41e252250f6019f56fb836aabb7fca7bcb0508c17b227d619c5d1a8fe499290afc3f1cc9232
-  data.tar.gz: 9b64da8f50ac9cb7d6bede77baec4dc1d9000ffe26efd9c018694968ea9ce115a1129a266fabfa56eae59ef54945bd867d3103bf5e8e0f9a62e4c3bdf73e8b03
+  metadata.gz: 2893bba8f89e811d70e8f30238cb553fe7045103e4ef009442fe3c40f378cc0da65cb3e13af51e0868cdc7652816444447d03d070288007087bf034256681fe1
+  data.tar.gz: 7d12ced6291f3ff5a68885a6f59b673b7dcab12edfcf14b6c3a0c95f63074a34e4edf3b3ae7f740180b5b39f376fdd734b68c95d6a5250e91736278b95b22808

data/README.md

@@ -1,6 +1,8 @@
+[![Code Climate](https://codeclimate.com/github/ovenbits/breadbox/badges/gpa.svg)](https://codeclimate.com/github/ovenbits/breadbox)
+
 # Breadbox
 
-A simple wrapper interface for the [DropBox SDK gem](https://github.com/dropbox/dropbox-sdk-ruby).
+A simple wrapper interface for uploading files to Dropbox or Amazon S3
 
 ## Disclaimer
 
@@ -21,7 +23,7 @@ Or install it yourself as:
 
     $ gem install breadbox
 
----
+
 ## Setup for Dropbox
 
 ### 1. Get a [Dropbox Access Token](https://www.dropbox.com/developers/blog/94/generate-an-access-token-for-your-own-account)
@@ -36,7 +38,7 @@ Breadbox.configure do |config|
 end
 ```
 
---
+
 ## Setup for S3
 
 ### 1. Get your [AWS Credentials](http://infinitewp.com/knowledge-base/where-are-my-amazon-s3-credentials/)
@@ -54,7 +56,7 @@ Breadbox.configure do |config|
 end
 ```
 
-### (Optional) Configure your root directory for uploading files
+## (Optional) Configure your root directory for uploading files
 
 > By default - the root path will be the root directory of your [DropBox folder or S3 Bucket].
 You can, however, change the root path to be anything you want.
@@ -79,8 +81,7 @@ end
   to your `root_path`, which if you didn't configure in your initializer, will be your root Dropbox
   folder `/`.
 - `file`: The file object that you are uploading, ex: `file = File.open('./path-to-local-file').
-- `cleanup`: defaults to `false`, but if you pass `true` - it will remove the local file after uploading
-  to DropBox
+- `cleanup`: defaults to `false`, but if you pass `true` - it will remove the local file after uploading.
 
 ```ruby
 # to upload a file to [Dropbox Folder or S3 Bucket]/uploads/my-cool-file.jpg

data/lib/breadbox.rb

@@ -13,7 +13,10 @@ module Breadbox
     attr_writer :configuration
   end
 
-  def self.cleanup(file: nil, cleanup: true)
+  def self.cleanup(options = {})
+    file    = options[:file]
+    cleanup = options[:cleanup]
+
     if cleanup && File.exists?(file)
       File.delete(file)
     end
@@ -36,10 +39,10 @@ module Breadbox
     @configuration = Configuration.new
   end
 
-  def self.upload(path: nil, file: nil, cleanup: false)
-    if client.upload(path: path, file: file)
-      cleanup(file: file, cleanup: cleanup)
-      true
+  def self.upload(options = {})
+    if result = client.upload(options)
+      cleanup(options)
+      result
     end
   end
 end

data/lib/breadbox/dropbox_client.rb

@@ -7,9 +7,20 @@ module Breadbox
       configuration.dropbox_access_token
     end
 
-    def upload(path: nil, file: nil)
-      filepath = filepath_from_paths_and_file(root_path, path, file)
-      client.put_file(filepath, file)
+    def upload(options = {})
+      path      = options[:path]
+      file      = options[:file]
+      overwrite = options[:overwrite] || false
+      share     = options[:share]
+      filepath  = filepath_from_paths_and_file(root_path, path, file)
+      result    = client.put_file(filepath, file, overwrite)
+
+      if share && result
+        share_hash = client.shares(result["path"])
+        share_hash["url"]
+      elsif result
+        result["path"]
+      end
     end
 
     protected

data/lib/breadbox/s3_client.rb

@@ -11,9 +11,16 @@ module Breadbox
       @bucket ||= AWS::S3.new.buckets[bucket]
     end
 
-    def upload(path: nil, file: nil)
+    def upload(options = {})
+      path     = options[:path]
+      file     = options[:file]
+      acl      = options[:public] ? :public_read : nil
       filepath = filepath_from_paths_and_file(root_path, path, file)[1..-1]
-      s3_bucket_object.objects[filepath].write(file)
+      result   = s3_bucket_object.objects[filepath].write(file, acl: acl)
+
+      if result
+        result.public_url.to_s
+      end
     end
 
     protected

data/lib/breadbox/version.rb

@@ -1,3 +1,3 @@
 module Breadbox
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/breadbox/dropbox_client_spec.rb

@@ -58,7 +58,8 @@ module Breadbox
         client         = DropboxClient.new(configuration)
         dropbox_client = instance_double(::DropboxClient)
         allow(client).to receive(:client).and_return(dropbox_client)
-        expect(dropbox_client).to receive(:put_file).with("/new-file.jpg", file)
+        expect(dropbox_client).to receive(:put_file)
+                                  .with("/new-file.jpg", file, false)
 
         client.upload(path: "/", file: file)
       end

data/spec/breadbox/s3_client_spec.rb

@@ -77,9 +77,11 @@ module Breadbox
       let(:client) { S3Client.new(configuration) }
 
       it "writes a file to an S3 Bucket Object" do
-        file = File.open("./tmp/new-file.jpg")
-        expect_any_instance_of(AWS::S3::S3Object).to receive(:write).with(file)
-        client.upload(path: "/", file: file)
+        file    = File.open("./tmp/new-file.jpg")
+        options = { acl: :public_read }
+        expect_any_instance_of(AWS::S3::S3Object).to receive(:write)
+                                                     .with(file, options)
+        client.upload(path: "/", file: file, public: true)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: breadbox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nathaniel Watts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dropbox-sdk