boxr 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44f0efa6c33c1ad7a0126cddc1cef3a883782be0
-  data.tar.gz: e2c3bd4cb8400ab48106db786a798bb81ed91638
+  metadata.gz: f372e70fa452b62c0c46bb5e8d4e7bb3d43d7f6c
+  data.tar.gz: 9b314c9dcf61db5c92d721ac8d2fbe7f1c2f40d2
 SHA512:
-  metadata.gz: 94f78c8a5af9b80583cf4ec615170201a72a3c5ff0f8d371209ca759249362ed9e6dd0d8a17ac5e95fe37c2ba761b3d5fd79e736ba3a5268b2b649941afb9e8c
-  data.tar.gz: a795b2fb4e8ab3e66c5a31177fd40bcb49fc15079cb6774bb9993f8592feade6603bdc84fe97062f72994ad4e645c742666f946d58809b12680dc2f10151069b
+  metadata.gz: c6f21f76dec7a9b6a7b56a39b3eb6416296ce966c260d918420635809f4b83c605f43e2bd3952107e15cd7fea6905fa65c3ce192c1035d19600c588b58f2531c
+  data.tar.gz: d8c96b6cc61d2f9ecc05ac49e58b583fd3988d2be293b13290b679d42973774b6343f184ba4a78e655eb2118919cb9c6f4b3dab70cefadb95fe6423d53138236

data/README.md

@@ -89,7 +89,7 @@ puts "Shared Link: #{file.shared_link.url}"
 ```
 
 ### Methods
-#### Folders
+#### [Folders](https://developers.box.com/docs/#folders)
 ```ruby
 folder_from_path(path)
      
@@ -121,7 +121,7 @@ delete_trashed_folder(folder)
       
 restore_trashed_folder(folder, name: nil, parent_id: nil)
 ```
-#### Files
+#### [Files](https://developers.box.com/docs/#files)
 ```ruby
 file_from_path(path)
 
@@ -161,7 +161,7 @@ delete_trashed_file(file)
 
 restore_trashed_file(file, name: nil, parent_id: nil)
 ```
-#### Comments
+#### [Comments](https://developers.box.com/docs/#comments)
 ```ruby
 file_comments(file, fields: [], offset: 0, limit: DEFAULT_LIMIT)
       
@@ -175,7 +175,7 @@ comment(comment_id, fields: [])
       
 delete_comment(comment)
 ```
-#### Collaborations
+#### [Collaborations](https://developers.box.com/docs/#collaborations)
 ```ruby
 folder_collaborations(folder)
     
@@ -189,23 +189,23 @@ collaboration(collaboration_id, fields: [], status: nil)
       
 pending_collaborations()
 ```
-#### Events
+#### [Events](https://developers.box.com/docs/#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
+#### [Shared Items](https://developers.box.com/docs/#shared-items)
 ```ruby
 shared_item(shared_link, shared_link_password: nil)
 ```
-#### Search
+#### [Search](https://developers.box.com/docs/#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
+#### [Users](https://developers.box.com/docs/#users)
 ```ruby
 current_user(fields: [])
       
@@ -228,7 +228,7 @@ update_user(user, notify: nil, enterprise: true, name: nil, role: nil, language:
 
 delete_user(user, notify: nil, force: nil)
 ```
-#### Groups
+#### [Groups](https://developers.box.com/docs/#groups)
 ```ruby
 groups(fields: [], offset: 0, limit: DEFAULT_LIMIT)
       
@@ -256,7 +256,7 @@ delete_group_membership(membership)
       
 group_collaborations(group, offset: 0, limit: DEFAULT_LIMIT)
 ```
-#### Tasks
+#### [Tasks](https://developers.box.com/docs/#tasks)
 ```ruby
 file_tasks(file, fields: [])
       
@@ -278,7 +278,16 @@ delete_task_assignment(task)
       
 update_task_assignment(task, message: nil, resolution_state: nil)
 ```
-
+#### [Metadata](https://developers.box.com/metadata-api/#crud)
+```ruby
+create_metadata(file, metadata, type: :properties)
+      
+metadata(file, type: :properties)
+     
+update_metadata(file, updates, type: :properties)
+     
+delete_metadata(file, type: :properties)
+```
 ## Contributing
 
 1. Fork it ( https://github.com/cburnette/boxr/fork )

data/lib/boxr.rb

@@ -12,6 +12,7 @@ require 'boxr/comments'
 require 'boxr/users'
 require 'boxr/groups'
 require 'boxr/collaborations'
+require 'boxr/collections'
 require 'boxr/search'
 require 'boxr/tasks'
 require 'boxr/metadata'

data/lib/boxr/client.rb

@@ -13,6 +13,7 @@ module Boxr
     GROUPS_URI = "#{API_URI}/groups"
     GROUP_MEMBERSHIPS_URI = "#{API_URI}/group_memberships"
     COLLABORATIONS_URI = "#{API_URI}/collaborations"
+    COLLECTIONS_URI = "#{API_URI}/collections"
     COMMENTS_URI = "#{API_URI}/comments"
     SEARCH_URI = "#{API_URI}/search"
     TASKS_URI = "#{API_URI}/tasks"
@@ -59,11 +60,13 @@ module Boxr
     def self.turn_on_debugging(device=STDOUT)
       BOX_CLIENT.debug_dev = device
       BOX_CLIENT.transparent_gzip_decompression = false
+      nil
     end
 
     def self.turn_off_debugging
       BOX_CLIENT.debug_dev = nil
       BOX_CLIENT.transparent_gzip_decompression = true
+      nil
     end
 
     def initialize(access_token, refresh_token: nil, box_client_id: ENV['BOX_CLIENT_ID'], box_client_secret: ENV['BOX_CLIENT_SECRET'], 
@@ -98,7 +101,7 @@ module Boxr
       end
     end
 
-    def get_with_pagination(uri, query: {}, offset: 0, limit: DEFAULT_LIMIT)
+    def get_all_with_pagination(uri, query: {}, offset: 0, limit: DEFAULT_LIMIT)
       entries = []
 
       begin

data/lib/boxr/collections.rb

@@ -0,0 +1,16 @@
+module Boxr
+  class Client
+
+    def collections
+      collections = get_all_with_pagination(COLLECTIONS_URI, offset: 0, limit: DEFAULT_LIMIT)
+    end
+
+    def collection_items(collection, fields: [])
+      collection_id = ensure_id(collection)
+      uri = "#{COLLECTIONS_URI}/#{collection_id}/items"
+      query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
+      items = get_all_with_pagination(uri, query: query, offset: 0, limit: DEFAULT_LIMIT)
+    end
+
+  end
+end

data/lib/boxr/comments.rb

@@ -1,12 +1,12 @@
 module Boxr
   class Client
 
-    def file_comments(file, fields: [], offset: 0, limit: DEFAULT_LIMIT)
+    def file_comments(file, fields: [])
       file_id = ensure_id(file)
       uri = "#{FILES_URI}/#{file_id}/comments"
       query = build_fields_query(fields, COMMENT_FIELDS_QUERY)
 
-      comments = get_with_pagination(uri, query: query, offset: offset, limit: limit)
+      comments = get_all_with_pagination(uri, query: query, offset: 0, limit: DEFAULT_LIMIT)
     end
 
     def add_comment_to_file(file, message: nil, tagged_message: nil)

data/lib/boxr/folders.rb

@@ -16,15 +16,22 @@ module Boxr
       end
     end
 
-    def folder_items(folder, fields: [], offset: 0, limit: FOLDER_ITEMS_LIMIT)
+    def folder_items(folder, fields: [], offset: nil, limit: nil)
       folder_id = ensure_id(folder)
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
       uri = "#{FOLDERS_URI}/#{folder_id}/items"
 
-      items = get_with_pagination(uri, query: query, offset: offset, limit: limit)
+      if offset.nil? || limit.nil?
+        items = get_all_with_pagination(uri, query: query, offset: 0, limit: FOLDER_ITEMS_LIMIT)
+      else
+        query[:offset] = offset
+        query[:limit] = limit
+        items, response = get(uri, query: query)
+        items['entries']
+      end
     end
 
-    def root_folder_items(fields: [], offset: 0, limit: FOLDER_ITEMS_LIMIT)
+    def root_folder_items(fields: [], offset: nil, limit: nil)
       folder_items(Boxr::ROOT, fields: fields, offset: offset, limit: limit)
     end
 
@@ -100,11 +107,18 @@ module Boxr
       disable_shared_link(uri, folder_id)
     end
 
-    def trash(fields: [], offset: 0, limit: FOLDER_ITEMS_LIMIT)
+    def trash(fields: [], offset: nil, limit: nil)
       uri = "#{FOLDERS_URI}/trash/items"
       query = build_fields_query(fields, FOLDER_AND_FILE_FIELDS_QUERY)
 
-      items = get_with_pagination(uri, query: query, offset: offset, limit: limit)
+      if offset.nil? || limit.nil?
+        items = get_all_with_pagination(uri, query: query, offset: 0, limit: FOLDER_ITEMS_LIMIT)
+      else
+        query[:offset] = offset
+        query[:limit] = limit
+        items, response = get(uri, query: query)
+        items['entries']
+      end
     end
 
     def trashed_folder(folder, fields: [])

data/lib/boxr/groups.rb

@@ -1,9 +1,9 @@
 module Boxr
   class Client
 
-    def groups(fields: [], offset: 0, limit: DEFAULT_LIMIT)
+    def groups(fields: [])
       query = build_fields_query(fields, GROUP_FIELDS_QUERY)
-      groups = get_with_pagination(GROUPS_URI, query: query, offset: offset, limit: limit)
+      groups = get_all_with_pagination(GROUPS_URI, query: query, offset: 0, limit: DEFAULT_LIMIT)
     end
 
     def create_group(name)
@@ -30,21 +30,21 @@ module Boxr
       result
     end
 
-    def group_memberships(group, offset: 0, limit: DEFAULT_LIMIT)
+    def group_memberships(group)
       group_id = ensure_id(group)
       uri = "#{GROUPS_URI}/#{group_id}/memberships"
-      memberships = get_with_pagination(uri, offset: offset, limit: limit)
+      memberships = get_all_with_pagination(uri, offset: 0, limit: DEFAULT_LIMIT)
     end
 
-    def group_memberships_for_user(user, offset: 0, limit: DEFAULT_LIMIT)
+    def group_memberships_for_user(user)
       user_id = ensure_id(user)
       uri = "#{USERS_URI}/#{user_id}/memberships"
-      memberships = get_with_pagination(uri, offset: offset, limit: limit)
+      memberships = get_all_with_pagination(uri, offset: 0, limit: DEFAULT_LIMIT)
     end
 
-    def group_memberships_for_me(offset: 0, limit: DEFAULT_LIMIT)
+    def group_memberships_for_me
       uri = "#{USERS_URI}/me/memberships"
-      memberships = get_with_pagination(uri, offset: offset, limit: limit)
+      memberships = get_all_with_pagination(uri, offset: 0, limit: DEFAULT_LIMIT)
     end
 
     def group_membership(membership_id)
@@ -79,10 +79,10 @@ module Boxr
       result
     end
 
-    def group_collaborations(group, offset: 0, limit: DEFAULT_LIMIT)
+    def group_collaborations(group)
       group_id = ensure_id(group)
       uri = "#{GROUPS_URI}/#{group_id}/collaborations"
-      collaborations = get_with_pagination(uri, offset: offset, limit: limit)
+      collaborations = get_all_with_pagination(uri, offset: 0, limit: DEFAULT_LIMIT)
     end
 
   end

data/lib/boxr/users.rb

@@ -18,11 +18,19 @@ module Boxr
       user
     end
 
-    def all_users(filter_term: nil, fields: [], offset: 0, limit: DEFAULT_LIMIT)
+    def all_users(filter_term: nil, fields: [], offset: nil, limit: nil)
       uri = USERS_URI
       query = build_fields_query(fields, USER_FIELDS_QUERY)
       query[:filter_term] = filter_term unless filter_term.nil?
-      users = get_with_pagination(uri, query: query, offset: offset, limit: limit)
+
+      if offset.nil? || limit.nil?
+        users = get_all_with_pagination(uri, query: query, offset: 0, limit: DEFAULT_LIMIT)
+      else
+        query[:offset] = offset
+        query[:limit] = limit
+        users, response = get(uri, query: query)
+        users['entries']
+      end
     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.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,6 +171,7 @@ files:
 - lib/boxr/auth.rb
 - lib/boxr/client.rb
 - lib/boxr/collaborations.rb
+- lib/boxr/collections.rb
 - lib/boxr/comments.rb
 - lib/boxr/events.rb
 - lib/boxr/exceptions.rb