boxr 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b149bf857a1d64b35578d649c769792c9569e1c2
-  data.tar.gz: 1cba489db37903b1ceea8f90508687baf76521da
+  metadata.gz: 0379d9a2e8adda91ee993826569aad62126edc32
+  data.tar.gz: 293610fefe3d43d506fe1b0f1b724792ef77e2e1
 SHA512:
-  metadata.gz: 6a9ff438d8b6a582d3e52bdea63457b874377b5c7290b945a3430241d308aa051cf6c9e0b4c8d929c273f411582d343f1c3ff7f79b3e217fccd27d61fe882e3b
-  data.tar.gz: b6ffbfe77e2060e9d7a01d60eec9aca993181f22353282da8df4e86185d357f96eb4b0edff5af74adfb924bc5768a81dc20f61c2cf2e21882ebd8ba547d336f1
+  metadata.gz: 5756edcdb7821e4b2bad784e55d6359c1652a35e441eb6143be5bfb990800baeaeb88e7c8beba416ff3cb995e9ae7933504b0f5113d2526ad87c871bd92a8b42
+  data.tar.gz: 04d9a0b727ffd182e9e69be9995a9e53f81129369c05a611752ab646d3bcd33c2cc21ed153f844ce6c5614bfc23f6ae49d1db2adaed42b0561cd850dff03670e

data/README.md

@@ -158,6 +158,10 @@ alias :file :file_from_id
 
 update_file(file, name: nil, description: nil, parent: nil, shared_link: nil, tags: nil, if_match: nil)
 
+lock_file(file, expires_at: nil, is_download_prevented: false, if_match: nil)
+
+unlock_file(file, if_match: nil)
+
 move_file(file, new_parent, name: nil, if_match: nil)
 
 download_file(file, version: nil, follow_redirect: true)
@@ -261,6 +265,12 @@ update_user(user, notify: nil, enterprise: true, name: nil, role: nil, language:
             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)
 
+email_aliases_for_user(user)
+
+add_email_alias_for_user(user, email)
+
+remove_email_alias_for_user(user, email_alias)
+
 delete_user(user, notify: nil, force: nil)
 ```
 #### [Groups](https://developers.box.com/docs/#groups)

data/bin/boxr

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'boxr'
+require 'dotenv'; Dotenv.load
+require 'awesome_print'
+require 'irb'
+
+$boxr = Boxr::Client.new #uses ENV['BOX_DEVELOPER_TOKEN']
+IRB.start

data/examples/enterprise_events.rb

@@ -4,7 +4,7 @@ require 'awesome_print'
 
 client = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
 
-now = Time.now
+now = Time.now.utc
 start_date = now - (60*60*24) #one day ago
 
 puts "fetching historic enterprise events..."
@@ -16,8 +16,8 @@ ap output
 
 #now that we have the latest stream position let's start monitoring in real-time
 puts "listening for new enterprise events..."
-client.enterprise_events_stream(result.next_stream_position) do |result|
-  result.events.each{|e| puts e.event_type}
+client.enterprise_events_stream(result.next_stream_position, refresh_period: 5) do |result|
+  result.events.each{|e| ap e}
   output={count: result.events.count, next_stream_position: result.next_stream_position}
   ap output
   puts "waiting..."

data/examples/use_events_to_send_sms.rb

@@ -33,7 +33,7 @@ end
 
 #need to look back in time to make sure we get a valid stream position; 
 #normally your app will be persisting the last known stream position and you wouldn't have to look this up
-now = Time.now
+now = Time.now.utc
 start_date = now - (60*60*24) #one day ago
 result = @box_client.enterprise_events(created_after: start_date, created_before: now)
 

data/examples/use_events_to_warn_about_sharing.rb

@@ -56,7 +56,7 @@ end
 
 #need to look back in time to make sure we get a valid stream position; 
 #normally your app will be persisting the last known stream position and you wouldn't have to look this up
-now = Time.now
+now = Time.now.utc
 start_date = now - (60*60*24) #one day ago
 result = @box_client.enterprise_events(created_after: start_date, created_before: now)
 

data/lib/boxr.rb

@@ -43,6 +43,7 @@ module Boxr
   #HTTPClient is high-performance, thread-safe, and supports persistent HTTPS connections
   #http://bibwild.wordpress.com/2012/04/30/ruby-http-performance-shootout-redux/
   BOX_CLIENT = HTTPClient.new
+  BOX_CLIENT.cookie_manager = nil
   BOX_CLIENT.send_timeout = 3600 #one hour; needed for lengthy uploads
   BOX_CLIENT.agent_name = "Boxr/#{Boxr::VERSION}"
   BOX_CLIENT.transparent_gzip_decompression = true 

data/lib/boxr/collaborations.rb

@@ -10,7 +10,6 @@ module Boxr
       collaborations['entries']
     end
 
-    #make sure 'role' value is a string as Box has role values with spaces and dashes; e.g. 'previewer uploader'
     def add_collaboration(folder, accessible_by, role, fields: [], notify: nil)
       folder_id = ensure_id(folder)
       query = build_fields_query(fields, COLLABORATION_FIELDS_QUERY)

data/lib/boxr/files.rb

@@ -26,7 +26,7 @@ module Boxr
     end
     alias :file :file_from_id
 
-    def update_file(file, name: nil, description: nil, parent: nil, shared_link: nil, tags: nil, if_match: nil)
+    def update_file(file, name: nil, description: nil, parent: nil, shared_link: nil, tags: nil, lock: nil, if_match: nil)
       file_id = ensure_id(file)
       parent_id = ensure_id(parent)
       uri = "#{FILES_URI}/#{file_id}"
@@ -37,6 +37,24 @@ module Boxr
       attributes[:parent] = {id: parent_id} unless parent_id.nil?
       attributes[:shared_link] = shared_link unless shared_link.nil?
       attributes[:tags] = tags unless tags.nil?
+      attributes[:lock] = lock unless lock.nil?
+
+      updated_file, response = put(uri, attributes, if_match: if_match)
+      updated_file
+    end
+
+    def lock_file(file, expires_at: nil, is_download_prevented: false, if_match: nil)
+      lock = {type: "lock"}
+      lock[:expires_at] = expires_at.to_datetime.rfc3339 unless expires_at.nil?
+      lock[:is_download_prevented] = is_download_prevented unless is_download_prevented.nil?
+
+      update_file(file, lock: lock, if_match: if_match)
+    end
+
+    def unlock_file(file, if_match: nil)
+      file_id = ensure_id(file)
+      uri = "#{FILES_URI}/#{file_id}"
+      attributes = {lock: nil}
 
       updated_file, response = put(uri, attributes, if_match: if_match)
       updated_file

data/lib/boxr/users.rb

@@ -4,6 +4,7 @@ module Boxr
     def current_user(fields: [])
       uri = "#{USERS_URI}/me"
       query = build_fields_query(fields, USER_FIELDS_QUERY)
+      
       user, response = get(uri, query: query)
       user
     end
@@ -13,6 +14,7 @@ module Boxr
       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
@@ -28,6 +30,7 @@ module Boxr
       else
         query[:offset] = offset
         query[:limit] = limit
+        
         users, response = get(uri, query: query)
         users['entries']
       end
@@ -97,9 +100,36 @@ module Boxr
       query = {}
       query[:notify] = notify unless notify.nil?
       query[:force] = force unless force.nil?
+
       result, response = delete(uri, query: query)
       result
     end
 
+    def email_aliases_for_user(user)
+      user_id = ensure_id(user)
+      uri = "#{USERS_URI}/#{user_id}/email_aliases"
+
+      aliases, response = get(uri)
+      aliases['entries']
+    end
+
+    def add_email_alias_for_user(user, email)
+      user_id = ensure_id(user)
+      uri = "#{USERS_URI}/#{user_id}/email_aliases"
+      attributes = {email: email}
+
+      updated_user, response = post(uri, attributes)
+      updated_user
+    end
+
+    def remove_email_alias_for_user(user, email_alias)
+      user_id = ensure_id(user)
+      email_alias_id = ensure_id(email_alias)
+      uri = "#{USERS_URI}/#{user_id}/email_aliases/#{email_alias_id}"
+
+      result, response = delete(uri)
+      result
+    end
+
   end
 end

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.19.0"
+  VERSION = "0.20.0"
 end

data/spec/boxr_spec.rb

@@ -46,9 +46,9 @@ describe Boxr::Client do
     @test_folder = new_folder
 
     all_users = BOX_CLIENT.all_users
-    test_user = all_users.find{|u| u.name == TEST_USER_NAME}
-    if(test_user)
-      BOX_CLIENT.delete_user(test_user, force: true)
+    test_users = all_users.select{|u| u.name == TEST_USER_NAME}
+    test_users.each do |u|
+      BOX_CLIENT.delete_user(u, force: true)
     end
     sleep BOX_SERVER_SLEEP
     test_user = BOX_CLIENT.create_user(TEST_USER_LOGIN, TEST_USER_NAME)
@@ -148,8 +148,24 @@ describe Boxr::Client do
 
     puts "update file"
     new_description = 'this file is used to test Boxr'
-    updated_file_info = BOX_CLIENT.update_file(test_file, description: new_description)
+    tags = ['tag one','tag two']
+    updated_file_info = BOX_CLIENT.update_file(test_file, description: new_description, tags: tags)
     expect(updated_file_info.description).to eq(new_description)
+    tag_file_info = BOX_CLIENT.file(updated_file_info, fields: [:tags])
+    expect(tag_file_info.tags.length).to eq(2)
+
+    puts "lock file"
+    expires_at_utc = Time.now.utc + (60*60*24) #one day from now
+    locked_file = BOX_CLIENT.lock_file(test_file, expires_at: expires_at_utc, is_download_prevented: true)
+    locked_file = BOX_CLIENT.file(locked_file, fields: [:lock])
+    expect(locked_file.lock.type).to eq('lock')
+    expect(locked_file.lock.expires_at).to_not be_nil
+    expect(locked_file.lock.is_download_prevented).to eq(true)
+
+    puts "unlock file"
+    unlocked_file = BOX_CLIENT.unlock_file(locked_file)
+    unlocked_file = BOX_CLIENT.file(unlocked_file, fields: [:lock])
+    expect(unlocked_file.lock).to be_nil
 
     puts "download file"
     file = BOX_CLIENT.download_file(test_file)
@@ -236,12 +252,25 @@ describe Boxr::Client do
     test_user = all_users.find{|u| u.id == @test_user.id}
     expect(test_user).to_not be_nil
 
+    #create user is tested in the before method
+    
     puts "update user"
     new_name = "Chuck Nevitt"
     user = BOX_CLIENT.update_user(@test_user, name: new_name)
     expect(user.name).to eq(new_name)
 
-    #create user is tested in the before method
+    puts "add email alias for user"
+    email_alias = "test-boxr-user-alias@boxntest.com" #{('a'..'z').to_a.shuffle[0,10].join}.com"
+    new_alias = BOX_CLIENT.add_email_alias_for_user(@test_user, email_alias)
+    expect(new_alias.type).to eq('email_alias')
+
+    puts "get email aliases for user"
+    email_aliases = BOX_CLIENT.email_aliases_for_user(@test_user)
+    expect(email_aliases.first.id).to eq(new_alias.id)
+
+    puts "remove email alias for user"
+    result = BOX_CLIENT.remove_email_alias_for_user(@test_user, new_alias.id)
+    expect(result).to eq({})
 
     puts "delete user"
     result = BOX_CLIENT.delete_user(@test_user, force: true)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,7 +167,8 @@ dependencies:
 description: ''
 email:
 - chadburnette@me.com
-executables: []
+executables:
+- boxr
 extensions: []
 extra_rdoc_files: []
 files:
@@ -177,6 +178,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/boxr
 - boxr.gemspec
 - examples/enterprise_events.rb
 - examples/oauth.rb