clever-ruby 1.2.5 → 2.0.0

data/lib/clever-ruby/api/events_api.rb

@@ -3,10 +3,10 @@
 
 #The Clever API
 
-OpenAPI spec version: 1.2.0
+OpenAPI spec version: 2.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.2.3
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 
@@ -79,6 +79,8 @@ module Clever
     # @option opts [Integer] :limit 
     # @option opts [String] :starting_after 
     # @option opts [String] :ending_before 
+    # @option opts [String] :school 
+    # @option opts [Array<String>] :record_type 
     # @return [EventsResponse]
     def get_events(opts = {})
       data, _status_code, _headers = get_events_with_http_info(opts)
@@ -91,6 +93,8 @@ module Clever
     # @option opts [Integer] :limit 
     # @option opts [String] :starting_after 
     # @option opts [String] :ending_before 
+    # @option opts [String] :school 
+    # @option opts [Array<String>] :record_type 
     # @return [Array<(EventsResponse, Fixnum, Hash)>] EventsResponse data, response status code and response headers
     def get_events_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -104,6 +108,8 @@ module Clever
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
       query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
+      query_params[:'school'] = opts[:'school'] if !opts[:'school'].nil?
+      query_params[:'record_type'] = @api_client.build_collection_param(opts[:'record_type'], :multi) if !opts[:'record_type'].nil?
 
       # header parameters
       header_params = {}
@@ -128,315 +134,5 @@ module Clever
       end
       return data, status_code, headers
     end
-
-    # 
-    # Returns a list of events for a school
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [EventsResponse]
-    def get_events_for_school(id, opts = {})
-      data, _status_code, _headers = get_events_for_school_with_http_info(id, opts)
-      return data
-    end
-
-    # 
-    # Returns a list of events for a school
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [Array<(EventsResponse, Fixnum, Hash)>] EventsResponse data, response status code and response headers
-    def get_events_for_school_with_http_info(id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: EventsApi.get_events_for_school ..."
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_events_for_school"
-      end
-      # resource path
-      local_var_path = "/schools/{id}/events".sub('{' + 'id' + '}', id.to_s)
-
-      # query parameters
-      query_params = {}
-      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
-      query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
-      query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['oauth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'EventsResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: EventsApi#get_events_for_school\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # 
-    # Returns a list of events for a school admin
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [EventsResponse]
-    def get_events_for_school_admin(id, opts = {})
-      data, _status_code, _headers = get_events_for_school_admin_with_http_info(id, opts)
-      return data
-    end
-
-    # 
-    # Returns a list of events for a school admin
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [Array<(EventsResponse, Fixnum, Hash)>] EventsResponse data, response status code and response headers
-    def get_events_for_school_admin_with_http_info(id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: EventsApi.get_events_for_school_admin ..."
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_events_for_school_admin"
-      end
-      # resource path
-      local_var_path = "/school_admins/{id}/events".sub('{' + 'id' + '}', id.to_s)
-
-      # query parameters
-      query_params = {}
-      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
-      query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
-      query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['oauth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'EventsResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: EventsApi#get_events_for_school_admin\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # 
-    # Returns a list of events for a section
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [EventsResponse]
-    def get_events_for_section(id, opts = {})
-      data, _status_code, _headers = get_events_for_section_with_http_info(id, opts)
-      return data
-    end
-
-    # 
-    # Returns a list of events for a section
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [Array<(EventsResponse, Fixnum, Hash)>] EventsResponse data, response status code and response headers
-    def get_events_for_section_with_http_info(id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: EventsApi.get_events_for_section ..."
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_events_for_section"
-      end
-      # resource path
-      local_var_path = "/sections/{id}/events".sub('{' + 'id' + '}', id.to_s)
-
-      # query parameters
-      query_params = {}
-      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
-      query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
-      query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['oauth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'EventsResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: EventsApi#get_events_for_section\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # 
-    # Returns a list of events for a student
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [EventsResponse]
-    def get_events_for_student(id, opts = {})
-      data, _status_code, _headers = get_events_for_student_with_http_info(id, opts)
-      return data
-    end
-
-    # 
-    # Returns a list of events for a student
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [Array<(EventsResponse, Fixnum, Hash)>] EventsResponse data, response status code and response headers
-    def get_events_for_student_with_http_info(id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: EventsApi.get_events_for_student ..."
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_events_for_student"
-      end
-      # resource path
-      local_var_path = "/students/{id}/events".sub('{' + 'id' + '}', id.to_s)
-
-      # query parameters
-      query_params = {}
-      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
-      query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
-      query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['oauth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'EventsResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: EventsApi#get_events_for_student\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # 
-    # Returns a list of events for a teacher
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [EventsResponse]
-    def get_events_for_teacher(id, opts = {})
-      data, _status_code, _headers = get_events_for_teacher_with_http_info(id, opts)
-      return data
-    end
-
-    # 
-    # Returns a list of events for a teacher
-    # @param id 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [String] :starting_after 
-    # @option opts [String] :ending_before 
-    # @return [Array<(EventsResponse, Fixnum, Hash)>] EventsResponse data, response status code and response headers
-    def get_events_for_teacher_with_http_info(id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: EventsApi.get_events_for_teacher ..."
-      end
-      # verify the required parameter 'id' is set
-      if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling EventsApi.get_events_for_teacher"
-      end
-      # resource path
-      local_var_path = "/teachers/{id}/events".sub('{' + 'id' + '}', id.to_s)
-
-      # query parameters
-      query_params = {}
-      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
-      query_params[:'starting_after'] = opts[:'starting_after'] if !opts[:'starting_after'].nil?
-      query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['oauth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'EventsResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: EventsApi#get_events_for_teacher\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end

data/lib/clever-ruby/api_client.rb

@@ -3,9 +3,10 @@
 
 #The Clever API
 
-OpenAPI spec version: 1.2.0
+OpenAPI spec version: 2.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
 
 =end
 
@@ -122,7 +123,9 @@ module Clever
         end
       end
 
-      Typhoeus::Request.new(url, req_opts)
+      request = Typhoeus::Request.new(url, req_opts)
+      download_file(request) if opts[:return_type] == 'File'
+      request
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -143,14 +146,16 @@ module Clever
     # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
     def deserialize(response, return_type)
       body = response.body
+
+      # handle file downloading - return the File instance processed in request callbacks
+      # note that response body is empty when the file is written in chunks in request on_body callback
+      return @tempfile if return_type == 'File'
+
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type
       return body if return_type == 'String'
 
-      # handle file downloading - save response body into a tmp file and return the File instance
-      return download_file(response) if return_type == 'File'
-
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
 
@@ -207,7 +212,7 @@ module Clever
         Clever.const_get(return_type).new.tap do |model|
           resp = model.build_from_hash data
           resps = []
-          data[:data].each do |eventResponse| 
+          data[:data].each do |eventResponse|
             singleResp = parse_event_response(eventResponse[:data])
             resps.push(singleResp)
           end
@@ -238,30 +243,38 @@ module Clever
 
     # Save response body into a file in (the defined) temporary folder, using the filename
     # from the "Content-Disposition" header if provided, otherwise a random filename.
+    # The response body is written to the file in chunks in order to handle files which
+    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
+    # process can use.
     #
     # @see Configuration#temp_folder_path
-    # @return [Tempfile] the file downloaded
-    def download_file(response)
-      content_disposition = response.headers['Content-Disposition']
-      if content_disposition and content_disposition =~ /filename=/i
-        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-        prefix = sanitize_filename(filename)
-      else
-        prefix = 'download-'
-      end
-      prefix = prefix + '-' unless prefix.end_with?('-')
-
+    def download_file(request)
       tempfile = nil
-      encoding = response.body.encoding
-      Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) do |file|
-        file.write(response.body)
-        tempfile = file
+      encoding = nil
+      request.on_headers do |response|
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition and content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = response.body.encoding
+        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        @tempfile = tempfile
+      end
+      request.on_body do |chunk|
+        chunk.force_encoding(encoding)
+        tempfile.write(chunk)
+      end
+      request.on_complete do |response|
+        tempfile.close
+        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
       end
-      @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                          "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                          "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                          "explicitly with `tempfile.delete`"
-      tempfile
     end
 
     # Sanitize filename by removing path.
@@ -292,7 +305,7 @@ module Clever
         data = {}
         form_params.each do |key, value|
           case value
-          when File, Array, nil
+          when ::File, ::Array, nil
             # let typhoeus handle File, Array and nil parameters
             data[key] = value
           else