browse-everything 0.3.0 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjFkMzhlOTI5ZmE2NWViNTM1ZGE1ZGZmM2E4NGI4ZDMzMWVhMDE3Mw==
+    OGZmMTA5NTFiMmVjY2M2YWUzMTU0Mzc0NzI3ZWJmZDFjY2ZjYTkzNg==
   data.tar.gz: !binary |-
-    ZTY1NzA0OGZkMjMyZWQ3YTY2ZDYwMjg3MWQ1ZDgwNmU1NDU2N2JkMg==
+    MDUwODBiZWQ1NDRiMDRmZThlNWJmN2I3NDU5MjM5YzMzMmMyMGE4OA==
 SHA512:
   metadata.gz: !binary |-
-    OTQ2OGI4MDAwMTczNTdjMTZmZDhkNzAwOGY0MjlhNjVmZTlkMDFiY2ZmNGZk
-    ZGYyYzA0Yzk3ZmVkN2ExYmMwY2FmYTIwYjY5MjFmY2E2N2QwOTI0MmM5N2Fm
-    YzE1YzdhOTg0ZWVjOTZjMGNmMThkYzVjODkxNmMxNjQ3MmQyYTI=
+    ZWE3YjBiNTM5OWNlOWI2ZDU3ZTJhYTYzMTE2MWQ3M2I1ZjBiZWRjMTRkYmY5
+    MzZjMjI0ZThmNWJiOTM2ZThjMTA2Njc5ZDFiZTc4ZTJhNTFmZTk3ODRkOGFh
+    ODE2YzQxMTFkOWQzMmUwNDFlMDMxMWU2MzRjMWZkYzBlOGE4NjE=
   data.tar.gz: !binary |-
-    NGJmMDBlODBmMDA4MDY1YTI5MjY2OTdkYmViYzIyNTc5ODlkMDJlZDY3ZmEw
-    YjcxYjM1ZmU1YzFjNDhjMDc0NmZjNWU2ZDRkNTAzNDA4NjJlMDYzYzJlNGEz
-    NmU0MzE0Yzk4ZDRjODg5OGZmZTA5MmJmMzU2NWYyZmQ0YzE1YTM=
+    ZGI3OGRhYmYwODgwMGYyOTA3Nzk0MzgwZmEzNmYwMjFiYjc0NTY2OTkxMjY5
+    NWUyNDA2NDYwNDExNDJkNWU5MzBhM2JmMTYyMDEyOGY3MDMxYzU2MjhkNWFh
+    YTM4MDFhOTI0NGE3NDY3ODMyZDg5MzhiNzc4NzIxNDU2ZWMyMmQ=

data/HISTORY.md

@@ -1,3 +1,7 @@
+### 0.4.0 (2014-04-01)
+- Added configuration generator
+- Improved documentation
+
 ### 0.3.0 (2014-03-24)
 - Additional response parameters
 - Refresh token fixes for Box, SkyDrive, and Google Drive

data/README.md

@@ -25,75 +25,36 @@ And then execute:
 Or install it yourself as:
 
     $ gem install browse-everything
+   
+### Configuring the gem
+ 
+After installing the gem, run the generator
 
-## Usage
-
-### Configuration
-
-To use the gem you will need to configure the providers by providing applcation keys that are required by each provider
-
-An example config/browse_everything_providers.yml:
-
-```yaml
----
-file_system:
-  :home: /<location for server file drop>
-sky_drive:
-  :client_id: <your client id>
-  :client_secret: <your client secret>
-box:
-  :client_id: <your client id>
-  :client_secret: <your client secret>
-drop_box:
-  :app_key: <your client id>
-  :app_secret: <your app secret>
-google_drive:
-  :client_id: <your client id>
-  :client_secret: <your client secret>
-```
+    $ rails g browse_anything:config
+    
+This generator will set up the _config/browse_everything_providers.yml_ file and add the browse-everything engine to your application's routes.
 
-You must register your application with each cloud provider separately:
+If you prefer not to use the generator, or need info on how to set up providers in the browse_everything_providers.yml, use the info on [Configuring browse-everything](https://github.com/projecthydra/browse-everything/wiki/Configuring-browse-everything).  
 
-* Skydrive: [https://account.live.com/developers/applications/create](https://account.live.com/developers/applications/create)
-* Dropbox: [https://www.dropbox.com/developers/apps/create](https://www.dropbox.com/developers/apps/create)
-* Box: [https://app.box.com/developers/services/edit/](https://app.box.com/developers/services/edit/)
-* GoogleDrive: [https://code.google.com/apis/console](https://code.google.com/apis/console)
-
-### CSS and JavaScript Modifications
+### Include the CSS and JavaScript 
 
 Add `@import "browse_everything";` to your application.css.scss
 
 Add `//= require browse_everything` to your application.js
 
-### Routes
+## Usage
 
-Mount the engine in your routes.rb
-
-```
-  mount BrowseEverything::Engine => '/browse'
-```
+### Adding Providers
+In order to connect to a provider like [DropBox](http://www.dropbox.com), 
+[Skydrive](https://skydrive.live.com/), [Google Drive](http://drive.google.com), or
+[Box](http://www.box.com), you must provide API keys in _config/browse_everything_providers.yml_.  For info on how to edit this file, see [Configuring browse-everything](https://github.com/projecthydra/browse-everything/wiki/Configuring-browse-everything)
 
 ### Views
 
-browse-everything can be triggered in one of two ways:
-
-#### Via data attributes
-
-```html
-<button type="button" data-toggle="browse-everything" data-route="<%=browse_everything_engine.root_path%>" 
-  data-target="#myForm" class="btn btn-large btn-success" id="browse">Browse!</button>
-```
-
-#### Via JavaScript
-
-```javascript
-$('#browse').browseEverything(options)
-```
+browse-everything can be triggered in two ways -- either via data attributes in an HTML tag or via JavaScript.  Either way, it accepts the same options:
 
 #### Options
 
-Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-`, 
-as in `data-target="#myForm"`.
 
 | Name            | type            | default         | description                                                    |
 |-----------------|-----------------|-----------------|----------------------------------------------------------------|
@@ -101,45 +62,40 @@ as in `data-target="#myForm"`.
 | target          | xpath or jQuery | null            | A form object to add the results to as hidden fields.          |
 
 If a `target` is provided, browse-everything will automatically convert the JSON response to a series of hidden form fields
-that can be posted back to Rails to re-create the array on the server side. 
+that can be posted back to Rails to re-create the array on the server side.
 
-#### Methods
 
-##### .browseEverything(options)
+#### Via data attributes
 
-Attaches the browsing behavior to the click event of the receiver.
+To trigger browse-everything using data attributes, set the _data-toggle_ attribute to "browse-everything" on the HTML tag.  This tells the javascript where to attach the browse-everything behaviors. Pass in the options using the _data-route_ and _data-target_ attributes, as in `data-target="#myForm"`.
+
+For example:
+
+```html
+<button type="button" data-toggle="browse-everything" data-route="<%=browse_everything_engine.root_path%>" 
+  data-target="#myForm" class="btn btn-large btn-success" id="browse">Browse!</button>
+```
+
+#### Via JavaScript
+
+To trigger browse-everything via javascript, use the .browseEverything() method to attach the behaviors to DOM elements. 
 
+```javascript
+$('#browse').browseEverything(options)
+```
+
+The options argument should be a JSON object with the route and (optionally) target values set.  For example:
 ```javascript
 $('#browse').browseEverything({
   route: "/browse",
   target: "#myForm"
-}).done(function(data) {
-  // User has submitted files; data contains an array of URLs and their options
-}).cancel(function() {
-  // User cancelled the browse operation
-}).fail(function(status, error, text) {
-  // URL retrieval experienced a techical failure
-});
+})
 ```
 
-##### .browseEverything()
-
-Returns the existing callback object for the receiver, allowing for a mix of data attribute and JavaScript modes.
-
-```html
-<button type="button" data-toggle="browse-everything" data-route="/browse" 
-  data-target="#myForm" class="btn btn-large btn-success" id="browse">Browse!</button>
+See [JavaScript Methods](https://github.com/projecthydra/browse-everything/wiki/JavaScript-Methods) for more info on using javascript to trigger browse-everything.
 
-<script>
-  $(document).ready(function() {
-    $('#browse').browseEverything().done(function(data) {
-      // Set the "done" callback for the already-defined #browse button
-    })
-  });
-</script>
-```
 
-#### Data Structure
+### The Results (Data Structure) 
 
 browse-everything returns a JSON data structure consisting of an array of URL specifications. Each URL specification
 is a plain object with the following properties:
@@ -151,6 +107,40 @@ is a plain object with the following properties:
 | expires            | The expiration date/time of the specified URL.                                       |
 | file_name          | The base name (filename.ext) of the selected file.                                   |
 
+For example, after picking two files from dropbox, 
+
+If you initialized browse-everything via JavaScript, the results data passed to the `.done()` callback will look like this:
+```json
+[
+  {
+    "url": "https://dl.dropbox.com/fake/filepicker-demo.txt.txt",
+    "expires": "2014-03-31T20:37:36.214Z",
+    "file_name": "filepicker-demo.txt.txt"
+  }, {
+    "url": "https://dl.dropbox.com/fake/Getting%20Started.pdf",
+    "expires": "2014-03-31T20:37:36.731Z",
+    "file_name": "Getting+Started.pdf"
+  }
+]
+```
+See [JavaScript Methods](https://github.com/projecthydra/browse-everything/wiki/JavaScript-Methods) for more info on using javascript to trigger browse-everything. 
+
+If you initialized browse-everything via data-attributes and set the _target_ option (via the _data-target_ attribute or via the _target_ option on the javascript method), the results data be written as hidden fields in the `<form>` you've specified as the target.  When the user submits that form, the results will look like this:
+```ruby
+"selected_files" => {
+  "0"=>{
+    "url"=>"https://dl.dropbox.com/fake/filepicker-demo.txt.txt", 
+    "expires"=>"2014-03-31T20:37:36.214Z", 
+    "file_name"=>"filepicker-demo.txt.txt"
+  }, 
+  "1"=>{
+    "url"=>"https://dl.dropbox.com/fake/Getting%20Started.pdf", 
+    "expires"=>"2014-03-31T20:37:36.731Z", 
+    "file_name"=>"Getting+Started.pdf"
+  }
+}
+```
+
 ### Examples
 
 See `spec/support/app/views/file_handler/index.html` for an example use case. You can also run `rake app:generate` to

data/app/assets/stylesheets/browse_everything.css.scss

@@ -32,6 +32,8 @@
   position: fixed !important;
   margin: 0 0 0 -37.5%;
   left: 50%;
+  top: 10%;
+  background-color: initial; 
   width: 75%;
 
   .modal-body {
@@ -90,4 +92,4 @@
     }
   }
 
-}
+}

data/browse-everything.gemspec

@@ -36,5 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "factory_girl_rails"
 
 end

data/lib/browse_everything/driver/file_system.rb

@@ -13,7 +13,7 @@ module BrowseEverything
       end
 
       def contents(path='')
-        relative_path = path.sub(%r{^[/.]+},'')
+        relative_path = path.sub(%r{^[\/.]+},'')
         real_path = File.join(config[:home], relative_path)
         result = []
         if File.directory?(real_path)

data/lib/browse_everything/version.rb

@@ -1,3 +1,3 @@
 module BrowseEverything
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/generators/browse_everything/config_generator.rb

@@ -0,0 +1,31 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+
+class BrowseEverything::ConfigGenerator < Rails::Generators::Base
+    desc """
+  This generator makes the following changes to your application:
+   1. Creates config/browse_everything_providers.yml with a placeholder value
+   2. Modifies your app's routes.rb to mount BrowseEverything at /browse
+         """
+  source_root File.expand_path('../templates', __FILE__)
+   
+  def inject_routes
+   insert_into_file "config/routes.rb", :after => ".draw do" do
+%{
+  mount BrowseEverything::Engine => '/browse'}
+   end
+  end 
+  
+  def copy_example_config
+    copy_file "browse_everything_providers.yml.example", "config/browse_everything_providers.yml"
+  end
+  
+  def insert_file_system_path
+    insert_into_file "config/browse_everything_providers.yml", :before => "# drop_box:" do
+      YAML.dump({ 'file_system' => { :home => Rails.root.to_s }})
+    end
+  end
+  
+
+        
+end

data/lib/generators/browse_everything/templates/browse_everything_providers.yml.example

@@ -0,0 +1,16 @@
+#
+# To make browse-everything aware of a provider, uncomment the info for that provider and add your API key information.
+# The file_system provider can be a path to any directory on the server where your application is running.
+#
+# drop_box:
+#   :app_key: YOUR_DROPBOX_APP_KEY
+#   :app_secret: YOUR_DROPBOX_APP_SECRET
+# box:
+#   :client_id: YOUR_BOX_CLIENT_ID
+#   :client_secret: YOUR_BOX_CLIENT_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/fixtures/vcr_cassettes/dropbox.yml

@@ -189,6 +189,45 @@ http_interactions:
         "expires": "Fri, 20 Sep 2013 19:39:01 +0000"}'
     http_version: '1.1'
   recorded_at: Fri, 20 Sep 2013 15:39:01 GMT
+- request:
+    method: get
+    uri: https://api.dropbox.com/1/media/auto/Writer/Writer%20FAQ.txt
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Accept: ! '*/*'
+      User-Agent: OfficialDropboxRubySDK/1.6.1
+      Authorization: Bearer FakeDropboxAccessToken01234567890ABCDEF_AAAAAAA987654321
+      Connection: close
+      Host: api.dropbox.com
+  response:
+    status:
+      code: '200'
+      message: OK
+    headers:
+      Server: nginx
+      Date: Fri, 20 Sep 2013 15:39:01 GMT
+      Content-Type: text/javascript
+      Transfer-Encoding: chunked
+      Connection: close
+      set-cookie: ! 'gvc=MjEyNTM5NjUyNDAyMDIwODUzNTU0MTY0NzA0ODU4MzczNTU0NDI%3D; expires=Wed,
+        19 Sep 2018 15:39:01
+
+        GMT; Path=/; httponly'
+      x-server-response-time: '68'
+      x-dropbox-request-id: d8dbc2e2080168d6e34d85165aa69c0e
+      pragma: no-cache
+      cache-control: no-cache
+      x-dropbox-http-protocol: None
+      x-frame-options: SAMEORIGIN
+      X-RequestId: e03a6c0ded5f7088ba59ecd9e97234a6
+    body:
+      encoding: UTF-8
+      string: ! '{"url": "https://dl.dropboxusercontent.com/1/view/FakeDropboxAccessPath/Writer/Writer%20FAQ.txt",
+        "expires": "Fri, 20 Sep 2013 19:39:01 +0000"}'
+    http_version: '1.1'
+  recorded_at: Fri, 20 Sep 2013 15:39:01 GMT
 - request:
     method: get
     uri: https://api.dropbox.com/1/media/auto/Writer/Markdown%20Test.txt?
@@ -228,4 +267,43 @@ http_interactions:
         "expires": "Fri, 20 Sep 2013 19:39:02 +0000"}'
     http_version: '1.1'
   recorded_at: Fri, 20 Sep 2013 15:39:02 GMT
+- request:
+    method: get
+    uri: https://api.dropbox.com/1/media/auto/Writer/Markdown%20Test.txt
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Accept: ! '*/*'
+      User-Agent: OfficialDropboxRubySDK/1.6.1
+      Authorization: Bearer FakeDropboxAccessToken01234567890ABCDEF_AAAAAAA987654321
+      Connection: close
+      Host: api.dropbox.com
+  response:
+    status:
+      code: '200'
+      message: OK
+    headers:
+      Server: nginx
+      Date: Fri, 20 Sep 2013 15:39:02 GMT
+      Content-Type: text/javascript
+      Transfer-Encoding: chunked
+      Connection: close
+      set-cookie: ! 'gvc=NjgwODYwOTI2NTA5OTAyNzE3NzE4MDU3MzY0NTQ3NTYyNTYyNDE%3D; expires=Wed,
+        19 Sep 2018 15:39:02
+
+        GMT; Path=/; httponly'
+      x-server-response-time: '78'
+      x-dropbox-request-id: b6fd9a3c039d2aea3def25f8f2f5ac3a
+      pragma: no-cache
+      cache-control: no-cache
+      x-dropbox-http-protocol: None
+      x-frame-options: SAMEORIGIN
+      X-RequestId: 30d2c0cf0122795ebce9bd5f26ce0c60
+    body:
+      encoding: UTF-8
+      string: ! '{"url": "https://dl.dropboxusercontent.com/1/view/FakeDropboxAccessPath/Writer/Markdown%20Test.txt",
+        "expires": "Fri, 20 Sep 2013 19:39:02 +0000"}'
+    http_version: '1.1'
+  recorded_at: Fri, 20 Sep 2013 15:39:02 GMT
 recorded_with: Charles Proxy

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

@@ -2,6 +2,11 @@ require 'rails/generators'
 
 class TestAppGenerator < Rails::Generators::Base
   source_root File.expand_path("../../../../support", __FILE__)
+  
+  def run_config_generator
+    generate "browse_everything:config"
+  end
+  
   def inject_css
     copy_file "../internal/app/assets/stylesheets/application.css", "app/assets/stylesheets/application.css.scss"
     remove_file "app/assets/stylesheets/application.css"
@@ -26,25 +31,15 @@ class TestAppGenerator < Rails::Generators::Base
     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"
       }
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browse-everything
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Carolyn Cole
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -266,6 +266,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: AJAX/Rails engine file browser for cloud storage services
 email:
 - cam156@psu.edu
@@ -317,6 +331,8 @@ files:
 - lib/browse_everything/engine.rb
 - lib/browse_everything/file_entry.rb
 - lib/browse_everything/version.rb
+- lib/generators/browse_everything/config_generator.rb
+- lib/generators/browse_everything/templates/browse_everything_providers.yml.example
 - spec/fixtures/file_system/dir_1/dir_3/file_3.m4v
 - spec/fixtures/file_system/dir_1/file_2.txt
 - spec/fixtures/file_system/dir_2/file_4.docx
@@ -327,7 +343,6 @@ files:
 - spec/spec_helper.rb.orig
 - spec/support/app/controllers/file_handler_controller.rb
 - spec/support/app/views/file_handler/index.html.erb
-- spec/support/config/browse_everything_providers.yml.example
 - spec/support/lib/generators/test_app_generator.rb
 - spec/unit/base_spec.rb
 - spec/unit/browser_spec.rb
@@ -372,7 +387,6 @@ test_files:
 - spec/spec_helper.rb.orig
 - spec/support/app/controllers/file_handler_controller.rb
 - spec/support/app/views/file_handler/index.html.erb
-- spec/support/config/browse_everything_providers.yml.example
 - spec/support/lib/generators/test_app_generator.rb
 - spec/unit/base_spec.rb
 - spec/unit/browser_spec.rb

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

@@ -1,15 +0,0 @@
----
-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