boxr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe63a17bee50c141a055587190b08b1487de5f5e
+  data.tar.gz: 0ddb73b50600453f306c7c8409c31f29c915083c
+SHA512:
+  metadata.gz: ecd0548d4c4d068ed54c8e96a7fa8374d8516819dff0ac0b296ba6942c48a54093519dd890104c458dbdee1b19e1ebabdb08f910eab2fd4cc65ca082d2b04f3d
+  data.tar.gz: 81b0c14fa6c5d01bed3fd2630de985a6f0869d2dee77c148f33de968d05fc9e2c20b1494181610190acab484bfb100fa17da39c5138f1c209f1bf46a989183f3

data/.env.example

@@ -0,0 +1,9 @@
+#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. paste the value below
+#7. save this file as .env
+
+BOX_DEVELOPER_TOKEN=bsuwpLRJYN123NJTOisOvdvBCloboMqW

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/.ruby-version
+/.ruby-gemset
+/.env.test
+/.env
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in boxr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chad Burnette
+
+MIT License
+
+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.md

@@ -0,0 +1,31 @@
+# Boxr
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'boxr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install boxr
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec
+

data/boxr.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boxr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "boxr"
+  spec.version       = Boxr::VERSION
+  spec.authors       = ["Chad Burnette"]
+  spec.email         = ["chadburnette@me.com"]
+  spec.summary       = "A Ruby client library for the Box V2 Content API that covers 100% of the underlying REST API."
+  spec.description   = ""
+  spec.homepage      = "https://github.com/cburnette/boxr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "dotenv", "~> 0.11"
+
+  spec.add_runtime_dependency "oj", "~> 2.11"
+  spec.add_runtime_dependency "httpclient", "~> 2.5"
+  spec.add_runtime_dependency "hashie", "~> 3.3"
+end

data/lib/boxr.rb

@@ -0,0 +1,38 @@
+require 'oj'
+require 'httpclient'
+require 'hashie'
+
+require "boxr/version"
+require 'boxr/exceptions'
+require 'boxr/client'
+require 'boxr/folders'
+require 'boxr/files'
+require 'boxr/comments'
+require 'boxr/users'
+require 'boxr/groups'
+require 'boxr/collaborations'
+require 'boxr/search'
+require 'boxr/tasks'
+require 'boxr/shared_items'
+require 'boxr/metadata'
+
+module Enumerable
+	def files
+		self.select{|i| i.type == 'file'}
+	end
+
+	def folders
+		self.select{|i| i.type == 'folder'}
+	end
+
+	def web_links
+		self.select{|i| i.type == 'web_link'}
+	end
+end
+
+module Boxr
+  Oj.default_options = {:mode => :compat }
+
+	#The root folder in Box is always identified by 0
+	ROOT = 0
+end

data/lib/boxr/client.rb

@@ -0,0 +1,215 @@
+module Boxr
+	
+	class Client
+
+		API_URI = "https://api.box.com/2.0"
+		UPLOAD_URI = "https://upload.box.com/api/2.0"
+		FILES_URI = "#{API_URI}/files"
+		FILES_UPLOAD_URI = "#{UPLOAD_URI}/files/content"
+		FOLDERS_URI = "#{API_URI}/folders"
+		USERS_URI = "#{API_URI}/users"
+		GROUPS_URI = "#{API_URI}/groups"
+		GROUP_MEMBERSHIPS_URI = "#{API_URI}/group_memberships"
+		COLLABORATIONS_URI = "#{API_URI}/collaborations"
+		COMMENTS_URI = "#{API_URI}/comments"
+		SEARCH_URI = "#{API_URI}/search"
+		TASKS_URI = "#{API_URI}/tasks"
+		TASK_ASSIGNMENTS_URI = "#{API_URI}/task_assignments"
+		SHARED_ITEMS_URI = "#{API_URI}/shared_items"
+		METADATA_URI = "#{API_URI}/files"
+
+		DEFAULT_LIMIT = 100
+		FOLDER_ITEMS_LIMIT = 1000
+
+		FOLDER_AND_FILE_FIELDS = [:type,:id,:sequence_id,:etag,:name,:created_at,:modified_at,:description,
+															:size,:path_collection,:created_by,:modified_by,:trashed_at,:purged_at,
+															:content_created_at,:content_modified_at,:owned_by,:shared_link,:folder_upload_email,
+															:parent,:item_status,:item_collection,:sync_state,:has_collaborations,:permissions,:tags,
+															:sha1,:shared_link,:version_number,:comment_count,:lock,:extension,:is_package,:can_non_owners_invite]
+		FOLDER_AND_FILE_FIELDS_QUERY = FOLDER_AND_FILE_FIELDS.join(',')
+
+		COMMENT_FIELDS = [:type,:id,:is_reply_comment,:message,:tagged_message,:created_by,:created_at,:item,:modified_at]
+		COMMENT_FIELDS_QUERY = COMMENT_FIELDS.join(',')
+		
+		TASK_FIELDS = [:type,:id,:item,:due_at,:action,:message,:task_assignment_collection,:is_completed,:created_by,:created_at]
+		TASK_FIELDS_QUERY = TASK_FIELDS.join(',')
+
+		COLLABORATION_FIELDS = [:type,:id,:created_by,:created_at,:modified_at,:expires_at,:status,:accessible_by,:role,:acknowledged_at,:item]
+		COLLABORATION_FIELDS_QUERY = COLLABORATION_FIELDS.join(',')
+
+		USER_FIELDS = [:type,:id,:name,:login,:created_at,:modified_at,:role,:language,:timezone,:space_amount,:space_used,
+									 :max_upload_size,:tracking_codes,:can_see_managed_users,:is_sync_enabled,:is_external_collab_restricted,
+									 :status,:job_title,:phone,:address,:avatar_uri,:is_exempt_from_device_limits,:is_exempt_from_login_verification,
+									 :enterprise,:my_tags]
+		USER_FIELDS_QUERY = USER_FIELDS.join(',')
+
+		GROUP_FIELDS = [:type, :id, :name, :created_at, :modified_at]
+		GROUP_FIELDS_QUERY = GROUP_FIELDS.join(',')
+
+		#Read this to see why the httpclient gem was chosen: http://bibwild.wordpress.com/2012/04/30/ruby-http-performance-shootout-redux/
+		#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.transparent_gzip_decompression = true 
+
+		def initialize(token, as_user_id: nil)
+			@token = token
+			@as_user_id = as_user_id
+		end
+
+		def debug_device=(device)
+			if device
+				BOX_CLIENT.debug_dev = device
+				BOX_CLIENT.transparent_gzip_decompression = false
+			else
+				BOX_CLIENT.debug_dev = nil
+				BOX_CLIENT.transparent_gzip_decompression = true
+			end
+		end
+
+
+
+		private
+
+		def get(uri, query: nil, success_codes: [200], process_response: true, if_match: nil, box_api_header: nil)
+			headers = standard_headers()
+			headers['If-Match'] = if_match unless if_match.nil?
+			headers['BoxApi'] = box_api_header unless box_api_header.nil?
+
+			res = BOX_CLIENT.get(uri, query: query, header: headers)
+			check_response_status(res, success_codes)
+
+			if process_response
+				return processed_response res
+			else
+				return res.body, res
+			end
+		end
+
+		def get_with_pagination(uri, query: {}, limit: DEFAULT_LIMIT)
+			entries = []
+			offset = 0
+			headers = standard_headers()
+
+			begin
+				query[:limit] = limit
+				query[:offset] = offset
+				res = BOX_CLIENT.get(uri, query: query, header: headers)
+				
+				if (res.status==200)
+					body_json = Oj.load(res.body)
+					total_count = body_json["total_count"]
+					offset = offset + limit
+
+					entries << body_json["entries"]
+				else
+					raise BoxrException.new(res.status, res.body, res.header)
+				end
+			end until offset - total_count >= 0
+
+			entries.flatten.map{|i| Hashie::Mash.new(i)}
+		end
+
+		def post(uri, body, query: nil, success_codes: [201], process_body: true, content_md5: nil, content_type: nil, if_match: nil)
+			body = Oj.dump(body) if process_body
+
+			headers = standard_headers()
+			headers['If-Match'] = if_match unless if_match.nil?
+			headers["Content-MD5"] = content_md5 unless content_md5.nil?
+			headers["Content-Type"] = content_type unless content_type.nil?
+
+			res = BOX_CLIENT.post(uri, body: body, query: query, header: headers)
+			check_response_status(res, success_codes)
+
+			processed_response res
+		end
+
+		def put(uri, body, query: nil, success_codes: [200], content_type: nil, if_match: nil)
+			headers = standard_headers()
+			headers['If-Match'] = if_match unless if_match.nil?
+			headers["Content-Type"] = content_type unless content_type.nil?
+
+			res = BOX_CLIENT.put(uri, body: Oj.dump(body), query: query, header: headers)
+			check_response_status(res, success_codes)
+
+			processed_response res
+		end
+
+		def delete(uri, query: nil, success_codes: [204], if_match: nil)
+			headers = standard_headers()
+			headers['If-Match'] = if_match unless if_match.nil?
+
+			res = BOX_CLIENT.delete(uri, query: query, header: headers)
+			check_response_status(res, success_codes)
+
+			processed_response res
+		end
+
+		def options(uri, body, success_codes: [200])
+			headers = standard_headers()
+
+			res = BOX_CLIENT.options(uri, body: Oj.dump(body), header: headers)
+			check_response_status(res, success_codes)
+
+			processed_response res
+		end
+
+		def standard_headers()
+			headers = {"Authorization" => "Bearer #{@token}"}
+			headers['As-User'] = "#{@as_user_id}" unless @as_user_id.nil?
+			headers
+		end
+
+		def check_response_status(res, success_codes)
+			raise BoxrException.new(res.status, res.body, res.header) unless success_codes.include?(res.status)
+		end
+
+		def processed_response(res)
+			body_json = Oj.load(res.body)
+			return Hashie::Mash.new(body_json), res
+		end
+
+		def build_fields_query(fields, all_fields_query)
+			if fields == :all
+				{:fields => all_fields_query}
+			elsif fields.is_a?(Array) && fields.length > 0
+				{:fields => fields.join(',')}
+			else
+				{}
+			end
+		end
+
+		def create_shared_link(uri, item_id, access, unshared_at, can_download, can_preview)
+			if access.nil?
+				attributes = {shared_link: {}}
+			else
+				attributes = {shared_link: {access: access}}
+				attributes[:shared_link][:unshared_at] = unshared_at.to_datetime.rfc3339 if unshared_at
+				attributes[:shared_link][:permissions] = {} unless can_download.nil? && can_preview.nil?
+				attributes[:shared_link][:permissions][:can_download] = can_download unless can_download.nil?
+				attributes[:shared_link][:permissions][:can_preview] = can_preview unless can_preview.nil?
+			end
+
+			updated_item, response = put uri, attributes
+			updated_item
+		end
+
+		def disable_shared_link(uri, item_id)
+			attributes = {shared_link: nil}
+
+			updated_item, response = put uri, attributes
+			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

@@ -0,0 +1,52 @@
+module Boxr
+	class Client
+
+		#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)
+			query[:notify] = :notify unless notify.nil?
+
+			attributes = {item: {id: folder_id, type: :folder}}
+			attributes[:accessible_by] = accessible_by
+			attributes[:role] = role
+
+			collaboration, response = post(COLLABORATIONS_URI, attributes, query: query)
+			collaboration
+		end
+
+		def edit_collaboration(collaboration_id, role: nil, status: nil)
+			uri = "#{COLLABORATIONS_URI}/#{collaboration_id}"
+			attributes = {}
+			attributes[:role] = role unless role.nil?
+			attributes[:status] = status unless status.nil?
+
+			updated_collaboration, response = put(uri, attributes)
+			updated_collaboration
+		end
+
+		def remove_collaboration(collaboration_id)
+			uri = "#{COLLABORATIONS_URI}/#{collaboration_id}"
+			result, response = delete(uri)
+			result
+		end
+
+		def collaboration(collaboration_id, fields: [], status: nil)
+			uri = "#{COLLABORATIONS_URI}/#{collaboration_id}"
+
+			query = build_fields_query(fields, COLLABORATION_FIELDS_QUERY)
+			query[:status] = status unless status.nil?
+
+			collaboration, response = get(uri, query: query)
+			collaboration
+		end
+
+		#these are pending collaborations for the current users; use the As-User Header to request for different users
+		def pending_collaborations
+			query = {status: :pending}
+			pending_collaborations, response = get(COLLABORATIONS_URI, query: query)
+			pending_collaborations['entries']
+		end
+
+
+	end
+end