boxr 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ae5afb3d84f050d0294084395417af4b38e3036
-  data.tar.gz: 9e2e2a339d4839e4ce2f7a8d1a2fd191ef64a834
+  metadata.gz: 9c4c27adff340e29abba4bcf0faad07015ac528c
+  data.tar.gz: 683c1ef609710dc2bb9c661562c94e461c4f2766
 SHA512:
-  metadata.gz: f3bdf146ed55c4da53f519a6df8b1cda0c979be4c05b4b4232bc8852aca4435473953a7346f8455062fd571aac301409f751fc6ab6a92878ee500f8b34bec91a
-  data.tar.gz: 1462e2544c327bc4fc4ced82426ee8be6ceb853dbcb84b530a7b07456e6a67bb8a6f5d75e71fb918e8d0fe6ae022a352a2ae68d9f59d384dda4f7a5ea629765c
+  metadata.gz: e315eb590f313753ba1c01f171ab9fda6f463f98372e16d9c4bf27a3c3a34bdaf0e04797e215cdbaafef4b6992417cd7b62281a547eeab156929cc87e0387bdb
+  data.tar.gz: 4da05a5a7890a733219eddf0e8e1e5ae3d36391825f5bfcc616e1ebbc09dbe22254bf8836ab6773d291a13748281661d88e33863962c2fd8e2ac1bf05e2e3a51

data/examples/use_events_to_send_sms.rb

@@ -10,19 +10,24 @@ BOX_TRIGGER_EVENT = 'UPLOAD'
 @box_client = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
 
 def send_sms_to_box_user(recipient, message)
-  phone = @box_client.user(recipient, fields: [:phone]).phone
-  unless phone.nil? || phone.empty?
-    begin
-      full_phone = "+1#{phone}"
-      @twilio_client.account.messages.create(
-        from: ENV['TWILIO_PHONE_NUMBER'],
-        to: full_phone,
-        body: message
-      )
-      puts "Sent SMS to user #{recipient.name} at #{full_phone}"
-    rescue Twilio::REST::RequestError => e
-      puts e.message
+  begin
+    phone = @box_client.user(recipient, fields: [:phone]).phone
+    unless phone.nil? || phone.empty?
+      begin
+        full_phone = "+1#{phone}"
+        @twilio_client.account.messages.create(
+          from: ENV['TWILIO_PHONE_NUMBER'],
+          to: full_phone,
+          body: message
+        )
+        puts "Sent SMS to user #{recipient.name} at #{full_phone}"
+      rescue Twilio::REST::RequestError => e
+        puts e.message
+      end
     end
+  rescue Boxr::BoxrError => e
+    #most likely error is that a collaborator is an external user and Box threw a 404
+    puts e.message
   end
 end
 
@@ -33,7 +38,7 @@ start_date = now - (60*60*24) #one day ago
 result = @box_client.enterprise_events(created_after: start_date, created_before: now)
 
 #now that we have the latest stream position let's start monitoring in real-time
-@box_client.enterprise_events_stream(result.next_stream_position, event_type: BOX_TRIGGER_EVENT) do |result|
+@box_client.enterprise_events_stream(result.next_stream_position, event_type: BOX_TRIGGER_EVENT, refresh_period: 5) do |result|
   if result.events.count==0
     puts "no new #{BOX_TRIGGER_EVENT} events..."
   else

data/examples/use_events_to_warn_about_sharing.rb

@@ -0,0 +1,92 @@
+require 'dotenv'; Dotenv.load("../.env")
+require 'boxr'
+require 'mailgun' #make sure you 'gem install mailgun-ruby'
+ 
+BOX_TRIGGER_EVENT = 'ITEM_SHARED_UPDATE,COLLABORATION_INVITE'
+FROM_EMAIL = "box-admin@#{ENV['MAILGUN_SENDING_DOMAIN']}"
+VALID_COLLABORATION_DOMAIN=ENV['VALID_COLLABORATION_DOMAIN'] #i.e. 'your-company.com'
+
+@mailgun_client = Mailgun::Client.new ENV['MAILGUN_API_KEY']
+@box_client = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
+
+def file_warning_text(event)
+%(
+Our records indicate that you just created an open shared link for the document '#{event.source.item_name}'
+located in the folder '#{event.source.parent.name}'. 
+
+If you meant to do this, please ignore this email.  Otherwise, please update this shared link
+so that it is no longer open access.
+
+Thanks,
+Your Box Admin
+)
+end
+
+def folder_warning_text(event)
+%(
+Our records indicate that you just created an open shared link for the folder '#{event.source.item_name}'. 
+
+If you meant to do this, please ignore this email.  Otherwise, please update this shared link
+so that it is no longer open access.
+
+Thanks,
+Your Box Admin
+)
+end
+
+def collaboration_warning_text(event)
+%(
+Our records indicate that you just invited #{event.accessible_by.login} to be an external collaborator
+with the role of #{event.additional_details.role} in the folder '#{event.source.folder_name}'. 
+
+If you meant to do this, please ignore this email.  Otherwise, please remove this collaborator.
+
+Thanks,
+Your Box Admin
+)
+end
+
+def send_email_to_box_user(from, to, subject, text)
+  #this example code uses Mailgun to send email, but you can use any standard SMTP server
+  message_params = {:from => from, :to => to, :subject => subject, :text => text}
+  @mailgun_client.send_message ENV['MAILGUN_SENDING_DOMAIN'], message_params
+
+  puts "Sent email to #{to} with subject '#{subject}'"
+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
+start_date = now - (60*60*24) #one day ago
+result = @box_client.enterprise_events(created_after: start_date, created_before: now)
+
+#now that we have the latest stream position let's start monitoring in real-time
+@box_client.enterprise_events_stream(result.next_stream_position, event_type: BOX_TRIGGER_EVENT, refresh_period: 60) do |result|
+  if result.events.count==0
+    puts "no new #{BOX_TRIGGER_EVENT} events..."
+  else
+    result.events.each do |e|
+      puts "detected new #{e.event_type}"
+      if e.event_type=='ITEM_SHARED_UPDATE'
+        if e.source.item_type=='file'
+          file = @box_client.file(e.source.item_id)
+          if file.shared_link.effective_access=='open'
+            send_email_to_box_user(FROM_EMAIL, e.created_by.login, "WARNING: Open Shared Link Detected", file_warning_text(e))
+          end
+        elsif e.source.item_type=='folder'
+          folder = @box_client.folder(e.source.item_id)
+          if folder.shared_link.effective_access=='open'
+            send_email_to_box_user(FROM_EMAIL, e.created_by.login, "WARNING: Open Shared Link Detected", folder_warning_text(e))
+          end
+        end
+      elsif e.event_type=='COLLABORATION_INVITE'
+        email = e.accessible_by.login
+        domain = email.split('@').last
+        unless domain.downcase==VALID_COLLABORATION_DOMAIN.downcase
+          send_email_to_box_user(FROM_EMAIL, e.created_by.login, "WARNING: External Collaborator Detected", collaboration_warning_text(e))
+        end
+      end
+    end
+  end
+end
+

data/lib/boxr.rb

@@ -3,7 +3,7 @@ require 'httpclient'
 require 'hashie'
 
 require 'boxr/version'
-require 'boxr/exceptions'
+require 'boxr/errors'
 require 'boxr/client'
 require 'boxr/shared_items'
 require 'boxr/folders'

data/lib/boxr/auth.rb

@@ -38,7 +38,7 @@ module Boxr
       body_json = Oj.load(res.body)
       return Hashie::Mash.new(body_json)
     else
-      raise BoxrException.new(status: res.status, body: res.body, header: res.header)
+      raise BoxrError.new(status: res.status, body: res.body, header: res.header)
     end
   end
 

data/lib/boxr/client.rb

@@ -54,7 +54,7 @@ module Boxr
     def initialize(access_token=ENV['BOX_DEVELOPER_TOKEN'], refresh_token: nil, box_client_id: ENV['BOX_CLIENT_ID'], box_client_secret: ENV['BOX_CLIENT_SECRET'], 
                     identifier: nil, as_user: nil, &token_refresh_listener)
       @access_token = access_token
-      raise BoxrException.new(boxr_message: "Access token cannot be nil") if @access_token.nil?
+      raise BoxrError.new(boxr_message: "Access token cannot be nil") if @access_token.nil?
 
       @refresh_token = refresh_token
       @box_client_id = box_client_id
@@ -103,7 +103,7 @@ module Boxr
 
           entries << body_json["entries"]
         else
-          raise BoxrException.new(status: res.status, body: res.body, header: res.header)
+          raise BoxrError.new(status: res.status, body: res.body, header: res.header)
         end
       end until offset - total_count >= 0
 
@@ -190,7 +190,7 @@ module Boxr
     end
 
     def check_response_status(res, success_codes)
-      raise BoxrException.new(status: res.status, body: res.body, header: res.header) unless success_codes.include?(res.status)
+      raise BoxrError.new(status: res.status, body: res.body, header: res.header) unless success_codes.include?(res.status)
     end
 
     def processed_response(res)
@@ -211,7 +211,7 @@ module Boxr
     def ensure_id(item)
       return item if item.class == String || item.class == Fixnum || item.nil?
       return item.id if item.respond_to?(:id)
-      raise BoxrException.new(boxr_message: "Expecting an id of class String or Fixnum, or object that responds to :id")
+      raise BoxrError.new(boxr_message: "Expecting an id of class String or Fixnum, or object that responds to :id")
     end
 
     def restore_trashed_item(uri, name, parent)

data/lib/boxr/{exceptions.rb → errors.rb}

@@ -1,6 +1,6 @@
 module Boxr
 
-  class BoxrException < Exception
+  class BoxrError < StandardError
 
     attr_reader :response_body, :type, :status, :code, :help_uri, :box_message, :boxr_message, :request_id
 

data/lib/boxr/events.rb

@@ -1,14 +1,14 @@
 module Boxr
   class Client
 
-    def user_events(stream_position, stream_type: :all, limit: 100)
+    def user_events(stream_position, stream_type: :all, limit: 800)
       query = {stream_position: stream_position, stream_type: stream_type, limit: limit}
       
       events, response = get(EVENTS_URI, query: query)
       Hashie::Mash.new({events: events["entries"], chunk_size: events["chunk_size"], next_stream_position: events["next_stream_position"]})
     end
 
-    def enterprise_events(created_after: nil, created_before: nil, stream_position: 0, event_type: nil, limit: 100)
+    def enterprise_events(created_after: nil, created_before: nil, stream_position: 0, event_type: nil, limit: 500)
       events = []
       loop do
         event_response = get_enterprise_events(created_after, created_before, stream_position, event_type, limit)
@@ -20,7 +20,7 @@ module Boxr
       Hashie::Mash.new({events: events, next_stream_position: stream_position})
     end
 
-    def enterprise_events_stream(initial_stream_position, event_type: nil, limit: 100, refresh_period: 5)
+    def enterprise_events_stream(initial_stream_position, event_type: nil, limit: 500, refresh_period: 300)
       stream_position = initial_stream_position
       loop do
         response = enterprise_events(stream_position: stream_position, event_type: event_type, limit: limit)

data/lib/boxr/files.rb

@@ -13,7 +13,7 @@ module Boxr
 
       files = folder_items(folder, fields: [:id, :name]).files
       file = files.select{|f| f.name == file_name}.first
-      raise BoxrException.new(boxr_message: "File not found: '#{file_name}'") if file.nil?
+      raise BoxrError.new(boxr_message: "File not found: '#{file_name}'") if file.nil?
       file
     end
 
@@ -86,7 +86,7 @@ module Boxr
 
       File.open(path_to_file) do |file|
         content_md5 = send_content_md5 ? Digest::SHA1.file(file).hexdigest : nil
-
+        
         attributes = {filename: file, parent_id: parent_id}
         attributes[:content_created_at] = content_created_at.to_datetime.rfc3339 unless content_created_at.nil?
         attributes[:content_modified_at] = content_modified_at.to_datetime.rfc3339 unless content_modified_at.nil?

data/lib/boxr/folders.rb

@@ -11,7 +11,7 @@ module Boxr
       folder = path_folders.inject(Boxr::ROOT) do |parent_folder, folder_name|
         folders = folder_items(parent_folder, fields: [:id, :name]).folders
         folder = folders.select{|f| f.name == folder_name}.first
-        raise BoxrException.new(boxr_message: "Folder not found: '#{folder_name}'") if folder.nil?
+        raise BoxrError.new(boxr_message: "Folder not found: '#{folder_name}'") if folder.nil?
         folder
       end
     end

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "0.17.0"
+  VERSION = "0.18.0"
 end

data/spec/boxr_spec.rb

@@ -449,7 +449,7 @@ describe Boxr::Client do
     expect(results).to eq([])
   end
 
-  it "invokes a Boxr exception" do
+  it "invokes a Boxr error" do
     expect { BOX_CLIENT.folder(1)}.to raise_error
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Chad Burnette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,6 +167,7 @@ files:
 - examples/enterprise_events.rb
 - examples/oauth.rb
 - examples/use_events_to_send_sms.rb
+- examples/use_events_to_warn_about_sharing.rb
 - examples/user_events.rb
 - lib/boxr.rb
 - lib/boxr/auth.rb
@@ -174,8 +175,8 @@ files:
 - lib/boxr/collaborations.rb
 - lib/boxr/collections.rb
 - lib/boxr/comments.rb
+- lib/boxr/errors.rb
 - lib/boxr/events.rb
-- lib/boxr/exceptions.rb
 - lib/boxr/files.rb
 - lib/boxr/folders.rb
 - lib/boxr/groups.rb