boxr 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cdb5f7265259244d249458468620150e7a64f19
-  data.tar.gz: 0adf2236b65d01221f5b5b00d249387ac613e6a8
+  metadata.gz: 44f0efa6c33c1ad7a0126cddc1cef3a883782be0
+  data.tar.gz: e2c3bd4cb8400ab48106db786a798bb81ed91638
 SHA512:
-  metadata.gz: 1113cc5af8e5de187b8c6ebd15625ae2164120ccde300b1e70dd484079ff6139d5eb4871605c1a6473c25e54e9a0896a07aef5ec63a62ff25d9429e3b3dd4963
-  data.tar.gz: 5a9985a2d4799935c622c0120cd477e7f3c8fd5a2061494dc0ac2cd3046729bb522daf747bd03c09ef7acded42a1863fd895ee069f6977254e3b2cb7386030a1
+  metadata.gz: 94f78c8a5af9b80583cf4ec615170201a72a3c5ff0f8d371209ca759249362ed9e6dd0d8a17ac5e95fe37c2ba761b3d5fd79e736ba3a5268b2b649941afb9e8c
+  data.tar.gz: a795b2fb4e8ab3e66c5a31177fd40bcb49fc15079cb6774bb9993f8592feade6603bdc84fe97062f72994ad4e645c742666f946d58809b12680dc2f10151069b

data/README.md

@@ -88,6 +88,196 @@ file = client.create_shared_link_for_file(file, access: :open)
 puts "Shared Link: #{file.shared_link.url}"
 ```
 
+### Methods
+#### Folders
+```ruby
+folder_from_path(path)
+     
+folder_items(folder, fields: [], offset: 0, limit: FOLDER_ITEMS_LIMIT)
+      
+root_folder_items(fields: [], offset: 0, limit: FOLDER_ITEMS_LIMIT)
+      
+create_folder(name, parent)
+     
+folder(folder_id, fields: [])
+     
+update_folder(folder, name: nil, description: nil, parent_id: nil, shared_link: nil,
+                folder_upload_email_access: nil, owned_by_id: nil, sync_state: nil, tags: nil,
+                can_non_owners_invite: nil, if_match: nil)
+     
+delete_folder(folder, recursive: false, if_match: nil)
+     
+copy_folder(folder, dest_folder, name: nil)
+      
+create_shared_link_for_folder(folder, access: nil, unshared_at: nil, can_download: nil, can_preview: nil)
+      
+disable_shared_link_for_folder(folder)
+     
+trash(fields: [], offset: 0, limit: FOLDER_ITEMS_LIMIT)
+      
+trashed_folder(folder, fields: [])
+     
+delete_trashed_folder(folder)
+      
+restore_trashed_folder(folder, name: nil, parent_id: nil)
+```
+#### Files
+```ruby
+file_from_path(path)
+
+file(file_id, fields: [])
+
+update_file(file, name: nil, description: nil, parent_id: nil, shared_link: nil, tags: nil, if_match: nil)
+
+download_file(file, version: nil, follow_redirect: true)
+
+download_url(file, version: nil)
+
+upload_file(path_to_file, parent, content_created_at: nil, content_modified_at: nil, 
+            preflight_check: true, send_content_md5: true)
+
+delete_file(file, if_match: nil)
+
+upload_new_version_of_file(path_to_file, file, content_modified_at: nil, send_content_md5: true, 
+                            preflight_check: true, if_match: nil)
+
+versions_of_file(file)
+
+promote_old_version_of_file(file, file_version)
+
+delete_old_version_of_file(file, file_version, if_match: nil)
+
+copy_file(file, parent, name: nil)
+
+thumbnail(file, min_height: nil, min_width: nil, max_height: nil, max_width: nil)
+
+create_shared_link_for_file(file, access: nil, unshared_at: nil, can_download: nil, can_preview: nil)
+
+disable_shared_link_for_file(file)
+
+trashed_file(file, fields: [])
+
+delete_trashed_file(file)
+
+restore_trashed_file(file, name: nil, parent_id: nil)
+```
+#### Comments
+```ruby
+file_comments(file, fields: [], offset: 0, limit: DEFAULT_LIMIT)
+      
+add_comment_to_file(file, message: nil, tagged_message: nil)
+     
+reply_to_comment(comment_id, message: nil, tagged_message: nil)
+      
+change_comment(comment, message)
+     
+comment(comment_id, fields: [])
+      
+delete_comment(comment)
+```
+#### Collaborations
+```ruby
+folder_collaborations(folder)
+    
+add_collaboration(folder, accessible_by, role, fields: [], notify: nil)
+     
+edit_collaboration(collaboration, role: nil, status: nil)
+      
+remove_collaboration(collaboration)
+      
+collaboration(collaboration_id, fields: [], status: nil)
+      
+pending_collaborations()
+```
+#### Events
+```ruby
+user_events(stream_position: 0, stream_type: :all, limit: 100)
+      
+enterprise_events(stream_position: 0, limit: 100, event_type: nil, created_after: nil, created_before: nil)
+```
+#### Shared Items
+```ruby
+shared_item(shared_link, shared_link_password: nil)
+```
+#### Search
+```ruby
+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)
+```
+#### Users
+```ruby
+current_user(fields: [])
+      
+alias :me :current_user
+
+user(user_id, fields: [])
+      
+all_users(filter_term: nil, fields: [], offset: 0, limit: DEFAULT_LIMIT)
+     
+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)
+
+
+update_user(user, 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)
+
+delete_user(user, notify: nil, force: nil)
+```
+#### Groups
+```ruby
+groups(fields: [], offset: 0, limit: DEFAULT_LIMIT)
+      
+create_group(name)
+     
+update_group(group, name)
+      
+alias :rename_group :update_group
+
+delete_group(group)
+     
+group_memberships(group, offset: 0, limit: DEFAULT_LIMIT)
+      
+group_memberships_for_user(user, offset: 0, limit: DEFAULT_LIMIT)
+      
+group_memberships_for_me(offset: 0, limit: DEFAULT_LIMIT)
+      
+group_membership(membership_id)
+     
+add_user_to_group(user, group, role: nil)
+      
+update_group_membership(membership, role)
+      
+delete_group_membership(membership)
+      
+group_collaborations(group, offset: 0, limit: DEFAULT_LIMIT)
+```
+#### Tasks
+```ruby
+file_tasks(file, fields: [])
+      
+create_task(file, action: :review, message: nil, due_at: nil)
+      
+task(task_id)
+     
+update_task(task, action: :review, message: nil, due_at: nil)
+      
+delete_task(task)
+      
+task_assignments(task)
+      
+create_task_assignment(task, assign_to_id: nil, assign_to_login: nil)
+      
+task_assignment(task)
+      
+delete_task_assignment(task)
+      
+update_task_assignment(task, message: nil, resolution_state: nil)
+```
 
 ## Contributing
 

data/lib/boxr/collaborations.rb

@@ -40,8 +40,8 @@ module Boxr
       result
     end
 
-    def collaboration(collaboration, fields: [], status: nil)
-      collaboration_id = ensure_id(collaboration)
+    def collaboration(collaboration_id, fields: [], status: nil)
+      collaboration_id = ensure_id(collaboration_id)
       uri = "#{COLLABORATIONS_URI}/#{collaboration_id}"
 
       query = build_fields_query(fields, COLLABORATION_FIELDS_QUERY)

data/lib/boxr/comments.rb

@@ -27,8 +27,8 @@ module Boxr
       updated_comment
     end
 
-    def comment(comment, fields: [])
-      comment_id = ensure_id(comment)
+    def comment(comment_id, fields: [])
+      comment_id = ensure_id(comment_id)
       uri ="#{COMMENTS_URI}/#{comment_id}"
       comment, response = get(uri)
       comment

data/lib/boxr/files.rb

@@ -17,8 +17,8 @@ module Boxr
       file
     end
 
-    def file(file, fields: [])
-      file_id = ensure_id(file)
+    def file(file_id, fields: [])
+      file_id = ensure_id(file_id)
       uri = "#{FILES_URI}/#{file_id}"
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
       file, response = get(uri, query: query)

data/lib/boxr/folders.rb

@@ -24,8 +24,8 @@ module Boxr
       items = get_with_pagination(uri, query: query, offset: offset, limit: limit)
     end
 
-    def root_folder_items(fields: [])
-      folder_items(Boxr::ROOT, fields: fields)
+    def root_folder_items(fields: [], offset: 0, limit: FOLDER_ITEMS_LIMIT)
+      folder_items(Boxr::ROOT, fields: fields, offset: offset, limit: limit)
     end
 
     def create_folder(name, parent)
@@ -37,8 +37,8 @@ module Boxr
       created_folder
     end
 
-    def folder(folder, fields: [])
-      folder_id = ensure_id(folder)
+    def folder(folder_id, fields: [])
+      folder_id = ensure_id(folder_id)
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
       uri = "#{FOLDERS_URI}/#{folder_id}"
 

data/lib/boxr/groups.rb

@@ -47,8 +47,8 @@ module Boxr
       memberships = get_with_pagination(uri, offset: offset, limit: limit)
     end
 
-    def group_membership(membership)
-      membership_id = ensure_id(membership)
+    def group_membership(membership_id)
+      membership_id = ensure_id(membership_id)
       uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
       membership, response = get(uri)
       membership

data/lib/boxr/tasks.rb

@@ -21,8 +21,8 @@ module Boxr
       new_task
     end
 
-    def task(task)
-      task_id = ensure_id(task)
+    def task(task_id)
+      task_id = ensure_id(task_id)
       uri = "#{TASKS_URI}/#{task_id}"
       task, response = get(uri)
       task

data/lib/boxr/users.rb

@@ -10,8 +10,8 @@ module Boxr
 
     alias :me :current_user
 
-    def user(user, fields: [])
-      user_id = ensure_id(user)
+    def user(user_id, fields: [])
+      user_id = ensure_id(user_id)
       uri = "#{USERS_URI}/#{user_id}"
       query = build_fields_query(fields, USER_FIELDS_QUERY)
       user, response = get(uri, query: query)

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Chad Burnette