gdsh 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea4c9787d401d716741f4db5606ddc739b16a8f9
+  data.tar.gz: 3f7a0aada9445817f3c3efdaaba3e3ddc6425ed8
+SHA512:
+  metadata.gz: 482ad86b93d60e9a832485aad59ccfd86043e60e366e594a086cab8350bcdfcbfe96b8ca714995ee570441a37753771890ef4c8b5e2650db9bfea90692cb325d
+  data.tar.gz: e0acf4d5cc78838575181a6b38164db73c165f150748f41fb30eb8b632dbeec54f1b2aa05dc430ebd1c54bce1f59f1c81d48ae3b93a129e2db1822e28d824239

data/.gitignore

@@ -0,0 +1,21 @@
+auth.json
+.session.yaml
+
+# Bundle generated
+*.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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gdsh.gemspec
+gemspec
+
+# forked from JakobR's branch + patch
+gem 'differ', git: 'git://github.com/emintham/differ'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Emin Tham
+
+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,31 @@
+# gdsh [![Code Climate](https://codeclimate.com/github/emintham/gdsh.png)](https://codeclimate.com/github/emintham/gdsh)
+
+A Google Drive shell in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'gdsh'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install gdsh
+
+## Usage
+
+(adapted from https://developers.google.com/drive/web/quickstart/quickstart-ruby)
+
+1. Set up a project in [Google](https://console.developers.google.com//start/api?id=drive&credential=client_key).
+2. Select the created project and select APIs & auth and make sure the status
+   is **ON** for the Drive API.
+3. In the sidebar on the left, select Credentials and set up new credentials
+   for this project.
+4. Download (as JSON) or save the client id and client secret.
+5. `bundle exec ruby gdsh.rb <credentials_json>` or `bundle exec ruby gdsh.rb`. In the former, credentials
+   will be automatically retrieved from JSON; in the latter, you will need to
+   copy and paste the `client_id` and `client_secret` from the credentials above.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gdsh

@@ -0,0 +1,10 @@
+#! /usr/bin/env ruby
+
+require_relative '../lib/gdsh'
+
+# if run as standalone script, launch shell
+if __FILE__ == $PROGRAM_NAME
+  filename = ARGV.first if ARGV.length > 0
+  s = Gdsh::Gdsh.new(filename)
+  s.shell
+end

data/document.txt

@@ -0,0 +1,2 @@
+hello
+world

data/gdsh.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gdsh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gdsh'
+  spec.version       = Gdsh::VERSION
+  spec.authors       = ['Emin Tham']
+  spec.email         = ['emintham@gmail.com']
+  spec.summary       = 'A Google Drive shell in Ruby.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/emintham/gdsh'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_runtime_dependency 'google-api-client'
+  spec.add_runtime_dependency 'launchy'
+  spec.add_runtime_dependency 'differ'
+  spec.add_runtime_dependency 'colorize'
+end

data/lib/gdsh.rb

@@ -0,0 +1,61 @@
+require 'google/api_client'
+require 'launchy'
+require 'json'
+
+require_relative 'gdsh/version'
+require_relative 'gdsh/drive'
+require_relative 'gdsh/command_factory'
+
+##
+# Implements a command interpreter to wrap Google Drive API.
+#
+module Gdsh
+  ##
+  # Gdsh Class
+  #
+  class Gdsh < DriveService
+    include CommandFactory
+
+    def puts_banner
+      puts ''
+      puts 'CLI tool to interface with Google Drive'.colorize(:green)
+      puts '======================================='.colorize(:green)
+    end
+
+    def puts_hint
+      puts 'Hint: type \'help\'.'.colorize(:green)
+    end
+
+    def clear_screen
+      system('clear') || system('cls')
+    end
+
+    def init_shell
+      puts_banner
+      authorize
+      clear_screen
+      puts_hint
+    end
+
+    def prints_prompt
+      print 'gdsh> '.colorize(:light_blue)
+    end
+
+    ##
+    # Command interpreter
+    #
+    def shell
+      init_shell
+
+      loop do
+        prints_prompt
+        params = parsed_inputs
+        command = next_command(params)
+        command.new(@client, params).execute
+        break if command.terminal?
+      end
+
+      write_session_info_to_file
+    end
+  end
+end

data/lib/gdsh/clear.rb

@@ -0,0 +1,20 @@
+require_relative 'commands'
+
+module Commands
+  ##
+  # Clear screen.
+  #
+  class Clear < Command
+    def self.command_name
+      'clear'
+    end
+
+    def self.function
+      'Clears the screen.'
+    end
+
+    def execute
+      system('clear') || system('cls')
+    end
+  end
+end

data/lib/gdsh/command_factory.rb

@@ -0,0 +1,32 @@
+require_relative 'commands'
+require_relative 'clear'
+require_relative 'help'
+require_relative 'list_files'
+require_relative 'query_revision'
+require_relative 'quit'
+require_relative 'unrecognized'
+require_relative 'upload_template'
+require_relative 'get_file'
+require_relative 'revision_diff'
+require_relative 'remove'
+require_relative 'share_read_only'
+require_relative 'share_read_write'
+
+##
+# Factory pattern to create the appropriate command.
+#
+module CommandFactory
+  include Commands
+
+  def parsed_inputs
+    # gets user input, defaulting to empty and removing newline
+    user_input = $stdin.gets || ''
+
+    # if command has parameters, split it up
+    user_input.chomp.split(/[\(,\),\,,\ ]/)
+  end
+
+  def next_command(params)
+    Commands.interpret(params[0])
+  end
+end

data/lib/gdsh/command_mixin.rb

@@ -0,0 +1,46 @@
+require 'colorize'
+
+##
+# Commands
+#
+module Commands
+  ##
+  # Command mixin
+  #
+  module CommandMixin
+    def execute
+      fail 'Method not implemented.'
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    ##
+    # Every 'useful' Command class should override the following
+    # (except terminal?)
+    #
+    module ClassMethods
+      def command_name
+        ''
+      end
+
+      def function
+        ''
+      end
+
+      def parameters
+        ''
+      end
+
+      def description
+        (command_name + parameters + ":\n  ").colorize(:green) + 
+        function.colorize(:yellow)
+      end
+
+      def terminal?
+        false
+      end
+    end
+  end
+end

data/lib/gdsh/commands.rb

@@ -0,0 +1,53 @@
+require 'google/api_client'
+require 'json'
+require 'colorize'
+
+require_relative 'command_mixin'
+require_relative 'error'
+
+##
+# Commands
+#
+module Commands
+  ##
+  # Command with an initialized client object.
+  #
+  class Command
+    include CommandMixin
+    include DriveError
+
+    def initialize(client, params)
+      @client, @params = client, params
+    end
+  end
+
+  module_function
+
+  def commands
+    constants.select { |c| const_get(c).is_a? Class }
+  end
+
+  def puts_usage_header
+    puts 'Commands'.colorize(:green)
+    puts '--------'.colorize(:green)
+  end
+
+  def usage
+    puts_usage_header
+    commands.each do |c|
+      klass = const_get(c)
+      puts klass.description unless klass.command_name.empty?
+    end
+  end
+
+  def interpret(input)
+    return Quit if input.nil?
+
+    commands.each do |c|
+      klass = const_get(c)
+      return klass if input == klass.command_name
+    end
+
+    Unrecognized
+  end
+end

data/lib/gdsh/drive.rb

@@ -0,0 +1,113 @@
+require 'google/api_client'
+require 'launchy'
+require 'json'
+require 'colorize'
+require 'yaml'
+
+##
+# DriveService module implements a service that interfaces with
+# Google Drive using Google Drive API.
+#
+class DriveService
+  ##
+  # Creates a new Google Drive Shell object.
+  #
+  # @param [String] filename
+  #   filename of json containing credentials downloaded from Google.
+  #
+  def initialize(filename = nil)
+    # default to per-file permissions
+    @oauth_scope = 'https://www.googleapis.com/auth/drive.file'
+    @redirect_uri = 'urn:ietf:wg:oauth:2.0:oob'
+    @filename = filename
+
+    if filename && File.exist?(filename)
+      credentials_from_file
+    else
+      credentials_from_stdin
+    end
+  end
+
+  def credentials_from_file
+    File.open(@filename, 'r') do |f|
+      buffer = f.read
+      credentials = JSON.parse(buffer)
+      @client_id = credentials['installed']['client_id']
+      @client_secret = credentials['installed']['client_secret']
+    end
+  end
+
+  def init_client
+    # Create a new API client & load the Google Drive API
+    @client = Google::APIClient.new
+
+    # Request authorization
+    @client.authorization.client_id = @client_id
+    @client.authorization.client_secret = @client_secret
+    @client.authorization.scope = @oauth_scope
+    @client.authorization.redirect_uri = @redirect_uri
+  end
+
+  def puts_refresh_error
+    puts 'Could not refresh token from saved session.'.colorize(:red)
+  end
+
+  def authorize
+    init_client
+
+    begin
+      authorize_from_refresh_token
+    rescue
+      puts_refresh_error
+      authorize_from_authorization_code
+    ensure
+      @client.authorization.fetch_access_token!
+    end
+  end
+
+  def authorize_from_refresh_token
+    fail StandardError unless File.exist?('.session.yaml')
+
+    f = File.open('.session.yaml', 'r')
+    session = YAML.load(f.read)
+    @client.authorization.grant_type = 'refresh_token'
+    @client.authorization.refresh_token = session.authorization.refresh_token
+    f.close
+  end
+
+  def authorize_from_authorization_code
+    uri = @client.authorization.authorization_uri
+    Launchy.open(uri)
+
+    # Exchange authorization code for access token
+    print 'Enter authorization code: '.colorize(:light_blue)
+    @client.authorization.code = $stdin.gets.chomp
+  end
+
+  ##
+  # Get credentials from shell if no credentials file was specified.
+  #
+  def credentials_from_stdin
+    # get preset if exists
+    @client_id ||= ''
+    @client_secret ||= ''
+
+    # Ask from user otherwise
+    if @client_id == ''
+      print 'Please enter your client id: '
+      @client_id = $stdin.gets.chomp
+    end
+
+    if @client_secret == ''
+      print 'Please enter your client secret: '
+      @client_secret = $stdin.gets.chomp
+    end
+  end
+
+  def write_session_info_to_file
+    return if @client.nil?
+    f = File.new('.session.yaml', 'w')
+    f.write(@client.to_yaml)
+    f.close
+  end
+end