breadbox 0.0.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24eaaf7bf16cc0ee063a61ab043a41080fc035e4
-  data.tar.gz: 8a43b4a5b7d283c7b9732b41426454ac8faecaa2
+  metadata.gz: 90f41d62df8c945f0e5daed62fd13f426ee8df0a
+  data.tar.gz: 359a0337bb8ce4943693637b4029ae56c8852e48
 SHA512:
-  metadata.gz: f6264b060ed5e71b9734f616c8619bc601eb1fe62b81acdf30adb8547b3afa27d565573926b49386f021676f8ce92c81b19041b623165d94e6bda11ec1b52c42
-  data.tar.gz: 1b26f6a994e1def0705739b89968b29ec8b199c3b7a263ae6f76ea54013c873013414cbb07ed2c1f291616a47d15d809cbd2f13bd149f4494d6b431b0446cff2
+  metadata.gz: cad5ed20ce72a87876fa9b4deacb15462b5c7102fe9569318e02eca64911873b27f98483ddfc7acbf1182fb93636f52df25e8d16e5353c087525489f79e66ea9
+  data.tar.gz: 3c2b44758c1eca95f72b2046f929d4c04aebcfa7dff8db994bcb9e2a1d81b0f7889a387e3a8665719a4ef38cebd17c2e1a6269ee3f087cba2aa4cd44235cdc6c

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -1,6 +1,11 @@
 # Breadbox
 
-TODO: Write a gem description
+A simple wrapper interface for the [DropBox SDK gem](https://github.com/dropbox/dropbox-sdk-ruby).
+
+## Disclaimer
+
+- This is a simple and fast implementation - Issues and PRs welcome.
+- Currently tested on Ruby 2.1.2
 
 ## Installation
 
@@ -18,7 +23,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### 1. Get a [Dropbox Access Token](https://www.dropbox.com/developers/blog/94/generate-an-access-token-for-your-own-account)
+### 2. Add to your initializers:
+
+```ruby
+# config/initializers/breadbox.rb
+
+Breadbox.configure do |config|
+  config.dropbox_access_token = xxxxxxx # THIS IS REQUIRED
+end
+```
+
+### 3. Configure your root directory for uploading files (Optional)
+
+> By default - the root path will be the root directory of your DropBox folder.
+You can, however, change the root path to be anything you want (inside of Dropbox).
+
+**Note: You have to prefix the folder you wnt with a `/`, ex: `/uploads/my-files`**
+
+```ruby
+# config/initializers/breadbox.rb
+
+Breadbox.configure do |config|
+  config.dropbox_access_token = xxxxxxx # THIS IS REQUIRED
+  config.root_path = "/uploads/my-files"
+end
+```
+
+### 4. Use it! :)
+
+#### Parameters:
+
+- `path`: defaults to `nil`, but this is where you put a custom folder if you so wish (in relation
+  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
+
+```ruby
+# to upload a file to Dropbox/uploads/my-cool-file.jpg
+# and remove it after upload
+
+file = File.open("./tmp/my-cool-file.jpg")
+Breadbox.upload(path: "uploads", file: file, cleanup: true)
+```
+
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "pry -r breadbox -I ./lib"
+end

data/breadbox.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nathaniel Watts"]
   spec.email         = ["reg@nathanielwatts.com"]
   spec.summary       = "A simple wrapper interface for the DropBox SDK gem."
-  spec.description   = "This gem is just to provide some niceties for interfacing with the DropBox SDK [https://github.com/dropbox/dropbox-sdk-ruby](https://github.com/dropbox/dropbox-sdk-ruby)."
+  spec.description   = "This gem is just to provide some niceties for interfacing with the DropBox SDK."
   spec.homepage      = "https://github.com/thewatts/breadbox"
   spec.license       = "MIT"
 
@@ -18,6 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "dropbox-sdk"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
 end

data/lib/breadbox/client.rb

@@ -0,0 +1,35 @@
+require "dropbox_sdk"
+
+module Breadbox
+  class Client
+    attr_reader :client, :root_path, :token
+
+    def initialize(options = {})
+      @token     = options[:token]
+      @root_path = options[:root_path]
+      @client    = new_client_from_token
+    end
+
+    def upload(path: nil, file: nil)
+      filepath = filepath_from_paths_and_file(root_path, path, file)
+      client.put_file(filepath, file)
+    end
+
+    protected
+
+    def filepath_from_paths_and_file(root_path, path, file)
+      filename = File.basename(file)
+      [root_path, path, filename].join("/").gsub(/\/{2,}/, '/')
+    end
+
+    def new_client_from_token
+      if token.nil? || token.empty?
+        raise MissingAccessToken, "You need a Dropbox Access Token."
+      else
+        DropboxClient.new(token)
+      end
+    end
+  end
+end
+
+class MissingAccessToken < Exception; end

data/lib/breadbox/configuration.rb

@@ -0,0 +1,15 @@
+module Breadbox
+  class Configuration
+    attr_accessor :dropbox_access_token, :root_path
+
+    def initialize
+      @root_path = default_root_path
+    end
+
+    protected
+
+    def default_root_path
+      "/"
+    end
+  end
+end

data/lib/breadbox/version.rb

@@ -1,3 +1,3 @@
 module Breadbox
-  VERSION = "0.0.1"
+  VERSION = "0.9.0"
 end

data/lib/breadbox.rb

@@ -1,5 +1,46 @@
 require "breadbox/version"
+require "breadbox/configuration"
+require "breadbox/client"
+
+begin
+  require "pry"
+rescue LoadError
+end
 
 module Breadbox
-  # Your code goes here...
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.cleanup(file: nil, cleanup: true)
+    if cleanup && File.exists?(file)
+      File.delete(file)
+    end
+  end
+
+  def self.client
+    @client ||= Client.new(
+      root_path: configuration.root_path,
+      token: configuration.dropbox_access_token,
+    )
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset
+    @client        = nil
+    @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)
+    end
+  end
 end

data/spec/breadbox/client_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+module Breadbox
+  describe Client do
+    it "should be a Dropbox client" do
+      client = Client.new(token: "12345").client
+      expect(client).to be_kind_of DropboxClient
+    end
+
+    it "should raise an exception if token is missing" do
+      expect{ Client.new }.to raise_exception(MissingAccessToken)
+    end
+
+    it "should raise an exception if the token is empty" do
+      expect{ Client.new(token: "") }.to raise_exception(MissingAccessToken)
+    end
+
+    describe "#upload" do
+      before { FileUtils.touch("./tmp/new-file.jpg") }
+      after  { File.delete("./tmp/new-file.jpg") }
+
+      it "tells the client to put_file from a full_filepath and file" do
+        file           = File.open("./tmp/new-file.jpg")
+        client         = Client.new(token: "12345", root_path: "/")
+        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)
+
+        client.upload(path: "/", file: file)
+      end
+
+      it "tells the client to put_file from a full_filepath and file" do
+        file           = File.open("./tmp/new-file.jpg")
+        client         = Client.new(token: "12345", root_path: "/")
+        dropbox_client = instance_double(DropboxClient)
+        allow(client).to receive(:client).and_return(dropbox_client)
+        expect(dropbox_client).to receive(:put_file).with("/images/new-file.jpg", file)
+
+        client.upload(path: "images", file: file)
+      end
+    end
+  end
+end

data/spec/breadbox/configuration_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+module Breadbox
+  describe Configuration do
+    describe "#root_path" do
+      it "defaults to /breadbox" do
+        config = Configuration.new
+        expect(config.root_path).to eq "/"
+      end
+    end
+
+    describe "#root_path=" do
+      it "assigns a root directory" do
+        config  = Configuration.new
+        new_dir = "/my-favorite-directory"
+        config.root_path = new_dir
+        expect(config.root_path).to eq new_dir
+      end
+    end
+
+    describe "#dropbox_access_token" do
+      it "defaults to nil" do
+        config = Configuration.new
+        expect(config.dropbox_access_token).to eq nil
+      end
+    end
+
+    describe "#dropbox_access_token=" do
+      it "assigns the access token" do
+        config = Configuration.new
+        access_token = "12345"
+        config.dropbox_access_token = access_token
+        expect(config.dropbox_access_token).to eq access_token
+      end
+    end
+  end
+end

data/spec/breadbox_spec.rb

@@ -0,0 +1,102 @@
+require "spec_helper"
+
+describe Breadbox do
+  describe "::configure" do
+    before do
+      Breadbox.configure do |config|
+        config.dropbox_access_token = "12345"
+        config.root_path            = "/my-new-root"
+      end
+    end
+
+    after { Breadbox.reset }
+
+    it "returns the newly assigned token" do
+      expect(Breadbox.configuration.dropbox_access_token).to eq "12345"
+    end
+
+    it "returns the newly assigned root" do
+      expect(Breadbox.configuration.root_path).to eq "/my-new-root"
+    end
+  end
+
+  describe "::client" do
+    before do
+      Breadbox.configure do |config|
+        config.dropbox_access_token = "12345"
+      end
+    end
+
+    after { Breadbox.reset }
+
+    it "assigns the token to a new Client" do
+      client = Breadbox.client
+      expect(client).to be_kind_of Breadbox::Client
+    end
+  end
+
+  describe "::upload" do
+    let!(:filepath) { "./tmp/my-new-file.jpg" }
+    let(:client)    { instance_double(Breadbox::Client) }
+
+    before(:each) do
+      FileUtils.touch(filepath)
+      allow(Breadbox).to receive(:client).and_return(client)
+    end
+
+    after { File.delete(filepath) }
+
+    it "tells the client the #upload" do
+      file   = File.open(filepath)
+      params = {
+        path: "/my-folder",
+        file: file,
+      }
+
+      allow(Breadbox).to receive(:client).and_return(client)
+      expect(client).to receive(:upload).with(params)
+
+      Breadbox.upload(params)
+    end
+
+    it "calls cleanup after upload" do
+      file   = File.open(filepath)
+
+      allow(Breadbox).to receive(:client).and_return(client)
+      allow(client).to receive(:upload).and_return(true)
+      expect(Breadbox).to receive(:cleanup).with(file: file, cleanup: true)
+
+      Breadbox.upload(file: file, cleanup: true)
+    end
+  end
+
+  describe "::cleanup" do
+    let!(:filepath) { "./tmp/my-new-file.jpg" }
+
+    before(:each) do
+      FileUtils.touch(filepath)
+    end
+
+    after { File.delete(filepath) if File.exists?(filepath) }
+
+    context "with cleanup flag as false" do
+      it "doesn't delete the file" do
+        file = File.open(filepath)
+        expect(File.exists?(filepath)).to be true
+        Breadbox.cleanup(file: file, cleanup: false)
+
+        expect(File.exists?(filepath)).to be true
+      end
+    end
+
+    context "with cleanup as true" do
+      it "deletes the file" do
+        file = File.open(filepath)
+        expect(File.exists?(filepath)).to be true
+        Breadbox.cleanup(file: file, cleanup: true)
+
+        expect(File.exists?(filepath)).to be false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+require "breadbox"
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: breadbox
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Nathaniel Watts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dropbox-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,8 +52,36 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem is just to provide some niceties for interfacing with the DropBox
-  SDK [https://github.com/dropbox/dropbox-sdk-ruby](https://github.com/dropbox/dropbox-sdk-ruby).
+  SDK.
 email:
 - reg@nathanielwatts.com
 executables: []
@@ -47,13 +89,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - breadbox.gemspec
 - lib/breadbox.rb
+- lib/breadbox/client.rb
+- lib/breadbox/configuration.rb
 - lib/breadbox/version.rb
+- spec/breadbox/client_spec.rb
+- spec/breadbox/configuration_spec.rb
+- spec/breadbox_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/thewatts/breadbox
 licenses:
 - MIT
@@ -78,5 +127,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple wrapper interface for the DropBox SDK gem.
-test_files: []
+test_files:
+- spec/breadbox/client_spec.rb
+- spec/breadbox/configuration_spec.rb
+- spec/breadbox_spec.rb
+- spec/spec_helper.rb
 has_rdoc: