ruby-box-updated 1.16.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 314ae7c359945bf35355e3497ffa67f7ab4871c6
+  data.tar.gz: f946edf10b08080be31c00c90d41fb6b2d214c68
+SHA512:
+  metadata.gz: 04f12b40f55fc76b0648e4d25482b421ea9636d2099dec5d96ae3fb2f7297d1d4c003abe20d4719952acdc803a1727c352b2f20bc11709164e8b0802a0fb6a2c
+  data.tar.gz: 0b16650a853982248d2c5e4e5d3e0ffaf0e613a85aa33d7a4a83609885d055b9f679840c3f37f58d79eaf59eb695ff0c8385c39dbac62a3262484598ddbea69f

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install:
+  - gem install bundler --pre
+script: bundle exec rake spec

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "multipart-post"
+gem "oauth2"
+gem "json"
+gem "addressable"
+
+group :development do
+  gem "rspec"
+  gem "bundler"
+  gem "jeweler"
+  gem "webmock"
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    builder (3.2.2)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    git (1.2.8)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (3.3.1)
+    highline (1.6.21)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.7.7)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
+    multi_json (1.6.0)
+    multipart-post (1.1.5)
+    nokogiri (1.5.10)
+    oauth2 (0.8.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    rack (1.4.5)
+    rake (10.3.2)
+    rdoc (4.1.2)
+      json (~> 1.4)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    webmock (1.8.7)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  addressable
+  bundler
+  jeweler
+  json
+  multipart-post
+  oauth2
+  rspec
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Attachments.me
+
+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.markdown

@@ -0,0 +1,356 @@
+ruby-box
+========
+
+Build Status: [![Build Status](https://travis-ci.org/attachmentsme/ruby-box.png)](https://travis-ci.org/attachmentsme/ruby-box)
+
+Maintained by: [Adrien Giboire](http://adriengiboire.com)
+
+RubyBox provides a simple, chainable, feature-rich client for [Box's 2.0 API](http://developers.box.com/docs/).
+
+Authorization
+-------------
+
+RubyBox uses Box's OAuth2 Implementaton, Here are the steps involved in authorizing a client:
+
+__1)__ Get the authorization url.
+
+```ruby
+require 'ruby-box-updated'
+
+session = RubyBox::Session.new({
+  client_id: 'your-client-id',
+  client_secret: 'your-client-secret'
+})
+
+authorize_url = session.authorize_url('https://redirect-url-in-app-settings')
+```
+
+__2)__ After redirecting to the authorize_url, exchange the _code_ given for an _access\_token_
+
+```ruby
+@token = session.get_access_token('code-returned-to-redirect_url')
+p '@token.token' # the access token.
+p '@token.refresh_token' # token that can be exchanged for a new access_token once the access_token expires.
+
+# refreshing token.
+
+session = RubyBox::Session.new({
+  client_id: 'your-client-id',
+  client_secret: 'your-client-secret',
+  access_token: 'original-access-token' 
+})
+
+# you need to persist this somehow. the refresh token will change every time you use it
+@token = session.refresh_token('your-refresh-token')
+save_me_somehow(@token.refresh_token)
+```
+
+__3)__ Create a client using a session initialized with the _access\_token_.
+
+```ruby
+require 'ruby-box-updated'
+
+session = RubyBox::Session.new({
+  client_id: 'your-client-id',
+  client_secret: 'your-client-secret',
+  access_token: 'access-token'
+})
+
+client = RubyBox::Client.new(session)
+```
+
+Usage
+=====
+
+Once you've created a client, you can start interacting with the Box API. What follows are some basic examples of RubyBox's usage.
+
+Warning
+=======
+
+Please note that using a file/folder path is extremely inefficient, as it causes the gem to traverse the directory structure recursively querying each folder in turn. Prefer the `_by_id` methods where possible for single-request access.
+
+Items
+-----
+
+`File`s and `Folder`s are subclasses of `Item`. `Folder` contents (i.e. files and folders inside that folder) are retrieved in a `mini-format` when the `Folder` instance is loaded.
+
+There are two caveats to this:
+
+### Only some fields are available
+
+a `File` mini looks like this:
+
+```
+{
+    "type": "file",
+    "id": "5000948880",
+    "sequence_id": "3",
+    "etag": "3",
+    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
+    "name": "tigers.jpeg"
+}
+```
+a `Folder` mini looks like this:
+
+```
+{
+    "type":"folder",
+    "id":"301415432",
+    "sequence_id":"0",
+    "name":"my first sub-folder"
+}
+```
+
+Requests to fields other than the above (e.g. `file.size`) will cause a one-off hit to the api, so take care when iterating over folder contents lest a single application method result in hundreds of api hits and take forever to complete.
+
+This can be mitigated by passing a list of extra fields you want to fetch into the `.items` method:
+
+```ruby
+folder = client.folder_by_id(@folder_id)
+# retrieve size, created_at, and description for all items in this directory
+detailed_items = folder.items(@item_limit, @offset, ['size', 'created_at', 'description'])
+```
+
+Note: only the `type` and `id` fields are included in addition to whatever you specify using the above method, so you must be explicit.
+
+
+Folders
+-------
+
+* Listing items in a folder:
+
+```ruby
+files = client.folder('/image_folder').files # all files in a folder using a path.
+files = client.folder(@folder_id).files # all files in a folder using an id.
+folders = client.root_folder.folders # all folders in the root directory.
+files_and_folders = client.folder('files').items # all files and folders in /files
+```
+
+* Creating a folder:
+
+```ruby
+client.folder_by_id(@folder_id).create_subfolder('subfolder') # using an id.
+client.folder('image_folder').create_subfolder('subfolder') # using a path.
+```
+
+* Setting the description on a folder:
+
+```ruby
+folder = client.folder('image_folder') # using a path.
+folder.description = 'Description on Folder'
+folder.update
+```
+
+* Listing the comments in a discussion surrounding a folder.
+
+```ruby
+folder = client.folder('image_folder') # lookups by id are more efficient
+discussion = folder.discussions.first
+discussion.comments.each {|comment| p comment.message}
+```
+
+* Creating a shared link for a folder.
+
+```ruby
+folder = client.folder('image_folder').create_shared_link # lookups by id are more efficient
+p folder.shared_link.url # https://www.box.com/s/d6de3224958c1755412
+```
+
+* Creating an email to upload files in a folder.
+
+```ruby
+folder = client.folder('documents_folder').create_folder_upload_email # lookups by id are more efficient
+p folder.folder_upload_email.email # upload.adrien_.8kge3wck1h@u.box.com
+```
+
+Files
+-----
+
+* Fetching a file's meta information.
+
+```ruby
+file = client.file('/image_folder/an-image.jpg')# lookups by id are more efficient
+file = client.file(@file_id)
+p file.name
+p file.created_at
+```
+
+* Uploading a file to a folder.
+
+```ruby
+file = client.upload_file('./LICENSE.txt', '/license_folder') # lookups by id are more efficient
+file = client.upload_file_by_folder_id('./LICENSE.txt', @folder_id) 
+```
+
+* Downloading a file.
+
+```ruby
+f = open('./LOCAL.txt', 'w+')
+f.write( client.file('/license_folder/LICENSE.txt').download )
+f.close()
+
+# Or you can fetch by file.id, which is more efficient:
+f = open('./LOCAL.txt', 'w+')
+f.write( client.file_by_id(@file_id).download ) # lookups by id are more efficient
+f.close()
+
+# You can also grab the raw url with
+client.file_by_id(@file_id).download_url
+
+# Note that this URL is not persistent. Clients will need to follow the url immediately in order to
+# actually download the file
+```
+
+* Deleting a file.
+
+```ruby
+client.file_by_id(@file_id).delete # this
+client.file('/license_folder/LICENSE.txt').delete
+```
+
+* Displaying comments on a file.
+
+```ruby
+comments = client.file('/image_folder/an-image.jpg').comments # lookups by id are more efficient
+comments = client.file_by_id(@file_id).comments
+
+comments.each do |comment|
+    p comment.message
+end
+```
+
+* Creating a shared link for a file.
+
+```ruby
+file = client.file('/image_folder/an-image.jpg').create_shared_link
+file = client.file_by_id(@file_id).create_shared_link # using an id
+p file.shared_link.url # https://www.box.com/s/d6de3224958c1755412
+```
+
+* Copying a file to another folder.
+
+```ruby
+
+file = client.file('/one_folder/cow_folder/an-image.jpg')
+folder = client.folder('image_folder')
+
+# lookups by id are more efficient
+
+file = client.file_by_id(@file_id)
+folder = client.folder_by_id(@folder_id)
+
+file.copy_to(folder)
+```
+
+* Moving a file to another folder.
+
+```ruby
+
+file = client.file('/one_folder/cow_folder/an-image.jpg')
+folder = client.folder('image_folder')
+
+# lookups by id are more efficient
+
+file = client.file_by_id(@file_id)
+folder = client.folder_by_id(@folder_id)
+
+
+file.move_to(folder)
+```
+
+* Adding a comment to a file.
+
+```ruby
+file = client.file('/image_folder/an-image.jpg') # path
+file = client.file_by_id(@file_id) # id
+comment = file.create_comment('Hello World!')
+```
+
+Search
+------
+
+You can use RubyBox's search method to return files and folders that match a given query.
+
+```ruby
+items = client.search('image')
+items.each do |item|
+    p "type=#{item.type} name=#{item.name}"
+end
+```
+
+Events
+------
+
+You can use RubyBox's event_response method to return an EventResponse that can be used to process any incoming events.
+
+```ruby
+eresp = client.event_response
+eresp.chunk_size
+eresp.next_stream_position
+eresp.events.each do |ev|
+  p "type=#{ev.event_id} type=#{ev.event_type} user=#{ev.created_by.name}"
+end
+```
+
+As-User
+-------
+
+* This must be manually enabled for your account by Box Staff.   Contact api@box.com for access.  [ More Info ] (http://developers.box.com/docs/#users-as-user)
+
+```ruby
+session = RubyBox::Session.new({
+  client_id: 'your-client-id',
+  client_secret: 'your-client-secret',
+  access_token: 'original-access-token' ,
+  as_user: 'your-users-box-id'
+})
+```
+Users
+------
+
+Current User Info
+
+```ruby
+me = client.me
+```
+
+Current User's enterprise
+
+```ruby
+me = client.me.enterprise
+```
+
+An array of Ruby:Box users in an enterprise (Supports Filtering, Limit and Offset)
+
+```ruby
+users = client.users
+```
+
+* Remember the API filters "name" and "login" by the start of the string. ie: to get "sean+awesome@gmail.com" an approriate filter term would be "sean"
+
+```ruby
+users = client.users("sean" , 10 , 1)
+```
+
+Contributors
+============
+
+* [full list of contributors](https://github.com/attachmentsme/ruby-box/graphs/contributors)
+
+Contributing to ruby-box
+========================
+
+RubyBox does not yet support all of Box's API Version 2.0 functionality, be liberal with your contributions.
+
+* Rename account.example to account.yml and fill in your Box credentials
+* Type bundle install
+* Type rake.. tests should pass
+* Add a failing test
+* Make it pass
+* Submit a pull request
+
+Copyright
+=========
+
+Copyright (c) 2012 Attachments.me. See LICENSE.txt for
+further details.