boxr 0.0.1

data/lib/boxr/metadata.rb

@@ -0,0 +1,29 @@
+module Boxr
+	class Client
+
+		def create_metadata(file_id, metadata, type: :properties)
+			uri = "#{METADATA_URI}/#{file_id}/metadata/#{type}"
+			metadata, response = post uri, metadata, content_type: "application/json"
+			metadata
+		end
+
+		def metadata(file_id, type: :properties)
+			uri = "#{METADATA_URI}/#{file_id}/metadata/#{type}"
+			metadata, response = get uri
+			metadata
+		end
+
+		def update_metadata(file_id, updates, type: :properties)
+			uri = "#{METADATA_URI}/#{file_id}/metadata/#{type}"
+			metadata, response = put uri, updates, content_type: "application/json-patch+json"
+			metadata
+		end
+
+		def delete_metadata(file_id, type: :properties)
+			uri = "#{METADATA_URI}/#{file_id}/metadata/#{type}"
+			result, response = delete uri
+			result
+		end
+
+	end
+end

data/lib/boxr/search.rb

@@ -0,0 +1,26 @@
+module Boxr
+	class Client
+
+		def search(query, scope: nil, file_extensions: nil, created_at_range: nil, updated_at_range: nil, size_range: nil, 
+											owner_user_ids: nil, ancestor_folder_ids: nil, content_types: nil, type: nil, 
+											limit: 30, offset: 0)
+
+			query = {query: query}
+			query[:scope] = scope unless scope.nil?
+			query[:file_extensions] = file_extensions unless file_extensions.nil?
+			query[:created_at_range] = created_at_range unless created_at_range.nil?
+			query[:updated_at_range] = updated_at_range unless updated_at_range.nil?
+			query[:size_range] = size_range unless size_range.nil?
+			query[:owner_user_ids] = owner_user_ids unless owner_user_ids.nil?
+			query[:ancestor_folder_ids] = ancestor_folder_ids unless ancestor_folder_ids.nil?
+			query[:content_types] = content_types unless content_types.nil?
+			query[:type] = type unless type.nil?
+			query[:limit] = limit unless limit.nil?
+			query[:offset] = offset unless offset.nil?
+
+			results, response = get SEARCH_URI, query: query
+			[results["entries"],results.total_count]
+		end
+
+	end
+end

data/lib/boxr/shared_items.rb

@@ -0,0 +1,13 @@
+module Boxr
+	class Client
+
+		def shared_item(shared_link, shared_link_password: nil)
+			box_api_header = "shared_link=#{shared_link}"
+			box_api_header += "&shared_link_password=#{shared_link_password}" unless shared_link_password.nil?
+
+			file_or_folder, response = get(SHARED_ITEMS_URI, box_api_header: box_api_header)
+			file_or_folder
+		end
+
+	end
+end

data/lib/boxr/tasks.rb

@@ -0,0 +1,77 @@
+module Boxr
+	class Client
+
+		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?
+			attributes[:message] = message unless message.nil?
+			attributes[:due_at] = due_at.to_datetime.rfc3339 unless due_at.nil?
+
+			new_task, response = post TASKS_URI, attributes
+			new_task
+		end
+
+		def task(task_id)
+			uri = "#{TASKS_URI}/#{task_id}"
+			task, response = get uri
+			task
+		end
+
+		def update_task(task_id, action: :review, message: nil, due_at: nil)
+			uri = "#{TASKS_URI}/#{task_id}"
+			attributes = {}
+			attributes[:action] = action unless action.nil?
+			attributes[:message] = message unless message.nil?
+			attributes[:due_at] = due_at.to_datetime.rfc3339 unless due_at.nil?
+
+			task, response = put uri, attributes
+			task
+		end
+
+		def delete_task(task_id)
+			uri = "#{TASKS_URI}/#{task_id}"
+			result, response = delete uri
+			result
+		end
+
+		def task_assignments(task_id)
+			uri = "#{TASKS_URI}/#{task_id}/assignments"
+			assignments, response = get uri
+			assignments['entries']
+		end
+
+		def create_task_assignment(task_id, assign_to_id: nil, assign_to_login: nil)
+			attributes = {task: {type: :task, id: "#{task_id}"}}
+			
+			attributes[:assign_to] = {} 
+			attributes[:assign_to][:login] = assign_to_login unless assign_to_login.nil?
+			attributes[:assign_to][:id] = assign_to_id unless assign_to_id.nil?
+
+			new_task_assignment, response = post TASK_ASSIGNMENTS_URI, attributes
+			new_task_assignment
+		end
+
+		def task_assignment(task_id)
+			uri = "#{TASK_ASSIGNMENTS_URI}/#{task_id}"
+			task_assignment, response = get uri
+			task_assignment
+		end
+
+		def delete_task_assignment(task_id)
+			uri = "#{TASK_ASSIGNMENTS_URI}/#{task_id}"
+			result, response = delete uri
+			result
+		end
+
+		def update_task_assignment(task_id, message: nil, resolution_state: nil)
+			uri = "#{TASK_ASSIGNMENTS_URI}/#{task_id}"
+			attributes = {}
+			attributes[:message] = message unless message.nil?
+			attributes[:resolution_state] = resolution_state unless resolution_state.nil?
+
+			updated_task, respons = put uri, attributes
+			updated_task
+		end
+
+	end
+end

data/lib/boxr/users.rb

@@ -0,0 +1,92 @@
+module Boxr
+	class Client
+
+		def current_user(fields: [])
+			uri = "#{USERS_URI}/me"
+			query = build_fields_query(fields, USER_FIELDS_QUERY)
+			user, response = get(uri, query: query)
+			user
+		end
+
+		def user(user_id, fields: [])
+			uri = "#{USERS_URI}/#{user_id}"
+			query = build_fields_query(fields, USER_FIELDS_QUERY)
+			user, response = get(uri, query: query)
+			user
+		end
+
+		def all_users(filter_term: nil, fields: [])
+			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)
+		end
+
+		def create_user(login, name, role: nil, language: nil, is_sync_enabled: nil, job_title: nil,
+																 phone: nil, address: nil, space_amount: nil, tracking_codes: nil,
+																 can_see_managed_users: nil, is_external_collab_restricted: nil, status: nil, timezone: nil,
+																 is_exempt_from_device_limits: nil, is_exempt_from_login_verification: nil)
+
+			uri = USERS_URI
+			attributes = {login: login, name: name}
+			attributes[:role] = role unless role.nil?
+			attributes[:language] = language unless language.nil?
+			attributes[:is_sync_enabled] = is_sync_enabled unless is_sync_enabled.nil?
+			attributes[:job_title] = job_title unless job_title.nil?
+			attributes[:phone] = phone unless phone.nil? 
+			attributes[:address] = address unless address.nil?
+			attributes[:space_amount] = space_amount unless space_amount.nil?
+			attributes[:tracking_codes] = tracking_codes unless tracking_codes.nil?
+			attributes[:can_see_managed_users] = can_see_managed_users unless can_see_managed_users.nil?
+			attributes[:is_external_collab_restricted] = is_external_collab_restricted unless is_external_collab_restricted.nil?
+			attributes[:status] = status unless status.nil?
+			attributes[:timezone] = timezone unless timezone.nil?
+			attributes[:is_exempt_from_device_limits] = is_exempt_from_device_limits unless is_exempt_from_device_limits.nil? 
+			attributes[:is_exempt_from_login_verification] = is_exempt_from_login_verification unless is_exempt_from_login_verification.nil?
+
+			new_user, response = post(uri, attributes)
+			new_user
+		end
+
+		def update_user(user_id, notify: nil, enterprise: true, name: nil, role: nil, language: nil, is_sync_enabled: nil,
+														 job_title: nil, phone: nil, address: nil, space_amount: nil, tracking_codes: nil,
+														 can_see_managed_users: nil, status: nil, timezone: nil, is_exempt_from_device_limits: nil,
+														 is_exempt_from_login_verification: nil, is_exempt_from_reset_required: nil, is_external_collab_restricted: nil)
+
+			uri = "#{USERS_URI}/#{user_id}"
+			query = {notify: notify} unless notify.nil?
+			
+			attributes = {}
+			attributes[:enterprise] = nil if enterprise.nil? #this is a special condition where setting this to nil means to roll this user out of the enterprise 
+			attributes[:name] = name unless name.nil?
+			attributes[:role] = role unless role.nil?
+			attributes[:language] = language unless language.nil?
+			attributes[:is_sync_enabled] = is_sync_enabled unless is_sync_enabled.nil?
+			attributes[:job_title] = job_title unless job_title.nil?
+			attributes[:phone] = phone unless phone.nil?
+			attributes[:address] = address unless address.nil?
+			attributes[:space_amount] = space_amount unless space_amount.nil?
+			attributes[:tracking_codes] = tracking_codes unless tracking_codes.nil?
+			attributes[:can_see_managed_users] = can_see_managed_users unless can_see_managed_users.nil?
+			attributes[:status] = status unless status.nil?
+			attributes[:timezone] = timezone unless timezone.nil?
+			attributes[:is_exempt_from_device_limits] = is_exempt_from_device_limits unless is_exempt_from_device_limits.nil?
+			attributes[:is_exempt_from_login_verification] = is_exempt_from_login_verification unless is_exempt_from_login_verification.nil?
+			attributes[:is_exempt_from_reset_required] = is_exempt_from_reset_required unless is_exempt_from_reset_required.nil?
+			attributes[:is_external_collab_restricted] = is_external_collab_restricted unless is_external_collab_restricted.nil?
+
+			updated_user, response = put(uri, attributes, query: query)
+			updated_user
+		end
+
+		def delete_user(user_id, notify: nil, force: nil)
+			uri = "#{USERS_URI}/#{user_id}"
+			query = {}
+			query[:notify] = notify unless notify.nil?
+			query[:force] = force unless force.nil?
+			result, response = delete(uri, query: query)
+			result
+		end
+
+	end
+end

data/lib/boxr/version.rb

@@ -0,0 +1,3 @@
+module Boxr
+  VERSION = "0.0.1"
+end

data/spec/boxr_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Boxr do
+
+	#follow the directions in .env.example to set up your BOX_DEVELOPER_TOKEN
+	BOX_CLIENT = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
+	
+	#uncomment this line to see the HTTP request and response debug info
+	#BOX_CLIENT.debug_device = STDOUT
+
+	it 'lists folder items' do
+		items = BOX_CLIENT.folder_items(Boxr::ROOT)
+		expect(items).to be_a Array
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'dotenv'; Dotenv.load
+require 'boxr'

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: boxr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chad Burnette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: ''
+email:
+- chadburnette@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- boxr.gemspec
+- lib/boxr.rb
+- lib/boxr/client.rb
+- lib/boxr/collaborations.rb
+- lib/boxr/comments.rb
+- lib/boxr/exceptions.rb
+- lib/boxr/files.rb
+- lib/boxr/folders.rb
+- lib/boxr/groups.rb
+- lib/boxr/metadata.rb
+- lib/boxr/search.rb
+- lib/boxr/shared_items.rb
+- lib/boxr/tasks.rb
+- lib/boxr/users.rb
+- lib/boxr/version.rb
+- spec/boxr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cburnette/boxr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A Ruby client library for the Box V2 Content API that covers 100% of the
+  underlying REST API.
+test_files:
+- spec/boxr_spec.rb
+- spec/spec_helper.rb