boxr 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0c27f80c271f3f13e8b2fb13946467f136b1955
-  data.tar.gz: 1ad858f6831a877a0f03dccf822941a4d6a91bb3
+  metadata.gz: 0aa4abe4312f4c46511db9986e8ad93b35b8cfe8
+  data.tar.gz: 47fb80ce3be0012b8690957bcc0e284d86e9c1c2
 SHA512:
-  metadata.gz: c62b62f3fd96d3a71edc34c636f7df4b1280ab91af52a4f899d7cde3250b3c9cafd0dc31e1b3ecee1cdf05e4f7a564cc4cb23961b2a355cd9f3729afe16b7924
-  data.tar.gz: 7d6fd3a95d20051270074956ed1379ade4bc2fbd999b58033056bf7967e5a5c59cb790d502094af23b9a55dc7a0f8a0c7ae1923059fd1d4c0f072c21ceba457d
+  metadata.gz: 53efb9140c1c6b83d14d83a825aad2541423f98508cb659b9946d093a5455ad675dc8abd9d71a19d8252c4b7e0ff4ce9d4c4d1330de132743a46d83c2244a26b
+  data.tar.gz: 7b93b21a33d06744eb47aa6af0c6352b54a358da83a5c7663b91163830e7a92117e122627cec995c3c7df2eb9e9dcca3f69578c98c214554d3467ed7295cbff6

data/README.md

@@ -92,6 +92,9 @@ puts "Shared Link: #{file.shared_link.url}"
 #### [Folders](https://developers.box.com/docs/#folders)
 ```ruby
 folder_from_path(path)
+
+folder_from_id(folder_id, fields: [])
+alias :folder :folder_from_id
      
 folder_items(folder, fields: [], offset: 0, limit: FOLDER_ITEMS_LIMIT)
       
@@ -99,8 +102,6 @@ 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)
@@ -125,7 +126,8 @@ restore_trashed_folder(folder, name: nil, parent_id: nil)
 ```ruby
 file_from_path(path)
 
-file(file_id, fields: [])
+file_from_id(file_id, fields: [])
+alias :file :file_from_id
 
 update_file(file, name: nil, description: nil, parent_id: nil, shared_link: nil, tags: nil, if_match: nil)
 
@@ -171,7 +173,8 @@ reply_to_comment(comment_id, message: nil, tagged_message: nil)
       
 change_comment(comment, message)
      
-comment(comment_id, fields: [])
+comment_from_id(comment_id, fields: [])
+alias :comment :comment_from_id
       
 delete_comment(comment)
 ```
@@ -185,7 +188,8 @@ edit_collaboration(collaboration, role: nil, status: nil)
       
 remove_collaboration(collaboration)
       
-collaboration(collaboration_id, fields: [], status: nil)
+collaboration_from_id(collaboration_id, fields: [], status: nil)
+alias :collaboration :collaboration_from_id
       
 pending_collaborations()
 ```
@@ -208,10 +212,10 @@ search(query, scope: nil, file_extensions: nil, created_at_range: nil, updated_a
 #### [Users](https://developers.box.com/docs/#users)
 ```ruby
 current_user(fields: [])
-      
 alias :me :current_user
 
-user(user_id, fields: [])
+user_from_id(user_id, fields: [])
+alias :user :user_from_id
       
 all_users(filter_term: nil, fields: [], offset: 0, limit: DEFAULT_LIMIT)
      
@@ -235,7 +239,6 @@ groups(fields: [], offset: 0, limit: DEFAULT_LIMIT)
 create_group(name)
      
 update_group(group, name)
-      
 alias :rename_group :update_group
 
 delete_group(group)
@@ -246,7 +249,8 @@ group_memberships_for_user(user, offset: 0, limit: DEFAULT_LIMIT)
       
 group_memberships_for_me(offset: 0, limit: DEFAULT_LIMIT)
       
-group_membership(membership_id)
+group_membership_from_id(membership_id)
+alias :group_membership :group_membership_from_id
      
 add_user_to_group(user, group, role: nil)
       
@@ -262,7 +266,8 @@ file_tasks(file, fields: [])
       
 create_task(file, action: :review, message: nil, due_at: nil)
       
-task(task_id)
+task_from_id(task_id)
+alias :task :task_from_id
      
 update_task(task, action: :review, message: nil, due_at: nil)
       

data/lib/boxr/comments.rb

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

data/lib/boxr/files.rb

@@ -17,13 +17,14 @@ module Boxr
       file
     end
 
-    def file(file_id, fields: [])
+    def file_from_id(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)
       file
     end
+    alias :file :file_from_id
 
     def update_file(file, name: nil, description: nil, parent_id: nil, shared_link: nil, tags: nil, if_match: nil)
       file_id = ensure_id(file)

data/lib/boxr/folders.rb

@@ -16,6 +16,16 @@ module Boxr
       end
     end
 
+    def folder_from_id(folder_id, fields: [])
+      folder_id = ensure_id(folder_id)
+      query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
+      uri = "#{FOLDERS_URI}/#{folder_id}"
+
+      folder, response = get(uri, query: query)
+      folder
+    end
+    alias :folder :folder_from_id
+
     def folder_items(folder, fields: [], offset: nil, limit: nil)
       folder_id = ensure_id(folder)
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
@@ -44,15 +54,6 @@ module Boxr
       created_folder
     end
 
-    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}"
-
-      folder, response = get(uri, query: query)
-      folder
-    end
-
     def 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)

data/lib/boxr/groups.rb

@@ -20,7 +20,6 @@ module Boxr
       updated_group, response = put(uri, attributes)
       updated_group
     end
-
     alias :rename_group :update_group
 
     def delete_group(group)
@@ -47,12 +46,13 @@ module Boxr
       memberships = get_all_with_pagination(uri, offset: 0, limit: DEFAULT_LIMIT)
     end
 
-    def group_membership(membership_id)
+    def group_membership_from_id(membership_id)
       membership_id = ensure_id(membership_id)
       uri = "#{GROUP_MEMBERSHIPS_URI}/#{membership_id}"
       membership, response = get(uri)
       membership
     end
+    alias :group_membership :group_membership_from_id
 
     def add_user_to_group(user, group, role: nil)
       user_id = ensure_id(user)

data/lib/boxr/tasks.rb

@@ -21,12 +21,13 @@ module Boxr
       new_task
     end
 
-    def task(task_id)
+    def task_from_id(task_id)
       task_id = ensure_id(task_id)
       uri = "#{TASKS_URI}/#{task_id}"
       task, response = get(uri)
       task
     end
+    alias :task :task_from_id
 
     def update_task(task, action: :review, message: nil, due_at: nil)
       task_id = ensure_id(task)

data/lib/boxr/users.rb

@@ -7,16 +7,16 @@ module Boxr
       user, response = get(uri, query: query)
       user
     end
-
     alias :me :current_user
 
-    def user(user_id, fields: [])
+    def user_from_id(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)
       user
     end
+    alias :user :user_from_id
 
     def all_users(filter_term: nil, fields: [], offset: nil, limit: nil)
       uri = USERS_URI

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

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