browse-everything 0.1.0

data/spec/spec_helper.rb.orig

@@ -0,0 +1,47 @@
+require File.expand_path("config/environment", ENV['RAILS_ROOT'] || File.expand_path("../internal", __FILE__))
+<<<<<<< HEAD
+require 'rspec/rails'
+require 'webmock/rspec'
+=======
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+module BrowserConfigHelper
+  def url_options
+    {
+      protocol: 'http://',
+      host: 'browse-everything.example.edu'
+    }
+  end
+
+  def stub_configuration
+    BrowseEverything.configure({
+      "file_system" => {
+        home: File.expand_path('../fixtures/file_system',__FILE__)
+      },
+      "box" => {
+        client_id: "BoxClientId",
+        client_secret: "BoxClientSecret"
+      },
+      "drop_box" => { 
+        app_key: "DropBoxAppKey", 
+        app_secret: "DropBoxAppSecret"
+      },
+      "google_drive" => {
+        client_id: "GoogleClientId",
+        client_secret: "GoogleClientSecret"
+      },
+      "sky_drive" => {
+        client_id: "SkyDriveClientId",
+        client_secret: "SkyDriveClientSecret"
+      }
+    })
+  end
+
+  def unstub_configuration
+    BrowseEverything.configure(nil)
+  end
+end
+>>>>>>> Add coverage and configuration stubs

data/spec/support/app/controllers/file_handler_controller.rb

@@ -0,0 +1,8 @@
+class FileHandlerController < ApplicationController
+  def index
+  end
+  
+  def update
+    render :json => params[:selected_files].to_json
+  end
+end

data/spec/support/app/views/file_handler/index.html.erb

@@ -0,0 +1,22 @@
+<div class="hero-unit">
+  <h1>Welcome!</h1>
+
+  <p>Please click the button below to start pickin' files!</p>
+
+  <%= form_tag(browse_everything_file_handler_path, id: 'main_form', method: 'post') do %>
+    <%= button_tag("Browse", type: 'button', class: 'btn btn-large btn-success', id: "browse-btn",
+      'data-toggle' => 'browse-everything', 'data-route' => browse_everything_engine.root_path,
+      'data-target' => '#main_form' ) %>
+    <%= button_tag("Submit", type: 'submit', class: 'btn btn-large btn-primary', id: "submit-btn") %>
+  <% end %>
+
+  <p id="status">0 items selected</p>
+
+  <script>
+    $(document).ready(function() {
+      $('#browse-btn').browseEverything()
+        .done(function(data) { $('#status').html(data.length.toString() + " items selected") })
+        .cancel(function()   { window.alert('Canceled!') });
+    });
+  </script>
+</div>

data/spec/support/config/browse_everything_providers.yml.example

@@ -0,0 +1,15 @@
+---
+file_system:
+  :home: SERVER_SIDE_BROWSE_ROOT
+box:
+  :client_id: YOUR_BOX_CLIENT_ID
+  :client_secret: YOUR_BOX_CLIENT_SECRET
+drop_box:
+  :app_key: YOUR_DROPBOX_APP_KEY
+  :app_secret: YOUR_DROPBOX_APP_SECRET
+google_drive:
+  :client_id: YOUR_GOOGLE_API_CLIENT_ID
+  :client_secret: YOUR_GOOGLE_API_CLIENT_SECRET
+sky_drive:
+  :client_id: YOUR_MS_LIVE_CONNECT_CLIENT_ID
+  :client_secret: YOUR_MS_LIVE_CONNECT_CLIENT_SECRET

data/spec/support/lib/generators/test_app_generator.rb

@@ -0,0 +1,50 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../../support", __FILE__)
+  def inject_css
+    copy_file "../internal/app/assets/stylesheets/application.css", "app/assets/stylesheets/application.css.scss"
+    remove_file "app/assets/stylesheets/application.css"
+    insert_into_file "app/assets/stylesheets/application.css.scss", :after => '*/' do
+      %{\n\n@import "browse_everything"}
+    end
+  end
+
+  def inject_javascript
+    insert_into_file "app/assets/javascripts/application.js", :after => '//= require_tree .' do
+      "\n//= require browse_everything"
+    end
+  end
+
+  def inject_application
+    insert_into_file "config/application.rb", :after => 'Rails::Application' do
+      "\nconfig.autoload_paths+=[File.join(Rails.root,'../../lib')]"
+    end
+  end
+
+  def inject_routes
+    insert_into_file "config/routes.rb", :after => ".draw do" do
+      %{
+
+  mount BrowseEverything::Engine => '/browse'
+  root :to => "file_handler#index"
+  post '/file', :to => "file_handler#update", :as => "browse_everything_file_handler"
+      }
+    end
+  end
+
+  def create_bev_configuration
+    create_file "config/browse_everything_providers.yml" do
+      YAML.dump({ 'file_system' => { :home => Rails.root.to_s }})
+    end
+  end
+
+  def create_test_route
+    copy_file "app/controllers/file_handler_controller.rb", "app/controllers/file_handler_controller.rb"
+    copy_file "app/views/file_handler/index.html.erb", "app/views/file_handler/index.html.erb"
+  end
+
+  def copy_example_config
+    copy_file "config/browse_everything_providers.yml.example", "config/browse_everything_providers.yml.example"
+  end
+end

data/spec/unit/base_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../../spec_helper',__FILE__)
+
+include BrowserConfigHelper
+
+describe BrowseEverything::Driver::Base do
+  subject { BrowseEverything::Driver::Base.new({}) }
+
+  describe "simple properties" do
+    its(:name)      { should == 'Base'         }
+    its(:key)       { should == 'base'         }
+    its(:icon)      { should be_a(String)      }
+    its(:auth_link) { should be_empty          }
+    specify         { should_not be_authorized }
+  end
+  context "#connect" do
+    specify { subject.connect({},{}).should be_blank }
+  end
+  context "#contents" do
+    specify { subject.contents('').should be_empty }
+  end
+  context "#details" do
+    specify { subject.details('/path/to/foo.txt').should be_nil }
+  end
+  context "#link_for" do
+    specify { subject.link_for('/path/to/foo.txt').should == '/path/to/foo.txt' }
+  end
+end
+

data/spec/unit/browser_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path('../../spec_helper',__FILE__)
+
+include BrowserConfigHelper
+
+describe BrowseEverything::Browser do
+  let(:file_config) { 
+    {
+      file_system: { home: '/file/config/home' },
+      drop_box:    { app_key: 'FileConfigKey', app_secret: 'FileConfigSecret' }
+    }.to_yaml
+  }
+
+  let(:global_config) {
+    {
+      file_system: { home: '/global/config/home' },
+      drop_box:    { app_key: 'GlobalConfigKey', app_secret: 'GlobalConfigSecret' }
+    }
+  }
+
+  let(:local_config) {
+    {
+      file_system: { home: '/local/config/home' },
+      drop_box:    { app_key: 'LocalConfigKey', app_secret: 'LocalConfigSecret' },
+      url_options: url_options
+    }
+  }
+
+  describe "file config" do
+    before(:each) { File.stub(:read).and_return(file_config) }
+    subject { BrowseEverything::Browser.new(url_options) }
+
+    it "should have 2 providers" do
+      expect(subject.providers.keys).to eq([:file_system,:drop_box])
+    end
+
+    it "should use the file configuration" do
+      expect(subject.providers[:drop_box].config[:app_key]).to eq('FileConfigKey')
+    end
+  end
+
+  describe "global config" do
+    before(:each) { BrowseEverything.configure(global_config) }
+    subject { BrowseEverything::Browser.new(url_options) }
+    
+    it "should have 2 providers" do
+      expect(subject.providers.keys).to eq([:file_system,:drop_box])
+    end
+
+    it "should use the global configuration" do
+      expect(subject.providers[:drop_box].config[:app_key]).to eq('GlobalConfigKey')
+    end
+  end
+
+  describe "local config" do
+    subject { BrowseEverything::Browser.new(local_config) }
+    
+    it "should have 2 providers" do
+      expect(subject.providers.keys).to eq([:file_system,:drop_box])
+    end
+
+    it "should use the local configuration" do
+      expect(subject.providers[:drop_box].config[:app_key]).to eq('LocalConfigKey')
+    end
+  end
+
+  describe "unknown provider" do
+    subject { 
+      BrowseEverything::Browser.new(local_config.merge(foo: { key: 'bar', secret: 'baz' }))
+    }
+
+    it "should complain but continue" do
+      Rails.logger.should_receive(:warn).with('Unknown provider: foo')
+      expect(subject.providers.keys).to eq([:file_system,:drop_box])
+    end
+  end
+end

data/spec/unit/drop_box_spec.rb

@@ -0,0 +1,119 @@
+require File.expand_path('../../spec_helper',__FILE__)
+
+include BrowserConfigHelper
+
+describe BrowseEverything::Driver::DropBox, vcr: { cassette_name: 'dropbox', record: :none } do
+  before(:all)  { stub_configuration   }
+  after(:all)   { unstub_configuration }
+
+  let(:browser) { BrowseEverything::Browser.new(url_options) }
+  let(:provider) { browser.providers['drop_box'] }
+  let(:auth_params) { {
+    'code' => 'FakeDropboxAuthorizationCodeABCDEFG',
+    'state' => 'GjDcUhPNZrZzdsw%2FghBy2A%3D%3D|drop_box'
+  } }
+  let(:csrf_data) { {token: 'GjDcUhPNZrZzdsw%2FghBy2A%3D%3D'} }
+
+  it "#validate_config" do
+    expect { BrowseEverything::Driver::DropBox.new({}) }.to raise_error(BrowseEverything::InitializationError)
+  end
+
+  describe "simple properties" do
+    subject    { provider                 }
+    its(:name) { should == 'Drop Box'     }
+    its(:key)  { should == 'drop_box'     }
+    its(:icon) { should be_a(String)      }
+  end
+
+  context "authorization" do
+    subject { provider }
+
+    specify { should_not be_authorized }
+
+    context "#auth_link" do
+      specify { subject.auth_link[0].should start_with('https://www.dropbox.com/1/oauth2/authorize') }
+    end
+    
+    it "should authorize" do
+      subject.connect(auth_params,csrf_data)
+      expect(subject).to be_authorized
+    end
+  end
+
+  describe "#contents" do
+    before(:each) { provider.connect(auth_params,csrf_data) }
+
+    context "root directory" do
+      let(:contents) { provider.contents('') }
+      context "[0]" do
+        subject { contents[0] }
+        its(:name) { should == 'Apps'    }
+        specify    { should be_container }
+      end
+      context "[1]" do
+        subject { contents[1] }
+        its(:name) { should == 'Books'   }
+        specify    { should be_container }
+      end
+      context "[4]" do
+        subject { contents[4] }
+        its(:name)     { should == 'iPad intro.pdf'           }
+        its(:size)     { should == '203.3 KB'                 }
+        its(:location) { should == "drop_box:/iPad intro.pdf" }
+        its(:type)     { should == "application/pdf"          }
+        specify        { should_not be_container              }
+      end
+    end
+
+    context "subdirectory" do
+      let(:contents) { provider.contents('/Writer') }
+      context "[0]" do
+        subject { contents[0] }
+        its(:name) { should == '..'      }
+        specify    { should be_container }
+      end
+      context "[1]" do
+        subject { contents[1] }
+        its(:name)     { should == 'About Writer.txt'      }
+        its(:location) { should == "drop_box:/Writer/About Writer.txt" }
+        its(:type)     { should == "text/plain"      }
+        specify        { should_not be_container     }
+      end
+      context "[2]" do
+        subject { contents[2] }
+        its(:name)     { should == 'Markdown Test.txt'      }
+        its(:location) { should == "drop_box:/Writer/Markdown Test.txt" }
+        its(:type)     { should == "text/plain"      }
+        specify        { should_not be_container     }
+      end
+      context "[3]" do
+        subject { contents[3] }
+        its(:name)     { should == 'Writer FAQ.txt'      }
+        its(:location) { should == "drop_box:/Writer/Writer FAQ.txt" }
+        its(:type)     { should == "text/plain"      }
+        specify        { should_not be_container     }
+      end
+    end
+
+    context "#details" do
+      subject { provider.details('') }
+      its(:name) { should == 'Apps'    }
+    end
+  end
+
+  describe "#link_for" do
+    before(:each) { provider.connect(auth_params,csrf_data) }
+
+    context "[0]" do 
+      subject { provider.link_for('/Writer/Writer FAQ.txt') }
+      specify { subject[0].should == "https://dl.dropboxusercontent.com/1/view/FakeDropboxAccessPath/Writer/Writer%20FAQ.txt" }
+      specify { subject[1].should have_key(:expires) }
+    end
+
+    context "[1]" do 
+      subject { provider.link_for('/Writer/Markdown Test.txt') }
+      specify { subject[0].should == "https://dl.dropboxusercontent.com/1/view/FakeDropboxAccessPath/Writer/Markdown%20Test.txt" }
+      specify { subject[1].should have_key(:expires) }
+    end
+  end
+end

data/spec/unit/file_entry_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../../spec_helper',__FILE__)
+
+describe BrowseEverything::FileEntry do
+  let(:mtime) { Time.now }
+  subject { 
+    BrowseEverything::FileEntry.new(
+      'file_id_01234', 'my_provider:/location/pa/th/file.m4v',
+      'file.m4v', '1.2 GB', mtime, false
+    )
+  }
+
+  it "should be a BrowseEverything::FileEntry" do
+    expect(subject).to be_a BrowseEverything::FileEntry                     
+  end
+
+  it "#id" do
+    expect(subject.id).to eq("file_id_01234")
+  end
+
+  it "#location" do
+    expect(subject.location).to eq("my_provider:/location/pa/th/file.m4v")
+  end
+
+  it "#name" do
+    expect(subject.name).to eq("file.m4v")
+  end
+
+  it "#size" do
+    expect(subject.size).to eq("1.2 GB")
+  end
+
+  it "#mtime" do
+    expect(subject.mtime).to eq(mtime)
+  end
+
+  it "#type" do
+    expect(subject.type).to eq("video/mp4")
+  end
+
+  it "#container?" do
+    expect(subject.container?).to be_false                                  
+  end
+
+end

data/spec/unit/file_system_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path('../../spec_helper',__FILE__)
+
+include BrowserConfigHelper
+
+describe BrowseEverything::Driver::FileSystem do
+  before(:all)  { stub_configuration   }
+  after(:all)   { unstub_configuration }
+  let(:home)    { File.expand_path(BrowseEverything.config['file_system'][:home]) }
+  let(:browser) { BrowseEverything::Browser.new(url_options) }
+  let(:provider) { browser.providers['file_system'] }
+
+  it "#validate_config" do
+    expect { BrowseEverything::Driver::FileSystem.new({}) }.to raise_error(BrowseEverything::InitializationError)
+  end
+
+  describe "simple properties" do
+    subject    { provider                }
+    its(:name) { should == 'File System' }
+    its(:key)  { should == 'file_system' }
+    its(:icon) { should be_a(String)     }
+    specify    { should be_authorized    }
+  end
+
+  describe "#contents" do
+    context "root directory" do
+      let(:contents) { provider.contents('/') }
+      context "[0]" do
+        subject { contents[0] }
+        its(:name) { should == 'dir_1'   }
+        specify    { should be_container }
+      end
+      context "[1]" do
+        subject { contents[1] }
+        its(:name) { should == 'dir_2'   }
+        specify    { should be_container }
+      end
+      context "[2]" do
+        subject { contents[2] }
+        its(:name)     { should == 'file_1.pdf'              }
+        its(:size)     { should == 2256                      }
+        its(:location) { should == "file_system:#{File.join(home,'file_1.pdf')}" }
+        its(:type)     { should == "application/pdf"         }
+        specify        { should_not be_container             }
+      end
+    end
+
+    context "subdirectory" do
+      let(:contents) { provider.contents('/dir_1') }
+      context "[0]" do
+        subject { contents[0] }
+        its(:name) { should == '..'      }
+        specify    { should be_container }
+      end
+      context "[1]" do
+        subject { contents[1] }
+        its(:name) { should == 'dir_3'   }
+        specify    { should be_container }
+      end
+      context "[2]" do
+        subject { contents[2] }
+        its(:name)     { should == 'file_2.txt'      }
+        its(:location) { should == "file_system:#{File.join(home,'dir_1/file_2.txt')}" }
+        its(:type)     { should == "text/plain"      }
+        specify        { should_not be_container     }
+      end
+    end
+
+    context "single file" do
+      let(:contents) { provider.contents('/dir_1/dir_3/file_3.m4v') }
+      context "[0]" do
+        subject { contents[0] }
+        its(:name)     { should == 'file_3.m4v'      }
+        its(:location) { should == "file_system:#{File.join(home,'dir_1/dir_3/file_3.m4v')}" }
+        its(:size)     { should == 3879              }
+        its(:type)     { should == "video/mp4"       }
+        specify        { should_not be_container     }
+      end
+    end
+  end
+
+  describe "#link_for('/path/to/file')" do
+    subject { provider.link_for('/path/to/file') }
+    it { should == "file:///path/to/file" }
+  end
+end