fallcli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ba9483a4dca769bd5b81f3e085a81002d1bf187
+  data.tar.gz: f192f00a01c5c3ea3a76223b35066bc81338fa82
+SHA512:
+  metadata.gz: e612c373df9e6a0f3c3822401e6400e7c6cd31ba63c63ce8ffbf16ff93bef8cd6338c777b707c699c451dab1a4e7ac1d7f6f624bab3b28432d8a66708d5a67d4
+  data.tar.gz: 9de372728cbdfe3b54a56846f69f8aa2dc5b4d577a51abec21627d5f43124e0b91031480b1372b6c7f857ce9e5194e4e345e62c7fdf3832e87b2f57956d5507c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 2.2.0
+- 2.1.0
+- 2.0.0
+matrix:
+  allow_failures:
+    - rvm: 2.2.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2015 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,45 @@
+# FallCLI
+[![Build Status](https://travis-ci.org/petems/fallcli.svg)](https://travis-ci.org/petems/fallcli)
+
+A hack for the [London Dropbox Hackathon](http://lanyrd.com/2015/london-dropbox-hackathon/)
+
+I'm probably going to refactor this into [Slipsquare](https://github.com/petems/slipsquare) in the future, as I recycled a lot of code :smile:
+
+### Installation
+
+    gem install fallcli
+
+### Configuration
+
+Run the configuration utility, `fallcli authorize`.
+
+### File browser
+
+```
+$ fallcli browser
+```
+
+Screenshot:
+![screenshot 2015-01-25 06 02 36](https://cloud.githubusercontent.com/assets/1064715/5890542/2949c490-a458-11e4-9e4c-935f6c623f77.png)
+
+### Upload Browser
+
+```
+$ slipsquare uploader-browser
+```
+
+Screenshot:
+![screenshot 2015-01-25 06 04 05](https://cloud.githubusercontent.com/assets/1064715/5890539/24dfc6e8-a458-11e4-8114-8f740f59db70.png)
+
+## 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/fallcli

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

data/fallcli.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fallcli/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "fallcli"
+  gem.version       = FallCli::VERSION
+  gem.authors       = ["Peter Souter"]
+  gem.email         = ["p.morsou@gmail.com"]
+  gem.description   = %q{A curses CLI app for Dropbox}
+  gem.summary       = %q{FallCli is a curses CLI app for Dropbox}
+  gem.homepage      = "https://github.com/petems/fallcli"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "thor", "~> 0.18.1"
+  gem.add_dependency "middleware" , "~> 0.1.0"
+
+  gem.add_dependency "dropbox-api-petems", "1.1.0"
+  gem.add_dependency "dispel", "0.0.7"
+  gem.add_dependency "ruby-progressbar", "~> 1.2.0"
+
+  gem.add_development_dependency "rake", "~> 10.1.0"
+  gem.add_development_dependency "rspec-core", "~> 2.13.0"
+  gem.add_development_dependency "rspec-expectations", "~> 2.13.0"
+  gem.add_development_dependency "rspec-mocks", "~> 2.13.0"
+  gem.add_development_dependency "webmock", "~> 1.11.0"
+  gem.add_development_dependency "coveralls", "~> 0.7.1"
+
+end

data/lib/fallcli.rb

@@ -0,0 +1,6 @@
+require 'fallcli/cli'
+require 'fallcli/config'
+require 'fallcli/version'
+
+module FallCli
+end

data/lib/fallcli/browser_helper.rb

@@ -0,0 +1,29 @@
+module FallCli
+  class BrowserHelper
+    attr_accessor :position
+
+    def initialize items
+      @files = Array.new
+      items.each { |item| @files << item }
+      @position = 0
+    end
+
+    def show_files
+      @files.each_with_index.map do |item, index|
+        position == index ? "[#{pretty_dropbox_file(item)}]" : " #{pretty_dropbox_file(item)} "
+      end
+    end
+
+    def pretty_dropbox_file file
+      "#{file.path} | #{file.mime_type} | #{file.size}"
+    end
+
+    def position_up
+      @position -= 1 unless @position < 1
+    end
+
+    def position_down
+      @position += 1 unless @position == (@files.size - 1)
+    end
+  end
+end

data/lib/fallcli/cli.rb

@@ -0,0 +1,69 @@
+require 'thor'
+
+module FallCli
+  autoload :Middleware, "fallcli/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/fallcli"
+      end
+    end
+
+    desc "authorize", "Authorize a Dropbox account with fallcli"
+    long_desc "This takes you through a workflow for adding configuration
+    details to fallcli."
+    def authorize
+      Middleware.sequence_authorize.call({})
+    end
+
+    desc "browser", "Run the browser"
+    long_desc "This is the file browser that renders a CLI to browse your Dropbox
+    files, and you can navigate using the arrow keys"
+    def browser
+      Middleware.sequence_browser.call({})
+    end
+
+    desc "uploader-browser", "Run the upload-browser"
+    long_desc "This is the file browser that renders your local file system files
+    files, and you can upload with the CLI"
+    def uploader_browser
+      Middleware.sequence_upload_browser.call({})
+    end
+
+    desc "verify", "Check your given credentials are valid"
+    long_desc "This checks that the credentials in ~/.fallcli are correct"
+    def verify
+      Middleware.sequence_verify.call({})
+    end
+
+    desc "get-keys", "Get your app and secret keys"
+    def get_keys
+      say "Please open this URL from your Browser, and login: https://www.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: FallCli#{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 "FallCli #{FallCli::VERSION}"
+    end
+
+  end
+end
+

data/lib/fallcli/config.rb

@@ -0,0 +1,69 @@
+require 'singleton'
+require 'fileutils'
+
+module FallCli
+  # This is the configuration object. It reads in configuration
+  # from a .fallcli file located in the user's home directory
+
+  class Configuration
+    include Singleton
+    attr_reader :data
+    attr_reader :path
+
+    FILE_NAME = '.fallcli/config'
+
+    def initialize
+      @path = ENV["FALLCLI_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)
+      FileUtils.mkdir_p File.join(File.expand_path("~"),'.fallcli/')
+      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/fallcli/middleware.rb

@@ -0,0 +1,55 @@
+require "middleware"
+
+module FallCli
+  module Middleware
+    autoload :Base, "fallcli/middleware/base"
+
+    autoload :AskForCredentials, "fallcli/middleware/ask_for_credentials"
+    autoload :Browser, "fallcli/middleware/browser"
+    autoload :CheckConfiguration, "fallcli/middleware/check_configuration"
+    autoload :CheckCredentials, "fallcli/middleware/check_credentials"
+    autoload :InjectClient, "fallcli/middleware/inject_client"
+    autoload :InjectConfiguration, "fallcli/middleware/inject_configuration"
+    autoload :UploaderBrowser, "fallcli/middleware/upload_browser"
+
+    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_browser
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use Browser
+      end
+    end
+
+    def self.sequence_upload_browser
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use CheckCredentials
+        use UploaderBrowser
+      end
+    end
+
+    def self.sequence_verify
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use CheckCredentials
+      end
+    end
+
+  end
+end

data/lib/fallcli/middleware/ask_for_credentials.rb

@@ -0,0 +1,39 @@
+require "dropbox-api"
+require "cgi"
+
+module FallCli
+  module Middleware
+    # Ask for user credentials from the command line, then write them out.
+    class AskForCredentials < Base
+      def call(env)
+
+        say "If you dont know your app and secret key, try `fallcli get-keys`"
+
+        app_key = ask "Enter your App key:"
+        secret_key = ask "Enter your Secret key:"
+
+        Dropbox::API::Config.app_key    = app_key
+        Dropbox::API::Config.app_secret = secret_key
+
+        consumer = Dropbox::API::OAuth.consumer(:authorize)
+        request_token = consumer.get_request_token
+        say "Go to this url and click 'Authorize' to get the token:"
+        say request_token.authorize_url, :green
+        query  = request_token.authorize_url.split('?').last
+        params = CGI.parse(query)
+        token  = params['oauth_token'].first
+        yes? "Once you authorize the app on Dropbox, type yes... "
+        access_token  = request_token.get_access_token(:oauth_verifier => token)
+
+        # Write the config file.
+        env['config'].create_config_file(app_key, secret_key, access_token.token, access_token.secret)
+        env['config'].reload!
+
+        say "Credentials saved to ~/.fallcli"
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/fallcli/middleware/base.rb

@@ -0,0 +1,28 @@
+module FallCli
+  module Middleware
+    # A base middleware class to initalize.
+    class Base
+      # Some colors for making things pretty.
+      CLEAR      = "\e[0m"
+      RED        = "\e[31m"
+      GREEN      = "\e[32m"
+      YELLOW     = "\e[33m"
+
+      # We want access to all of the fun thor cli helper methods,
+      # like say, yes?, ask, etc.
+      include Thor::Shell
+
+      def initialize(app)
+        @app = app
+        # This resets the color to "clear" on the user's terminal.
+        say "", :clear, false
+      end
+
+      def call(env)
+        @app.call(env)
+      end
+
+    end
+  end
+end
+