slipsquare 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a010880a46f5c654486ac768be01ea64fc53b4f8
+  data.tar.gz: 458574fa784b56fdc85af8b7e77961b3f43bc92b
+SHA512:
+  metadata.gz: c09e12099dd70cbbae87f4c9e47951cb634ffddc24e22b030fec3d4591c6e3acc293124bfbf8e5b399922d43967ac418d6469b041b4aa64af338f75f6faa05da
+  data.tar.gz: 3bdad2880500f948fff5719ae17d7b915f3bffd667ff5e81657dac6717d467bbed3835cbda799324b9eb3cdedacd975161135432901fa01a92665a2384fac6b7

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.rbc
+*~
+*.swp
+*.swo
+.bundle
+.rvmrc
+Gemfile.lock
+doc/*
+log/*
+pkg/*

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3
+- 1.9.2
+- 1.8.7
+matrix:
+  allow_failures:
+    - rvm: 1.8.7

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## 0.0.1 (Unreleased)
+
+Initial release.
+
+Current Commands:
+
+  * account                
+  * authorize              
+  * chunked-upload [PATH]  
+  * download [FILENAME]    
+  * get-keys               
+  * help [COMMAND]         
+  * ls                     
+  * mkdir [PATH]           
+  * upload [PATH]          
+  * verify                 
+  * version 
+
+Added but not implemented
+
+  * delete [PATH] - Need to figure out why it doesnt return a file object from the find command, which I can then call a delete on, I think I have some idea, but I want to release 0.0.1 before the weekend so I'll stub for now...  

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# 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
+
+## Development Environment
+
+To add a feature, fix a bug, or to run a development build of Slipsquare
+on your machine, clone down the repo and run:
+
+    $ bundle
+
+You can then execute slipsquare:
+
+    $ bundle exec slipsquare [command]
+
+As well as run the tests:
+
+    $ bundle exec rspec
+
+To install the gem on your system from source:
+
+    $ bundle exec rake install
+
+If you need help with your environment, feel free to open an issue.

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Peter Souter
+
+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,93 @@
+# Slipsquare
+
+A work-in-progress command line tool for uploading files to Dropbox, heavily inspired by tools such as
+[Dropbox Uploader](https://github.com/andreafabrizi/Dropbox-Uploader) and [Tugboat](https://github.com/pearkes/tugboat)
+
+### Installation
+
+    gem install slipsquare
+
+Note: Currently not on Rubygems yet...
+
+### Configuration
+
+Run the configuration utility, `slipsquare authorize`.
+
+### Download a file
+
+```
+$ slipsquare download miley_cyrus_dubstep.mp3
+Downloading file...
+File 'miley_cyrus_dubstep.mp3' downloaded successfully!
+```
+
+### Upload a file
+
+```
+$ slipsquare upload secret_plans.doc
+Uploading file...
+File 'secret_plans.doc' uploaded successfully
+```
+
+**Coming soon - Chunked uploads with progress bar!**
+
+### Delete a file
+
+*To be implemented*
+
+```
+$ slipsquare delete remove_me.tmp
+Deleting file...
+To be implemented...
+```
+
+### Create a directory
+
+```
+$ slipsquare mkdir breaking_bad_episodes
+Creating directory on Dropbox...
+Directory `breaking_bad_episodes` created successfully
+```
+
+### List files on dropbox
+
+#### All files/Root
+```
+$ slipsquare ls
+Listing files from Dropbox
+PATH                           | MIME_TYPE                | SIZE
+-------------------------------|--------------------------|---------
+/what_does_the_fox_say.mp3     | audio/mpeg               | 7.6 MB
+/photo_album.zip               | application/zip          | 83.7 MB
+/Books                         | Method Missing           | 0 bytes
+/Camera Uploads                | Method Missing           | 0 bytes
+/Comics                        | Method Missing           | 0 bytes
+/Music                         | Method Missing           | 0 bytes
+/Photos                        | Method Missing           | 0 bytes
+/Public                        | Method Missing           | 0 bytes
+```
+
+#### Particular Path
+```
+$ slipsquare ls music
+PATH                           | MIME_TYPE  | SIZE
+-------------------------------|------------|---------
+/Music/01-paul_oakenfold_-_... | audio/mpeg | 183.9 MB
+/Music/Big Bad Wolf (Dada L... | audio/mpeg | 12.5 MB
+/Music/Drums Of Death - War... | audio/mpeg | 84.6 MB
+/Music/Layo & Bushwacka! - ... | audio/mpeg | 78.8 MB
+/Music/Lost Woods (Crizzly ... | audio/mpeg | 9.7 MB
+/Music/The Glitch Mob -- We... | audio/mpeg | 12.6 MB
+```
+
+## Help
+
+For a complete overview of all of the available commands, run:
+
+    $ slipsquare help
+
+Feel free to open issues in case of bugs or improvments.
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md). Pull-requests welcome!

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/slipsquare

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+Signal.trap("INT") { exit 1 }
+
+require "slipsquare"
+
+Slipsquare::CLI.start(ARGV)

data/lib/slipsquare.rb

@@ -0,0 +1,6 @@
+require 'slipsquare/cli'
+require "slipsquare/config"
+require "slipsquare/version"
+
+module Slipsquare
+end

data/lib/slipsquare/cli.rb

@@ -0,0 +1,105 @@
+require 'thor'
+
+module Slipsquare
+  autoload :Middleware, "slipsquare/middleware"
+
+  class CLI < Thor
+    include Thor::Actions
+    ENV['THOR_COLUMNS'] = '120'
+
+    !check_unknown_options
+
+    map "--version"      => :version,
+        "-v"             => :version
+
+    desc "help [COMMAND]", "Describe commands or a specific command"
+    def help(meth=nil)
+      super
+      if !meth
+        say "To learn more or to contribute, please see github.com/petems/slipsquare"
+      end
+    end
+
+    desc "authorize", "Authorize a Dropbox account with slipsquare"
+    long_desc "This takes you through a workflow for adding configuration
+    details to slipsquare."
+    def authorize
+      Middleware.sequence_authorize.call({})
+    end
+
+
+    desc "account", "Shows Dropbox account details"
+    long_desc "This displays your main Dropbox meta-data, such as
+    Display Name, County, Download Quota information and the like"
+    def account
+      Middleware.sequence_account.call({})
+    end
+
+    desc "download [FILENAME]", "Download a file or directory"
+    long_desc "Download or directory from dropbox"
+    def download(filename)
+      Middleware.sequence_download_file.call({"download_file_name" => filename})
+    end
+
+    desc "verify", "Check your given credentials are valid"
+    long_desc "This checks that the credentials in ~/.slipsquare are correct"
+    def verify
+      Middleware.sequence_verify.call({})
+    end
+
+    desc "ls", "Show files for a particular path"
+    method_option "path",
+                  :type => :string,
+                  :aliases => "-p",
+                  :desc => "The path you want to give."
+    long_desc "This shows all the files of a given path (defaulting to root)"
+    def ls(path=nil)
+      Middleware.sequence_ls.call({"list_files_path" => path})
+    end
+
+    desc "mkdir [PATH]", "Make a directory on dropbox"
+    long_desc "This creates a directory on Dropbox, it allows you to enter
+    multiple directories and all will be created eg. `slipsquare mkdir photos/america/san_fran"
+    def mkdir(path)
+      Middleware.sequence_mkdir.call({"mkdir_path" => path})
+    end
+
+    desc "delete [PATH]", "Delete a directory or file on Dropbox"
+    long_desc "This creates a directory on Dropbox"
+    def delete(path)
+      Middleware.sequence_delete_file.call({"delete_path" => path})
+    end
+
+    desc "upload [PATH]", "Upload a file or directory"
+    long_desc "Upload a file or directory to dropbox"
+    def upload(filename)
+      Middleware.sequence_upload_file.call({"upload_file_name" => filename})
+    end
+
+    desc "chunked-upload [PATH]", "Chunk Upload a file or directory"
+    long_desc "Upload a file or directory to dropbox with chunks, typically
+    4mb in size, allowing a way of showing progress of downloads."
+    def chunked_upload(filename)
+      Middleware.sequence_chunked_upload_file.call({"chunked_upload_file_name" => filename})
+    end
+
+    desc "get-keys", "Get your app and secret keys"
+    def get_keys
+      say "Please open this URL from your Browser, and login: https://www2.dropbox.com/developers/apps"
+      say "Click \"Create app\" button, and choose the following options:"
+      say "Type: Dropbox API app"
+      say "Data: Files and Datastores"
+      say "Permission type: Full Dropbox"
+      say "File Types: All file types"
+      say "App name: Slipsquare#{Time.now.to_i}"
+      say "Cick on the \"Create\" button, and note down the 'app key' and 'app secret'"
+    end
+
+    desc "version", "Show version"
+    def version
+      say "Slipsquare #{Slipsquare::VERSION}"
+    end
+
+  end
+end
+

data/lib/slipsquare/config.rb

@@ -0,0 +1,67 @@
+require 'singleton'
+
+module Slipsquare
+  # This is the configuration object. It reads in configuration
+  # from a .slipsquare file located in the user's home directory
+
+  class Configuration
+    include Singleton
+    attr_reader :data
+    attr_reader :path
+
+    FILE_NAME = '.slipsquare'
+
+    def initialize
+      @path = ENV["SLIPSTREAM_CONFIG_PATH"] || File.join(File.expand_path("~"), FILE_NAME)
+      @data = self.load_config_file
+    end
+
+    # If we can't load the config file, self.data is nil, which we can
+    # check for in CheckConfiguration
+    def load_config_file
+      require 'yaml'
+      YAML.load_file(@path)
+    rescue Errno::ENOENT
+      return
+    end
+
+    def app_key
+      @data['authentication']['app_key']
+    end
+
+    def secret_key
+      @data['authentication']['secret_key']
+    end
+
+    def app_token
+      @data['client']['app_token']
+    end
+
+    def app_secret
+      @data['client']['app_secret']
+    end
+
+    # Re-runs initialize
+    def reset!
+      self.send(:initialize)
+    end
+
+    # Re-loads the config
+    def reload!
+      @data = self.load_config_file
+    end
+
+    # Writes a config file
+    def create_config_file(app_key, secret_key, app_token, app_secret)
+      require 'yaml'
+      File.open(@path, File::RDWR|File::TRUNC|File::CREAT, 0600) do |file|
+        data = {
+          "authentication" => { "app_key" => app_key, "secret_key" => secret_key },
+          "client" => { "app_token" => app_token, "app_secret" => app_secret }
+        }
+        file.write data.to_yaml
+      end
+    end
+
+  end
+end

data/lib/slipsquare/middleware.rb

@@ -0,0 +1,106 @@
+require "middleware"
+
+module Slipsquare
+  module Middleware
+    autoload :Base, "slipsquare/middleware/base"
+
+    autoload :AskForCredentials, "slipsquare/middleware/ask_for_credentials"
+    autoload :Account, "slipsquare/middleware/account"
+    autoload :CheckConfiguration, "slipsquare/middleware/check_configuration"
+    autoload :CheckCredentials, "slipsquare/middleware/check_credentials"
+    autoload :ChunkedUpload, "slipsquare/middleware/chunked_upload"
+    autoload :DeleteFile, "slipsquare/middleware/delete_file"
+    autoload :DownloadFile, "slipsquare/middleware/download_file"
+    autoload :InjectClient, "slipsquare/middleware/inject_client"
+    autoload :InjectConfiguration, "slipsquare/middleware/inject_configuration"
+    autoload :ListFiles, "slipsquare/middleware/list_files"
+    autoload :MakeDirectory, "slipsquare/middleware/make_directory"
+    autoload :UploadFile, "slipsquare/middleware/upload_file"
+
+    # Start the authorization flow.
+    # This writes a ~/.slipsquare file, which can be edited manually.
+    def self.sequence_authorize
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use AskForCredentials
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use CheckCredentials
+      end
+    end
+
+    def self.sequence_account
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use Account
+      end
+    end
+
+    def self.sequence_verify
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use CheckCredentials
+      end
+    end
+
+    def self.sequence_ls
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use ListFiles
+      end
+    end
+
+    def self.sequence_mkdir
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use MakeDirectory
+      end
+    end
+
+    def self.sequence_upload_file
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use UploadFile
+      end
+    end
+
+    def self.sequence_download_file
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use DownloadFile
+      end
+    end
+
+    def self.sequence_delete_file
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use DeleteFile
+      end
+    end
+
+    def self.sequence_chunked_upload_file
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use ChunkedUpload
+      end
+    end
+
+  end
+end