files.com 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 891d58e7e3d98bb4f267ba5b81383f32ce5faf08a84cc3d1881094ccde5186a0
+  data.tar.gz: e19353b0cb333d0cf3795d453a502f50dc106629dd98eba0444ba437394f984e
+SHA512:
+  metadata.gz: aba59d36146a7f7c33ffb6d4f47ea68064c7d5611d93be4c693213c81dd6417681eb3b44ae21076db933772c0504e4fa05fe817843779503542fa9edee3d7301
+  data.tar.gz: b5de315a3c897a98c4a3faaa059076a48cb5389b4f9a3001e691cc435be4c7fa6c59373935ff9e1cfe7fd7300742d68aed5f171bf408f6043bf0edcb912cc19d

data/CONTRIBUTORS

@@ -0,0 +1,4 @@
+Kevin Bombino <kevin.bombino@files.com>
+Martyn Garcia <martyn.garcia@files.com>
+Dustin Zeisler <dustin.zeisler@files.com>
+Rommel Santor <rommel.santor@files.com>

data/Gemfile

@@ -0,0 +1,12 @@
+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'
+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/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2019- Action Verb, LLC (https://www.files.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# Files.com Ruby Client
+
+The Files.com Ruby client library provides convenient access to the Files.com API from applications written in the Ruby language.
+
+
+## Installation
+
+To install the package:
+
+    gem install files.com
+
+Or add this to your app's Gemfile:
+
+    gem 'files.com', '~> 1.0'
+
+
+### Requirements
+
+* Ruby 2.3+
+
+
+## Usage
+
+### Authentication
+
+There are multiple ways to authenticate to the API.
+
+#### Global API Key
+
+You can set an API key globally, like this:
+
+    Files.api_key = "my-key"
+
+
+#### Per-Request API Key
+
+Or, you can pass an API key per-request, in the Options hash at the end
+of every method.  Like this:
+
+    Files::Group.list({}, api_key: "my-key")
+
+That key will automatically be used for any followup actions that occur
+on models returned from the API.
+
+
+#### User Session
+
+Or, you can open a user session by calling `Files::Session.create`
+
+    session = Files::Session.create(username: "username", password: "password")
+
+Then use it as follows:
+
+    Files::Group.list({}, session: session)
+
+Or use if for all subsequent API calls globally like this:
+
+    Files.session = Files::Session.create(username: "username", password: "password")
+
+
+### Setting Global Options
+
+You can set the following global options directly on the `Files` module:
+
+ * `Files.log_level` - set to `nil`, `info`, or `debug`
+ * `Files.open_timeout` - open timeout in seconds (default: 30)
+ * `Files.read_timeout` - read timeout in seconds (default: 80)
+ * `Files.initial_network_retry_delay` - initial retry delay in seconds (default: 0.5)
+ * `Files.max_network_retries` - max retries (default: 3)
+ * `Files.max_network_retry_delay` - max retry delay in seconds (default: 2)
+ * `Files.base_url` - to point this client at an on-premise
+   installation of Files.com, set its URL here.
+ * `Files.proxy` - proxy configuration (uses Faraday format)
+
+
+### File Operations
+
+The Files::File and Files::Dir models implement the standard Ruby API
+for File and Dir, respectively.  (Note that the Files.com API uses the
+word Folder, not Dir, and Files::Dir is simply an alias for
+Files::Folder).
+
+
+#### List root folder
+
+    Files::Folder.list_for("/").each do |file|
+      puts file.path
+    end
+    
+
+#### Writing a file example
+
+    Files::File.open("foo.txt", 'w') do |f|
+      f.write("contents")
+    end
+
+
+#### Reading a file example
+
+    Files::File.find("foo.txt").read
+
+
+### Additional Object Documentation
+
+Additional docs are available at https://developers.files.com/ and also
+in the `docs/` subdirectory of this directory.
+
+
+### RDoc (YARD) Generated Documentation coming in the future
+
+We hope to add RDoc/Yard documentation to a future release.
+
+
+## Getting Support
+
+The Files.com team is happy to help with any SDK Integration challenges you
+may face.
+
+Just email support@files.com and we'll get the process started.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/_VERSION

@@ -0,0 +1 @@
+1.0.1

data/bin/files

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "#{::File.dirname(__FILE__)}/../lib/files.com"
+require "#{::File.dirname(__FILE__)}/../lib/files.com/cli"
+
+Files::Cli.new.run

data/bin/files-console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "irb"
+require "irb/completion"
+
+require "#{::File.dirname(__FILE__)}/../lib/files.com"
+
+# Config IRB to enable --simple-prompt and auto indent
+IRB.conf[:PROMPT_MODE] = :SIMPLE
+IRB.conf[:AUTO_INDENT] = true
+
+puts "Loaded Files.com Console."
+
+IRB.start

data/docs/account_line_item.md

@@ -0,0 +1,41 @@
+# AccountLineItem
+
+## Example AccountLineItem Object
+
+```
+{
+  "id": 1,
+  "amount": "",
+  "balance": "",
+  "created_at": "2000-01-01T01:00:00Z",
+  "currency": "USD",
+  "download_uri": "https://url...",
+  "invoice_line_items": [
+
+  ],
+  "method": "paypal",
+  "payment_line_items": [
+
+  ],
+  "payment_reversed_at": "2000-01-01T01:00:00Z",
+  "payment_type": "",
+  "site_name": "My Site",
+  "type": "invoice",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Line item Id
+* `amount` (double): Line item amount
+* `balance` (double): Line item balance
+* `created_at` (date-time): Line item created at
+* `currency` (string): Line item currency
+* `download_uri` (string): Line item download uri
+* `invoice_line_items` (array): Associated invoice line items
+* `method` (string): Line item payment method
+* `payment_line_items` (array): Associated payment line items
+* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
+* `payment_type` (string): Type of payment if applicable
+* `site_name` (string): Site name this line item is for
+* `type` (string): Type of line item, either payment or invoice
+* `updated_at` (date-time): Line item updated at

data/docs/action.md

@@ -0,0 +1,37 @@
+# Action
+
+## Example Action Object
+
+```
+{
+  "id": 1,
+  "path": "path",
+  "when": "2000-01-01T01:00:00Z",
+  "destination": "/to_path",
+  "display": "Actual text of the action here.",
+  "ip": "192.283.128.182",
+  "source": "/from_path",
+  "targets": [
+
+  ],
+  "user_id": 1,
+  "username": "user",
+  "action": "create",
+  "failure_type": "none",
+  "interface": "web"
+}
+```
+
+* `id` (int64): Action ID
+* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `when` (date-time): Action occurrence date/time
+* `destination` (string): The destination path for this action, if applicable
+* `display` (string): Friendly displayed output
+* `ip` (string): IP Address that performed this action
+* `source` (string): The source path for this action, if applicable
+* `targets` (array): Targets
+* `user_id` (int64): User ID
+* `username` (string): Username
+* `action` (string): Type of action
+* `failure_type` (string): Failure type.  If action was a user login or session failure, why did it fail?
+* `interface` (string): Interface on which this action occurred.

data/docs/api_key.md

@@ -0,0 +1,190 @@
+# ApiKey
+
+## Example ApiKey Object
+
+```
+{
+  "id": 1,
+  "descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
+  "created_at": "2000-01-01T01:00:00Z",
+  "expires_at": "2000-01-01T01:00:00Z",
+  "key": "[key]",
+  "last_use_at": "2000-01-01T01:00:00Z",
+  "name": "My Main API Key",
+  "permission_set": "full",
+  "platform": "win32",
+  "user_id": 1
+}
+```
+
+* `id` (int64): API Key ID
+* `descriptive_label` (string): Unique label that describes this API key.  Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
+* `created_at` (date-time): Time which API Key was created
+* `expires_at` (date-time): API Key expiration date
+* `key` (string): API Key actual key string
+* `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
+* `name` (string): Internal name for the API Key.  For your use.
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations.)  We hope to offer additional permission sets in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+* `platform` (string): If this API key represents a Desktop app, what platform was it created on?
+* `user_id` (int64): User ID for the owner of this API Key.  May be blank for Site-wide API Keys.
+
+
+---
+
+## List Api Keys
+
+```
+Files::ApiKey.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `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 information about current API key.  (Requires current API connection to be using an API key.)
+
+```
+Files::ApiKey.find_current
+```
+
+
+---
+
+## Show Api Key
+
+```
+Files::ApiKey.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Api Key ID.
+
+
+---
+
+## Create Api Key
+
+```
+Files::ApiKey.create(
+  user_id: 1, 
+  name: "My Key", 
+  permission_set: "full", 
+  expires_at: "2000-01-01T01:00:00Z"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `name` (string): Internal name for key.  For your reference only.
+* `permission_set` (string): Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
+* `expires_at` (string): Have the key expire at this date/time.
+
+
+---
+
+## Update current API key.  (Requires current API connection to be using an API key.)
+
+```
+Files::ApiKey.update_current(
+  name: "My Key", 
+  permission_set: "full", 
+  expires_at: "2000-01-01T01:00:00Z"
+)
+```
+
+### Parameters
+
+* `name` (string): Internal name for key.  For your reference only.
+* `permission_set` (string): Leave blank, or set to `desktop_app` to restrict the key to only desktop app functions.
+* `expires_at` (string): Have the key expire at this date/time.
+
+
+---
+
+## Update Api Key
+
+```
+Files::ApiKey.update(id, 
+  name: "My Key", 
+  permission_set: "full", 
+  expires_at: "2000-01-01T01:00:00Z"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Api Key ID.
+* `name` (string): Internal name for key.  For your reference only.
+* `permission_set` (string): Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
+* `expires_at` (string): Have the key expire at this date/time.
+
+
+---
+
+## Delete current API key.  (Requires current API connection to be using an API key.)
+
+```
+Files::ApiKey.delete_current
+```
+
+
+---
+
+## Delete Api Key
+
+```
+Files::ApiKey.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Api Key ID.
+
+
+---
+
+## Update Api Key
+
+```
+api_key = Files::ApiKey.list_for(path).first
+
+api_key.update(
+  name: "My Key",
+  permission_set: "full",
+  expires_at: "2000-01-01T01:00:00Z"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Api Key ID.
+* `name` (string): Internal name for key.  For your reference only.
+* `permission_set` (string): Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
+* `expires_at` (string): Have the key expire at this date/time.
+
+
+---
+
+## Delete Api Key
+
+```
+api_key = Files::ApiKey.list_for(path).first
+
+api_key.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Api Key ID.