boxr 1.13.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a9682a76314abdb2ca543bc244885f87491e8f1e9585ccdaca573bf93e11495
-  data.tar.gz: 9cdf7ddd389d95367db57dad7fd3b4cb1335f0aff4c1a7833bed709d33952aea
+  metadata.gz: ecda6bc31119954e1441132e89cb3730c72832a9d27a4b50cef02631889ac16d
+  data.tar.gz: 78e5f729e9e50695560cc15b28286e865940e7222cf258794763ee8efa61c8ee
 SHA512:
-  metadata.gz: f560b285eb744a38ff2a6cc52628a21d67b9894de51c127bc9513150eec641bef1f996c01026c0e47b4d4a5b9b40aeda20c5e64328492d5fa334f16120661d0b
-  data.tar.gz: 5f43467d364b6692f1d3b117d9905a9fb87c7b018a6d202d3b0358a14397ce568df16af7740d5ccd421df87cf8d71b239d24a495dbd4f5807b3ada81716b2869
+  metadata.gz: 4b35c744df6ef3a020d3d201ed8caae441b33595ebd4dbd22d510db478a39bd5c548dca20b01899ba38ded2d6a9d00e5df9659df62d535ba9442672a88395630
+  data.tar.gz: f83a2c3cdeec8795c57d22a3ae1e12850f62f68b984fe28fcc63b6885fb9b0ad4d009c7330821f8d449f15a7b430eb15262dc17ac74de896359e2616e5cd52e7

data/.env.example

@@ -13,3 +13,5 @@ BOX_CLIENT_SECRET={client secret of your Box app}
 BOX_ENTERPRISE_ID={box enterprise id}
 JWT_PRIVATE_KEY_PATH={path to your JWT private key}
 JWT_PRIVATE_KEY_PASSWORD={JWT private key password}
+BOX_PRIMARY_SIGNATURE_KEY={primary key for webhooks}
+BOX_SECONDARY_SIGNATURE_KEY={secondary key for webhooks}

data/README.md

@@ -4,7 +4,7 @@
 
 Boxr is a Ruby client library for the Box V2 Content API.  Box employees affectionately refer to one another as Boxers, hence the name of this gem.
 
-The purpose of this gem is to provide a clear, efficient, and intentional method of interacting with the Box Content API. As with any SDK that wraps a REST API, it is important to fully understand the Box Content API at the REST endpoint level.  You are strongly encouraged to read through the Box documentation located [here](https://box-content.readme.io/).
+The purpose of this gem is to provide a clear, efficient, and intentional method of interacting with the Box Content API. As with any SDK that wraps a REST API, it is important to fully understand the Box Content API at the REST endpoint level.  You are strongly encouraged to read through the Box documentation located [here](https://developer.box.com/en/reference/).
 
 The full RubyDocs for Boxr can be found [here](http://www.rubydoc.info/gems/boxr/Boxr/Client).  You are also encouraged to rely heavily on the source code found in the [lib/boxr](https://github.com/cburnette/boxr/tree/master/lib/boxr) directory of this gem, as well as on the integration tests found [here](https://github.com/cburnette/boxr/blob/master/spec/boxr_spec.rb).
 
@@ -223,11 +223,17 @@ 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)
 
+upload_file_from_io(io, parent, name:, 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)
 
+upload_new_version_of_file_from_io(io, file, name: nil, 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)
@@ -289,6 +295,12 @@ get_web_link(web_link)
 update_web_link(web_link, url: nil, parent: nil, name: nil, description: nil)
 
 delete_web_link(web_link)
+
+trashed_web_link(web_link, fields: [])
+
+delete_trashed_web_link(web_link)
+
+restore_trashed_web_link(web_link, name: nil, parent: nil)
 ```
 #### [Comments](https://developer.box.com/en/reference/resources/comment/)
 ```ruby
@@ -444,6 +456,7 @@ delete_folder_metadata(folder, scope, template)
 
 get_enterprise_templates
 get_metadata_template_by_name(scope, template_key)
+get_metadata_template_by_id(template_id)
 
 create_metadata_template(display_name, template_key: nil, fields: [], hidden: nil)
 delete_metadata_template(scope, template_key)
@@ -463,6 +476,29 @@ apply_watermark_on_folder(folder)
 
 remove_watermark_on_folder(folder)
 ```
+
+#### [Webhooks](https://developer.box.com/en/reference/resources/webhook/) & [Webhook Signatures](https://developer.box.com/guides/webhooks/handle/setup-signatures/)
+```ruby
+create_webhook(target_id, target_type, triggers, address)
+
+get_webhooks(marker: nil, limit: nil)
+
+get_webhook(webhook_id)
+
+update_webhook(webhook_id, attributes)
+
+delete_webhook(webhook_id)
+
+# When receiving a webhook, it is advised to verify that it was sent by Box
+Boxr::WebhookValidator.new(
+  headers,
+  payload,
+  primary_signature_key: primary_signature_key,
+  secondary_signature_key: secondary_signature_key
+).valid_message?
+
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/cburnette/boxr/fork )

data/boxr.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = '>= 2.0'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/boxr.rb

@@ -24,6 +24,8 @@ require 'boxr/events'
 require 'boxr/auth'
 require 'boxr/web_links'
 require 'boxr/watermarking'
+require 'boxr/webhooks'
+require 'boxr/webhook_validator'
 
 class BoxrCollection < Array
   def files

data/lib/boxr/client.rb

@@ -29,7 +29,7 @@ module Boxr
     METADATA_TEMPLATES_URI = "#{API_URI}/metadata_templates"
     EVENTS_URI = "#{API_URI}/events"
     WEB_LINKS_URI = "#{API_URI}/web_links"
-
+    WEBHOOKS_URI = "#{API_URI}/webhooks"
 
     DEFAULT_LIMIT = 100
     FOLDER_ITEMS_LIMIT = 1000
@@ -59,6 +59,10 @@ module Boxr
     GROUP_FIELDS = [:type, :id, :name, :created_at, :modified_at]
     GROUP_FIELDS_QUERY = GROUP_FIELDS.join(',')
 
+    WEB_LINK_FIELDS = [:type, :id, :created_at, :created_by, :description, :etag, :item_status, :modified_at, :modified_by,
+                       :name, :owned_by, :parent, :path_collection, :purged_at, :sequence_id, :shared_link, :trashed_at, :url]
+    WEB_LINK_FIELDS_QUERY = WEB_LINK_FIELDS.join(',')
+
     VALID_COLLABORATION_ROLES = ['editor','viewer','previewer','uploader','previewer uploader','viewer uploader','co-owner','owner']
 
 

data/lib/boxr/collaborations.rb

@@ -1,21 +1,38 @@
 module Boxr
   class Client
 
-    def folder_collaborations(folder, fields: [])
+    def folder_collaborations(folder, fields: [], offset: 0, limit: DEFAULT_LIMIT)
       folder_id = ensure_id(folder)
       query = build_fields_query(fields, COLLABORATION_FIELDS_QUERY)
       uri = "#{FOLDERS_URI}/#{folder_id}/collaborations"
+      collaborations = get_all_with_pagination(uri, query: query, offset: offset, limit: limit)
+    end
+
+    def file_collaborations(file, fields: [], limit: DEFAULT_LIMIT, marker: nil)
+      file_id = ensure_id(file)
+      query = build_fields_query(fields, COLLABORATION_FIELDS_QUERY)
+      query[:limit] = limit
+      query[:marker] = marker unless marker.nil?
+
+      uri = "#{FILES_URI}/#{file_id}/collaborations"
 
       collaborations, response = get(uri, query: query)
       collaborations['entries']
     end
 
-    def add_collaboration(folder, accessible_by, role, fields: [], notify: nil)
-      folder_id = ensure_id(folder)
+    def group_collaborations(group, offset: 0, limit: DEFAULT_LIMIT)
+      group_id = ensure_id(group)
+      uri = "#{GROUPS_URI}/#{group_id}/collaborations"
+
+      collaborations = get_all_with_pagination(uri, offset: offset, limit: limit)
+    end
+
+    def add_collaboration(item, accessible_by, role, fields: [], notify: nil, type: :folder)
+      item_id = ensure_id(item)
       query = build_fields_query(fields, COLLABORATION_FIELDS_QUERY)
       query[:notify] = notify unless notify.nil?
 
-      attributes = {item: {id: folder_id, type: :folder}}
+      attributes = {item: {id: item_id, type: type}}
       attributes[:accessible_by] = accessible_by
       attributes[:role] = validate_role(role)
 
@@ -60,9 +77,8 @@ module Boxr
       pending_collaborations['entries']
     end
 
-
     private
-    
+
     def validate_role(role)
       case role
       when :previewer_uploader
@@ -75,7 +91,7 @@ module Boxr
 
       role = role.to_s
       raise BoxrError.new(boxr_message: "Invalid collaboration role: '#{role}'") unless VALID_COLLABORATION_ROLES.include?(role)
-      
+
       role
     end
   end

data/lib/boxr/files.rb

@@ -12,7 +12,7 @@ module Boxr
       folder = folder_from_path(path_items.join('/'))
 
       files = folder_items(folder, fields: [:id, :name]).files
-      file = files.select{|f| f.name == file_name}.first
+      file = files.select{|f| f.name.casecmp?(file_name) }.first
       raise BoxrError.new(boxr_message: "File not found: '#{file_name}'") if file.nil?
       file
     end
@@ -136,21 +136,35 @@ module Boxr
                                     preflight_check: true, if_match: nil, name: nil)
       filename = name ? name : File.basename(path_to_file)
 
+      File.open(path_to_file) do |io|
+        upload_new_version_of_file_from_io(io, file, name: filename, content_modified_at: content_modified_at, preflight_check: preflight_check, send_content_md5: send_content_md5, if_match: if_match)
+      end
+    end
+
+    def upload_new_version_of_file_from_io(io, file, name: nil, content_modified_at: nil, send_content_md5: true,
+                                    preflight_check: true, if_match: nil)
+
+      filename = name ? name : file.name
+
       file_id = ensure_id(file)
-      preflight_check_new_version_of_file(path_to_file, file_id) if preflight_check
+      preflight_check_new_version_of_file(io, file_id) if preflight_check
 
       uri = "#{UPLOAD_URI}/files/#{file_id}/content"
       file_info = nil
       response = nil
 
-      File.open(path_to_file) do |file|
-        content_md5 = send_content_md5 ? Digest::SHA1.file(file).hexdigest : nil
-        attributes = {name: filename}
-        attributes[:content_modified_at] = content_modified_at.to_datetime.rfc3339 unless content_modified_at.nil?
-        body = {attributes: JSON.dump(attributes), file: file}
-        file_info, response = post(uri, body, process_body: false, content_md5: content_md5, if_match: if_match)
+      if send_content_md5
+        content_md5 = Digest::SHA1.hexdigest(io.read)
+        io.rewind
       end
 
+      attributes = {name: name}
+      attributes[:content_modified_at] = content_modified_at.to_datetime.rfc3339 unless content_modified_at.nil?
+
+      body = {attributes: JSON.dump(attributes), file: io}
+
+      file_info, response = post(uri, body, process_body: false, content_md5: content_md5, if_match: if_match)
+
       file_info.entries[0]
     end
 
@@ -265,8 +279,8 @@ module Boxr
       body_json, res = options("#{FILES_URI}/content", attributes)
     end
 
-    def preflight_check_new_version_of_file(path_to_file, file_id)
-      size = File.size(path_to_file)
+    def preflight_check_new_version_of_file(io, file_id)
+      size = File.size(io)
       attributes = {size: size}
       body_json, res = options("#{FILES_URI}/#{file_id}/content", attributes)
     end

data/lib/boxr/folders.rb

@@ -10,7 +10,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
+        folder = folders.select{|f| f.name.casecmp?(folder_name) }.first
         raise BoxrError.new(boxr_message: "Folder not found: '#{folder_name}'") if folder.nil?
         folder
       end

data/lib/boxr/groups.rb

@@ -89,11 +89,5 @@ module Boxr
       result
     end
 
-    def group_collaborations(group, offset: 0, limit: DEFAULT_LIMIT)
-      group_id = ensure_id(group)
-      uri = "#{GROUPS_URI}/#{group_id}/collaborations"
-      collaborations = get_all_with_pagination(uri, offset: offset, limit: limit)
-    end
-
   end
 end

data/lib/boxr/metadata.rb

@@ -93,6 +93,13 @@ module Boxr
     end
     alias :get_metadata_template_by_name :metadata_schema
 
+    def get_metadata_template_by_id(template_id)
+      template_id = ensure_id(template_id)
+      uri = "#{METADATA_TEMPLATES_URI}/#{template_id}"
+      schema, response = get(uri)
+      schema
+    end
+
     def create_metadata_template(display_name, template_key: nil, fields: [], hidden: nil)
       uri = "#{METADATA_TEMPLATES_URI}/schema"
       schema = {

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "1.13.0".freeze
+  VERSION = "1.18.0".freeze
 end

data/lib/boxr/web_links.rb

@@ -51,6 +51,31 @@ module Boxr
       result
     end
 
+    def trashed_web_link(web_link, fields: [])
+      web_link_id = ensure_id(web_link)
+      uri = "#{WEB_LINKS_URI}/#{web_link_id}/trash"
+      query = build_fields_query(fields, WEB_LINK_FIELDS_QUERY)
+
+      web_link, response = get(uri, query: query)
+      web_link
+    end
+    alias :get_trashed_web_link :trashed_web_link
+
+    def delete_trashed_web_link(web_link)
+      web_link_id = ensure_id(web_link)
+      uri = "#{WEB_LINKS_URI}/#{web_link_id}/trash"
+      result, response = delete(uri)
+      result
+    end
+
+    def restore_trashed_web_link(web_link, name: nil, parent: nil)
+      web_link_id = ensure_id(web_link)
+      parent_id = ensure_id(parent)
+
+      uri = "#{WEB_LINKS_URI}/#{web_link_id}"
+      restore_trashed_item(uri, name, parent_id)
+    end
+
     private
 
     def verify_url(item)

data/lib/boxr/webhook_validator.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Boxr
+  class WebhookValidator
+    attr_reader(
+      :payload,
+      :primary_signature,
+      :primary_signature_key,
+      :secondary_signature,
+      :secondary_signature_key,
+      :timestamp
+    )
+
+    MAXIMUM_MESSAGE_AGE = 600 # 10 minutes (in seconds)
+
+    def initialize(headers, payload, primary_signature_key: nil, secondary_signature_key: nil)
+      @payload                 = payload
+      @timestamp               = headers['BOX-DELIVERY-TIMESTAMP'].to_s
+      @primary_signature_key   = primary_signature_key.to_s
+      @secondary_signature_key = secondary_signature_key.to_s
+      @primary_signature       = headers['BOX-SIGNATURE-PRIMARY']
+      @secondary_signature     = headers['BOX-SIGNATURE-SECONDARY']
+    end
+
+    def valid_message?
+      verify_delivery_timestamp && verify_signature
+    end
+
+    def verify_delivery_timestamp
+      message_age < MAXIMUM_MESSAGE_AGE
+    end
+
+    def verify_signature
+      generate_signature(primary_signature_key) == primary_signature || generate_signature(secondary_signature_key) == secondary_signature
+    end
+
+    def generate_signature(key)
+      message_as_bytes = (payload.bytes + timestamp.bytes).pack('U')
+      digest = OpenSSL::HMAC.hexdigest('SHA256', key, message_as_bytes)
+      Base64.encode64(digest)
+    end
+
+    private
+
+    def current_time
+      Time.now.utc
+    end
+
+    def delivery_time
+      Time.parse(timestamp).utc
+    rescue ArgumentError
+      raise BoxrError.new(boxr_message: "Webhook authenticity not verified: invalid timestamp")
+    end
+
+    def message_age
+      current_time - delivery_time
+    end
+  end
+end

data/lib/boxr/webhooks.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Boxr
+  class Client
+    def create_webhook(target_id, target_type, triggers, address)
+      attributes = { target: { id: target_id, type: target_type }, triggers: triggers, address: address }
+      new_webhook, response = post(WEBHOOKS_URI, attributes)
+      new_webhook
+    end
+
+    def get_webhooks(marker: nil, limit: nil)
+      query_params = { marker: marker, limit: limit }.compact
+      webhooks, response = get(WEBHOOKS_URI, query: query_params)
+      webhooks
+    end
+
+    def get_webhook(webhook)
+      webhook_id = ensure_id(webhook)
+      uri = "#{WEBHOOKS_URI}/#{webhook_id}"
+      webhook, response = get(uri)
+      webhook
+    end
+
+    def update_webhook(webhook, attributes = {})
+      webhook_id = ensure_id(webhook)
+      uri = "#{WEBHOOKS_URI}/#{webhook_id}"
+      updated_webhook, response = put(uri, attributes)
+      updated_webhook
+    end
+
+    def delete_webhook(webhook)
+      webhook_id = ensure_id(webhook)
+      uri = "#{WEBHOOKS_URI}/#{webhook_id}"
+      result, response = delete(uri)
+      result
+    end
+  end
+end

data/spec/boxr/collaborations_spec.rb

@@ -1,10 +1,22 @@
 #rake spec SPEC_OPTS="-e \"invokes collaborations operations"\"
 describe 'collaborations operations' do
   it "invokes collaborations operations" do
+    puts "test setup"
+    new_file = BOX_CLIENT.upload_file("./spec/test_files/#{TEST_FILE_NAME}", @test_folder)
+    test_group = BOX_CLIENT.create_group(TEST_GROUP_NAME)
+    second_test_user = BOX_CLIENT.create_user("Second Test User", login: "second_test_user@#{('a'..'z').to_a.shuffle[0,10].join}.com", role: 'coadmin')
+
     puts "add collaboration"
     collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :viewer_uploader)
+    file_collaboration = BOX_CLIENT.add_collaboration(new_file, {id: second_test_user.id, type: :user}, :viewer, type: :file)
+    group_collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: test_group.id, type: :group}, :editor)
     expect(collaboration.accessible_by.id).to eq(@test_user.id)
+    expect(file_collaboration.accessible_by.id).to eq(second_test_user.id)
+    expect(group_collaboration.accessible_by.id).to eq(test_group.id)
+
     COLLABORATION = collaboration
+    FILE_COLLABORATION = file_collaboration
+    GROUP_COLLABORATION = group_collaboration
 
     puts "inspect collaboration"
     collaboration = BOX_CLIENT.collaboration(COLLABORATION)
@@ -16,14 +28,24 @@ describe 'collaborations operations' do
 
     puts "inspect folder collaborations"
     collaborations = BOX_CLIENT.folder_collaborations(@test_folder)
-    expect(collaborations.count).to eq(1)
+    expect(collaborations.count).to eq(2)
     expect(collaborations[0].id).to eq(COLLABORATION.id)
 
+    puts "inspect file collaborations"
+    collaborations = BOX_CLIENT.file_collaborations(new_file)
+    expect(collaborations.count).to eq(3)
+    expect(collaborations[0].id).to eq(FILE_COLLABORATION.id)
+
+    puts "inspect group collaborations"
+    collaborations = BOX_CLIENT.group_collaborations(test_group)
+    expect(collaborations.count).to eq(1)
+    expect(collaborations[0].id).to eq(GROUP_COLLABORATION.id)
+
     puts "remove collaboration"
     result = BOX_CLIENT.remove_collaboration(COLLABORATION)
     expect(result).to eq({})
     collaborations = BOX_CLIENT.folder_collaborations(@test_folder)
-    expect(collaborations.count).to eq(0)
+    expect(collaborations.count).to eq(1)
 
     puts "inspect pending collaborations"
     pending_collaborations = BOX_CLIENT.pending_collaborations
@@ -31,5 +53,10 @@ describe 'collaborations operations' do
 
     puts "add invalid collaboration"
     expect { BOX_CLIENT.add_collaboration(@test_folder, {id: @test_user.id, type: :user}, :invalid_role)}.to raise_error{Boxr::BoxrError}
+
+    puts "test teardown"
+    BOX_CLIENT.delete_file(new_file)
+    BOX_CLIENT.delete_group(test_group)
+    BOX_CLIENT.delete_user(second_test_user, force: true)
   end
 end

data/spec/boxr/files_spec.rb

@@ -67,20 +67,25 @@ describe "file operations" do
     new_version = BOX_CLIENT.upload_new_version_of_file("./spec/test_files/#{TEST_FILE_NAME}", test_file)
     expect(new_version.id).to eq(test_file.id)
 
+    puts "upload new version of file from IO"
+    io = File.open("./spec/test_files/#{TEST_FILE_NAME}")
+    new_version = BOX_CLIENT.upload_new_version_of_file_from_io(io, test_file)
+    expect(new_version.id).to eq(test_file.id)
+
     puts "inspect versions of file"
     versions = BOX_CLIENT.versions_of_file(test_file)
-    expect(versions.count).to eq(1) #the reason this is 1 instead of 2 is that Box considers 'versions' to be a versions other than 'current'
+    expect(versions.count).to eq(2) #the reason this is 2 instead of 3 is that Box considers 'versions' to be a versions other than 'current'
     v1 = versions.first
 
     puts "promote old version of file"
     newer_version = BOX_CLIENT.promote_old_version_of_file(test_file, v1)
     versions = BOX_CLIENT.versions_of_file(test_file)
-    expect(versions.count).to eq(2)
+    expect(versions.count).to eq(3)
 
     puts "delete old version of file"
     result = BOX_CLIENT.delete_old_version_of_file(test_file,v1)
     versions = BOX_CLIENT.versions_of_file(test_file)
-    expect(versions.count).to eq(2) #this is still 2 because with Box you can restore a trashed old version
+    expect(versions.count).to eq(3) #this is still 3 because with Box you can restore a trashed old version
 
     puts "get file thumbnail"
     thumb = BOX_CLIENT.thumbnail(test_file)

data/spec/boxr/groups_spec.rb

@@ -56,10 +56,6 @@ describe 'group operations' do
     group_memberships = BOX_CLIENT.group_memberships_for_user(@test_user)
     expect(group_memberships.count).to eq(0)
 
-    puts "inspect group collaborations"
-    group_collaboration = BOX_CLIENT.add_collaboration(@test_folder, {id: test_group.id, type: :group}, :editor)
-    expect(group_collaboration.accessible_by.id).to eq(test_group.id)
-
     puts "delete group"
     response = BOX_CLIENT.delete_group(test_group)
     expect(response).to eq({})

data/spec/boxr/metadata_spec.rb

@@ -76,6 +76,10 @@ describe 'file metadata operations' do
     template_key = metadata_template["templateKey"]
     scope = metadata_template["scope"]
 
+    puts "get metadata template by id"
+    metadata_template = BOX_CLIENT.get_metadata_template_by_id(metadata_template["id"])
+    expect(metadata_template["displayName"]).to eq("Test Template")
+
     puts "delete metadata template"
     result = BOX_CLIENT.delete_metadata_template(scope, template_key)
     expect(result).to eq({})

data/spec/boxr/web_links_spec.rb

@@ -16,5 +16,18 @@ describe "web links operations" do
     puts "delete web link"
     result = BOX_CLIENT.delete_web_link(web_link)
     expect(result).to eq({})
+
+    puts "get trashed web link"
+    trashed_web_link = BOX_CLIENT.trashed_web_link(web_link)
+    expect(trashed_web_link.item_status).to eq("trashed")
+
+    puts "restore trashed web link"
+    restored_web_link = BOX_CLIENT.restore_trashed_web_link(web_link)
+    expect(restored_web_link.item_status).to eq("active")
+
+    puts "trash and permanently delete web link"
+    BOX_CLIENT.delete_web_link(web_link)
+    result = BOX_CLIENT.delete_trashed_web_link(web_link)
+    expect(result).to eq({})
   end
 end

data/spec/boxr/webhook_validator_spec.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+def generate_signature(payload, timestamp, key)
+  message_as_bytes = (payload.bytes + timestamp.bytes).pack('U')
+  digest = OpenSSL::HMAC.hexdigest('SHA256', key, message_as_bytes)
+  Base64.encode64(digest)
+end
+
+# rake spec SPEC_OPTS="-e \"Boxr::WebhookValidator"\"
+describe Boxr::WebhookValidator, :skip_reset do
+  describe '#verify_delivery_timestamp' do
+    let(:payload) { 'not relevant' }
+    subject { described_class.new(headers, payload).verify_delivery_timestamp }
+    context 'maximum age is under 10 minutes' do
+      let(:five_minutes_ago) { (Time.now.utc - 300).to_s } # 5 minutes (in seconds)
+      let(:headers) { { 'BOX-DELIVERY-TIMESTAMP' => five_minutes_ago} }
+      it 'returns true' do
+        expect(subject).to eq(true)
+      end
+    end
+
+    context 'maximum age is over 10 minute' do
+      let(:eleven_minutes_ago) { (Time.now.utc - 660).to_s } # 11 minutes (in seconds)
+      let(:headers) { { 'BOX-DELIVERY-TIMESTAMP' => eleven_minutes_ago } }
+      it 'returns false' do
+        expect(subject).to eq(false)
+      end
+    end
+
+    context 'no delivery timestamp is supplied' do
+      let(:headers) { { 'BOX-DELIVERY-TIMESTAMP' => nil } }
+      it 'raises an error' do
+        expect do
+          subject
+        end.to raise_error(RuntimeError, 'Webhook authenticity not verified: invalid timestamp')
+      end
+    end
+
+    context 'bogus timestamp is supplied' do
+      let(:headers) { { 'BOX-DELIVERY-TIMESTAMP' => 'foo' } }
+      it 'raises an error' do
+        expect do
+          subject
+        end.to raise_error(RuntimeError, 'Webhook authenticity not verified: invalid timestamp')
+      end
+    end
+  end
+
+  describe '#verify_signature' do
+    let(:payload) { 'some data' }
+    let(:timestamp) { (Time.now.utc - 300).to_s } # 5 minutes ago (in seconds)
+    let(:signature_primary) { generate_signature(payload, timestamp, ENV['BOX_PRIMARY_SIGNATURE_KEY'].to_s) }
+    let(:signature_secondary) { generate_signature(payload, timestamp, ENV['BOX_SECONDARY_SIGNATURE_KEY'].to_s) }
+    subject { described_class.new(headers,
+                                  payload,
+                                  primary_signature_key: ENV['BOX_PRIMARY_SIGNATURE_KEY'].to_s,
+                                  secondary_signature_key: ENV['BOX_SECONDARY_SIGNATURE_KEY'].to_s,
+                                  ).verify_signature }
+
+    context 'valid primary key' do
+      let(:headers) do
+        { 'BOX-DELIVERY-TIMESTAMP' => timestamp,
+          'BOX-SIGNATURE-PRIMARY' => signature_primary }
+      end
+
+      it 'returns true' do
+        expect(subject).to eq(true)
+      end
+    end
+
+    context 'invalid primary key, valid secondary key' do
+      let(:headers) do
+        { 'BOX-DELIVERY-TIMESTAMP' => timestamp,
+          'BOX-SIGNATURE-PRIMARY' => 'invalid',
+          'BOX-SIGNATURE-SECONDARY' => signature_secondary }
+      end
+
+      it 'returns true' do
+        expect(subject).to eq(true)
+      end
+    end
+
+    context 'invalid primary key, invalid secondary key' do
+      let(:headers) do
+        { 'BOX-DELIVERY-TIMESTAMP' => timestamp,
+          'BOX-SIGNATURE-PRIMARY' => 'invalid',
+          'BOX-SIGNATURE-SECONDARY' => 'also invalid' }
+      end
+
+      it 'returns false' do
+        expect(subject).to eq(false)
+      end
+    end
+
+    context 'no signatures were supplied' do
+      let(:headers) do
+        { 'BOX-DELIVERY-TIMESTAMP' => timestamp,
+          'BOX-SIGNATURE-PRIMARY' => nil,
+          'BOX-SIGNATURE-SECONDARY' => nil }
+      end
+
+      it 'returns false' do
+        subject = described_class.new(headers, payload, primary_signature_key: nil, secondary_signature_key: nil).verify_signature
+        expect(subject).to eq(false)
+      end
+    end
+  end
+
+  describe '#valid_message?' do
+    let(:headers) { { 'doesnt' => 'matter' } }
+    let(:payload) { 'not relevant' }
+
+    it 'delegates to timestamp and signature verification' do
+      validator = described_class.new(headers, payload)
+      expect(validator).to receive(:verify_delivery_timestamp).and_return(true)
+      expect(validator).to receive(:verify_signature)
+      validator.valid_message?
+    end
+  end
+end

data/spec/boxr/webhooks_spec.rb

@@ -0,0 +1,30 @@
+# rake spec SPEC_OPTS="-e \"invokes webhook operations"\"
+describe "webhook operations" do
+  it 'invokes webhook operations' do
+    puts 'create webhook'
+    resource_id = @test_folder.id
+    type = 'folder'
+    triggers = ['FOLDER.RENAMED']
+    address = 'https://example.com'
+    new_webhook = BOX_CLIENT.create_webhook(resource_id, type, triggers, address)
+    new_webhook_id = new_webhook.id
+    expect(new_webhook.triggers.to_a).to eq(triggers)
+
+    puts 'get webhooks'
+    all_webhooks = BOX_CLIENT.get_webhooks
+    expect(all_webhooks.entries.first.id).to eq(new_webhook_id)
+
+    puts 'get webhook'
+    single_webhook = BOX_CLIENT.get_webhook(new_webhook_id)
+    expect(single_webhook.id).to eq(new_webhook_id)
+
+    puts 'update webhooks'
+    new_address = 'https://foo.com'
+    updated_webhook = BOX_CLIENT.update_webhook(new_webhook, { address: new_address })
+    expect(updated_webhook.address).to eq(new_address)
+
+    puts 'delete webhooks'
+    deleted_webhook = BOX_CLIENT.delete_webhook(updated_webhook)
+    expect(deleted_webhook).to be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -5,6 +5,11 @@ require 'awesome_print'
 
 RSpec.configure do |config|
   config.before(:each) do
+    if test.metadata[:skip_reset]
+      puts "Skipping reset"
+      next
+    end
+
     puts "-----> Resetting Box Environment"
     sleep BOX_SERVER_SLEEP
     root_folders = BOX_CLIENT.root_folder_items.folders

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Chad Burnette
 - Xavier Hocquet
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-11 00:00:00.000000000 Z
+date: 2021-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -227,6 +227,8 @@ files:
 - lib/boxr/version.rb
 - lib/boxr/watermarking.rb
 - lib/boxr/web_links.rb
+- lib/boxr/webhook_validator.rb
+- lib/boxr/webhooks.rb
 - spec/boxr/auth_spec.rb
 - spec/boxr/chunked_uploads_spec.rb
 - spec/boxr/collaborations_spec.rb
@@ -240,6 +242,8 @@ files:
 - spec/boxr/users_spec.rb
 - spec/boxr/watermarking_spec.rb
 - spec/boxr/web_links_spec.rb
+- spec/boxr/webhook_validator_spec.rb
+- spec/boxr/webhooks_spec.rb
 - spec/boxr_spec.rb
 - spec/spec_helper.rb
 - spec/test_files/large test file.txt
@@ -248,13 +252,13 @@ homepage: https://github.com/cburnette/boxr
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -263,8 +267,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A Ruby client library for the Box V2 Content API.
 test_files:
@@ -281,6 +285,8 @@ test_files:
 - spec/boxr/users_spec.rb
 - spec/boxr/watermarking_spec.rb
 - spec/boxr/web_links_spec.rb
+- spec/boxr/webhook_validator_spec.rb
+- spec/boxr/webhooks_spec.rb
 - spec/boxr_spec.rb
 - spec/spec_helper.rb
 - spec/test_files/large test file.txt