files.com 1.0.33 → 1.0.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 826a7f03949844aebecf585f0a51b79d77faaddeb353ce8f993f8d45e3d202b3
-  data.tar.gz: 9c4b4f2ecee43ec3e0606fbd80cb708918c8d0f6a4a3f8bdb096ee33098540ce
+  metadata.gz: 95f6118254b939d113400ea9575b5f352f957de2760b911d4cbddca2daaf2e7b
+  data.tar.gz: ff0ebe62222940de1aac19014c8f88c23f3bf27a279f01982c0afb237a695849
 SHA512:
-  metadata.gz: c5c94fcd236187d9ad215a2157b7cf2db9a57860ba77ea4c49e8b6abe1abda29e22d163f9aa4a599aa1257d3e0220bd495d24658950e364fceb76e1810d9e854
-  data.tar.gz: 24c4306f9ad6ad772da4355eba69e66d64da3054c83748a58ce46b5cf723d81fa6a4423129e9a8a47cbc7a2812ac50548bb9e8625af098818ff73c8160e5dfad
+  metadata.gz: 1360c574244c44858bdeb03d2b83e3d5c0f05a2f4bc313fe3d78317188dc1fd0982e69848e41b5e408c0b90766786417753185b0af1d44e7c870be8f9ab843a1
+  data.tar.gz: 1225e3cc3ac3c3a10448eea2b01ba048f0b54a6f93f6faec6114fda68cd9625365515853844d1416393012a75d0defc691b5950c69507a243e787b3d63451a85

data/CONTRIBUTORS

@@ -1,2 +1,3 @@
 Kevin Bombino <kevin.bombino@files.com>
 Martyn Garcia <martyn.garcia@files.com>
+Dustin Zeisler <dustin.zeisler@files.com>

data/Gemfile

@@ -6,5 +6,7 @@ group :development, :test do
   gem 'pry'
   gem 'pry-byebug'
   gem 'rake', '~> 12.0.0'
-  gem 'rspec'
+  gem 'rspec', '~> 3.9.0'
+  gem 'rubocop'
+  gem 'memory_profiler'
 end

data/_VERSION

@@ -1 +1 @@
-1.0.33
+1.0.34

data/lib/files.com.rb

@@ -22,6 +22,7 @@ require "files.com/errors"
 require "files.com/response"
 require "files.com/system_profiler"
 require "files.com/util"
+require "files.com/list"
 
 require "files.com/models/account_line_item"
 require "files.com/models/action"

data/lib/files.com/api_client.rb

@@ -132,6 +132,10 @@ module Files
       end
     end
 
+    def cursor
+      @last_response.http_headers["x-files-cursor"]
+    end
+
     private def api_url(url = "", base_url = nil)
       (base_url || Files.base_url) + "/api/rest/v1" + url
     end
@@ -232,7 +236,7 @@ module Files
         http_headers: resp.http_headers,
         http_status: resp.http_status,
         json_body: resp.data,
-        code: error_data[:code],
+        code: error_data[:code] || resp.http_status,
       }
 
       case resp.http_status

data/lib/files.com/list.rb

@@ -0,0 +1,95 @@
+module Files
+  class List
+    include Enumerable
+
+    def initialize(resource_wrapper, params, current_response = nil, current_options = nil, &request_page)
+      @resource_wrapper = resource_wrapper
+      @params = params
+      @current_response = current_response
+      @current_options = current_options
+      @request_page = request_page
+    end
+
+    # Iterates through each resource in all pages, making additional fetches to
+    # the API as necessary.
+    #
+    # Note that this method will make as many API calls as necessary to fetch
+    # all resources. For more granular control, please see +each+ and
+    # +next_page+.
+    def auto_paging_each
+      return enum_for(:auto_paging_each).lazy unless block_given?
+
+      loop do
+        page = next_page
+        break unless page.valid_response?
+
+        page.set_cursor
+
+        page.wrap_data do |data|
+          yield data
+        end
+        break if page.on_last_page?
+      end
+    end
+
+    # Iterates through each resource in the current page.
+    #
+    # Note that this method makes no effort to fetch a new page when it gets to
+    # the end of the current page's resources. See also +auto_paging_each+.
+    def each(&block)
+      page = current_page
+      return [] unless page.valid_response?
+
+      page.set_cursor
+      page.wrap_data { |data| block.call data }
+    end
+
+    # Fetches the next page of resources (if there is one).
+    #
+    # This method will try to respect the per_page set. If none
+    # was given, the default per_page will be used.
+    def next_page
+      self.class.new(resource_wrapper, params, *request_page.call, &request_page)
+    end
+
+    protected
+
+    attr_reader :resource_wrapper,
+                :params,
+                :request_page
+
+    def current_page
+      @current_page ||= if @current_response and @current_options
+                          self
+                        else
+                          next_page
+                        end
+    end
+
+    def data
+      @current_response.data
+    end
+
+    def wrap_data
+      data.map do |object|
+        yield resource_wrapper.new(object, @current_options)
+      end
+    end
+
+    def set_cursor
+      params[:cursor] ||= @current_options[:client].cursor
+    end
+
+    def cursor
+      params[:cursor]
+    end
+
+    def valid_response?
+      @current_response.http_status == 200
+    end
+
+    def on_last_page?
+      !cursor or (data.count < params[:per_page])
+    end
+  end
+end

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

@@ -147,7 +147,6 @@ module Files
       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("/api_keys", :get, params, options)
-      response.data.map { |object| ApiKey.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -191,7 +191,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
 
       response, options = Api.send_request("/automations", :get, params, options)
-      response.data.map { |object| Automation.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -112,7 +112,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: behavior must be an String") if params.dig(:behavior) and !params.dig(:behavior).is_a?(String)
 
       response, options = Api.send_request("/behaviors", :get, params, options)
-      response.data.map { |object| Behavior.new(object, options) }
     end
 
     def self.all(params = {}, options = {})
@@ -137,8 +136,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: behavior must be an String") if params.dig(:behavior) and !params.dig(:behavior).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/behaviors/folders/#{Addressable::URI.encode_component(params[:path])}", :get, params, options)
-      response.data.map { |object| Behavior.new(object, options) }
+      response, options = Api.send_request("/behaviors/folders/#{URI.encode_www_form_component(params[:path])}", :get, params, options)
     end
 
     # Parameters:

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

@@ -166,7 +166,6 @@ module Files
       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("/bundles", :get, params, options)
-      response.data.map { |object| Bundle.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -39,7 +39,6 @@ module Files
       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("/dns_records", :get, params, options)
-      response.data.map { |object| DnsRecord.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -45,7 +45,7 @@ module Files
     def self.exist?(path, options = {})
       find(path, {}, options)
       true
-    rescue ApiError => e
+    rescue Error => e
       if e.code == 404
         false
       else
@@ -90,8 +90,8 @@ module Files
       new(path).mtime
     end
 
-    def self.open(path, mode = "r", &block)
-      file = new(path, mode)
+    def self.open(path, mode = "r", options={}, &block)
+      file = new(path, mode, options)
       if block
         yield file
         file.close
@@ -187,7 +187,8 @@ module Files
 
     def initialize(*args)
       @attributes = (args[0].is_a?(Hash) && args[0]) || {}
-      @options = (args[1].is_a?(Hash) && args[1]) || {}
+      @options = (args[1].is_a?(Hash) && args[1])
+      @options ||= (args[2].is_a?(Hash) && args[2]) || {}
       @attributes[:path] = args[0] if args[0].is_a?(String)
       @mode = args[1] || 'r' if args[1].is_a?(String)
       @write_io = StringIO.new
@@ -925,7 +926,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/files/#{Addressable::URI.encode_component(params[:path])}", :get, params, options)
+      response, options = Api.send_request("/files/#{URI.encode_www_form_component(params[:path])}", :get, params, options)
       File.new(response.data, options)
     end
 
@@ -960,7 +961,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: structure must be an String") if params.dig(:structure) and !params.dig(:structure).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/files/#{Addressable::URI.encode_component(params[:path])}", :post, params, options)
+      response, options = Api.send_request("/files/#{URI.encode_www_form_component(params[:path])}", :post, params, options)
       File.new(response.data, options)
     end
 
@@ -975,7 +976,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: priority_color must be an String") if params.dig(:priority_color) and !params.dig(:priority_color).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/files/#{Addressable::URI.encode_component(params[:path])}", :patch, params, options)
+      response, options = Api.send_request("/files/#{URI.encode_www_form_component(params[:path])}", :patch, params, options)
       File.new(response.data, options)
     end
 
@@ -987,7 +988,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, _options = Api.send_request("/files/#{Addressable::URI.encode_component(params[:path])}", :delete, params, options)
+      response, _options = Api.send_request("/files/#{URI.encode_www_form_component(params[:path])}", :delete, params, options)
       response.data
     end
 

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

@@ -76,7 +76,7 @@ module Files
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
       raise MissingParameterError.new("Parameter missing: destination") unless params.dig(:destination)
 
-      response, _options = Api.send_request("/file_actions/copy/#{Addressable::URI.encode_component(params[:path])}", :post, params, options)
+      response, _options = Api.send_request("/file_actions/copy/#{URI.encode_www_form_component(params[:path])}", :post, params, options)
       response.data
     end
 
@@ -92,7 +92,7 @@ module Files
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
       raise MissingParameterError.new("Parameter missing: destination") unless params.dig(:destination)
 
-      response, _options = Api.send_request("/file_actions/move/#{Addressable::URI.encode_component(params[:path])}", :post, params, options)
+      response, _options = Api.send_request("/file_actions/move/#{URI.encode_www_form_component(params[:path])}", :post, params, options)
       response.data
     end
 
@@ -115,7 +115,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: restart must be an Integer") if params.dig(:restart) and !params.dig(:restart).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/file_actions/begin_upload/#{Addressable::URI.encode_component(params[:path])}", :post, params, options)
+      response, options = Api.send_request("/file_actions/begin_upload/#{URI.encode_www_form_component(params[:path])}", :post, params, options)
       FilePartUpload.new(response.data, options)
     end
   end

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

@@ -96,8 +96,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/file_comments/files/#{Addressable::URI.encode_component(params[:path])}", :get, params, options)
-      response.data.map { |object| FileComment.new(object, options) }
+      response, options = Api.send_request("/file_comments/files/#{URI.encode_www_form_component(params[:path])}", :get, params, options)
     end
 
     # Parameters:

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

@@ -353,8 +353,9 @@ module Files
       raise InvalidParameterError.new("Bad parameter: search must be an String") if params.dig(:search) and !params.dig(:search).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/folders/#{Addressable::URI.encode_component(params[:path])}", :get, params, options)
-      response.data.map { |object| File.new(object, options) }
+      List.new(File, params) do
+        Api.send_request("/folders/#{Addressable::URI.encode_component(params[:path])}", :get, params, options)
+      end
     end
 
     # Create folder
@@ -364,7 +365,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/folders/#{Addressable::URI.encode_component(params[:path])}", :post, params, options)
+      response, options = Api.send_request("/folders/#{URI.encode_www_form_component(params[:path])}", :post, params, options)
       File.new(response.data, options)
     end
   end

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

@@ -117,7 +117,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: ids must be an String") if params.dig(:ids) and !params.dig(:ids).is_a?(String)
 
       response, options = Api.send_request("/groups", :get, params, options)
-      response.data.map { |object| Group.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -113,7 +113,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer)
 
       response, options = Api.send_request("/group_users", :get, params, options)
-      response.data.map { |object| GroupUser.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -95,7 +95,6 @@ module Files
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
       response, options = Api.send_request("/history/files(/*path)", :get, params, options)
-      response.data.map { |object| Action.new(object, options) }
     end
 
     # Parameters:
@@ -119,7 +118,6 @@ module Files
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
       response, options = Api.send_request("/history/folders(/*path)", :get, params, options)
-      response.data.map { |object| Action.new(object, options) }
     end
 
     # Parameters:
@@ -143,7 +141,6 @@ module Files
       raise MissingParameterError.new("Parameter missing: user_id") unless params.dig(:user_id)
 
       response, options = Api.send_request("/history/users/#{params[:user_id]}", :get, params, options)
-      response.data.map { |object| Action.new(object, options) }
     end
 
     # Parameters:
@@ -162,7 +159,6 @@ module Files
       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("/history/login", :get, params, options)
-      response.data.map { |object| Action.new(object, options) }
     end
 
     # Parameters:
@@ -181,7 +177,6 @@ module Files
       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("/history", :get, params, options)
-      response.data.map { |object| Action.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -260,7 +260,6 @@ module Files
       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("/history_exports", :get, params, options)
-      response.data.map { |object| HistoryExport.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -89,7 +89,6 @@ module Files
       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("/invoices", :get, params, options)
-      response.data.map { |object| AccountLineItem.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -39,7 +39,6 @@ module Files
       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("/ip_addresses", :get, params, options)
-      response.data.map { |object| IpAddress.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -147,8 +147,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/locks/#{Addressable::URI.encode_component(params[:path])}", :get, params, options)
-      response.data.map { |object| Lock.new(object, options) }
+      response, options = Api.send_request("/locks/#{URI.encode_www_form_component(params[:path])}", :get, params, options)
     end
 
     # Create Lock
@@ -162,7 +161,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: timeout must be an Integer") if params.dig(:timeout) and !params.dig(:timeout).is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/locks/#{Addressable::URI.encode_component(params[:path])}", :post, params, options)
+      response, options = Api.send_request("/locks/#{URI.encode_www_form_component(params[:path])}", :post, params, options)
       Lock.new(response.data, options)
     end
 
@@ -176,7 +175,7 @@ module Files
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
       raise MissingParameterError.new("Parameter missing: token") unless params.dig(:token)
 
-      response, _options = Api.send_request("/locks/#{Addressable::URI.encode_component(params[:path])}", :delete, params, options)
+      response, _options = Api.send_request("/locks/#{URI.encode_www_form_component(params[:path])}", :delete, params, options)
       response.data
     end
 

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

@@ -121,7 +121,6 @@ module Files
       raise MissingParameterError.new("Parameter missing: project_id") unless params.dig(:project_id)
 
       response, options = Api.send_request("/messages", :get, params, options)
-      response.data.map { |object| Message.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -97,7 +97,6 @@ module Files
       raise MissingParameterError.new("Parameter missing: message_id") unless params.dig(:message_id)
 
       response, options = Api.send_request("/message_comments", :get, params, options)
-      response.data.map { |object| MessageComment.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -74,7 +74,6 @@ module Files
       raise MissingParameterError.new("Parameter missing: message_comment_id") unless params.dig(:message_comment_id)
 
       response, options = Api.send_request("/message_comment_reactions", :get, params, options)
-      response.data.map { |object| MessageCommentReaction.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -74,7 +74,6 @@ module Files
       raise MissingParameterError.new("Parameter missing: message_id") unless params.dig(:message_id)
 
       response, options = Api.send_request("/message_reactions", :get, params, options)
-      response.data.map { |object| MessageReaction.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -169,7 +169,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer)
 
       response, options = Api.send_request("/notifications", :get, params, options)
-      response.data.map { |object| Notification.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -89,7 +89,6 @@ module Files
       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("/payments", :get, params, options)
-      response.data.map { |object| AccountLineItem.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -130,7 +130,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: user_id must be an String") if params.dig(:user_id) and !params.dig(:user_id).is_a?(String)
 
       response, options = Api.send_request("/permissions", :get, params, options)
-      response.data.map { |object| Permission.new(object, options) }
     end
 
     def self.all(path, params = {}, options = {})

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

@@ -74,7 +74,6 @@ module Files
       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("/projects", :get, params, options)
-      response.data.map { |object| Project.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -108,7 +108,6 @@ module Files
       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("/public_keys", :get, params, options)
-      response.data.map { |object| PublicKey.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -258,7 +258,6 @@ module Files
       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("/remote_servers", :get, params, options)
-      response.data.map { |object| RemoteServer.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -121,7 +121,6 @@ module Files
       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("/requests", :get, params, options)
-      response.data.map { |object| Request.new(object, options) }
     end
 
     def self.all(params = {}, options = {})
@@ -143,8 +142,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/requests/folders/#{Addressable::URI.encode_component(params[:path])}", :get, params, options)
-      response.data.map { |object| Request.new(object, options) }
+      response, options = Api.send_request("/requests/folders/#{URI.encode_www_form_component(params[:path])}", :get, params, options)
     end
 
     # Create Request

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

@@ -129,7 +129,6 @@ module Files
       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("/sso_strategies", :get, params, options)
-      response.data.map { |object| SsoStrategy.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -93,7 +93,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, options = Api.send_request("/styles/#{Addressable::URI.encode_component(params[:path])}", :get, params, options)
+      response, options = Api.send_request("/styles/#{URI.encode_www_form_component(params[:path])}", :get, params, options)
       Style.new(response.data, options)
     end
 
@@ -110,7 +110,7 @@ module Files
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
       raise MissingParameterError.new("Parameter missing: file") unless params.dig(:file)
 
-      response, options = Api.send_request("/styles/#{Addressable::URI.encode_component(params[:path])}", :patch, params, options)
+      response, options = Api.send_request("/styles/#{URI.encode_www_form_component(params[:path])}", :patch, params, options)
       Style.new(response.data, options)
     end
 
@@ -120,7 +120,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
 
-      response, _options = Api.send_request("/styles/#{Addressable::URI.encode_component(params[:path])}", :delete, params, options)
+      response, _options = Api.send_request("/styles/#{URI.encode_www_form_component(params[:path])}", :delete, params, options)
       response.data
     end
 

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

@@ -39,7 +39,6 @@ module Files
       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("/usage_daily_snapshots", :get, params, options)
-      response.data.map { |object| UsageDailySnapshot.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -84,7 +84,6 @@ module Files
       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("/usage_snapshots", :get, params, options)
-      response.data.map { |object| UsageSnapshot.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -609,7 +609,6 @@ module Files
       raise InvalidParameterError.new("Bad parameter: search must be an String") if params.dig(:search) and !params.dig(:search).is_a?(String)
 
       response, options = Api.send_request("/users", :get, params, options)
-      response.data.map { |object| User.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

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

@@ -51,7 +51,6 @@ module Files
       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("/user_cipher_uses", :get, params, options)
-      response.data.map { |object| UserCipherUse.new(object, options) }
     end
 
     def self.all(params = {}, options = {})

data/spec/list_spec.rb

@@ -0,0 +1,192 @@
+require "spec_helper"
+
+RSpec.describe Files::List do
+  ResourceWrapper = Struct.new(:object, :options)
+  let(:options) { { client: client } }
+  let(:client) { instance_double(Files::ApiClient, cursor: nil) }
+  let(:params) { {} }
+
+  describe "#auto_paging_each" do
+    context "when per_page is set" do
+      let(:params) { { per_page: per_page } }
+      let(:per_page) { 3 }
+
+      context "when response includes a cursor" do
+        let(:client) { instance_double(Files::ApiClient, cursor: "XXX-XXX") }
+
+        it "does not call the API until out of responses" do
+          server_results = ('a'..'h').to_a
+          times_block_yielded = 0
+          list = described_class.new(ResourceWrapper, params) {
+            times_block_yielded += 1
+            [
+              instance_double(Files::Response, data: server_results.shift(per_page), http_status: 200),
+              options
+            ]
+          }
+          results = list.auto_paging_each
+          expect(results.class).to eq(Enumerator::Lazy)
+          expect(times_block_yielded).to eq(0)
+          expect(results.next.object).to eq('a')
+          expect(times_block_yielded).to eq(1)
+          expect(results.next.object).to eq('b')
+          expect(results.next.object).to eq('c')
+          expect(results.next.object).to eq('d')
+          expect(times_block_yielded).to eq(2)
+          expect(results.next.object).to eq('e')
+          expect(results.next.object).to eq('f')
+          expect(results.next.object).to eq('g')
+          expect(results.next.object).to eq('h')
+          expect(times_block_yielded).to eq(3)
+        end
+
+        it "stops calling the API once there is an error" do
+          server_results = ('a'..'h').to_a
+          times_block_yielded = 0
+          list = described_class.new(ResourceWrapper, params) {
+            times_block_yielded += 1
+            [
+              instance_double(Files::Response, data: server_results.shift(per_page), http_status: 400),
+              options
+            ]
+          }
+          results = list.auto_paging_each
+          expect(results.count).to eq(0)
+          expect(times_block_yielded).to eq(1)
+        end
+      end
+
+      context "when response does not include a cursor" do
+        let(:client) { instance_double(Files::ApiClient, cursor: nil) }
+
+        it "stops requesting any more results after the first try" do
+          server_results = ('a'..'h').to_a
+          times_block_yielded = 0
+          list = described_class.new(ResourceWrapper, params) {
+            times_block_yielded += 1
+            [
+              instance_double(Files::Response, data: server_results.shift(per_page), http_status: 200),
+              options
+            ]
+          }
+          results = list.auto_paging_each
+          expect(results.count).to eq(3)
+          expect(times_block_yielded).to eq(1)
+        end
+      end
+    end
+
+    it "returns all results at once" do
+      server_results = ('a'..'h').to_a
+      times_block_yielded = 0
+      list = described_class.new(ResourceWrapper, params) {
+        times_block_yielded += 1
+        [
+          instance_double(Files::Response, data: server_results, http_status: 200),
+          options
+        ]
+      }
+      results = list.auto_paging_each
+      expect(results.count).to eq(8)
+      expect(times_block_yielded).to eq(1)
+    end
+  end
+
+  describe "#each" do
+    it "returns all results at once" do
+      server_results = ('a'..'h').to_a
+      times_block_yielded = 0
+      results = described_class.new(ResourceWrapper, params) {
+        times_block_yielded += 1
+        [
+          instance_double(Files::Response, data: server_results, http_status: 200),
+          options
+        ]
+      }
+      expect(results.count).to eq(8)
+      expect(times_block_yielded).to eq(1)
+    end
+
+    context "when per_page is set" do
+      let(:params) { { per_page: per_page } }
+      let(:per_page) { 3 }
+
+      context "when response includes a cursor" do
+        let(:client) { instance_double(Files::ApiClient, cursor: "XXX-XXX") }
+
+        it "does not call the API until out of responses" do
+          server_results = ('a'..'h').to_a
+          times_block_yielded = 0
+          list = described_class.new(ResourceWrapper, params) {
+            times_block_yielded += 1
+            [
+              instance_double(Files::Response, data: server_results.shift(per_page), http_status: 200),
+              options
+            ]
+          }
+          results = list.enum_for(:each)
+          expect(times_block_yielded).to eq(0)
+          expect(results.next.object).to eq('a')
+          expect(times_block_yielded).to eq(1)
+          expect(results.next.object).to eq('b')
+          expect(results.next.object).to eq('c')
+          next_results = list.next_page.enum_for(:each)
+          expect(times_block_yielded).to eq(2)
+          expect(next_results.next.object).to eq('d')
+          expect(next_results.next.object).to eq('e')
+          expect(next_results.next.object).to eq('f')
+          next_results = list.next_page.enum_for(:each)
+          expect(times_block_yielded).to eq(3)
+          expect(next_results.next.object).to eq('g')
+          expect(next_results.next.object).to eq('h')
+          next_results = list.next_page.enum_for(:each)
+          expect(next_results.count).to eq(0)
+        end
+
+        it "return the same data when call more than once" do
+          server_results = ('a'..'h').to_a
+          list = described_class.new(ResourceWrapper, params) {
+            [
+              instance_double(Files::Response, data: server_results.shift(per_page), http_status: 200),
+              options
+            ]
+          }
+          expect(list.to_a).to eq(list.to_a)
+        end
+
+        it "stops calling the API once there is an error" do
+          server_results = ('a'..'h').to_a
+          times_block_yielded = 0
+          results = described_class.new(ResourceWrapper, params) {
+            times_block_yielded += 1
+            [
+              instance_double(Files::Response, data: server_results, http_status: 400),
+              options
+            ]
+          }
+          expect(results.count).to eq(0)
+          expect(times_block_yielded).to eq(1)
+        end
+      end
+
+      context "when response does not include a cursor" do
+        let(:client) { instance_double(Files::ApiClient, cursor: nil) }
+
+        it "stops requesting any more results after the first try" do
+          server_results = ('a'..'h').to_a
+          times_block_yielded = 0
+          list = described_class.new(ResourceWrapper, params) {
+            times_block_yielded += 1
+            [
+              instance_double(Files::Response, data: server_results, http_status: 200),
+              options
+            ]
+          }
+          results = list.enum_for(:each)
+          expect(results.count).to eq(8)
+          expect(times_block_yielded).to eq(1)
+        end
+      end
+    end
+  end
+end

data/spec/models/file_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+RSpec.describe Files::File, :with_test_folder do
+  describe "#read" do
+    before do
+      Files::File.open(test_folder.join("read.txt").to_s, 'w', options) do |f|
+        f.write("contents")
+      end
+    end
+
+    it "returns the body of the file" do
+      file = Files::File.find(test_folder.join("read.txt").to_s, {}, options)
+      expect(file.read).to eq("contents")
+    end
+  end
+
+  describe "#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")
+      end
+
+      file = Files::File.find(test_folder.join("write-as-string.txt").to_s, {}, options)
+      expect(file.read).to eq("I am a string")
+    end
+
+    it "can take IO object" do
+      Files::File.open(test_folder.join("write-as-io.txt").to_s, 'w', options) do |f|
+        f.write(StringIO.new("I am a string via IO"))
+      end
+
+      file = Files::File.find(test_folder.join("write-as-io.txt").to_s, {}, options)
+      expect(file.read).to eq("I am a string via IO")
+    end
+  end
+end

data/spec/models/folder_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+RSpec.describe Files::Folder, :with_test_folder do
+  describe "#list_for" do
+    before do
+      Files::File.open(test_folder.join("example.txt").to_s, 'w', options) do |f|
+        f.write("my text")
+      end
+
+      Files::Folder.mkdir(test_folder.join("other").to_s, {}, options)
+
+      Files::File.open(test_folder.join("other/example2.txt").to_s, 'w', options) do |f|
+        f.write("my text 2")
+      end
+    end
+
+    it "lists from the root" do
+      results = described_class.list_for(test_folder.to_s, {}, options)
+
+      expect(results.map(&:path).to_a).to match_array([ test_folder.join("example.txt").to_s, test_folder.join("other").to_s ])
+      expect(results.map(&:type).to_a).to match_array(%w[file directory])
+    end
+  end
+
+  describe "#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)
+
+      expect(Files::Folder.exist?(test_folder.join("my-new-folder").to_s, options)).to eq(false)
+    end
+  end
+
+  describe "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)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require "files.com"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  RSpec.shared_context "API Helpers" do
+    let(:test_folder) { @test_folder }
+    let(:api_key) { @api_key }
+    let(:options) { { api_key: api_key } }
+  end
+
+  RSpec.configure do |config|
+    config.include_context "API Helpers", :with_test_folder
+  end
+
+  config.around(:example, :with_test_folder) do |all|
+    @api_key = ENV["TEST_API_KEY"] || File.read("../../config/test_api_key.txt")
+    @test_folder = Pathname.new("files_regional_worker/#{SecureRandom.uuid}")
+    Files::Folder.exist?("files_regional_worker", api_key: @api_key)
+    Files::Folder.mkdir("files_regional_worker", {}, api_key: @api_key) unless Files::Folder.exist?("files_regional_worker", api_key: @api_key)
+    Files::Folder.mkdir(@test_folder.to_s, {}, api_key: @api_key)
+    all.run
+    Files::Folder.delete(@test_folder.to_s, { recursive: true }, api_key: @api_key)
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.disable_monkey_patching!
+  config.order = :random
+  Kernel.srand config.seed
+end

data/test.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "bundler"
+Bundler.with_clean_env do
+  Dir.chdir("generated/ruby") do
+    system "bundle install" if ARGV[0] == "true"
+    system "bundle exec rspec"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.33
+  version: 1.0.34
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -152,6 +152,7 @@ files:
 - lib/files.com/api.rb
 - lib/files.com/api_client.rb
 - lib/files.com/errors.rb
+- lib/files.com/list.rb
 - lib/files.com/models/account.rb
 - lib/files.com/models/account_line_item.rb
 - lib/files.com/models/action.rb
@@ -233,6 +234,11 @@ files:
 - lib/files.com/system_profiler.rb
 - lib/files.com/util.rb
 - lib/files.com/version.rb
+- spec/list_spec.rb
+- spec/models/file_spec.rb
+- spec/models/folder_spec.rb
+- spec/spec_helper.rb
+- test.sh
 - test/test.rb
 homepage: https://www.files.com
 licenses: