boxr 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23f49821fe447ccaa83629e1e7c530ebdf35fa1b
-  data.tar.gz: 53d8bd6bb8908a2329806b3cb1a5e25dad233251
+  metadata.gz: 67e27a5d8aa317d4f5367ca297a6effba37f940c
+  data.tar.gz: b3541ffde249148cbdde2f1666479c1377993b7e
 SHA512:
-  metadata.gz: b62553d9f612f370de59617b893285f4046a1c33eb922638041b73c84596fef4cc96d1ae3eda4620159feb6ea3c3a18d0814d14d6d976c163cc9868625870959
-  data.tar.gz: bbb792f645ab02ea642be299770d395f6bb32f545c40b38d88e050bb6497fe1ab07c0d3b14f849884e47450983e213ee4d48b0078a1d826c9db5052e1b803063
+  metadata.gz: 9837ce765c7cf63b3df57ab8fbf513b2e9f6745d447291bcedfd7a9bdc672028b185b93b52797c1fc9e36600f931fe6f40f0824122f659eff96ca052d3a3ae0d
+  data.tar.gz: bd84a9467ad8df991be52c8832cd63e0e5bb112352e20d7d1418b3ad7ddc77d98d4dbbb6c71eee253eeeb5d70a926fe10b4d1188ec4ec7df45c31aad7d536e01

data/.gitignore

@@ -5,6 +5,7 @@
 /.ruby-gemset
 /.env.test
 /.env
+/examples/.env
 /_yardoc/
 /coverage/
 /doc/

data/README.md

@@ -1,6 +1,6 @@
 # Boxr
 
-TODO: Write a gem description
+PLEASE NOTE: I need to complete this README with much more detailed instructions.  However, feel free to try it out. The integration test suite is achieving 95% code coverage. Thanks!
 
 ## Installation
 
@@ -20,11 +20,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Super-fast instructions for now (much more to come):
+
+1. go to https://developers.box.com
+2. find or create your Box Content API app for testing
+3. click 'Edit Application'
+4. check the boxes for 'Read and write all files and folders' and 'Manage an enterprise'
+5. click 'Create a developer token'
+6. copy the token and use it in the code below in place of {BOX_DEVELOPER_TOKEN}
+
+```ruby
+require 'boxr'
+
+client = Boxr::Client.new({BOX_DEVELOPER_TOKEN})
+items = client.folder_items(Boxr::ROOT)
+items.each {|i| puts i.name}
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/boxr/fork )
+1. Fork it ( https://github.com/cburnette/boxr/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,3 +1,5 @@
+import "./lib/tasks/oauth.rake"
+
 require 'rspec/core/rake_task'
 require "bundler/gem_tasks"
 

data/boxr.gemspec

@@ -20,10 +20,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "simplecov", "~> 0.9"
   spec.add_development_dependency "dotenv", "~> 0.11"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "lru_redux"
 
   spec.add_runtime_dependency "oj", "~> 2.11"
   spec.add_runtime_dependency "httpclient", "~> 2.5"

data/examples/enterprise_events.rb

@@ -0,0 +1,21 @@
+require 'dotenv'; Dotenv.load("../.env")
+require 'boxr'
+require 'awesome_print'
+
+client = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
+
+now = Time.now
+start_date = now - (60*60*24*30) #three days ago
+end_date = now - (60*60*24) #one day ago
+
+stream_position = 0
+puts "fetching enterprise events..."
+loop do
+	event_response = client.enterprise_events(stream_position: stream_position, created_after: start_date.utc, created_before: end_date.utc)
+	event_response.events.each do |event|
+		ap event
+	end
+	stream_position = event_response.next_stream_position
+
+	break if event_response.events.empty?
+end

data/examples/user_events.rb

@@ -0,0 +1,24 @@
+require 'dotenv'; Dotenv.load("../.env")
+require 'boxr'
+require 'awesome_print'
+require 'lru_redux'
+
+client = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
+cache = LruRedux::Cache.new(1000)
+
+stream_position = :now
+loop do 
+	puts "fetching events..."
+	event_response = client.user_events(stream_position: stream_position)
+	event_response.events.each do |event|
+		key = "/box-event/id/#{event.event_id}"
+
+		#we need to de-dupe the events because we will receive multiple events with the same event_id; this is to ensure that we get the event
+		if (cache.fetch(event.event_id)==nil)
+			cache[event.event_id] = true
+			puts event.event_type
+		end
+	end
+	stream_position = event_response.next_stream_position
+	sleep 2
+end

data/lib/boxr.rb

@@ -2,9 +2,10 @@ require 'oj'
 require 'httpclient'
 require 'hashie'
 
-require "boxr/version"
+require 'boxr/version'
 require 'boxr/exceptions'
 require 'boxr/client'
+require 'boxr/shared_items'
 require 'boxr/folders'
 require 'boxr/files'
 require 'boxr/comments'
@@ -13,8 +14,8 @@ require 'boxr/groups'
 require 'boxr/collaborations'
 require 'boxr/search'
 require 'boxr/tasks'
-require 'boxr/shared_items'
 require 'boxr/metadata'
+require 'boxr/events'
 
 module Enumerable
 	def files

data/lib/boxr/client.rb

@@ -17,6 +17,7 @@ module Boxr
 		TASK_ASSIGNMENTS_URI = "#{API_URI}/task_assignments"
 		SHARED_ITEMS_URI = "#{API_URI}/shared_items"
 		METADATA_URI = "#{API_URI}/files"
+		EVENTS_URI = "#{API_URI}/events"
 
 		DEFAULT_LIMIT = 100
 		FOLDER_ITEMS_LIMIT = 1000
@@ -50,6 +51,7 @@ module Boxr
 		#All instances of Boxr::Client will use this one class instance of HTTPClient; that way persistent HTTPS connections work.
 		#Plus, httpclient is thread-safe so we can use the same class instance with multiple instances of Boxr::Client
 		BOX_CLIENT = HTTPClient.new
+		BOX_CLIENT.send_timeout = 3600 #one hour; needed for lengthy uploads
 		BOX_CLIENT.transparent_gzip_decompression = true 
 
 		def initialize(token, as_user_id: nil)
@@ -103,7 +105,7 @@ module Boxr
 
 					entries << body_json["entries"]
 				else
-					raise BoxrException.new(res.status, res.body, res.header)
+					raise BoxrException.new(status: res.status, body: res.body, header: res.header)
 				end
 			end until offset - total_count >= 0
 
@@ -161,7 +163,7 @@ module Boxr
 		end
 
 		def check_response_status(res, success_codes)
-			raise BoxrException.new(res.status, res.body, res.header) unless success_codes.include?(res.status)
+			raise BoxrException.new(status: res.status, body: res.body, header: res.header) unless success_codes.include?(res.status)
 		end
 
 		def processed_response(res)
@@ -179,6 +181,15 @@ module Boxr
 			end
 		end
 
+		def restore_trashed_item(uri, name, parent_id)
+			attributes = {}
+			attributes[:name] = name unless name.nil?
+			attributes[:parent] = {id: parent_id} unless parent_id.nil?
+			
+			restored_item, response = post uri, attributes
+			restored_item
+		end
+
 		def create_shared_link(uri, item_id, access, unshared_at, can_download, can_preview)
 			if access.nil?
 				attributes = {shared_link: {}}
@@ -201,15 +212,6 @@ module Boxr
 			updated_item
 		end
 
-		def restore_trashed_item(uri, name, parent_id)
-			attributes = {}
-			attributes[:name] = name if name
-			attributes[:parent] = {id: parent_id} if parent_id
-			
-			restored_item, response = post uri, attributes
-			restored_item
-		end
-
 	end
 
 end

data/lib/boxr/collaborations.rb

@@ -1,6 +1,12 @@
 module Boxr
 	class Client
 
+		def folder_collaborations(folder_id)
+			uri = "#{FOLDERS_URI}/#{folder_id}/collaborations"
+			collaborations, response = get(uri)
+			collaborations['entries']
+		end
+
 		#make sure 'role' value is a string as Box has role values with spaces and dashes; e.g. 'previewer uploader'
 		def add_collaboration(folder_id, accessible_by, role, fields: [], notify: nil)
 			query = build_fields_query(fields, COLLABORATION_FIELDS_QUERY)
@@ -40,7 +46,7 @@ module Boxr
 			collaboration
 		end
 
-		#these are pending collaborations for the current users; use the As-User Header to request for different users
+		#these are pending collaborations for the current user; use the As-User Header to request for different users
 		def pending_collaborations
 			query = {status: :pending}
 			pending_collaborations, response = get(COLLABORATIONS_URI, query: query)

data/lib/boxr/comments.rb

@@ -1,6 +1,13 @@
 module Boxr
 	class Client
 
+		def file_comments(file_id, fields: [])
+			uri = "#{FILES_URI}/#{file_id}/comments"
+			query = build_fields_query(fields, COMMENT_FIELDS_QUERY)
+
+			comments = get_with_pagination uri, query: query
+		end
+
 		def add_comment_to_file(file_id, message: nil, tagged_message: nil)
 			add_comment(:file, file_id, message, tagged_message)
 		end
@@ -16,7 +23,7 @@ module Boxr
 			updated_comment
 		end
 
-		def comment_info(comment_id, fields: [])
+		def comment(comment_id, fields: [])
 			uri ="#{COMMENTS_URI}/#{comment_id}"
 			comment, response = get uri
 			comment

data/lib/boxr/events.rb

@@ -0,0 +1,22 @@
+module Boxr
+	class Client
+
+		def user_events(stream_position: 0, stream_type: :all, limit: 100)
+			query = {stream_position: stream_position, stream_type: stream_type, limit: limit}
+			
+			events, response = get(EVENTS_URI, query: query)
+			Hashie::Mash.new({events: events["entries"], chunk_size: events["chunk_size"], next_stream_position: events["next_stream_position"]})
+		end
+
+		def enterprise_events(stream_position: 0, limit: 100, event_type: nil, created_after: nil, created_before: nil)
+			query = {stream_position: stream_position, stream_type: :admin_logs, limit: limit}
+			query['event_type'] = event_type unless event_type.nil?
+			query['created_after'] = created_after.to_datetime.rfc3339 unless created_after.nil?
+			query['created_before'] = created_before.to_datetime.rfc3339 unless created_before.nil?
+
+			events, response = get(EVENTS_URI, query: query)
+			Hashie::Mash.new({events: events["entries"], chunk_size: events["chunk_size"], next_stream_position: events["next_stream_position"]})
+		end
+
+	end
+end

data/lib/boxr/exceptions.rb

@@ -2,30 +2,35 @@ module Boxr
 
 	class BoxrException < Exception
 
-		attr_reader :response_body, :type, :status, :code, :help_uri, :box_message, :request_id
+		attr_reader :response_body, :type, :status, :code, :help_uri, :box_message, :boxr_message, :request_id
 
-		def initialize(status,body,header)
+		def initialize(status: nil, body: nil, header: nil, boxr_message: nil)
 			@status = status
 			@response_body = body
 			@header = header
+			@boxr_message = boxr_message
 
-			body_json = Oj.load(body)
-			if body_json
-				@type = body_json["type"]
-				@box_status = body_json["status"]
-				@code = body_json["code"]
-				@help_uri = body_json["help_uri"]
-				@box_message = body_json["message"]
-				@request_id = body_json["request_id"]
+			if(body)
+				body_json = Oj.load(body)
+				if body_json
+					@type = body_json["type"]
+					@box_status = body_json["status"]
+					@code = body_json["code"]
+					@help_uri = body_json["help_uri"]
+					@box_message = body_json["message"]
+					@request_id = body_json["request_id"]
+				end
 			end
 		end
 
 		def message
-			auth_header = @header['WWW-Authenticate']
-			if(auth_header)
+			auth_header = @header['WWW-Authenticate'] unless @header.nil?
+			if(auth_header && auth_header != [])
 				"#{@status}: #{auth_header}"
-			elsif(!@box_message.blank?)
+			elsif(@box_message)
 				"#{@status}: #{@box_message}"
+			elsif(@boxr_message)
+				@boxr_message
 			else
 				"#{@status}: #{@response_body}"
 			end

data/lib/boxr/files.rb

@@ -1,14 +1,33 @@
 module Boxr
 	class Client
 
-		def file_info(file_id, fields: [])
+		def file_id(path)
+			if(path.start_with?('/'))
+				path = path.slice(1..-1)
+			end
+
+			path_items = path.split('/')
+			file_name = path_items.slice!(-1)
+
+			folder_id = folder_id(path_items.join('/'))
+
+			files = folder_items(folder_id, fields: [:id, :name])
+
+			begin
+				files.select{|f| f.name == file_name}.first.id
+			rescue
+				raise BoxrException.new(boxr_message: "File not found: '#{file_name}'")
+			end
+		end
+
+		def file(file_id, fields: [])
 			uri = "#{FILES_URI}/#{file_id}"
 			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
 			file, response = get uri, query: query
 			file
 		end
 
-		def update_file_info(file_id, name: nil, description: nil, parent_id: nil, shared_link: nil, tags: nil, if_match: nil)
+		def update_file(file_id, name: nil, description: nil, parent_id: nil, shared_link: nil, tags: nil, if_match: nil)
 			uri = "#{FILES_URI}/#{file_id}"
 
 			attributes = {}
@@ -22,7 +41,7 @@ module Boxr
 			updated_file
 		end
 
-		def download_file(file_id, version: nil)
+		def download_file(file_id, version: nil, follow_redirect: true)
 			begin
 				uri = "#{FILES_URI}/#{file_id}/content"
 				query = {}
@@ -31,7 +50,12 @@ module Boxr
 
 				if(response.status==302)
 					location = response.header['Location'][0]
-					file, response = get location, process_response: false
+
+					if(follow_redirect)
+						file, response = get location, process_response: false
+					else
+						return location #simply return the url
+					end
 				elsif(response.status==202)
 					retry_after_seconds = response.header['Retry-After'][0]
 					sleep retry_after_seconds.to_i
@@ -41,6 +65,10 @@ module Boxr
 			file
 		end
 
+		def download_url(file_id, version: nil)
+			download_file(file_id, version: version, follow_redirect: false)
+		end
+
 		def upload_file(path_to_file, parent_id, content_created_at: nil, content_modified_at: nil, 
 										preflight_check: true, send_content_md5: true)
 
@@ -91,10 +119,6 @@ module Boxr
 			versions["entries"]
 		end
 
-		def download_old_version_of_file
-
-		end
-
 		def promote_old_version_of_file(file_id, file_version_id)
 			uri = "#{FILES_URI}/#{file_id}/versions/current"
 			attributes = {:type => 'file_version', :id => file_version_id}
@@ -104,8 +128,8 @@ module Boxr
 
 		def delete_old_version_of_file(file_id, file_version_id, if_match: nil)
 			uri = "#{FILES_URI}/#{file_id}/versions/#{file_version_id}"
-			body_json, res = delete uri, if_match: if_match
-			body_json
+			result, response = delete uri, if_match: if_match
+			result
 		end
 
 		def copy_file(file_id, parent_id, name: nil)
@@ -145,9 +169,11 @@ module Boxr
 			disable_shared_link(uri, file_id)
 		end
 
-		def trashed_file(file_id)
+		def trashed_file(file_id, fields: [])
 			uri = "#{FILES_URI}/#{file_id}/trash"
-			trashed_file, response = get uri
+			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
+
+			trashed_file, response = get uri, query: query
 			trashed_file
 		end
 
@@ -163,21 +189,6 @@ module Boxr
 			restore_trashed_item(uri, name, parent_id)
 		end
 
-		def file_comments(file_id, fields: [])
-			uri = "#{FILES_URI}/#{file_id}/comments"
-			query = build_fields_query(fields, COMMENT_FIELDS_QUERY)
-
-			comments = get_with_pagination uri, query: query
-		end
-
-		def file_tasks(file_id, fields: [])
-			uri = "#{FILES_URI}/#{file_id}/tasks"
-			query = build_fields_query(fields, TASK_FIELDS_QUERY)
-
-			tasks, response = get uri, query: query
-			tasks["entries"]
-		end
-
 
 		private
 

data/lib/boxr/folders.rb

@@ -1,6 +1,24 @@
 module Boxr
 	class Client
 
+		def folder_id(path)
+			if(path.start_with?('/'))
+				path = path.slice(1..-1)
+			end
+
+			path_folders = path.split('/')
+
+			folder_id = path_folders.inject(Boxr::ROOT) do |parent_id, folder_name|
+				folders = folder_items(parent_id, fields: [:id, :name]).folders
+
+				begin
+					folders.select{|f| f.name == folder_name}.first.id
+				rescue
+					raise BoxrException.new(boxr_message: "Folder not found: '#{folder_name}'")
+				end
+			end
+		end
+
 		def folder_items(folder_id, fields: [])
 			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
 			uri = "#{FOLDERS_URI}/#{folder_id}/items"
@@ -16,7 +34,7 @@ module Boxr
 			created_folder
 		end
 
-		def folder_info(folder_id, fields: [])
+		def folder(folder_id, fields: [])
 			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
 			uri = "#{FOLDERS_URI}/#{folder_id}"
 
@@ -24,7 +42,7 @@ module Boxr
 			folder
 		end
 
-		def update_folder_info(folder_id, name: nil, description: nil, parent_id: nil, shared_link: nil,
+		def update_folder(folder_id, name: nil, description: nil, parent_id: nil, shared_link: nil,
 													 folder_upload_email: nil, owned_by_id: nil, sync_state: nil, tags: nil,
 													 can_non_owners_invite: nil, if_match: nil)
 			uri = "#{FOLDERS_URI}/#{folder_id}"
@@ -48,7 +66,7 @@ module Boxr
 			uri = "#{FOLDERS_URI}/#{folder_id}"
 			query = {:recursive => recursive}
 
-			result, response = delete uri, query, if_match: if_match
+			result, response = delete uri, query: query, if_match: if_match
 			result
 		end
 
@@ -71,12 +89,6 @@ module Boxr
 			disable_shared_link(uri, folder_id)
 		end
 
-		def folder_collaborations(folder_id)
-			uri = "#{FOLDERS_URI}/#{folder_id}/collaborations"
-			collaborations, response = get uri
-			collaborations
-		end
-
 		def trash(fields: [])
 			uri = "#{FOLDERS_URI}/trash/items"
 			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
@@ -84,10 +96,12 @@ module Boxr
 			items = get_with_pagination uri, query: query, limit: FOLDER_ITEMS_LIMIT
 		end
 
-		def trashed_folder(folder_id)
+		def trashed_folder(folder_id, fields: [])
 			uri = "#{FOLDERS_URI}/#{folder_id}/trash"
-			item, response = get uri
-			item
+			query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
+			
+			folder, response = get uri, query: query
+			folder
 		end
 
 		def delete_trashed_folder(folder_id)

data/lib/boxr/groups.rb

@@ -20,6 +20,8 @@ module Boxr
 			updated_group
 		end
 
+		alias :rename_group :update_group
+
 		def delete_group(group_id)
 			uri = "#{GROUPS_URI}/#{group_id}"
 			result, response = delete(uri)

data/lib/boxr/search.rb

@@ -19,7 +19,7 @@ module Boxr
 			query[:offset] = offset unless offset.nil?
 
 			results, response = get SEARCH_URI, query: query
-			[results["entries"],results.total_count]
+			results["entries"]
 		end
 
 	end

data/lib/boxr/tasks.rb

@@ -1,6 +1,14 @@
 module Boxr
 	class Client
 
+		def file_tasks(file_id, fields: [])
+			uri = "#{FILES_URI}/#{file_id}/tasks"
+			query = build_fields_query(fields, TASK_FIELDS_QUERY)
+
+			tasks, response = get uri, query: query
+			tasks["entries"]
+		end
+
 		def create_task(file_id, action: :review, message: nil, due_at: nil)
 			attributes = {item: {type: :file, id: file_id}}
 			attributes[:action] = action unless action.nil?
@@ -69,7 +77,7 @@ module Boxr
 			attributes[:message] = message unless message.nil?
 			attributes[:resolution_state] = resolution_state unless resolution_state.nil?
 
-			updated_task, respons = put uri, attributes
+			updated_task, response = put uri, attributes
 			updated_task
 		end
 

data/lib/boxr/users.rb

@@ -8,6 +8,10 @@ module Boxr
 			user
 		end
 
+		def me(fields: [])
+			current_user(fields: fields)
+		end
+
 		def user(user_id, fields: [])
 			uri = "#{USERS_URI}/#{user_id}"
 			query = build_fields_query(fields, USER_FIELDS_QUERY)
@@ -19,7 +23,7 @@ module Boxr
 			uri = USERS_URI
 			query = build_fields_query(fields, USER_FIELDS_QUERY)
 			query[:filter_term] = filter_term unless filter_term.nil?
-			users, response = get_with_pagination(uri, query: query)
+			users = get_with_pagination(uri, query: query)
 		end
 
 		def create_user(login, name, role: nil, language: nil, is_sync_enabled: nil, job_title: nil,

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/tasks/oauth.rake

@@ -0,0 +1,22 @@
+require 'dotenv/tasks'
+require 'boxr'
+
+#to call this from bash, etc. use: rake oauth:get_tokens[YOUR_CLIENT_ID, YOUR CLIENT_SECRET]
+
+#however, if you use zsh you must call as such: rake 'oauth:get_tokens[YOUR_CLIENT_ID, YOUR CLIENT_SECRET]'
+#the single quotes are important for zsh!
+
+
+namespace :oauth do
+	desc "some stuff"
+	task :get_tokens, [:client_id, :client_secret] => :environment do |task, args|
+		puts args.client_id, args.client_secret
+
+		# print "Whoa! Pushing to production. Type 'pushitrealgood' to continue: "
+  #   if STDIN.gets.chomp == 'pushitrealgood'
+  #     system "heroku pgbackups:capture -e -a zenph-production" or abort "aborted backing up production database"
+  #   else
+  #     abort 'task aborted'
+  #   end
+	end
+end

data/spec/boxr_spec.rb

@@ -1,15 +1,447 @@
 require 'spec_helper'
 
-describe Boxr do
+describe Boxr::Client do
+
+	#PLEASE NOTE 
+	#This test is intentionally NOT a series of unit tests.  The goal is to smoke test the entire code base
+	#against an actual Box account, making real calls to the Box API.  The Box API is subject to frequent
+	#changes and it is not sufficient to mock responses as those responses will change over time.  Successfully
+	#running this test suite shows that the code base works with the current Box API.  The main premise here
+	#is that an exception will be thrown if anything unexpected happens.
+
+	#REQUIRED BOX SETTINGS
+	# 1. The developer token used must have admin or co-admin priviledges
+	# 2. Enterprise settings must allow Admin and Co-admins to permanently delete content in Trash
 
 	#follow the directions in .env.example to set up your BOX_DEVELOPER_TOKEN
+	#keep in mind it is only valid for 60 minutes
 	BOX_CLIENT = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
 	
-	#uncomment this line to see the HTTP request and response debug info
+	#uncomment this line to see the HTTP request and response debug info in the rspec output
 	#BOX_CLIENT.debug_device = STDOUT
 
-	it 'lists folder items' do
-		items = BOX_CLIENT.folder_items(Boxr::ROOT)
-		expect(items).to be_a Array
+	BOX_SERVER_SLEEP = 5
+	TEST_FOLDER_NAME = 'Boxr Test'
+	SUB_FOLDER_NAME = 'sub_folder_1'
+	SUB_FOLDER_DESCRIPTION = 'This was created by the Boxr test suite'
+	TEST_FILE_NAME = 'test file.txt'
+	DOWNLOADED_TEST_FILE_NAME = 'downloaded test file.txt'
+	COMMENT_MESSAGE = 'this is a comment'
+	REPLY_MESSAGE = 'this is a comment reply'
+	CHANGED_COMMENT_MESSAGE = 'this comment has been changed'
+	TEST_USER_LOGIN = "test-boxr-user@example.com"
+	TEST_USER_NAME = "Test Boxr User"
+	TEST_GROUP_NAME= "Test Boxr Group"
+	TEST_TASK_MESSAGE = "Please review"
+
+	before(:each) do
+		puts "-----> Resetting Box Environment"
+	  sleep BOX_SERVER_SLEEP
+		root_folders = BOX_CLIENT.folder_items(Boxr::ROOT).folders
+		test_folder = root_folders.find{|f| f.name == TEST_FOLDER_NAME}
+		if(test_folder)
+			BOX_CLIENT.delete_folder(test_folder.id, recursive: true)
+		end
+		new_folder = BOX_CLIENT.create_folder(TEST_FOLDER_NAME, Boxr::ROOT)
+		@test_folder_id = new_folder.id
+
+		all_users = BOX_CLIENT.all_users
+		test_user = all_users.find{|u| u.login == TEST_USER_LOGIN}
+		if(test_user)
+			BOX_CLIENT.delete_user(test_user.id, force: true)
+		end
+		sleep BOX_SERVER_SLEEP
+		test_user = BOX_CLIENT.create_user(TEST_USER_LOGIN, TEST_USER_NAME)
+		@test_user_id = test_user.id
+
+		all_groups = BOX_CLIENT.groups
+		test_group = all_groups.find{|g| g.name == TEST_GROUP_NAME}
+		if(test_group)
+			BOX_CLIENT.delete_group(test_group.id)
+		end
+	end
+
+	it 'invokes folder operations' do
+		puts "get folder id using path"
+		folder_id = BOX_CLIENT.folder_id(TEST_FOLDER_NAME)
+		expect(folder_id).to eq(@test_folder_id)
+
+		puts "get folder info"
+		folder = BOX_CLIENT.folder(@test_folder_id)
+		expect(folder.id).to eq(@test_folder_id)
+
+		puts "create new folder"
+		new_folder = BOX_CLIENT.create_folder(SUB_FOLDER_NAME, @test_folder_id)
+		expect(new_folder).to be_a Hashie::Mash
+		SUB_FOLDER_ID = new_folder.id
+
+		puts "update folder"
+		updated_folder = BOX_CLIENT.update_folder(SUB_FOLDER_ID, description: SUB_FOLDER_DESCRIPTION)
+		expect(updated_folder.description).to eq(SUB_FOLDER_DESCRIPTION)
+
+		puts "copy folder"
+		new_folder = BOX_CLIENT.copy_folder(SUB_FOLDER_ID,@test_folder_id, name: 'copy of sub_folder_1')
+		expect(new_folder).to be_a Hashie::Mash
+		SUB_FOLDER_COPY_ID = new_folder.id
+
+		puts "create shared link for folder"
+		updated_folder = BOX_CLIENT.create_shared_link_for_folder(@test_folder_id, access: :open)
+		expect(updated_folder.shared_link.access).to eq("open")
+		shared_link = updated_folder.shared_link.url
+
+		puts "inspect shared link"
+		shared_item = BOX_CLIENT.shared_item(shared_link)
+		expect(shared_item.id).to eq(@test_folder_id)
+
+		puts "disable shared link for folder"
+		updated_folder = BOX_CLIENT.disable_shared_link_for_folder(@test_folder_id)
+		expect(updated_folder.shared_link).to be_nil
+
+		puts "delete folder"
+		result = BOX_CLIENT.delete_folder(SUB_FOLDER_COPY_ID, recursive: true)
+		expect(result).to eq ({})
+
+		puts "inspect the trash"
+		trash = BOX_CLIENT.trash()
+		expect(trash).to be_a Array
+
+		puts "inspect trashed folder"
+		trashed_folder = BOX_CLIENT.trashed_folder(SUB_FOLDER_COPY_ID)
+		expect(trashed_folder.item_status).to eq("trashed")
+
+		puts "restore trashed folder"
+		restored_folder = BOX_CLIENT.restore_trashed_folder(SUB_FOLDER_COPY_ID)
+		expect(restored_folder.item_status).to eq("active")
+
+		puts "trash and permanently delete folder"
+		BOX_CLIENT.delete_folder(SUB_FOLDER_COPY_ID, recursive: true)
+		result = BOX_CLIENT.delete_trashed_folder(SUB_FOLDER_COPY_ID)
+		expect(result).to eq({})
+	end
+
+	it "invokes file operations" do
+		puts "upload a file"
+		new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder_id)
+		expect(new_file.name).to eq(TEST_FILE_NAME)
+		test_file_id = new_file.id
+
+		puts "get file id using path"
+		file_id = BOX_CLIENT.file_id("/#{TEST_FOLDER_NAME}/#{TEST_FILE_NAME}")
+		expect(file_id).to eq(test_file_id)
+
+		puts "get file download url"
+		download_url = BOX_CLIENT.download_url(test_file_id)
+		expect(download_url).to start_with("https://")
+
+		puts "get file info"
+		file_info = BOX_CLIENT.file(test_file_id)
+		expect(file_info.id).to eq(test_file_id)
+
+		puts "update file"
+		new_description = 'this file is used to test Boxr'
+		updated_file_info = BOX_CLIENT.update_file(test_file_id, description: new_description)
+		expect(updated_file_info.description).to eq(new_description)
+
+		puts "download file"
+		file = BOX_CLIENT.download_file(test_file_id)
+		f = open("./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}", 'w+')
+		f.write(file)
+		f.close
+		expect(FileUtils.identical?("./spec/test_files/#{TEST_FILE_NAME}","./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}")).to eq(true)
+		File.delete("./spec/test_files/#{DOWNLOADED_TEST_FILE_NAME}")
+
+		puts "upload new version of file"
+		new_version = BOX_CLIENT.upload_new_version_of_file("./spec/test_files/#{TEST_FILE_NAME}", test_file_id)
+		expect(new_version.id).to eq(test_file_id)
+
+		puts "inspect versions of file"
+		versions = BOX_CLIENT.versions_of_file(test_file_id)
+		expect(versions.count).to eq(1) #the reason this is 1 instead of 2 is that Box considers 'versions' to be a versions other than 'current'
+		v1_id = versions.first.id
+
+		puts "promote old version of file"
+		newer_version = BOX_CLIENT.promote_old_version_of_file(test_file_id, v1_id)
+		versions = BOX_CLIENT.versions_of_file(test_file_id)
+		expect(versions.count).to eq(2)
+
+		puts "delete old version of file"
+		result = BOX_CLIENT.delete_old_version_of_file(test_file_id,v1_id)
+		versions = BOX_CLIENT.versions_of_file(test_file_id)
+		expect(versions.count).to eq(2) #this is still 2 because with Box you can restore a trashed old version
+
+		puts "get file thumbnail"
+		thumb = BOX_CLIENT.thumbnail(test_file_id)
+		expect(thumb).not_to be_nil
+
+		puts "create shared link for file"
+		updated_file = BOX_CLIENT.create_shared_link_for_file(test_file_id, access: :open)
+		expect(updated_file.shared_link.access).to eq("open")
+
+		puts "disable shared link for file"
+		updated_file = BOX_CLIENT.disable_shared_link_for_file(test_file_id)
+		expect(updated_file.shared_link).to be_nil
+
+		puts "copy file"
+		new_file_name = "copy of #{TEST_FILE_NAME}"
+		new_file = BOX_CLIENT.copy_file(test_file_id, @test_folder_id, name: new_file_name)
+		expect(new_file.name).to eq(new_file_name)
+		NEW_FILE_ID = new_file.id
+
+		puts "delete file"
+		result = BOX_CLIENT.delete_file(NEW_FILE_ID)
+		expect(result).to eq({})
+
+		puts "get trashed file info"
+		trashed_file = BOX_CLIENT.trashed_file(NEW_FILE_ID)
+		expect(trashed_file.item_status).to eq("trashed")
+
+		puts "restore trashed file"
+		restored_file = BOX_CLIENT.restore_trashed_file(NEW_FILE_ID)
+		expect(restored_file.item_status).to eq("active")
+
+		puts "trash and permanently delete file"
+		BOX_CLIENT.delete_file(NEW_FILE_ID)
+		result = BOX_CLIENT.delete_trashed_file(NEW_FILE_ID)
+		expect(result).to eq({})
+	end
+
+	it "invokes user operations" do 
+		puts "inspect current user"
+		user = BOX_CLIENT.current_user
+		expect(user.status).to eq('active')
+		user = BOX_CLIENT.me(fields: [:role])
+		expect(user.role).to_not be_nil
+
+		puts "inspect a user"
+		user = BOX_CLIENT.user(@test_user_id)
+		expect(user.id).to eq(@test_user_id)
+
+		puts "inspect all users"
+		all_users = BOX_CLIENT.all_users()
+		test_user = all_users.find{|u| u.id == @test_user_id}
+		expect(test_user).to_not be_nil
+
+		puts "update user"
+		new_name = "Chuck Nevitt"
+		user = BOX_CLIENT.update_user(@test_user_id, name: new_name)
+		expect(user.name).to eq(new_name)
+
+		#create user is tested in the before method
+
+		puts "delete user"
+		result = BOX_CLIENT.delete_user(@test_user_id, force: true)
+		expect(result).to eq({})
+	end
+
+	it "invokes group operations" do
+		puts "create group"
+		group = BOX_CLIENT.create_group(TEST_GROUP_NAME)
+		expect(group.name).to eq(TEST_GROUP_NAME)
+		test_group_id = group.id
+
+		puts "inspect groups"
+		groups = BOX_CLIENT.groups
+		test_group = groups.find{|g| g.name == TEST_GROUP_NAME}
+		expect(test_group).to_not be_nil
+
+		puts "update group"
+		new_name = "Test Boxr Group Renamed"
+		group = BOX_CLIENT.update_group(test_group_id, new_name)
+		expect(group.name).to eq(new_name)
+		group = BOX_CLIENT.rename_group(test_group_id,TEST_GROUP_NAME)
+		expect(group.name).to eq(TEST_GROUP_NAME)
+
+		puts "add user to group"
+		group_membership = BOX_CLIENT.add_user_to_group(@test_user_id, test_group_id)
+		expect(group_membership.user.id).to eq(@test_user_id)
+		expect(group_membership.group.id).to eq(test_group_id)
+		membership_id = group_membership.id
+
+		puts "inspect group membership"
+		group_membership = BOX_CLIENT.group_membership(membership_id)
+		expect(group_membership.id).to eq(membership_id)
+
+		puts "inspect group memberships"
+		group_memberships = BOX_CLIENT.group_memberships(test_group_id)
+		expect(group_memberships.count).to eq(1)
+		expect(group_memberships.first.id).to eq(membership_id)
+
+		puts "inspect group memberships for a user"
+		group_memberships = BOX_CLIENT.group_memberships_for_user(@test_user_id)
+		expect(group_memberships.count).to eq(1)
+		expect(group_memberships.first.id).to eq(membership_id)
+
+		puts "inspect group memberships for me"
+		#this is whatever user your developer token is tied to
+		group_memberships = BOX_CLIENT.group_memberships_for_me
+		expect(group_memberships).to be_a(Array)
+
+		puts "update group membership"
+		group_membership = BOX_CLIENT.update_group_membership(membership_id, :admin)
+		expect(group_membership.role).to eq("admin")
+
+		puts "delete group membership"
+		result = BOX_CLIENT.delete_group_membership(membership_id)
+		expect(result).to eq({})
+		group_memberships = BOX_CLIENT.group_memberships_for_user(@test_user_id)
+		expect(group_memberships.count).to eq(0)
+
+		puts "inspect group collaborations"
+		group_collaboration = BOX_CLIENT.add_collaboration(@test_folder_id, {id: test_group_id, type: :group}, :editor)
+		expect(group_collaboration.accessible_by.id).to eq(test_group_id)
+
+		puts "delete group"
+		response = BOX_CLIENT.delete_group(test_group_id)
+		expect(response).to eq({})
+	end
+
+	it "invokes comment operations" do 
+		new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder_id)
+		test_file_id = new_file.id
+
+		puts "add comment to file"
+		comment = BOX_CLIENT.add_comment_to_file(test_file_id, message: COMMENT_MESSAGE)
+		expect(comment.message).to eq(COMMENT_MESSAGE)
+		COMMENT_ID = comment.id
+
+		puts "reply to comment"
+		reply = BOX_CLIENT.reply_to_comment(COMMENT_ID, message: REPLY_MESSAGE)
+		expect(reply.message).to eq(REPLY_MESSAGE)
+
+		puts "get file comments"
+		comments = BOX_CLIENT.file_comments(test_file_id)
+		expect(comments.count).to eq(2)
+
+		puts "update a comment"
+		comment = BOX_CLIENT.change_comment(COMMENT_ID, CHANGED_COMMENT_MESSAGE)
+		expect(comment.message).to eq(CHANGED_COMMENT_MESSAGE)
+
+		puts "get comment info"
+		comment = BOX_CLIENT.comment(COMMENT_ID)
+		expect(comment.id).to eq(COMMENT_ID)
+
+		puts "delete comment"
+		result = BOX_CLIENT.delete_comment(COMMENT_ID)
+		expect(result).to eq({})
+	end
+
+	it "invokes collaborations operations" do
+		puts "add collaboration"
+		collaboration = BOX_CLIENT.add_collaboration(@test_folder_id, {id: @test_user_id, type: :user}, :editor)
+		expect(collaboration.accessible_by.id).to eq(@test_user_id)
+		collaboration_id = collaboration.id
+
+		puts "inspect collaboration"
+		collaboration = BOX_CLIENT.collaboration(collaboration_id)
+		expect(collaboration.id).to eq(collaboration_id)
+
+		puts "edit collaboration"
+		collaboration = BOX_CLIENT.edit_collaboration(collaboration_id, role: "viewer uploader")
+		expect(collaboration.role).to eq("viewer uploader")
+
+		puts "inspect folder collaborations"
+		collaborations = BOX_CLIENT.folder_collaborations(@test_folder_id)
+		expect(collaborations.count).to eq(1)
+		expect(collaborations[0].id).to eq(collaboration_id)
+
+		puts "remove collaboration"
+		result = BOX_CLIENT.remove_collaboration(collaboration_id)
+		expect(result).to eq({})
+		collaborations = BOX_CLIENT.folder_collaborations(@test_folder_id)
+		expect(collaborations.count).to eq(0)
+
+		puts "inspect pending collaborations"
+		pending_collaborations = BOX_CLIENT.pending_collaborations
+		expect(pending_collaborations).to eq([])
+	end
+
+	it "invokes task operations" do
+		new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder_id)
+		test_file_id = new_file.id
+		collaboration = BOX_CLIENT.add_collaboration(@test_folder_id, {id: @test_user_id, type: :user}, :editor)
+
+		puts "create task"
+		new_task = BOX_CLIENT.create_task(test_file_id, message: TEST_TASK_MESSAGE)
+		expect(new_task.message).to eq(TEST_TASK_MESSAGE)
+		TEST_TASK_ID = new_task.id
+
+		puts "inspect file tasks"
+		tasks = BOX_CLIENT.file_tasks(test_file_id)
+		expect(tasks.first.id).to eq(TEST_TASK_ID)
+
+		puts "inspect task"
+		task = BOX_CLIENT.task(TEST_TASK_ID)
+		expect(task.id).to eq(TEST_TASK_ID)
+
+		puts "update task"
+		NEW_TASK_MESSAGE = "new task message"
+		updated_task = BOX_CLIENT.update_task(TEST_TASK_ID, message: NEW_TASK_MESSAGE)
+		expect(updated_task.message).to eq(NEW_TASK_MESSAGE)
+
+		puts "create task assignment"
+		task_assignment = BOX_CLIENT.create_task_assignment(TEST_TASK_ID, assign_to_id: @test_user_id)
+		expect(task_assignment.assigned_to.id).to eq(@test_user_id)
+		task_assignment_id = task_assignment.id
+
+		puts "inspect task assignment"
+		task_assignment = BOX_CLIENT.task_assignment(task_assignment_id)
+		expect(task_assignment.id).to eq(task_assignment_id)
+
+		puts "inspect task assignments"
+		task_assignments = BOX_CLIENT.task_assignments(TEST_TASK_ID)
+		expect(task_assignments.count).to eq(1)
+		expect(task_assignments[0].id).to eq(task_assignment_id)
+
+	  #TODO: can't do this test yet because the test user needs to confirm their email address before you can do this
+		puts "update task assignment"
+		expect {
+							box_client_as_test_user = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'], as_user_id: @test_user_id)
+							new_message = "Updated task message"
+							task_assignment = box_client_as_test_user.update_task_assignment(TEST_TASK_ID, resolution_state: :completed)
+							expect(task_assignment.resolution_state).to eq('completed')
+						}.to raise_error
+
+		puts "delete task assignment"
+		result = BOX_CLIENT.delete_task_assignment(task_assignment_id)
+		expect(result).to eq({})
+
+		puts "delete task"
+		result = BOX_CLIENT.delete_task(TEST_TASK_ID)
+		expect(result).to eq({})
+	end
+
+	it "invokes metadata operations" do
+		new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder_id)
+		test_file_id = new_file.id
+
+		puts "create metadata"
+		meta = {"a" => "hello", "b" => "world"}
+		metadata = BOX_CLIENT.create_metadata(test_file_id, meta)
+		expect(metadata.a).to eq("hello")
+
+		puts "update metadata"
+		metadata = BOX_CLIENT.update_metadata(test_file_id, [{op: :replace, path: "/b", value: "there"}])
+		expect(metadata.b).to eq("there")
+
+		puts "get metadata"
+		metadata = BOX_CLIENT.metadata(test_file_id)
+		expect(metadata.a).to eq("hello")
+
+		puts "delete metadata"
+		result = BOX_CLIENT.delete_metadata(test_file_id)
+		expect(result).to eq({})
+	end
+
+	it "invokes search operations" do
+		#the issue with this test is that Box can take between 5-10 minutes to index any content uploaded; this is just a smoke test
+		#so we are searching for something that should return zero results
+		puts "perform search"
+		results = BOX_CLIENT.search("sdlfjuwnsljsdfuqpoiqweouyvnnadsfkjhiuweruywerbjvhvkjlnasoifyukhenlwdflnsdvoiuawfydfjh")
+		expect(results).to eq([])
 	end
+
+	it "invokes a Boxr exception" do
+		expect { BOX_CLIENT.folder(1)}.to raise_error
+	end
+
 end

data/spec/spec_helper.rb

@@ -1,2 +1,4 @@
 require 'dotenv'; Dotenv.load
-require 'boxr'
+require 'simplecov'; SimpleCov.start
+require 'boxr'
+require 'awesome_print'

data/spec/test_files/test file.txt

@@ -0,0 +1 @@
+This is a test file for the Boxr Gem RSpec smoke test.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+- !ruby/object:Gem::Dependency
+  name: lru_redux
+  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'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -122,10 +164,13 @@ files:
 - README.md
 - Rakefile
 - boxr.gemspec
+- examples/enterprise_events.rb
+- examples/user_events.rb
 - lib/boxr.rb
 - lib/boxr/client.rb
 - lib/boxr/collaborations.rb
 - lib/boxr/comments.rb
+- lib/boxr/events.rb
 - lib/boxr/exceptions.rb
 - lib/boxr/files.rb
 - lib/boxr/folders.rb
@@ -136,8 +181,10 @@ files:
 - lib/boxr/tasks.rb
 - lib/boxr/users.rb
 - lib/boxr/version.rb
+- lib/tasks/oauth.rake
 - spec/boxr_spec.rb
 - spec/spec_helper.rb
+- spec/test_files/test file.txt
 homepage: https://github.com/cburnette/boxr
 licenses:
 - MIT
@@ -166,3 +213,4 @@ summary: A Ruby client library for the Box V2 Content API that covers 100% of th
 test_files:
 - spec/boxr_spec.rb
 - spec/spec_helper.rb
+- spec/test_files/test file.txt