ruby-box 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODI5MWRhMWMwNjYwMDFhN2QyYTg3YzM1OTJhMWE2ZDM5NjMzODNjOQ==
+  data.tar.gz: !binary |-
+    YTM1OGYwMmMyOGU0Y2EyZmU0NGFjYWUyMTM0ZjQ2NDM0ZDllMmVhYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjgxZWMxODc2MzIyODg4YTAyMzIzMzg4NGI4MTM4NzdkYmFjNTBhNGFlYmY2
+    MjAxOGU0MmU4ZGYyYWU1MjQ4MWYzNWYxMTcyYmFlYWM3ZDgxMWFhMTcyZTQ3
+    OGMzYTQzMWQzZjAwYTliOGMxMjMwNTcwMWVmNzA0NzQ5MzJmNmQ=
+  data.tar.gz: !binary |-
+    YzhkODAxM2Q2YjZlMWVlMWE5YjAyNzFhMTcwOTA5YmE0MmQ5MzE0NmI0ZTMx
+    YmQxMTM4YTUyZjQ3YzJhM2NhNWJjMTAwZjk0MmNiY2I1NDRhODE4MjA1ZTNi
+    NmZmOGMyYTcxZmViOGZiZjQ3NjE2YzlkMTk4ODc1OTY2YmM2NDY=

data/.document

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

data/.gitignore

@@ -0,0 +1,52 @@
+account.yml
+
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+*.gem
+.DS_Store

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "multipart-post", "~> 1.1.5"
+gem "oauth2"
+
+group :development do
+  gem "rspec"
+  gem "bundler"
+  gem "jeweler", "~> 1.6.4"
+  gem "webmock"
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    git (1.2.5)
+    httpauth (0.2.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    jwt (0.1.5)
+      multi_json (>= 1.0)
+    multi_json (1.6.0)
+    multipart-post (1.1.5)
+    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 (0.9.2.2)
+    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
+  bundler
+  jeweler (~> 1.6.4)
+  multipart-post (~> 1.1.5)
+  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,160 @@
+ruby-box
+--------
+
+Mainted by: [Attachments.me](https://attachments.me)
+
+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'
+
+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
+session.get_access_token('code-returned-to-redirect_url')
+```
+
+__3)__ Create a client using a session initialized with the _access\_token_.
+
+```ruby
+require 'ruby-box'
+
+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:
+
+Folders
+=======
+
+* Listing items in a folder:
+
+```ruby
+files = client.folder('/image_folder').files # all files in a folder.
+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('image_folder').create_subfolder('subfolder')
+```
+
+* Setting the description on a folder:
+
+```ruby
+folder = client.folder('image_folder')
+folder.description = 'Description on Folder'
+folder.update
+```
+
+* Listing the comments in a discussion surrounding a folder.
+
+```ruby
+folder = client.folder('image_folder')
+discussion = folder.discussions.first
+discussion.comments.each {|comment| p comment.message}
+```
+
+Files
+=====
+
+* Fetching a file's meta information.
+
+```ruby
+file = client.file('/image_folder/an-image.jpg')
+p file.name
+p file.created_at
+```
+
+* Uploading a file to a folder.
+
+```ruby
+file = client.upload_file('./LICENSE.txt', '/license_folder')
+```
+
+* Downloading a file.
+
+```ruby
+f = open('./LOCAL.txt', 'w+')
+f.write( client.file('/license_folder/LICENSE.txt').download )
+f.close()
+```
+
+* Deleting a file.
+
+```ruby
+client.file('/license_folder/LICENSE.txt').delete
+```
+
+* Displaying comments on a file.
+
+```ruby
+comments = client.file('/image_folder/an-image.jpg').comments
+comments.each do |comment|
+    p comment.message
+end
+```
+
+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
+```
+
+Contributors
+------------
+
+* Benjamin Coe
+* Larry Kang
+* Dan Reed
+* Jesse Miller
+
+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.

data/Rakefile

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ruby-box"
+  gem.homepage = "http://github.com/jessemiller/ruby-box"
+  gem.license = "MIT"
+  gem.summary = %Q{ruby gem for box.com 2.0 api}
+  gem.description = %Q{ruby gem for box.com 2.0 api}
+  gem.email = "millerjesse@gmail.com"
+  gem.authors = ["Jesse Miller"]
+  gem.files.exclude 'spec/*.test'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/ruby-box.rb

@@ -0,0 +1,16 @@
+require 'ruby-box/client'
+require 'ruby-box/session'
+
+require 'ruby-box/item'
+require 'ruby-box/file'
+require 'ruby-box/folder'
+require 'ruby-box/user'
+require 'ruby-box/comment'
+require 'ruby-box/discussion'
+require 'ruby-box/exceptions'
+
+module RubyBox
+  API_URL = 'https://api.box.com/2.0'
+  UPLOAD_URL = 'https://upload.box.com/api/2.0'
+  ISO_8601_TEST = Regexp.new(/^[0-9]{4}-[0-9]{2}-[0-9]{2}T/)
+end

data/lib/ruby-box/client.rb

@@ -0,0 +1,97 @@
+require 'uri'
+require 'net/https'
+require 'json'
+require 'net/http/post/multipart'
+require 'open-uri'
+
+module RubyBox
+  class Client
+
+    def initialize(session)
+      @session = session
+    end
+
+    def root_folder
+      folder = Folder.new(@session, {'id' => '0'})
+      folder.reload_meta
+    end
+
+    def folder(path)
+      folder_from_split_path( split_path(path) )
+    end
+
+    def file(path)
+      path = split_path(path)
+      file_name = path.pop
+      folder = folder_from_split_path( path )
+      folder.files(file_name).first if folder
+    end
+
+    def download(path)
+      file = file(path)
+      file.download if file
+    end
+
+    def stream(path, opts={})
+      file = file(path)
+      file.stream(opts) if file
+    end
+
+    def search(query, item_limit=100, offset=0)
+      Enumerator.new do |yielder|
+        while true
+          url = "#{RubyBox::API_URL}/search?query=#{URI::encode(query)}&limit=#{item_limit}&offset=#{offset}"
+          resp = @session.get( url )
+          resp['entries'].each do |entry|
+            yielder.yield(RubyBox::Item.factory(@session, entry))
+          end
+          offset += resp['entries'].count
+          break if resp['offset'].to_i + resp['limit'].to_i >= resp['total_count'].to_i
+        end
+      end
+    end
+
+    def create_folder(path)
+      folder = root_folder
+      folder_names = split_path(path)
+      folder_names.each do |folder_name|
+        new_folder = folder.folders(folder_name).first
+        folder = new_folder ? new_folder : folder.create_subfolder(folder_name)
+      end
+      folder
+    end
+
+    def upload_data(path, data)
+      path = split_path(path)
+      file_name = path.pop
+      folder = create_folder(path.join('/'))
+      folder.upload_file(file_name, data) if folder
+    end
+
+    def upload_file(local_path, remote_path)
+      file_name = local_path.split('/').pop
+      folder = create_folder( remote_path )
+      return unless folder
+      ::File.open( local_path ) do |data|
+        folder.upload_file(file_name, data)
+      end
+    end
+
+    def split_path(path)
+      path.gsub!(/(^\/)|(\/$)/, '')
+      path.split('/')
+    end
+
+    private
+
+    def folder_from_split_path(path)
+      folder = root_folder
+      path.each do |folder_name|
+        folder = folder.folders(folder_name).first
+        return nil unless folder
+      end
+      folder
+    end
+    
+  end
+end