boxr 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc54a36782e08382d054e9ae513dc57068c6863248a150d929b3556697e7498d
-  data.tar.gz: a272930b0bd35e2cf6e7cea800e73b85df37642821cdfde99fda811e71a3cfdc
+  metadata.gz: 6fe53be6f1ffc2011088a31f8c40e6ed6e574f948ea6d08f634742b65633fcb1
+  data.tar.gz: aee3efc2e1b573c15de8af52d410f3c93f39d5bf897692c3992a502c9ea15c3f
 SHA512:
-  metadata.gz: 6a9a2d42cee09c8612b98e91db459cbe266a20faea28466dd2bdcd4fe39f6778d82c1fdfa358c5699dd03090bfebc0449093c374b3cc6f7d2ea2fec15e4ede6d
-  data.tar.gz: f04ae30c4919d836d948ac595df01aea192b64fc4d26d3d42f72ce740bd29b8af7e699b18d8fd5cbcf93808cbf8f1aad5c2149bb8274ae884997dd907a861d5a
+  metadata.gz: 623fff67ad55230bf68b62a24e318a7ca9464f43a9f5745cce620f6d47ecf7c873909eb5970bc8c47fedfe6ecaa963138d0176159294c5acf9b5afe18dc6345d
+  data.tar.gz: 905a779b88f4fc7aee66026497e0afc2d7f0530925a614473459b06cc2d62d713ab6b50e9d1cdf168a73f6fe6e0dd8e026137a6bea0082d82af2952724113041

data/.github/workflows/ruby-tests.yml

@@ -0,0 +1,52 @@
+name: Ruby Tests
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+        bundler: '2.4.22'
+
+    - name: Run unit tests
+      run: bundle exec rspec spec/unit/
+      env:
+        BOX_DEVELOPER_TOKEN: test_token
+
+  test_bundler_2_5:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [ '3.3', '3.4']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+        bundler: '2.5.23'
+
+    - name: Run unit tests
+      run: bundle exec rspec spec/unit/
+      env:
+        BOX_DEVELOPER_TOKEN: test_token

data/.gitignore

@@ -19,3 +19,4 @@
 *.o
 *.a
 mkmf.log
+*.key

data/.rspec

@@ -1,2 +1 @@
 --color
---require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
+
+Layout/LineLength:
+  Max: 100
+
+# Due to legacy test format
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -13,7 +13,12 @@ The full RubyDocs for Boxr can be found [here](http://www.rubydoc.info/gems/boxr
 Boxr follows Semantic Versioning since version 1.5.0
 
 ## Requirements
-This gem requires Ruby 2.0.0 or higher.
+This gem requires a Ruby version depending on the version of the gem you are using. We aim to deprecate support for EOL Ruby versions.
+
+- For version 1.23.0 and higher, this gem requires Ruby 2.7 or higher.
+- For version 1.22.0 and lower, this gem requires Ruby 2.0.0 or higher.
+
+
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -99,7 +104,7 @@ client = Boxr::Client.new('zX3UjFwNerOy5PSWc2WI8aJgMHtAjs8T',
 
 # You can provide another parameter called as_user. Read about what that means here: https://developer.box.com/reference#as-user-1
 
-# You can provide yet another parameter called identifier. This can be used, for example, to
+# You can provide another parameter called identifier. This can be used, for example, to
 # hold the id of the user associated with this Boxr client.  When the callback is invoked this value
 # will be provided.
 ```
@@ -115,6 +120,7 @@ initialize( access_token=ENV['BOX_DEVELOPER_TOKEN'],
             jwt_public_key_id: ENV['JWT_PUBLIC_KEY_ID'],
             identifier: nil,
             as_user: nil,
+            proxy: nil,
             &token_refresh_listener)
 ```
 
@@ -132,6 +138,14 @@ updated_file = client.create_shared_link_for_file(file, access: :open)
 puts "Shared Link: #{updated_file.shared_link.url}"
 ```
 
+### Using a proxy
+You can provide a proxy to Boxr::Client.new by passing the proxy parameter.
+```ruby
+client = Boxr::Client.new(proxy: 'http://username:password@proxy.example.com:8080')
+```
+Boxr uses HTTPClient under the hood, so you can use all the features of HTTPClient's proxy support.
+See https://www.rubydoc.info/gems/httpclient/HTTPClient#proxy=-instance_method for more details.
+
 ### NOTE: Using HTTP mocking libraries for testing
 When using HTTP mocking libraries for testing, you may need to set Boxr::BOX_CLIENT to a fresh instance of HTTPClient in your test setup after loading the HTTP mocking library. For example, when using WebMock with RSpec you might could add the following to your RSpec configuration:
 ``` ruby
@@ -240,7 +254,7 @@ promote_old_version_of_file(file, file_version)
 
 delete_old_version_of_file(file, file_version, if_match: nil)
 
-copy_file(file, parent, name: nil)
+copy_file(file, parent, name: nil, version: nil)
 
 thumbnail(file, min_height: nil, min_width: nil, max_height: nil, max_width: nil)
 
@@ -319,7 +333,9 @@ delete_comment(comment)
 ```
 #### [Collaborations](https://developer.box.com/en/reference/resources/collaboration/)
 ```ruby
-folder_collaborations(folder)
+folder_collaborations(folder, fields: [], limit: DEFAULT_LIMIT, marker: nil)
+
+file_collaborations(file, fields: [], limit: DEFAULT_LIMIT, marker: nil)
 
 add_collaboration(folder, accessible_by, role, fields: [], notify: nil)
 
@@ -346,7 +362,7 @@ shared_item(shared_link, shared_link_password: nil)
 ```
 #### [Search](https://developer.box.com/en/reference/get-search/)
 ```ruby
-search( query=nil, scope: nil, file_extensions: [],
+search( query=nil, scope: nil, file_extensions: [], fields: [],
         created_at_range_from_date: nil, created_at_range_to_date: nil,
         updated_at_range_from_date: nil, updated_at_range_to_date: nil,
         size_range_lower_bound_bytes: nil, size_range_upper_bound_bytes: nil,
@@ -515,3 +531,16 @@ create_zip_download(items, download_file_name: nil)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Test Commands
+
+```
+rspec spec/files_spec.rb
+rspec spec/folders_spec.rb
+rspec spec/groups_spec.rb
+rspec spec/tasks_spec.rb
+rspec spec/users_spec.rb
+rspec spec/watermarking_spec.rb
+rspec spec/webhooks_spec.rb
+rspec spec/zip_downloads_spec.rb
+```

data/Rakefile

@@ -1,10 +1,9 @@
 require 'rspec/core/rake_task'
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
-# Default directory to look in is `/specs`
 # Run with `rake spec`
 RSpec::Core::RakeTask.new(:spec) do |task|
-  task.rspec_opts = ['--color', '--format', 'documentation']
+  task.rspec_opts = ['--format', 'documentation']
 end
 
-task :default => :spec
+task default: :spec

data/bin/boxr

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

data/boxr.gemspec

@@ -1,37 +1,42 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'boxr/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "boxr"
+  spec.name          = 'boxr'
   spec.version       = Boxr::VERSION
-  spec.authors       = ["Chad Burnette", "Xavier Hocquet"]
-  spec.email         = ["chadburnette@me.com", "xhocquet@gmail.com"]
-  spec.summary       = "A Ruby client library for the Box V2 Content API."
-  spec.description   = ""
-  spec.homepage      = "https://github.com/cburnette/boxr"
-  spec.license       = "MIT"
+  spec.authors       = ['Chad Burnette', 'Xavier Hocquet']
+  spec.email         = ['chadburnette@me.com', 'xhocquet@gmail.com']
+  spec.summary       = 'A Ruby client library for the Box V2 Content API.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/cburnette/boxr'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_development_dependency "bundler", "~> 2.3"
-  spec.add_development_dependency "rake", "~> 13.1"
-  spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "simplecov", "~> 0.9"
-  spec.add_development_dependency "dotenv", "~> 2.8"
-  spec.add_development_dependency "awesome_print", "~> 1.8"
-  spec.add_development_dependency "lru_redux", "~> 1.1"
-  spec.add_development_dependency "parallel", "~> 1.0"
-  spec.add_development_dependency "rubyzip", "~> 2.3"
+  spec.add_development_dependency 'awesome_print', '~> 1.8'
+  spec.add_development_dependency 'bundler', '>= 2.4' # Keep this locked for Ruby 2.7 compatibility
+  spec.add_development_dependency 'dotenv', '~> 2.8'
+  spec.add_development_dependency 'parallel', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 13.1'
+  spec.add_development_dependency 'rspec', '~> 3.13.1'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.7.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 3.7.0'
+  spec.add_development_dependency 'rubyzip', '~> 2.3'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'sin_lru_redux', '~> 2.5'
+  spec.add_development_dependency 'webmock', '~> 3.19'
 
-  spec.add_runtime_dependency "httpclient", "~> 2.8"
-  spec.add_runtime_dependency "hashie", ">= 3.5", "< 6"
-  spec.add_runtime_dependency "addressable", "~> 2.8"
-  spec.add_runtime_dependency "jwt", ">= 1.4", "< 3"
+  spec.add_runtime_dependency 'addressable', '~> 2.8'
+  spec.add_runtime_dependency 'hashie', '>= 3.5', '< 6'
+  spec.add_runtime_dependency 'httpclient', '~> 2.8'
+  spec.add_runtime_dependency 'jwt', '>= 1.4', '< 3'
 end

data/examples/enterprise_events.rb

@@ -1,24 +1,28 @@
-require 'dotenv'; Dotenv.load("../.env")
+require 'dotenv'
+Dotenv.load('../.env')
 require 'boxr'
 require 'awesome_print'
 
 client = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
 
 now = Time.now.utc
-start_date = now - (60*60*24) #one day ago
+start_date = now - (60 * 60 * 24) # one day ago
 
-puts "fetching historic enterprise events..."
+puts 'fetching historic enterprise events...'
 result = client.enterprise_events(created_after: start_date, created_before: now)
 
-ap result.events.each{|event| ap event; puts;}
-output={count: result.events.count, next_stream_position: result.next_stream_position}
+ap(result.events.each do |event|
+  ap event
+  puts
+end)
+output = { count: result.events.count, next_stream_position: result.next_stream_position }
 ap output
 
-#now that we have the latest stream position let's start monitoring in real-time
-puts "listening for new enterprise events..."
+# 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, refresh_period: 5) do |result|
-  result.events.each{|e| ap e}
-  output={count: result.events.count, next_stream_position: result.next_stream_position}
+  result.events.each { |e| ap e }
+  output = { count: result.events.count, next_stream_position: result.next_stream_position }
   ap output
-  puts "waiting..."
-end
+  puts 'waiting...'
+end

data/examples/jwt_auth.rb

@@ -1,12 +1,13 @@
-require 'dotenv'; Dotenv.load("../.env")
+require 'dotenv'
+Dotenv.load('../.env')
 require 'boxr'
 require 'awesome_print'
 require 'openssl'
 
+private_key = OpenSSL::PKey::RSA.new(File.read(ENV['JWT_PRIVATE_KEY_PATH']),
+                                     ENV['JWT_PRIVATE_KEY_PASSWORD'])
 
-private_key = OpenSSL::PKey::RSA.new(File.read(ENV['JWT_PRIVATE_KEY_PATH']), ENV['JWT_PRIVATE_KEY_PASSWORD'])
-
-#make sure ENV['BOX_ENTERPRISE_ID'], ENV['BOX_CLIENT_ID'] and ENV['BOX_CLIENT_SECRET'] are set
-response = Boxr::get_enterprise_token(private_key: private_key)
+# make sure ENV['BOX_ENTERPRISE_ID'], ENV['BOX_CLIENT_ID'] and ENV['BOX_CLIENT_SECRET'] are set
+response = Boxr.get_enterprise_token(private_key: private_key)
 
 ap response

data/examples/metadata_search.rb

@@ -1,19 +1,20 @@
-require 'dotenv'; Dotenv.load("../.env")
+require 'dotenv'
+Dotenv.load('../.env')
 require 'awesome_print'
 require 'boxr'
 
 box_client = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
 
 mdfilters = [
-              {
-                "templateKey" => "test1", 
-                "scope" => "enterprise", 
-                "filters" => {
-                  "attrone" => "blah",
-                  "attrtwo" => {"gt" => "4", "lt" => "7"}
-                }
-              }
-            ]
+  {
+    'templateKey' => 'test1',
+    'scope' => 'enterprise',
+    'filters' => {
+      'attrone' => 'blah',
+      'attrtwo' => { 'gt' => '4', 'lt' => '7' }
+    }
+  }
+]
 
 results = box_client.search(mdfilters: mdfilters)
-ap results
+ap results

data/examples/oauth.rb

@@ -1,12 +1,13 @@
-require 'dotenv'; Dotenv.load("../.env")
+require 'dotenv'
+Dotenv.load('../.env')
 require 'boxr'
 require 'uri'
 require 'awesome_print'
 
-#make sure you have BOX_CLIENT_ID and BOX_CLIENT_SECRET set in your .env file
-#make sure you have the redirect_uri for your application set to something like http://localhost:1234 in the developer portal
+# make sure you have BOX_CLIENT_ID and BOX_CLIENT_SECRET set in your .env file
+# make sure you have the redirect_uri for your application set to something like http://localhost:1234 in the developer portal
 
-oauth_url = Boxr::oauth_url(URI.encode_www_form_component('your-anti-forgery-token'))
+oauth_url = Boxr.oauth_url(URI.encode_www_form_component('your-anti-forgery-token'))
 
 puts "Copy the URL below and paste into a browser. Go through the OAuth flow using the desired Box account. \
 When you are finished your browser will redirect to a 404 error page. This is expected behavior. Look at the URL in the address \
@@ -17,11 +18,7 @@ puts
 puts "URL:  #{oauth_url}"
 puts
 
-print "Enter the code: "
-code = STDIN.gets.chomp.split('=').last
-
-ap Boxr::get_tokens(code)
-
-
-
+print 'Enter the code: '
+code = $stdin.gets.chomp.split('=').last
 
+ap Boxr.get_tokens(code)

data/examples/remove_collaborators.rb

@@ -1,4 +1,5 @@
-require 'dotenv'; Dotenv.load("../.env")
+require 'dotenv'
+Dotenv.load('../.env')
 require 'awesome_print'
 require 'boxr'
 
@@ -6,13 +7,13 @@ box_client = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
 
 current_user_id = box_client.me.id
 
-folders = box_client.root_folder_items(fields:[:owned_by, :name]).folders
-owned_folders = folders.select{|f| f.owned_by.id == current_user_id}
+folders = box_client.root_folder_items(fields: %i[owned_by name]).folders
+owned_folders = folders.select { |f| f.owned_by.id == current_user_id }
 
 removed_count = 0
 owned_folders.each do |f|
   puts "Checking folder '#{f.name}'"
-  collabs = box_client.folder_collaborations(f, fields:[:accessible_by])
+  collabs = box_client.folder_collaborations(f, fields: [:accessible_by])
   collabs.each do |c|
     box_client.remove_collaboration(c)
     removed_count += 1
@@ -21,4 +22,4 @@ owned_folders.each do |f|
 end
 
 puts
-puts "Removed #{removed_count} collaborations from #{owned_folders.count} folders"
+puts "Removed #{removed_count} collaborations from #{owned_folders.count} folders"

data/examples/use_events_to_send_sms.rb

@@ -1,59 +1,60 @@
-require 'dotenv'; Dotenv.load("../.env")
+require 'dotenv'
+Dotenv.load('../.env')
 require 'boxr'
-require 'twilio-ruby' #make sure you 'gem install twilio-ruby'
- 
+require 'twilio-ruby' # make sure you 'gem install twilio-ruby'
+
 # Get your Account Sid, Auth Token, and phone number from twilio.com/user/account
-TWILIO_PHONE_NUMBER= ENV['TWILIO_PHONE_NUMBER']
-BOX_TRIGGER_EVENT = 'UPLOAD'
+TWILIO_PHONE_NUMBER = ENV['TWILIO_PHONE_NUMBER']
+BOX_TRIGGER_EVENT = 'UPLOAD'.freeze
 
 @twilio_client = Twilio::REST::Client.new(ENV['TWILIO_ACCOUNT_SID'], ENV['TWILIO_AUTH_TOKEN'])
 @box_client = Boxr::Client.new(ENV['BOX_DEVELOPER_TOKEN'])
 
 def send_sms_to_box_user(recipient, 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
+  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
-  rescue Boxr::BoxrError => e
-    #most likely error is that a collaborator is an external user and Box threw a 404
-    puts e.message
   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
 
-#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
+# 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.utc
-start_date = now - (60*60*24) #one day ago
+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: 5) do |result|
-  if result.events.count==0
+# 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: 5) do |result|
+  if result.events.count.zero?
     puts "no new #{BOX_TRIGGER_EVENT} events..."
   else
     puts "detected #{result.events.count} new #{BOX_TRIGGER_EVENT}"
     result.events.each do |e|
       folder = @box_client.folder(e.source.parent)
       message = "Document '#{e.source.item_name}' uploaded to folder '#{folder.name}' by #{e.created_by.name}"
-      
-      #first notify the folder owner
+
+      # first notify the folder owner
       send_sms_to_box_user(folder.owned_by, message)
 
-      #now notify collaborators
-      user_collabs = @box_client.folder_collaborations(folder).select{|c| c.accessible_by.type=='user'}
-      user_collabs.each{|c| send_sms_to_box_user(c.accessible_by, message)}
+      # now notify collaborators
+      user_collabs = @box_client.folder_collaborations(folder).select do |c|
+        c.accessible_by.type == 'user'
+      end
+      user_collabs.each { |c| send_sms_to_box_user(c.accessible_by, message) }
     end
   end
 end
-