dropbox-archive 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 842319a02d6fd7c95cdc6f0b2e69ab74934b8bea
+  data.tar.gz: 0538226fd058d788f6be0574a3ad56bbd4045f1e
+SHA512:
+  metadata.gz: 6a0fdbdca5365965b355f6bf06f0bcd94ca34d890ff5e3fc4e16c29c2443acad4f144f135be0e833d406e8b98f55a4d98a1f7616284a3cd35650cbae822fecba
+  data.tar.gz: 1771807b76b7170bc49f616816ee1a66fb2f8f2645ae8cf83b40e9e73a3de1e7cb70d329ba0e8dbc411cb8763ff2a54cc9ae0b17f4d61d023e4a949143b0eb22

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dropbox-archive.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josh McArthur
+
+MIT License
+
+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,52 @@
+# Dropbox::Archive
+
+[![Build Status](https://travis-ci.org/joshmcarthur/dropbox-archive.png?branch=master)](https://travis-ci.org/joshmcarthur/dropbox-archive) [![Code Climate](https://codeclimate.com/github/joshmcarthur/dropbox-archive.png)](https://codeclimate.com/github/joshmcarthur/dropbox-archive)
+
+Provides the ability to 'archive' files to your Dropbox account. By 'archive', I mean upload, and then remove from your hard drive, to make the most of your Dropbox storage AND your disk space.
+
+## Background
+
+I have a Macbook Air, with 64gb of SSD space. While these specifications are fantastic for my everyday use, I do have some issues with keeping large files around, or large folders of files - the perfect example being photos from my camera. The idea with this gem is to provide the ability to perform a 'one-way sync' from a folder - uploading files, without requiring those files be kept locally.
+
+This is similar to Dropbox's 'selective sync' option, but still provides the ability to upload files to the folder.
+
+
+## Installation
+
+The gem should be installed where you can get to it outside of a gemset or otherwise, especially if you wish to run it as a background process.
+
+If you are using system ruby or rbenv, then you should just be able to:
+
+	$ gem install dropbox-archive
+
+If you are using RVM, then you may wish to use a wrapper:
+
+	$ rvm use default
+	$ gem install dropbox-archive
+	$ rvm wrapper default dropbox-archive --no-prefix
+
+    
+## Configuration
+
+At the moment, configuration is a four-step process - I'm hoping to streamline this process in the near future, as the configuration so far has been a bit build-as-you-go.
+
+1. Create a file in your home folder, called ".dropbox_archive"
+2. Go to the [Dropbox Developer Center](https://dropbox.com/developers/apps) and create an application for yourself. This is needed to perform OAuth login, which Dropbox requires for API authentication.
+3. Run `dropbox-archive setup` for a link to acquire an access token from Dropbox. When this process is complete, you should see a welcome message, with your name, and your access token will have been saved in your settings. If you see an error, lodge an issue, and I'll help you out.
+4. Open up your `~/.dropbox_archive` file, and add a setting called `directory` that has the full path of the directory you want to watch. When files are added to this directory, they will be uploaded to Dropbox and then deleted from your local filesystem. 
+
+Once the configuration is done once, it should just continue working as long as you need it to, but if you need to re-generate your access token, then just run `dropbox-archive setup` again. I do appreciate that configuration isn't too easy right now, and plan to integrate many of these steps into the `setup` command.
+
+
+## Usage
+
+Simply run `dropbox-archive monitor` to begin monitoring the directory you configured in your settings file. Try creating a file in this directory - after a couple of seconds you should receive a notification that the file has been uploaded to Dropbox, and the file will have been removed from local storage.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/bin/dropbox-archive

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'dropbox/archive'
+
+Dropbox::Archive::CLI.start

data/dropbox-archive.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dropbox/archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dropbox-archive"
+  spec.version       = Dropbox::Archive::VERSION
+  spec.authors       = ["Josh McArthur"]
+  spec.email         = ["joshua.mcarthur@gmail.com"]
+  spec.description   = %q{Automatically upload files to dropbox and remove them from the local filesystem when they are added to a folder}
+  spec.summary       = %q{Upload files to Dropbox and delete from local filesystem.}
+  spec.homepage      = "https://github.com/joshmcarthur/dropbox-archive"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+  spec.add_dependency "dropbox-sdk"
+  spec.add_dependency "thor"
+  spec.add_dependency "listen"
+end

data/lib/dropbox/archive.rb

@@ -0,0 +1,26 @@
+require "dropbox/archive/version"
+require "dropbox/archive/actions"
+require "dropbox/archive/configuration"
+require "dropbox/archive/authorization"
+require "dropbox/archive/cli"
+require "dropbox/archive/monitor"
+require "dropbox_sdk"
+
+module Dropbox
+  module Archive
+    extend Actions
+    class << self; attr_accessor :config_path; end
+
+    def self.config
+      @config ||= Configuration.new(self.config_path || "~/.dropbox_archive")
+    end
+
+    def self.client
+      if Dropbox::Archive.config.get('dropbox_access_token').nil?
+        raise "No access token configured! Please run dropbox-archive setup."
+      end
+
+      @client ||= ::DropboxClient.new(Dropbox::Archive.config.get('dropbox_access_token'))
+    end
+  end
+end

data/lib/dropbox/archive/actions.rb

@@ -0,0 +1,17 @@
+module Dropbox
+  module Archive
+    module Actions
+
+      def upload(path)
+        file = File.open(path)
+        Dropbox::Archive.client.put_file(File.basename(path), file)
+        return remove(file)
+      end
+
+      def remove(file)
+        FileUtils.rm(file)
+        return File.path(file)
+      end
+    end
+  end
+end

data/lib/dropbox/archive/authorization.rb

@@ -0,0 +1,27 @@
+require 'dropbox_sdk'
+
+module Dropbox
+  module Archive
+    class Authorization
+
+      def initialize
+        DropboxOAuth2FlowNoRedirect.new(
+          Dropbox::Archive.config.get("dropbox_app_key"),
+          Dropbox::Archive.config.get("dropbox_app_secret")
+        ).tap do |flow|
+          authorize_url = flow.start
+
+          puts "Please authorize this application at: #{authorize_url}"
+          puts "Enter authorization code:"
+          authorization_code = $stdin.gets.chomp
+
+          access_token, user_id = flow.finish(authorization_code)
+          Dropbox::Archive.config.set("dropbox_access_token", access_token)
+        end
+
+        puts "Welcome, #{Dropbox::Archive.client.account_info['display_name']}!"
+        Dropbox::Archive.client
+      end
+    end
+  end
+end

data/lib/dropbox/archive/cli.rb

@@ -0,0 +1,13 @@
+require 'thor'
+
+class Dropbox::Archive::CLI < Thor
+  desc "setup", "setup client"
+  def setup
+    Dropbox::Archive::Authorization.new
+  end
+
+  desc "monitor", "start monitoring folder"
+  def monitor
+    Dropbox::Archive::Monitor.new
+  end
+end

data/lib/dropbox/archive/configuration.rb

@@ -0,0 +1,41 @@
+module Dropbox
+  module Archive
+    class Configuration
+
+      attr_accessor :config_path, :config_cache
+
+      def initialize(config_path)
+        @config_path = config_path
+      end
+
+      def get(key)
+        load
+        config_cache[key]
+      end
+
+      def set(key, value)
+        load
+        config_cache[key] = value
+        save
+        value
+      end
+
+      private
+
+      def load
+        if !File.exists?(File.expand_path(config_path))
+          FileUtils.touch(File.expand_path(config_path))
+        end
+
+        self.config_cache = YAML.load_file(File.expand_path(config_path)) || {}
+      end
+
+      def save
+        load unless config_cache
+        File.open(File.expand_path(config_path), 'wb') do |f|
+          f.write config_cache.to_yaml
+        end
+      end
+    end
+  end
+end

data/lib/dropbox/archive/monitor.rb

@@ -0,0 +1,17 @@
+require 'listen'
+
+module Dropbox
+  module Archive
+    class Monitor
+      def initialize
+        listener = Listen.to(Dropbox::Archive.config.get('directory')) do |modified, added, removed|
+          added.each { |path| Dropbox::Archive.upload(path) }
+          modified.each { |path| Dropbox::Archive.upload(path) }
+        end
+
+        listener.start
+        sleep
+      end
+    end
+  end
+end

data/lib/dropbox/archive/version.rb

@@ -0,0 +1,5 @@
+module Dropbox
+  module Archive
+    VERSION = "0.0.1"
+  end
+end

data/test/actions_test.rb

@@ -0,0 +1,36 @@
+require "test_helper"
+
+class ActionsTest < Test::Unit::TestCase
+  def setup
+    @test_file_path = File.join(File.dirname(__FILE__), 'fixtures', 'test.txt')
+    add_test_file!
+    setup_config!
+
+    @test_file = File.open(@test_file_path)
+  end
+
+  def test_upload_file
+    Dropbox::Archive.client
+    .expects(:put_file)
+    .with("test.txt", instance_of(File))
+
+    assert_equal @test_file_path,
+                 Dropbox::Archive.upload(@test_file)
+  end
+
+  def test_remove_file
+    assert File.exists?(@test_file_path)
+
+
+  end
+
+  def add_test_file!
+    FileUtils.touch(@test_file_path)
+  end
+
+  def setup_config!
+    @filepath = File.join(File.dirname(__FILE__), 'fixtures', 'test_config.yml')
+    Dropbox::Archive.config_path = @filepath
+    Dropbox::Archive.config
+  end
+end

data/test/cli_test.rb

@@ -0,0 +1,14 @@
+require "test_helper"
+
+class CLITest < Test::Unit::TestCase
+
+  def test_setup_invokes_authorization
+    Dropbox::Archive::Authorization.expects(:new)
+    Dropbox::Archive::CLI.new.setup
+  end
+
+  def test_monitor_invokes_monitor
+    Dropbox::Archive::Monitor.expects(:new)
+    Dropbox::Archive::CLI.new.monitor
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,22 @@
+require "test_helper"
+
+class ConfigurationTest < Test::Unit::TestCase
+  def setup
+    @filepath = File.join(File.dirname(__FILE__), 'test.yml')
+    @configuration = Dropbox::Archive::Configuration.new(@filepath)
+  end
+
+  def teardown
+    FileUtils.rm(@filepath)
+  end
+
+  def test_set_key
+    @configuration.set("test", "key")
+    assert_equal File.read(@filepath), "---\ntest: key\n"
+  end
+
+  def test_get_key
+    File.open(@filepath, 'w') { |f| f.write "---\ntest: key\n" }
+    assert_equal @configuration.get("test"), "key"
+  end
+end

data/test/dropbox_archive_test.rb

@@ -0,0 +1,36 @@
+require "test_helper"
+
+class DropboxArchiveTest < Test::Unit::TestCase
+  def setup
+    setup_config!
+  end
+
+  def test_load_config
+    config = Dropbox::Archive.config
+    assert_not_nil config.get('directory')
+    assert_equal config, Dropbox::Archive.config
+  end
+
+  def test_client_access_token_not_present
+    Dropbox::Archive.config.stubs(get: nil)
+    assert_raise RuntimeError do
+      Dropbox::Archive.client
+    end
+  end
+
+  def test_client_instantiated
+    DropboxClient.expects(:new)
+    # Make sure client has not already been set,
+    # since the value is cached
+    Dropbox::Archive.instance_variable_set("@client", nil)
+    Dropbox::Archive.client
+  end
+
+  private
+
+  def setup_config!
+    @filepath = File.join(File.dirname(__FILE__), 'fixtures', 'test_config.yml')
+    Dropbox::Archive.config_path = @filepath
+  end
+
+end

data/test/fixtures/test_config.yml

@@ -0,0 +1,5 @@
+---
+dropbox_app_key: test
+dropbox_app_secret: test
+dropbox_access_token: test
+directory: test/fixtures/sync_test

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require "bundler/setup"
+Bundler.require
+
+require "dropbox/archive"
+require "test/unit"
+require "mocha/setup"

data/test/version_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class VersionTest < Test::Unit::TestCase
+  def test_version_defined
+    assert_not_nil Dropbox::Archive::VERSION
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: dropbox-archive
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: mocha
+  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: 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: thor
+  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: listen
+  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'
+description: Automatically upload files to dropbox and remove them from the local
+  filesystem when they are added to a folder
+email:
+- joshua.mcarthur@gmail.com
+executables:
+- dropbox-archive
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dropbox-archive
+- dropbox-archive.gemspec
+- lib/dropbox/archive.rb
+- lib/dropbox/archive/actions.rb
+- lib/dropbox/archive/authorization.rb
+- lib/dropbox/archive/cli.rb
+- lib/dropbox/archive/configuration.rb
+- lib/dropbox/archive/monitor.rb
+- lib/dropbox/archive/version.rb
+- test/actions_test.rb
+- test/cli_test.rb
+- test/configuration_test.rb
+- test/dropbox_archive_test.rb
+- test/fixtures/test_config.yml
+- test/monitor_test.rb
+- test/test_helper.rb
+- test/version_test.rb
+homepage: https://github.com/joshmcarthur/dropbox-archive
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Upload files to Dropbox and delete from local filesystem.
+test_files:
+- test/actions_test.rb
+- test/cli_test.rb
+- test/configuration_test.rb
+- test/dropbox_archive_test.rb
+- test/fixtures/test_config.yml
+- test/monitor_test.rb
+- test/test_helper.rb
+- test/version_test.rb