files.com 1.0.70 → 1.0.75

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 354b517bc5f6ddc6a4755e0abc37559b06219ca42b065681e1b1d4382c9454c9
-  data.tar.gz: 3143fda44f1cd72abc7f2de6a7756040f7c9312845ecb0aa79ae01aa121e7e01
+  metadata.gz: 4e2a6520ef9479c777f51d37952731010b36853d48689a0bbc5709b335d0a3d2
+  data.tar.gz: 206b9bcf98ff21c55323c5aa11ca0484a169b296049cbbd47b6bcc59e01f44e4
 SHA512:
-  metadata.gz: 3b630b22648bb86650b8d8ecc73f7115583cb17923befb847c56174e48babc102f1f25bf378628c3e8abd577abc0c9abac1e97e26fc092cea722fad8ae4d27af
-  data.tar.gz: ea01983e584a06a03d96636d1f1b198aa18660c377732a16d4931673aab4d90a78afbb4e4feec54e4a2e8c284c2d9f6e33d269935f59ebcbf653e9ab945c335b
+  metadata.gz: b412285db5b0b86422a96528e84a20f63fea5c8d7179e9ed9aa5cd2254246aa6c23aa7da757cd08ac8854659f24ab211e93a3428b4da2e0cffdb09fefce9edd8
+  data.tar.gz: d32fe9ba666a77ec11f4ec4b46e7c1cad7ae48b5911a817bfa43e47d2426bed60c167ff7786ab16ef53313ad68d2ea49dce714bc0eb532236fa6d038fd9eb449

data/Gemfile

@@ -3,10 +3,10 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'memory_profiler'
   gem 'pry'
   gem 'pry-byebug'
   gem 'rake', '~> 12.0.0'
   gem 'rspec', '~> 3.9.0'
   gem 'rubocop'
-  gem 'memory_profiler'
 end

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    files.com (1.0)
+      addressable (>= 2.7.0)
+      concurrent-ruby (>= 1.1.3)
+      faraday (>= 1.0.1)
+      net-http-persistent
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    connection_pool (2.2.3)
+    diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    memory_profiler (0.9.14)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    net-http-persistent (4.0.0)
+      connection_pool (~> 2.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rake (12.0.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  files.com!
+  memory_profiler
+  pry
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.9.0)
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/_VERSION

@@ -1 +1 @@
-1.0.70
+1.0.75

data/docs/bundle.md

@@ -9,12 +9,14 @@
   "description": "The public description of the bundle.",
   "password_protected": true,
   "require_registration": true,
+  "clickwrap_body": "[Legal text]",
   "id": 1,
   "created_at": "2000-01-01T01:00:00Z",
   "expires_at": "2000-01-01T01:00:00Z",
   "note": "The internal note on the bundle.",
   "user_id": 1,
   "username": "user",
+  "clickwrap_id": 1,
   "paths": [
 
   ]
@@ -26,12 +28,14 @@
 * `description` (string): Public description
 * `password_protected` (boolean): Is this bundle password protected?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
 * `id` (int64): Bundle ID
 * `created_at` (date-time): Bundle created at date/time
 * `expires_at` (date-time): Bundle expiration date/time
 * `note` (string): Bundle internal note
 * `user_id` (int64): Bundle creator user ID
 * `username` (string): Bundle creator username
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `paths` (array): A list of paths in this bundle
 * `password` (string): Password for this bundle.
 
@@ -82,7 +86,8 @@ Files::Bundle.create(
   description: "The public description of the bundle.", 
   note: "The internal note on the bundle.", 
   code: "abc123", 
-  require_registration: true
+  require_registration: true, 
+  clickwrap_id: 1
 )
 ```
 
@@ -96,6 +101,7 @@ Files::Bundle.create(
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 
 
 ---
@@ -127,7 +133,8 @@ Files::Bundle.update(id,
   description: "The public description of the bundle.", 
   note: "The internal note on the bundle.", 
   code: "abc123", 
-  require_registration: true
+  require_registration: true, 
+  clickwrap_id: 1
 )
 ```
 
@@ -140,6 +147,7 @@ Files::Bundle.update(id,
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 
 
 ---
@@ -188,7 +196,8 @@ bundle.update(
   description: "The public description of the bundle.",
   note: "The internal note on the bundle.",
   code: "abc123",
-  require_registration: true
+  require_registration: true,
+  clickwrap_id: 1
 )
 ```
 
@@ -201,6 +210,7 @@ bundle.update(
 * `note` (string): Bundle internal note
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 
 
 ---

data/docs/clickwrap.md

@@ -0,0 +1,143 @@
+# Clickwrap
+
+## Example Clickwrap Object
+
+```
+{
+  "name": "Example Site NDA for Files.com Use",
+  "body": "[Legal body text]",
+  "use_with_users": "",
+  "use_with_bundles": "",
+  "use_with_inboxes": ""
+}
+```
+
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `id` (int64): Clickwrap ID.
+
+
+---
+
+## List Clickwraps
+
+```
+Files::Clickwrap.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+
+
+---
+
+## Show Clickwrap
+
+```
+Files::Clickwrap.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+
+
+---
+
+## Create Clickwrap
+
+```
+Files::Clickwrap.create(
+  name: "Example Site NDA for Files.com Use", 
+  body: "[Legal body text]"
+)
+```
+
+### Parameters
+
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+
+
+---
+
+## Update Clickwrap
+
+```
+Files::Clickwrap.update(id, 
+  name: "Example Site NDA for Files.com Use", 
+  body: "[Legal body text]"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+
+
+---
+
+## Delete Clickwrap
+
+```
+Files::Clickwrap.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+
+
+---
+
+## Update Clickwrap
+
+```
+clickwrap = Files::Clickwrap.list_for(path).first
+
+clickwrap.update(
+  name: "Example Site NDA for Files.com Use",
+  body: "[Legal body text]"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+
+
+---
+
+## Delete Clickwrap
+
+```
+clickwrap = Files::Clickwrap.list_for(path).first
+
+clickwrap.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.

data/docs/remote_server.md

@@ -22,7 +22,14 @@
   "backblaze_b2_s3_endpoint": "s3.us-west-001.backblazeb2.com",
   "backblaze_b2_bucket": "my-bucket",
   "wasabi_bucket": "us-west-1",
-  "wasabi_region": "my-bucket"
+  "wasabi_region": "my-bucket",
+  "rackspace_username": "rackspaceuser",
+  "rackspace_region": "dfw",
+  "rackspace_container": "my-container",
+  "auth_setup_link": "auth/:provider",
+  "auth_status": "in_setup",
+  "auth_account_name": "me@example.com",
+  "one_drive_account_type": "personnel"
 }
 ```
 
@@ -45,6 +52,13 @@
 * `backblaze_b2_bucket` (string): Backblaze B2 Cloud Storage Bucket name
 * `wasabi_bucket` (string): Wasabi region
 * `wasabi_region` (string): Wasabi Bucket name
+* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
+* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
+* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
+* `auth_setup_link` (string): Returns link to login with an Oauth provider
+* `auth_status` (string): Either `in_setup` or `complete`
+* `auth_account_name` (string): Describes the authorized account
+* `one_drive_account_type` (string): Either personnel or business_other account types
 * `aws_access_key` (string): AWS Access Key.
 * `aws_secret_key` (string): AWS secret key.
 * `password` (string): Password if needed.
@@ -54,6 +68,8 @@
 * `wasabi_secret_key` (string): Wasabi secret key.
 * `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
 * `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
+* `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
+* `reset_authentication` (boolean): Reset authenticated account
 
 
 ---
@@ -93,6 +109,7 @@ Files::RemoteServer.find(id)
 
 ```
 Files::RemoteServer.create(
+  reset_authentication: true, 
   hostname: "remote-server.com", 
   name: "My Remote server", 
   max_connections: 1, 
@@ -109,7 +126,11 @@ Files::RemoteServer.create(
   backblaze_b2_bucket: "my-bucket", 
   backblaze_b2_s3_endpoint: "s3.us-west-001.backblazeb2.com", 
   wasabi_bucket: "us-west-1", 
-  wasabi_region: "my-bucket"
+  wasabi_region: "my-bucket", 
+  rackspace_username: "rackspaceuser", 
+  rackspace_region: "dfw", 
+  rackspace_container: "my-container", 
+  one_drive_account_type: "personnel"
 )
 ```
 
@@ -124,6 +145,8 @@ Files::RemoteServer.create(
 * `wasabi_secret_key` (string): Wasabi secret key.
 * `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
 * `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
+* `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
+* `reset_authentication` (boolean): Reset authenticated account
 * `hostname` (string): Hostname or IP address
 * `name` (string): Internal name for your reference
 * `max_connections` (int64): Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
@@ -141,6 +164,10 @@ Files::RemoteServer.create(
 * `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
 * `wasabi_bucket` (string): Wasabi region
 * `wasabi_region` (string): Wasabi Bucket name
+* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
+* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
+* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
+* `one_drive_account_type` (string): Either personnel or business_other account types
 
 
 ---
@@ -149,6 +176,7 @@ Files::RemoteServer.create(
 
 ```
 Files::RemoteServer.update(id, 
+  reset_authentication: true, 
   hostname: "remote-server.com", 
   name: "My Remote server", 
   max_connections: 1, 
@@ -165,7 +193,11 @@ Files::RemoteServer.update(id,
   backblaze_b2_bucket: "my-bucket", 
   backblaze_b2_s3_endpoint: "s3.us-west-001.backblazeb2.com", 
   wasabi_bucket: "us-west-1", 
-  wasabi_region: "my-bucket"
+  wasabi_region: "my-bucket", 
+  rackspace_username: "rackspaceuser", 
+  rackspace_region: "dfw", 
+  rackspace_container: "my-container", 
+  one_drive_account_type: "personnel"
 )
 ```
 
@@ -181,6 +213,8 @@ Files::RemoteServer.update(id,
 * `wasabi_secret_key` (string): Wasabi secret key.
 * `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
 * `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
+* `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
+* `reset_authentication` (boolean): Reset authenticated account
 * `hostname` (string): Hostname or IP address
 * `name` (string): Internal name for your reference
 * `max_connections` (int64): Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
@@ -198,6 +232,10 @@ Files::RemoteServer.update(id,
 * `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
 * `wasabi_bucket` (string): Wasabi region
 * `wasabi_region` (string): Wasabi Bucket name
+* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
+* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
+* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
+* `one_drive_account_type` (string): Either personnel or business_other account types
 
 
 ---
@@ -221,6 +259,7 @@ Files::RemoteServer.delete(id)
 remote_server = Files::RemoteServer.list_for(path).first
 
 remote_server.update(
+  reset_authentication: true,
   hostname: "remote-server.com",
   name: "My Remote server",
   max_connections: 1,
@@ -237,7 +276,11 @@ remote_server.update(
   backblaze_b2_bucket: "my-bucket",
   backblaze_b2_s3_endpoint: "s3.us-west-001.backblazeb2.com",
   wasabi_bucket: "us-west-1",
-  wasabi_region: "my-bucket"
+  wasabi_region: "my-bucket",
+  rackspace_username: "rackspaceuser",
+  rackspace_region: "dfw",
+  rackspace_container: "my-container",
+  one_drive_account_type: "personnel"
 )
 ```
 
@@ -253,6 +296,8 @@ remote_server.update(
 * `wasabi_secret_key` (string): Wasabi secret key.
 * `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
 * `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
+* `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
+* `reset_authentication` (boolean): Reset authenticated account
 * `hostname` (string): Hostname or IP address
 * `name` (string): Internal name for your reference
 * `max_connections` (int64): Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
@@ -270,6 +315,10 @@ remote_server.update(
 * `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
 * `wasabi_bucket` (string): Wasabi region
 * `wasabi_region` (string): Wasabi Bucket name
+* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
+* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
+* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
+* `one_drive_account_type` (string): Either personnel or business_other account types
 
 
 ---