boxr 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f6b8f2bce035186870e3cddbfe09fb78e6196e1d702a5dfa5cf27a92375b610
-  data.tar.gz: e929906cfba8506d72df7bbb37efa782a84e1890dbf75b0a08798ac0ab3fddf1
+  metadata.gz: bc9199475be8f2f434b78c3e9f97235a81070d0feb4ebd194816ba5fe6f78bfb
+  data.tar.gz: d758a7ada5f0761da42c8dff7accb946ad8567b19c0aa0e5b970d082d8a7ca34
 SHA512:
-  metadata.gz: f254ec12207c54482a3e06870a07f70c570d1dc9e8f2e30f4ff0ea3e8114185450d38b9fb99b3a2fd94bd57c9497ccfd32c79a26a2b0380a90b8a7c4a2e675ca
-  data.tar.gz: 54db201675a4c45944f7e592639f819af97b3102b080c2149684455a2938bf18839d4a9109a8e62e8e838e9cd024cf375cf5e9baff86984723ac96a580840f05
+  metadata.gz: 343eac2cc180333da53e939e584c0beccd21a4ed0a72ef46f6a208f11c782fc35646ba7af14979789f4de541aeebd96a2a70db352944278ba8dc8ef44e791aef
+  data.tar.gz: 21f27d4284e8b713e10a8cf1a97b4929b946aca1c64452baebd50c1bbe4516a60cfcbe1fa9a7e2dbd03593c87bbb635bde380143fb63d298a4c7c8155a45645d

data/.env.example

@@ -7,6 +7,10 @@
 #7. copy and paste the client id and client secret of your Box app below
 #8. save this file as .env
 
+# You will need to create two custom apps for testing. One of them will be a JWT app
+# and the other will be a server authentication app. The server authentication app
+# credentials will be used to test the client credentials grant
+
 BOX_DEVELOPER_TOKEN={a valid developer token for your Box app}
 BOX_CLIENT_ID={client id of your Box app}
 BOX_CLIENT_SECRET={client secret of your Box app}
@@ -15,3 +19,5 @@ 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}
+BOX_OAUTH_CLIENT_ID={client_id for your server authentication app}
+BOX_OAUTH_CLIENT_SECRET={client_secret for your server authentication app}

data/README.md

@@ -499,6 +499,15 @@ Boxr::WebhookValidator.new(
 
 ```
 
+#### [Zip Downloads](https://developer.box.com/reference/resources/zip-download/)
+```ruby
+# Requests creation of zip archive
+# Returns a download_url and a status_url that can be used to download the archive.
+#
+# Example: create_zip_download([{ id: '1', type: 'file' }, { id: '2', type: 'folder' }])
+create_zip_download(items, download_file_name: nil)
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/cburnette/boxr/fork )

data/boxr.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
   spec.add_development_dependency "simplecov", "~> 0.9"
@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "awesome_print", "~> 1.8"
   spec.add_development_dependency "lru_redux", "~> 0.8"
   spec.add_development_dependency "parallel", "~> 1.0"
+  spec.add_development_dependency "rubyzip", "~> 2.3"
 
   spec.add_runtime_dependency "httpclient", "~> 2.8"
   spec.add_runtime_dependency "hashie", ">= 3.5", "< 6"

data/lib/boxr/auth.rb

@@ -15,13 +15,15 @@ module Boxr
     uri
   end
 
-  def self.get_tokens(code=nil, grant_type: "authorization_code", assertion: nil, scope: nil, username: nil, client_id: ENV['BOX_CLIENT_ID'], client_secret: ENV['BOX_CLIENT_SECRET'])
+  def self.get_tokens(code=nil, grant_type: "authorization_code", assertion: nil, scope: nil, username: nil, client_id: ENV['BOX_CLIENT_ID'], client_secret: ENV['BOX_CLIENT_SECRET'], box_subject_type: nil, box_subject_id: nil)
     uri = Boxr::Client::AUTH_URI
     body = "grant_type=#{grant_type}&client_id=#{client_id}&client_secret=#{client_secret}"
     body = body + "&code=#{code}" unless code.nil?
     body = body + "&scope=#{scope}" unless scope.nil?
     body = body + "&username=#{username}" unless username.nil?
     body = body + "&assertion=#{assertion}" unless assertion.nil?
+    body = body + "&box_subject_type=#{box_subject_type}" unless box_subject_type.nil?
+    body = body + "&box_subject_id=#{box_subject_id}" unless box_subject_id.nil?
 
     auth_post(uri, body)
   end

data/lib/boxr/client.rb

@@ -30,6 +30,7 @@ module Boxr
     EVENTS_URI = "#{API_URI}/events"
     WEB_LINKS_URI = "#{API_URI}/web_links"
     WEBHOOKS_URI = "#{API_URI}/webhooks"
+    ZIP_DOWNLOADS_URI = "#{API_URI}/zip_downloads"
 
     DEFAULT_LIMIT = 100
     FOLDER_ITEMS_LIMIT = 1000

data/lib/boxr/version.rb

@@ -1,3 +1,3 @@
 module Boxr
-  VERSION = "1.19.0".freeze
+  VERSION = "1.20.0".freeze
 end

data/lib/boxr/zip_downloads.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Boxr
+  class Client
+    def create_zip_download(targets, download_file_name: nil)
+      attributes = {
+        download_file_name: download_file_name,
+        items: targets
+      }
+      zip_download, _response = post(ZIP_DOWNLOADS_URI, attributes, success_codes: [200, 202])
+      zip_download
+    end
+  end
+end

data/lib/boxr.rb

@@ -26,6 +26,7 @@ require 'boxr/web_links'
 require 'boxr/watermarking'
 require 'boxr/webhooks'
 require 'boxr/webhook_validator'
+require 'boxr/zip_downloads'
 
 class BoxrCollection < Array
   def files

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boxr
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Chad Burnette
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
@@ -241,6 +255,7 @@ files:
 - lib/boxr/web_links.rb
 - lib/boxr/webhook_validator.rb
 - lib/boxr/webhooks.rb
+- lib/boxr/zip_downloads.rb
 homepage: https://github.com/cburnette/boxr
 licenses:
 - MIT
@@ -260,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A Ruby client library for the Box V2 Content API.