files.com 1.1.4 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc12dc51a718f7038296a0977a646b081b3c94ecb3607a63a991a17b55ed6055
-  data.tar.gz: 1b1dd7732ddb9b1afb7040e6b224be756cd5726e74a8d7c95dfc1d13be164d81
+  metadata.gz: 7d204d36cb4681395bf61b23e0c9d73d33827e4c04211334b7cd0b57633f5029
+  data.tar.gz: ab71996f578fcb8249c2d2d36888d3202889a6793cb5a90242012627e8845943
 SHA512:
-  metadata.gz: bbc0e7a34b1eff8583435a7f8d98a05caf569de77bb1053704662eb5b5dffc69c7e095aca3848cb0a544d55637bc2da63abb176714e603bcf7816f23b4162ad2
-  data.tar.gz: 9529b09d0e24ab182b6aef0bc5c0de3c8b3a0f679ee4c88a11ea0a2436adbcc9ccf07c6732261f5ecf6acd963f52c6af5cb3515d8f89c179d200e5d0f7e17bac
+  metadata.gz: dbb4c50ed59def6332dac58512c5732dc0beab6f19d2d9e87355736566321af92d55b33667461430d8a3d0c0337b40b73bffc8d5fdd076f967061ff2a9874511
+  data.tar.gz: 02c8ebf097990aa18dc3d05be9e97011a385b95611f752979b46641f852b1429716358b8853583355a58a9a58619788eb590a2c04de5c6c5f5af79fc55c714b9

data/_VERSION

@@ -1 +1 @@
-1.1.4
+1.1.6

data/docs/group.md

@@ -9,7 +9,11 @@
   "admin_ids": "1",
   "notes": "example",
   "user_ids": "1",
-  "usernames": "example"
+  "usernames": "example",
+  "ftp_permission": true,
+  "sftp_permission": true,
+  "dav_permission": true,
+  "restapi_permission": true
 }
 ```
 
@@ -19,6 +23,10 @@
 * `notes` (string): Notes about this group
 * `user_ids` (string): Comma-delimited list of user IDs who belong to this group (separated by commas)
 * `usernames` (string): Comma-delimited list of usernames who belong to this group (separated by commas)
+* `ftp_permission` (boolean): If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
+* `sftp_permission` (boolean): If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
+* `dav_permission` (boolean): If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
+* `restapi_permission` (boolean): If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
 
 
 ---
@@ -63,6 +71,10 @@ Files::Group.create(
   notes: "example", 
   user_ids: "1", 
   admin_ids: "1", 
+  ftp_permission: true, 
+  sftp_permission: true, 
+  dav_permission: true, 
+  restapi_permission: true, 
   name: "name"
 )
 ```
@@ -72,6 +84,10 @@ Files::Group.create(
 * `notes` (string): Group notes.
 * `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
 * `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
+* `ftp_permission` (boolean): If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
+* `sftp_permission` (boolean): If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
+* `dav_permission` (boolean): If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
+* `restapi_permission` (boolean): If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
 * `name` (string): Required - Group name.
 
 
@@ -84,6 +100,10 @@ Files::Group.update(id,
   notes: "example", 
   user_ids: "1", 
   admin_ids: "1", 
+  ftp_permission: true, 
+  sftp_permission: true, 
+  dav_permission: true, 
+  restapi_permission: true, 
   name: "owners"
 )
 ```
@@ -94,6 +114,10 @@ Files::Group.update(id,
 * `notes` (string): Group notes.
 * `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
 * `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
+* `ftp_permission` (boolean): If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
+* `sftp_permission` (boolean): If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
+* `dav_permission` (boolean): If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
+* `restapi_permission` (boolean): If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
 * `name` (string): Group name.
 
 
@@ -121,6 +145,10 @@ group.update(
   notes: "example",
   user_ids: "1",
   admin_ids: "1",
+  ftp_permission: true,
+  sftp_permission: true,
+  dav_permission: true,
+  restapi_permission: true,
   name: "owners"
 )
 ```
@@ -131,6 +159,10 @@ group.update(
 * `notes` (string): Group notes.
 * `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
 * `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
+* `ftp_permission` (boolean): If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
+* `sftp_permission` (boolean): If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
+* `dav_permission` (boolean): If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
+* `restapi_permission` (boolean): If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
 * `name` (string): Group name.
 
 

data/docs/site.md

@@ -486,6 +486,7 @@ Files::Site.update(
   sftp_enabled: true, 
   sftp_host_key_type: "default", 
   active_sftp_host_key_id: 1, 
+  protocol_access_groups_only: true, 
   bundle_watermark_value: {"key":"example value"}, 
   group_admins_can_set_user_password: true, 
   bundle_recipient_blacklist_free_email_domains: true, 
@@ -624,6 +625,7 @@ Files::Site.update(
 * `sftp_enabled` (boolean): Is SFTP enabled?
 * `sftp_host_key_type` (string): Sftp Host Key Type
 * `active_sftp_host_key_id` (int64): Id of the currently selected custom SFTP Host Key
+* `protocol_access_groups_only` (boolean): If `true`, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
 * `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
 * `group_admins_can_set_user_password` (boolean): Allow group admins set password authentication method
 * `bundle_recipient_blacklist_free_email_domains` (boolean): Disallow free email domains for Bundle/Inbox recipients?

data/lib/files.com/errors.rb

@@ -28,17 +28,18 @@ module Files
   class NotImplementedError < Error; end
 
   class APIError < Error
-    attr_reader :detail, :error, :errors, :http_code, :instance, :model_errors, :title, :type
+    attr_reader :detail, :error, :errors, :http_code, :instance, :model_errors, :title, :type, :data
 
     def initialize(message = nil, **kwargs)
-      @detail = kwargs.dig(:json_body, 'detail')
-      @error = kwargs.dig(:json_body, 'error')
-      @errors = kwargs.dig(:json_body, 'errors')
-      @http_code = kwargs.dig(:json_body, 'http-code')
-      @instance = kwargs.dig(:json_body, 'instance')
-      @model_errors = kwargs.dig(:json_body, 'model_errors')
-      @title = kwargs.dig(:json_body, 'title')
-      @type = kwargs.dig(:json_body, 'type')
+      @detail = kwargs.dig(:json_body, :detail)
+      @error = kwargs.dig(:json_body, :error)
+      @errors = kwargs.dig(:json_body, :errors)
+      @http_code = kwargs.dig(:json_body, :'http-code')
+      @instance = kwargs.dig(:json_body, :instance)
+      @model_errors = kwargs.dig(:json_body, :model_errors)
+      @title = kwargs.dig(:json_body, :title)
+      @type = kwargs.dig(:json_body, :type)
+      @data = kwargs.dig(:json_body, :data)
 
       super(message, **kwargs)
     end

data/lib/files.com/models/group.rb

@@ -63,10 +63,50 @@ module Files
       @attributes[:usernames] = value
     end
 
+    # boolean - If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
+    def ftp_permission
+      @attributes[:ftp_permission]
+    end
+
+    def ftp_permission=(value)
+      @attributes[:ftp_permission] = value
+    end
+
+    # boolean - If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
+    def sftp_permission
+      @attributes[:sftp_permission]
+    end
+
+    def sftp_permission=(value)
+      @attributes[:sftp_permission] = value
+    end
+
+    # boolean - If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
+    def dav_permission
+      @attributes[:dav_permission]
+    end
+
+    def dav_permission=(value)
+      @attributes[:dav_permission] = value
+    end
+
+    # boolean - If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
+    def restapi_permission
+      @attributes[:restapi_permission]
+    end
+
+    def restapi_permission=(value)
+      @attributes[:restapi_permission] = value
+    end
+
     # Parameters:
     #   notes - string - Group notes.
     #   user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
     #   admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
+    #   ftp_permission - boolean - If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
+    #   sftp_permission - boolean - If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
+    #   dav_permission - boolean - If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
+    #   restapi_permission - boolean - If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
     #   name - string - Group name.
     def update(params = {})
       params ||= {}
@@ -152,6 +192,10 @@ module Files
     #   notes - string - Group notes.
     #   user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
     #   admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
+    #   ftp_permission - boolean - If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
+    #   sftp_permission - boolean - If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
+    #   dav_permission - boolean - If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
+    #   restapi_permission - boolean - If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
     #   name (required) - string - Group name.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
@@ -168,6 +212,10 @@ module Files
     #   notes - string - Group notes.
     #   user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
     #   admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
+    #   ftp_permission - boolean - If true, users in this group can use FTP to login.  This will override a false value of `ftp_permission` on the user level.
+    #   sftp_permission - boolean - If true, users in this group can use SFTP to login.  This will override a false value of `sftp_permission` on the user level.
+    #   dav_permission - boolean - If true, users in this group can use WebDAV to login.  This will override a false value of `dav_permission` on the user level.
+    #   restapi_permission - boolean - If true, users in this group can use the REST API to login.  This will override a false value of `restapi_permission` on the user level.
     #   name - string - Group name.
     def self.update(id, params = {}, options = {})
       params ||= {}

data/lib/files.com/models/site.rb

@@ -851,6 +851,7 @@ module Files
     #   sftp_enabled - boolean - Is SFTP enabled?
     #   sftp_host_key_type - string - Sftp Host Key Type
     #   active_sftp_host_key_id - int64 - Id of the currently selected custom SFTP Host Key
+    #   protocol_access_groups_only - boolean - If `true`, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored.  Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
     #   bundle_watermark_value - object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
     #   group_admins_can_set_user_password - boolean - Allow group admins set password authentication method
     #   bundle_recipient_blacklist_free_email_domains - boolean - Disallow free email domains for Bundle/Inbox recipients?

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.4"
+  VERSION = "1.1.6"
 end

data/spec/lib/api_client_spec.rb

@@ -53,12 +53,24 @@ RSpec.describe Files::ApiClient do
         type: "bad-request/request-param-path-cannot-have-trailing-whitespace"
       }
     }
+    let(:bad_region_request_with_data) {
+      {
+        error: "You have connected to a URL that has different security settings than those required for your site.",
+        'http-code': 403,
+        title: "Lockout Region Mismatch",
+        type: "not-authenticated/lockout-region-mismatch",
+        data: {
+          host: "test.host"
+        }
+      }
+    }
     let(:bad_request_without_data) {
       {
         error: 'Bad Request'
       }
     }
     let(:mock_good_response) { { status: 400, headers: {}, body: bad_request_with_data.to_json } }
+    let(:mock_good_region_response) { { status: 403, headers: {}, body: bad_region_request_with_data.to_json } }
     let(:mock_response_without_type) { { status: 400, headers: {}, body: bad_request_without_data.to_json } }
     let(:mock_empty_response) { { status: 400, headers: {}, body: '' } }
 
@@ -66,7 +78,14 @@ RSpec.describe Files::ApiClient do
       allow(subject).to receive(:log_request).and_raise(Faraday::BadRequestError.new('', mock_good_response))
       expect {
         subject.execute_request_with_rescues(1, context) { 'empty block' }
-      }.to raise_error(Files::RequestParamPathCannotHaveTrailingWhitespaceError, bad_request_with_data[:error])
+      }.to raise_error do |error|
+        expect(error).to be_a(Files::RequestParamPathCannotHaveTrailingWhitespaceError)
+        expect(error.message).to eq bad_request_with_data[:error]
+        expect(error.title).to eq "Request Param Path Cannot Have Trailing Whitespace"
+        expect(error.type).to eq "bad-request/request-param-path-cannot-have-trailing-whitespace"
+        expect(error.http_code).to eq 400
+        expect(error.data).to be_nil
+      end
     end
 
     it "throws generic bad request error when no type" do
@@ -82,5 +101,20 @@ RSpec.describe Files::ApiClient do
         subject.execute_request_with_rescues(1, context) { 'empty block' }
       }.to raise_error(Files::APIConnectionError)
     end
+
+    it "handles region lockout error response" do
+      allow(subject).to receive(:log_request).and_raise(Faraday::BadRequestError.new('', mock_good_region_response))
+      expect {
+        subject.execute_request_with_rescues(1, context) { 'empty block' }
+      }.to raise_error do |error|
+        expect(error).to be_a(Files::LockoutRegionMismatchError)
+        expect(error.message).to eq bad_region_request_with_data[:error]
+        expect(error.title).to eq "Lockout Region Mismatch"
+        expect(error.type).to eq "not-authenticated/lockout-region-mismatch"
+        expect(error.http_code).to eq 403
+        expect(error.data).to have_key(:host)
+        expect(error.data[:host]).to eq "test.host"
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.6
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-15 00:00:00.000000000 Z
+date: 2023-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable