files.com 1.0.99 → 1.0.100

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d61d5f715d4e894f0102913b5180614d20c07774fd57df8cb2d93cfa4f83ad9
-  data.tar.gz: ebde8436aa8818e3332660352998e4bc1ef57564a523a4a1614e8e085b275ae6
+  metadata.gz: de1ee65d3dc0f22e11043ad9510774254de6242cfed0379e7889891d7d4e01f7
+  data.tar.gz: f84015f3af4655695eaa9707376de457cf54cf79499c73bace3875dbbc355c6c
 SHA512:
-  metadata.gz: 175cb4d587cb172d326a5bd3ea213e042dcd023d8816cb91da5f23510abffcd8de34083484e577d6cdef12d6b15b4f935d16c1394a80e76b7411f73ec8cc3426
-  data.tar.gz: fe5baf51329e93cd9a6edf8e9396f764b2fb90df7781e09326441f67f3f3e2276b6aa0e4ec3ec16a17522c56d0cd4b996c4f71860b8b03e7c73c5e6f840c55e5
+  metadata.gz: bb0c1c342f5d9417ef8ecb3124256c9dbd00207002f343db51a96798ce5b6ef074e02f08c86521a678b8e09ac6ddc51cde6985d6f83a1d1cf7414d8819158b1e
+  data.tar.gz: 19ec076e011a1d909ef6fd63e36a02063414e39928aff129741be4a972f68df8737990ce07c44952f4e7fedc4a3ea786459c29f025ce5d83ce15ef9558b5508a

data/_VERSION

@@ -1 +1 @@
-1.0.99
+1.0.100

data/docs/bandwidth_snapshot.md

@@ -0,0 +1,45 @@
+# BandwidthSnapshot
+
+## Example BandwidthSnapshot Object
+
+```
+{
+  "id": 1,
+  "bytes_received": 1.0,
+  "bytes_sent": 1.0,
+  "requests_get": 1.0,
+  "requests_put": 1.0,
+  "requests_other": 1.0,
+  "logged_at": "2000-01-01T01:00:00Z",
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Site bandwidth ID
+* `bytes_received` (double): Site bandwidth report bytes received
+* `bytes_sent` (double): Site bandwidth report bytes sent
+* `requests_get` (double): Site bandwidth report get requests
+* `requests_put` (double): Site bandwidth report put requests
+* `requests_other` (double): Site bandwidth report other requests
+* `logged_at` (date-time): Time the site bandwidth report was logged
+* `created_at` (date-time): Site bandwidth report created at date/time
+* `updated_at` (date-time): The last time this site bandwidth report was updated
+
+
+---
+
+## List Bandwidth Snapshots
+
+```
+Files::BandwidthSnapshot.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.

data/lib/files.com.rb

@@ -33,6 +33,7 @@ require "files.com/models/app"
 require "files.com/models/as2_key"
 require "files.com/models/auto"
 require "files.com/models/automation"
+require "files.com/models/bandwidth_snapshot"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
 require "files.com/models/bundle_download"

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Files
+  class BandwidthSnapshot
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Site bandwidth ID
+    def id
+      @attributes[:id]
+    end
+
+    # double - Site bandwidth report bytes received
+    def bytes_received
+      @attributes[:bytes_received]
+    end
+
+    # double - Site bandwidth report bytes sent
+    def bytes_sent
+      @attributes[:bytes_sent]
+    end
+
+    # double - Site bandwidth report get requests
+    def requests_get
+      @attributes[:requests_get]
+    end
+
+    # double - Site bandwidth report put requests
+    def requests_put
+      @attributes[:requests_put]
+    end
+
+    # double - Site bandwidth report other requests
+    def requests_other
+      @attributes[:requests_other]
+    end
+
+    # date-time - Time the site bandwidth report was logged
+    def logged_at
+      @attributes[:logged_at]
+    end
+
+    # date-time - Site bandwidth report created at date/time
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # date-time - The last time this site bandwidth report was updated
+    def updated_at
+      @attributes[:updated_at]
+    end
+
+    # 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.
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
+
+      response, options = Api.send_request("/bandwidth_snapshots", :get, params, options)
+      response.data.map do |entity_data|
+        BandwidthSnapshot.new(entity_data, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

data/spec/models/file_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "tempfile"
 
 RSpec.describe Files::File, :with_test_folder do
-  describe "#read" do
+  xdescribe "#read" do
     before do
       Files::File.open(test_folder.join("[[strange stuff]]#yes.text").to_s, 'w', options) do |f|
         f.write("contents")
@@ -15,7 +15,7 @@ RSpec.describe Files::File, :with_test_folder do
     end
   end
 
-  describe "#read_io" do
+  xdescribe "#read_io" do
     before do
       Files::File.open(test_folder.join("read.txt").to_s, 'w', options) do |f|
         f.write("contents")
@@ -30,7 +30,7 @@ RSpec.describe Files::File, :with_test_folder do
     end
   end
 
-  describe "#write" do
+  xdescribe "#write" do
     it "can take string" do
       Files::File.open(test_folder.join("write-as-string.txt").to_s, 'w', options) do |f|
         f.write("I am a string")

data/spec/models/folder_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.describe Files::Folder, :with_test_folder do
-  describe "#list_for" do
+  xdescribe "#list_for" do
     before do
       Files::File.open(test_folder.join("example.txt").to_s, 'w', options) do |f|
         f.write("my text")
@@ -22,7 +22,7 @@ RSpec.describe Files::Folder, :with_test_folder do
     end
   end
 
-  describe "#delete" do
+  xdescribe "#delete" do
     it "deletes a folder" do
       Files::Folder.mkdir(test_folder.join("my-new-folder").to_s, {}, options)
       Files::Folder.delete(test_folder.join("my-new-folder").to_s, {}, options)
@@ -31,7 +31,7 @@ RSpec.describe Files::Folder, :with_test_folder do
     end
   end
 
-  describe "mkdir" do
+  xdescribe "mkdir" do
     it "makes a new folder" do
       Files::Folder.mkdir(test_folder.join("my-new-folder").to_s, {}, options)
       expect(Files::Folder.exist?(test_folder.join("my-new-folder").to_s, options)).to eq(true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.99
+  version: 1.0.100
 platform: ruby
 authors:
 - files.com
@@ -92,6 +92,7 @@ files:
 - docs/as2_key.md
 - docs/auto.md
 - docs/automation.md
+- docs/bandwidth_snapshot.md
 - docs/behavior.md
 - docs/bundle.md
 - docs/bundle_download.md
@@ -153,6 +154,7 @@ files:
 - lib/files.com/models/as2_key.rb
 - lib/files.com/models/auto.rb
 - lib/files.com/models/automation.rb
+- lib/files.com/models/bandwidth_snapshot.rb
 - lib/files.com/models/behavior.rb
 - lib/files.com/models/bundle.rb
 - lib/files.com/models/bundle_download.rb