files.com 1.1.206 → 1.1.208

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0935c1b5be8a28d599f93067c4009b0c4505e4f3eac0268ca674676264bbd850'
-  data.tar.gz: a25ac5ae242c66b0c190f6d79b213072928c89b47ed628d204697ba018e29250
+  metadata.gz: 841e24eb4898f1224f694a8c7d3aab281f1109bf0bae63e6fa8557fc6bd99132
+  data.tar.gz: b8c2f09b1891a50890792366e5bb8d67a90a276e7b1690c6a4bb84d47e17e4cc
 SHA512:
-  metadata.gz: 1ba8f7b5d32fc82668600e1a3167725215a7ce73cc93211d46dc34831dda539d389b8aaa206ca6eeb1b278d5ad946c0bf9c0325e6e2bdcd9a55b28bfb0ec7279
-  data.tar.gz: eae8efbee5b7783c25ad15cf6217da46f23ef372e50833f7f70aa2a7b005a165dcb4b2460342cb894bcc7ee73ebc2ab0128c733bf2d53edd080fe50bc935014c
+  metadata.gz: 72cf7f33373f789864ec482a2a30912b1e9260dd83d4fcb3cf5fdaecc87f88c51c1271759b2e2ba0dfe4e94450216838a872485139e627b4fe684ace192be883
+  data.tar.gz: 4edd9ff18e3bbee8572c9a6b20edd533e9909cb944813f13a4feeb4ecd0b2c61ff2c2bd53ce22d75a97515c2d4ba229cc645c87d264b82838bf6ef6fadbf2d7e

data/README.md

@@ -69,8 +69,14 @@ that user can access, and no access will be granted to site administration funct
 ```ruby title="Example Request"
 Files.api_key = 'YOUR_API_KEY'
 
-## Alternatively, you can specify the API key on a per-request basis in the final parameter to any method or initializer.
-Files::User.new(params, api_key: 'YOUR_API_KEY')
+begin
+  # Alternatively, you can specify the API key on a per-request basis in the final parameter to any method or initializer.
+  Files::User.new(params, api_key: 'YOUR_API_KEY')
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
 ```
 
 Don't forget to replace the placeholder, `YOUR_API_KEY`, with your actual API key.
@@ -95,7 +101,13 @@ password.
 This returns a session object that can be used to authenticate SDK method calls.
 
 ```ruby title="Example Request"
-session = Files::Session.create(username: "username", password: "password")
+begin
+  session = Files::Session.create(username: "username", password: "password")
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
 ```
 
 #### Using a Session
@@ -104,14 +116,19 @@ Once a session has been created, you can store the session globally, use the ses
 
 ```ruby title="Example Requests"
 ## You may set the returned session to be used by default for subsequent requests.
-Files.session = Files::Session.create(username: "username", password: "password")
-
-## Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
-user = Files::User.new(params, session_id: session.id)
+Files.session = session
 
-## You may also specify the session ID on a per-request basis in the final parameter to static methods.
-Files::Group.list({}, session_id: session.id)
+begin
+  # Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
+  user = Files::User.new(params, session_id: session.id)
 
+  # You may also specify the session ID on a per-request basis in the final parameter to static methods.
+  Files::Group.list({}, session_id: session.id)
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
 ```
 
 #### Logging Out
@@ -119,7 +136,13 @@ Files::Group.list({}, session_id: session.id)
 User sessions can be ended calling the `destroy` method on the `session` object.
 
 ```ruby title="Example Request"
-session.destroy()
+begin
+  session.destroy()
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
 ```
 
 ## Configuration
@@ -216,11 +239,16 @@ The argument value is a Ruby hash that has a key of the resource field name to s
 of either ```"asc"``` or ```"desc"``` to specify the sort order.
 
 ```ruby title="Sort Example"
-## users sorted by username
-Files.api_key = 'YOUR_API_KEY'
-Files::User.list(
-  sort_by: { "username": "asc"}
-)
+begin
+  # users sorted by username
+  Files::User.list(
+    sort_by: { "username": "asc" }
+  )
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
 ```
 
 ### Filtering
@@ -247,37 +275,57 @@ and a passed in value to use in the filter comparison.
 | `filter_lteq` | Range | Find resources that have a field value that is less than or equal to the passed in value.  (i.e., FIELD_VALUE \<= PASS_IN_VALUE). |
 
 ```ruby title="Exact Filter Example"
-## non admin users
-Files.api_key = 'YOUR_API_KEY'
-Files::User.list(
-  filter: { not_site_admin: true }
-)
+begin
+  # non admin users
+  Files::User.list(
+    filter: { not_site_admin: true }
+  )
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
 ```
 
 ```ruby title="Range Filter Example"
-## users who haven't logged in since 2024-01-01
-Files.api_key = 'YOUR_API_KEY'
-Files::User.list(
-  filter_gteq: { "last_login_at": "2024-01-01" }
-)
+begin
+  # users who haven't logged in since 2024-01-01
+  Files::User.list(
+    filter_gteq: { "last_login_at": "2024-01-01" }
+  )
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
 ```
 
 ```ruby title="Pattern Filter Example"
-## users whose usernames start with 'test'
-Files.api_key = 'YOUR_API_KEY'
-Files::User.list(
-  filter_pre: { username: "test" }
-)
+begin
+  # users whose usernames start with 'test'
+  Files::User.list(
+    filter_pre: { username: "test" }
+  )
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
 ```
 
 ```ruby title="Combination Filter with Sort Example"
-## users whose usernames start with 'test' and are not admins
-Files.api_key = 'YOUR_API_KEY'
-Files::User.list(
-  filter_prefix: { username: "test" },
-  filter: { not_site_admin: true },
-  sort_by: { "username": "asc"}
-)
+begin
+  # users whose usernames start with 'test' and are not admins
+  Files::User.list(
+    filter_prefix: { username: "test" },
+    filter: { not_site_admin: true },
+    sort_by: { "username": "asc" }
+  )
+rescue Files::NotAuthenticatedError => e
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
+rescue Files::Error => e
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
+end
 ```
 
 ## Errors
@@ -301,9 +349,9 @@ rescue for general `Files::Error` as a catch-all.
 begin
   session = Files::Session.create(username: "USERNAME", password: "BADPASSWORD")
 rescue Files::NotAuthenticatedError => e
-  puts "An Authentication Error has occurred (#{e.class.to_s}): " + e.message
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
 rescue Files::Error => e
-  puts "An Unknown Error has occurred (#{e.class.to_s}): " + e.message
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
 end
 ```
 

data/_VERSION

@@ -1 +1 @@
-1.1.206
+1.1.208

data/lib/files.com/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.206
+  version: 1.1.208
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-07 00:00:00.000000000 Z
+date: 2025-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable