box_cli 0.1.0

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/
+*.DS_Store
+coverage/*
+*.sw[op]
+tags
+!.keep

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+env:
+  - BOX_CLI_API_KEY=abodaciouskey BOX_CLI_USER=barack@whitehouse.gov BOX_CLI_PASSWORD=bananatime

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    box_cli (0.1.0)
+      active_support
+      box-api
+      commander
+      highline (~> 1.6.15)
+      mechanize
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    aruba (0.4.11)
+      childprocess (>= 0.2.3)
+      cucumber (>= 1.1.1)
+      ffi (>= 1.0.11)
+      rspec (>= 2.7.0)
+    bourne (1.2.0)
+      mocha (= 0.12.3)
+    box-api (0.2.2)
+      httmultiparty (~> 0.3.6)
+    builder (3.1.4)
+    childprocess (0.3.6)
+      ffi (~> 1.0, >= 1.0.6)
+    commander (4.1.2)
+      highline (~> 1.6.11)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    diff-lcs (1.1.3)
+    domain_name (0.5.4)
+      unf (~> 0.0.3)
+    fakeweb (1.3.0)
+    ffi (1.1.5)
+    gherkin (2.11.5)
+      json (>= 1.4.6)
+    highline (1.6.15)
+    httmultiparty (0.3.8)
+      httparty (>= 0.7.3)
+      multipart-post
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    json (1.7.5)
+    mechanize (2.5.1)
+      domain_name (~> 0.5, >= 0.5.1)
+      mime-types (~> 1.17, >= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (~> 2.5, >= 2.5.2)
+      nokogiri (~> 1.4)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (~> 0.0, >= 0.0.9)
+    metaclass (0.0.1)
+    mime-types (1.19)
+    mocha (0.12.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    multipart-post (1.1.5)
+    net-http-digest_auth (1.2.1)
+    net-http-persistent (2.8)
+    nokogiri (1.5.5)
+    ntlm-http (0.1.1)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    unf (0.0.5)
+      unf_ext
+    unf_ext (0.0.5)
+    vcr (2.2.5)
+    webrobots (0.0.13)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 0.4.11)
+  bourne (~> 1.2.0)
+  box_cli!
+  cucumber (~> 1.2.1)
+  fakeweb (~> 1.3.0)
+  mocha (~> 0.12.3)
+  rake (~> 0.9.2)
+  rspec (~> 2.11.0)
+  vcr (~> 2.2.5)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Iora Health
+
+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,81 @@
+
+# box_cli
+
+box_cli provides a basic and minimal command-line interface to Box (<https://www.box.com/>). It is not written by Box; use at your own risk. We hope that eventually Box will provide their own command-line interfaces for Linux, BSD, OS/X, Windows, etc. Until then, this may help.
+
+[![Build Status](https://api.travis-ci.org/IoraHealth/box_cli.png)](https://travis-ci.org/IoraHealth/box_cli)  
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/IoraHealth/box_cli)  
+
+## Install
+
+Install the gem:
+
+    gem install box_cli
+
+## Usage
+
+After installing the gem, you can run the command `box` to use the application. For help, type
+
+    box --help
+
+NOTE: All of the commands that communicate with Box require an API key and user credentials. To obtain your own Box API key, read the documentation here: <http://developers.box.net/w/page/12923956/ApiOverview#GettingStartedwiththeBoxAPI> -- We do not ship an API key with this gem, because you may be
+working off of a forked copy.
+
+When a command requires an API key and user credentials, it will find them in the following order:
+
+1. It will find the values in the options `--api_key`, `--user`, and `--password`
+2. Failing that, it will check for environment variables `BOX_CLI_API_KEY`, `BOX_CLI_USER`, and `BOX_CLI_PASSWORD`
+3. Failing that, it will prompt for the value from the keyboard
+
+You may define each of these options separately. In other words, if you define only the environment variables `BOX_CLI_API_KEY` and `BOX_CLI_USER`, you will
+be prompted only for the password.
+
+The most commonly-used commands are:
+
+    box info path
+    box upload file path
+    box download path
+    box delete path
+    box account_info
+    
+The commands adhere fairly closely to the Box API, as defined by the list of calls in the right sidebar at the developer site: <http://developers.box.net/w/page/12923956/ApiOverview>. For example, `box account_info` might produce an interaction similar to this:
+
+    $ box account_info
+    Status: get_account_info_ok
+    User:   
+       Login:           john@iorahealth.com
+       Email:           john@iorahealth.com
+       Access:          11756654
+       User:            11756654
+       Space amount:    21474836480
+       Space used:      1657381056
+       Max upload size: 2147483647
+
+To understand what the status value "get_account_info_ok" means, consult the documentation for the API call that corresponds to the command (i.e., <http://developers.box.net/w/page/12923928/ApiFunction_get_account_info>).
+
+## Testing
+
+To run all tests that don't require exercising box directly, set the BOX_CLI_* environment variables. Unless they are
+set to something, the console will be prompted for values. The values don't have to be realistic.
+
+    BOX_CLI_API_KEY=abodaciouskey BOX_CLI_USER=barack@whitehouse.gov BOX_CLI_PASSWORD=bananatime bundle exec rake
+
+Many of the Cucumber features require a *working* Box API key and user credentials, which should be defined through environment variables. The default rake task excludes all features tagged with `@requires_authorization` so that TravisCI will not exercise the actual service. This means that if you make changes in features, you should verify by running cucumber directly (not through rake) with your own key, user, and password:
+
+    BOX_CLI_API_KEY=pzay0j0o2psakijtm9ysn2jjd2ho7qg5 BOX_CLI_USER=box_cli_testing@iorahealth.com BOX_CLI_PASSWORD=secretpassword01 bundle exec cucumber
+
+NOTE: If you recreate the VCR cassettes, make sure to invalidate your API key and credentials before making a pull request or anything else that would reveal your key or credentials. While we've set VCR to filter out these sensitive data, don't run the risk of something getting captured.
+
+## Contributing to box_cli
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Iora Health. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+desc 'Default: run specs and features'
+task :default => [:spec, :cucumber]
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--color', '--format progress']
+  t.pattern = 'spec/box_cli/**/*_spec.rb'
+end
+
+desc 'Run cucumber features'
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = [
+    '--tags', '~@wip',
+    '--tags', '~@requires_authorization',
+    '--format', (ENV['CUCUMBER_FORMAT'] || 'progress')
+  ]
+end

data/bin/box

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'commander/import'
+require 'box_cli'
+
+program :version,        BoxCli::VERSION
+program :description,    'CLI for box'
+program :help_formatter, :compact
+program :help, 'Note', "When a file item and a folder item have the same name, generic commands such as 'delete' will delete the file first."
+
+global_option '-k', '--api_key API_KEY',   String, 'api key'
+global_option '-u', '--user USER',         String, 'username or email address'
+global_option '-p', '--password PASSWORD', String, 'password'
+
+def make_command(name, syntax, description)
+  command name do |c|
+    c.syntax = syntax
+    c.description = description
+    c.action { |args, options| exit BoxCli.dispatch(c.name, options, args) }
+  end
+end
+
+make_command :account_info,     'box account_info',              'Show account information'
+make_command :create_folder,    'box create_folder folder_name', 'Create a folder named folder_name in the root folder'
+make_command :delete,           'box delete path',               'Delete whatever is at path'
+make_command :info,             'box info [path]',               'Show info for path (default: root)'
+make_command :settings,         'box settings',                  'Show settings'
+make_command :upload,           'box upload path folder_path',   'Upload the file at path to folder_path'

data/box-cli.gemspec

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift File.expand_path(File.join('..', 'lib'), __FILE__)
+require 'box_cli/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'box_cli'
+  s.version       = BoxCli::VERSION
+  s.date          = Time.now.utc.strftime('%Y-%m-%d')
+  s.summary       = 'CLI for box'
+  s.description   = 'CLI for box'
+  s.authors       = ['Iora Health']
+  s.email         = 'rubygems@iorahealth.com'
+  s.files         = `git ls-files`.split("\n")
+  s.homepage      = 'https://github.com/IoraHealth/box_cli'
+  s.rdoc_options  = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.test_files    = `git ls-files spec`.split("\n")
+  s.add_dependency 'box-api'
+  s.add_dependency 'active_support'
+  s.add_dependency 'commander'
+  s.add_dependency 'highline',             '~> 1.6.15'
+  s.add_dependency 'mechanize'
+  s.executables << 'box'
+
+  s.add_development_dependency 'aruba',    '~> 0.4.11'
+  s.add_development_dependency 'bourne',   '~> 1.2.0'
+  s.add_development_dependency 'cucumber', '~> 1.2.1'
+  s.add_development_dependency 'fakeweb',  '~> 1.3.0'
+  s.add_development_dependency 'mocha',    '~> 0.12.3'
+  s.add_development_dependency 'rake',     '~> 0.9.2'
+  s.add_development_dependency 'rspec',    '~> 2.11.0'
+  s.add_development_dependency 'vcr',      '~> 2.2.5'
+end

data/features/account_info_command.feature

@@ -0,0 +1,12 @@
+Feature: account_info command
+
+  In order to use box from the command line
+  As a CLI user
+  I want to be able to see my account info
+
+  @requires_authorization
+  Scenario: Get account info
+    When I've set the box cli env variables
+    And I run `box account_info`
+    Then the output should match /Space used:\s+\d+/
+    And the exit status should be 0

data/features/cli.feature

@@ -0,0 +1,21 @@
+Feature: cli basics
+
+  In order to use box from the command line
+  As a CLI user
+  I want to be able to run box and specify some options
+
+  Scenario: use the box command with no command
+    When I run `box`
+    Then the exit status should be 1
+
+  Scenario: use the box command with an unrecognized command
+    When I run `box foobar`
+    Then the exit status should be 1
+
+  Scenario: use the box command with a valid command
+    When I run `box --version`
+    Then the exit status should be 0
+
+  Scenario: use the box command to get help
+    When I run `box help`
+    Then the output should contain "CLI for box"

data/features/create_folder_command.feature

@@ -0,0 +1,11 @@
+Feature: create folder command
+
+  In order to use box from the command line
+  As a CLI user
+  I want to be able to create a folder
+
+  @requires_authorization
+  Scenario: create a new folder
+    When I've set the box cli env variables
+    And I create a temporary folder at box
+    And there should be something at the temporary path

data/features/delete_command.feature

@@ -0,0 +1,21 @@
+Feature: delete command
+
+  In order to use box from the command line
+  As a CLI user
+  I want to be able to delete files and folders
+
+  @requires_authorization
+  Scenario: delete a folder
+    When I've set the box cli env variables
+    And I create a temporary folder at box
+    And I run `box delete` on the temporary path
+    Then the exit status should be 0
+    And there should be nothing at the temporary path
+
+  @requires_authorization
+  Scenario: delete a file
+    When I've set the box cli env variables
+    And I create a temporary file at box
+    And I run `box delete` on the temporary path
+    Then the exit status should be 0
+    And there should be nothing at the temporary path

data/features/info_command.feature

@@ -0,0 +1,20 @@
+Feature: info command
+
+  In order to use box from the command line
+  As a CLI user
+  I want to be able to see info for what's at a path
+
+  @requires_authorization
+  Scenario: get info about root
+    When I've set the box cli env variables
+    And I run `box info`
+    Then the output should match /^Type: folder\s+Data:\s+Id: 0$/
+    And the exit status should be 0
+    
+  @requires_authorization
+  Scenario: get info about a folder
+    When I've set the box cli env variables
+    And I create a temporary folder at box
+    And I run `box info` on the temporary path
+    Then the output should match /^Type: folder\s+Data:/
+    And the exit status should be 0

data/features/settings_command.feature

@@ -0,0 +1,48 @@
+Feature: settings command
+
+  In order to use box from the command line
+  As a CLI user
+  I want to be able to show settings
+
+  Scenario: show all settings
+    When I run `box settings --user john --password 123456 --api_key abc`
+    Then the output should match:
+      """
+        api_key: abc
+        password: 123456
+        user: john
+      """
+
+  Scenario: show all settings and arguments
+    When I run `box settings --user john --password 123456 --api_key abc arg2 arg1`
+    Then the output should match:
+      """
+        api_key: abc
+        password: 123456
+        user: john
+      .*
+        arg2
+        arg1
+      """
+
+  Scenario: show settings when defined by environment variables
+    When I unset all env variables matching /BOX_CLI_/
+    And I set env variable "BOX_CLI_USER" to "john"
+    And I run `box settings --password 123456 --api_key abc`
+    Then the output should match:
+      """
+        api_key: abc
+        password: 123456
+        user: john
+      """
+
+  Scenario: Have explicit setting override environment variable
+    When I unset all env variables matching /BOX_CLI_/
+    And I set env variable "BOX_CLI_USER" to "john"
+    And I run `box settings --password 123456 --api_key abc --user booboo`
+    Then the output should match:
+      """
+        api_key: abc
+        password: 123456
+        user: booboo
+      """

data/features/step_definitions/box.rb

@@ -0,0 +1,43 @@
+require 'box_cli/wrapper'
+
+When /^I create a temporary folder at box$/ do
+  setup_filename
+  box_wrapper.create_folder(box_path)
+end
+
+When /^I create a local temporary file$/ do
+  create_local_file
+end
+
+When /^I create a temporary file at box$/ do
+  create_local_file
+  box_wrapper.upload(local_filename, '/')
+end
+
+Then /^there should be something at the temporary path$/ do
+  box_wrapper.info(box_path)
+end
+
+Then /^there should be nothing at the temporary path$/ do
+  begin
+    box_wrapper.info(box_path)
+    raise "Expected nothing at '#{box_path}'"
+  rescue BoxCli::NotFound
+  end
+end
+
+When /^I run `box delete` on the temporary path$/ do
+  step "I run `box delete #{box_path}`"
+end
+
+When /^I run `box info` on the temporary path$/ do
+  step "I run `box info #{box_path}`"
+end
+
+When /^I run `box upload` for a local temporary file$/ do
+  step "I run `box upload #{local_filename} /`"
+end
+
+When /^I create a folder named "(.*?)"$/ do |folder_name|
+  step "I run `box create_folder #{folder_name}`"
+end

data/features/step_definitions/environment.rb

@@ -0,0 +1,12 @@
+When /^I unset all env variables matching \/([^\/]*)\/$/ do |regexp|
+  ENV.keys.find_all { |k| k =~ Regexp.new(regexp) }.each { |k| ENV[k] = nil }
+end
+
+When /^I set env variable "(\w+)" to "([^"]*)"$/ do |var, value|
+  ENV[var] = value
+end
+
+When /^I've set the box cli env variables$/ do
+  required_env_vars = ['BOX_CLI_API_KEY', 'BOX_CLI_USER', 'BOX_CLI_PASSWORD']
+  raise "\n\n* You must define the env variables #{required_env_vars.join(', ')} *\n\n\n" unless required_env_vars.all? { |v| !ENV[v].nil? }
+end

data/features/support/box_helpers.rb

@@ -0,0 +1,63 @@
+require 'box_cli/auth_token_manager'
+require 'box_cli/wrapper'
+
+module BoxHelpers
+  attr_reader :box_path, :local_filename
+  
+  def setup_filename
+     @box_path = "box_cli_" + Digest::MD5.hexdigest(Time.now.strftime('%FT%T.%N%:z') + rand.to_s).tap do |path|
+       # Ensure that there's nothing there
+       delete_all_at_path(path)
+     end
+  end
+
+  def box_wrapper
+    @box_wrapper ||= BoxCli::Wrapper.new(ENV['BOX_CLI_API_KEY'], ENV['BOX_CLI_USER'], ENV['BOX_CLI_PASSWORD'])
+  end
+
+  def create_local_file
+    setup_filename
+    @local_filename = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'tmp', @box_path))
+    FileUtils.touch @local_filename
+    @filenames ||= []
+    @filenames <<  @local_filename
+  end
+
+  private
+
+  def delete_all_at_path(path)
+    # Twice, because a file and a folder can live at the same path
+    delete_at_path(path)
+    delete_at_path(path)
+  end
+
+  def delete_at_path(path)
+    begin
+      box_wrapper.delete(path)
+    rescue BoxCli::NotFound
+    rescue Box::Api::Unknown  # Sometimes deletion is in progress?
+    end
+  end
+end
+
+def box_before
+  @save_env = {
+    :box_cli_api_key  => ENV['BOX_CLI_API_KEY'],
+    :box_cli_user     => ENV['BOX_CLI_USER'],
+    :box_cli_password => ENV['BOX_CLI_PASSWORD']
+  }
+end
+
+def box_after
+  if @box_path
+    delete_all_at_path(@box_path)
+  end
+
+  FileUtils.rm @filenames if @filenames
+  
+  ENV['BOX_CLI_API_KEY']  = @save_env[:box_cli_api_key]
+  ENV['BOX_CLI_USER']     = @save_env[:box_cli_user]
+  ENV['BOX_CLI_PASSWORD'] = @save_env[:box_cli_password]
+end
+
+World(BoxHelpers)

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require 'aruba/cucumber'
+
+Before('@requires_authorization') do
+  @aruba_timeout_seconds = 10
+  @aruba_io_wait_seconds = 10
+end

data/features/support/hooks.rb

@@ -0,0 +1,7 @@
+Before do
+  box_before
+end
+
+After do
+  box_after
+end

data/features/upload_command.feature

@@ -0,0 +1,20 @@
+Feature: upload command
+
+  In order to use box from the command line
+  As a CLI user
+  I want to be able to upload a file to a path
+  
+  @requires_authorization
+  Scenario: upload a file
+    When I've set the box cli env variables
+    And I create a local temporary file
+    And I run `box upload` for a local temporary file
+    Then the exit status should be 0
+
+  @requires_authorization
+  Scenario: upload a file when one already exists with the same name
+    When I've set the box cli env variables
+    And I create a local temporary file
+    And I run `box upload` for a local temporary file
+    And I run `box upload` for a local temporary file
+    Then the exit status should be 1