commonlit-clever-ruby 2.1.6.beta1 → 2.1.6.beta3

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

@@ -1,17 +1,14 @@
 =begin
-#Data API
+#Clever API
 
-#Serves the Clever Data API
+#The Clever API
 
 OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.37
-
+Swagger Codegen version: 3.0.51
 =end
 
-require 'uri'
-
 module Clever
   class EventsApi
     attr_accessor :api_client
@@ -31,7 +28,7 @@ module Clever
     # Returns the specific event
     # @param id 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(EventResponse, Fixnum, Hash)>] EventResponse data, response status code and response headers
+    # @return [Array<(EventResponse, Integer, Hash)>] EventResponse data, response status code and response headers
     def get_event_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: EventsApi.get_event ...'
@@ -44,26 +41,30 @@ module Clever
       local_var_path = '/events/{id}'.sub('{' + 'id' + '}', id.to_s)
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['oauth']
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'EventResponse' 
+
+      auth_names = opts[: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 => 'EventResponse')
+        :return_type => return_type)
+
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: EventsApi#get_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -89,7 +90,7 @@ module Clever
     # @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
+    # @return [Array<(EventsResponse, Integer, Hash)>] EventsResponse data, response status code and response headers
     def get_events_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: EventsApi.get_events ...'
@@ -98,7 +99,7 @@ module Clever
       local_var_path = '/events'
 
       # query parameters
-      query_params = {}
+      query_params = opts[: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?
@@ -106,23 +107,27 @@ module Clever
       query_params[:'record_type'] = @api_client.build_collection_param(opts[:'record_type'], :multi) if !opts[:'record_type'].nil?
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = ['oauth']
+      post_body = opts[:body] 
+
+      return_type = opts[:return_type] || 'EventsResponse' 
+
+      auth_names = opts[: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')
+        :return_type => return_type)
+
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: EventsApi#get_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/clever-ruby/api_error.rb

@@ -1,13 +1,12 @@
 =begin
-#Data API
+#Clever API
 
-#Serves the Clever Data API
+#The Clever API
 
 OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.37
-
+Swagger Codegen version: 3.0.51
 =end
 
 module Clever
@@ -34,5 +33,25 @@ module Clever
         super arg
       end
     end
+
+    # Override to_s to display a friendly error message
+    def to_s
+      message
+    end
+
+    def message
+      if @message.nil?
+        msg = "Error message: the server returns an error"
+      else
+        msg = @message
+      end
+
+      msg += "\nHTTP status code: #{code}" if code
+      msg += "\nResponse headers: #{response_headers}" if response_headers
+      msg += "\nResponse body: #{response_body}" if response_body
+
+      msg
+    end
+
   end
 end

data/lib/clever-ruby/configuration.rb

@@ -1,17 +1,14 @@
 =begin
-#Data API
+#Clever API
 
-#Serves the Clever Data API
+#The Clever API
 
 OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.37
-
+Swagger Codegen version: 3.0.51
 =end
 
-require 'addressable/uri'
-
 module Clever
   class Configuration
     # Defines url scheme
@@ -130,7 +127,7 @@ module Clever
     def initialize
       @scheme = 'https'
       @host = 'api.clever.com'
-      @base_path = ''
+      @base_path = 'v2.1'
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
@@ -174,8 +171,7 @@ module Clever
     end
 
     def base_url
-      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
-      Addressable::URI.encode(url)
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
     end
 
     # Gets API key (with prefix if set).

data/lib/clever-ruby/models/admin_name.rb

@@ -1,13 +1,12 @@
 =begin
-#Data API
+#Clever API
 
-#Serves the Clever Data API
+#The Clever API
 
 OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.37
-
+Swagger Codegen version: 3.0.51
 =end
 
 require 'date'
@@ -27,26 +26,41 @@ module Clever
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
-        :'first' => :'String',
-        :'last' => :'String'
+        :'first' => :'Object',
+        :'last' => :'Object'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'first',
+        :'last'
+      ])
+    end
+  
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Clever::AdminName` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Clever::AdminName`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'first')
+      if attributes.key?(:'first')
         self.first = attributes[:'first']
       end
 
-      if attributes.has_key?(:'last')
+      if attributes.key?(:'last')
         self.last = attributes[:'last']
       end
     end
@@ -80,17 +94,24 @@ module Clever
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [first, last].hash
     end
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
+      self.class.openapi_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
@@ -99,7 +120,9 @@ module Clever
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
       end
 
       self
@@ -121,7 +144,7 @@ module Clever
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -142,8 +165,7 @@ module Clever
           end
         end
       else # model
-        temp_model = Clever.const_get(type).new
-        temp_model.build_from_hash(value)
+        Clever.const_get(type).build_from_hash(value)
       end
     end
 
@@ -165,7 +187,11 @@ module Clever
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
         hash[param] = _to_hash(value)
       end
       hash
@@ -187,7 +213,5 @@ module Clever
       else
         value
       end
-    end
-
-  end
+    end  end
 end

data/lib/clever-ruby/models/bad_request.rb

@@ -1,13 +1,12 @@
 =begin
-#Data API
+#Clever API
 
-#Serves the Clever Data API
+#The Clever API
 
 OpenAPI spec version: 2.1.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.37
-
+Swagger Codegen version: 3.0.51
 =end
 
 require 'date'
@@ -24,21 +23,34 @@ module Clever
     end
 
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
-        :'message' => :'String'
+        :'message' => :'Object'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+  
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Clever::BadRequest` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Clever::BadRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'message')
+      if attributes.key?(:'message')
         self.message = attributes[:'message']
       end
     end
@@ -71,17 +83,24 @@ module Clever
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [message].hash
     end
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
+      self.class.openapi_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
@@ -90,7 +109,9 @@ module Clever
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
       end
 
       self
@@ -112,7 +133,7 @@ module Clever
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -133,8 +154,7 @@ module Clever
           end
         end
       else # model
-        temp_model = Clever.const_get(type).new
-        temp_model.build_from_hash(value)
+        Clever.const_get(type).build_from_hash(value)
       end
     end
 
@@ -156,7 +176,11 @@ module Clever
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
         hash[param] = _to_hash(value)
       end
       hash
@@ -178,7 +202,5 @@ module Clever
       else
         value
       end
-    end
-
-  end
+    end  end
 end