artikcloud 2.0.0 → 2.0.5

data/lib/artikcloud/api_error.rb

@@ -1,14 +1,23 @@
 =begin
-ARTIK Cloud API
+#ARTIK Cloud API
+
+#No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
 OpenAPI spec version: 2.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-License: MIT
-http://en.wikipedia.org/wiki/MIT_License
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
 
-Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 

data/lib/artikcloud/configuration.rb

@@ -1,3 +1,26 @@
+=begin
+#ARTIK Cloud API
+
+#No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
 require 'uri'
 
 module ArtikCloud
@@ -64,7 +87,7 @@ module ArtikCloud
     # Default to 0 (never times out).
     attr_accessor :timeout
 
-    ### TLS/SSL
+    ### TLS/SSL setting
     # Set this to false to skip verifying SSL certificate when calling API from https server.
     # Default to true.
     #
@@ -73,6 +96,16 @@ module ArtikCloud
     # @return [true, false]
     attr_accessor :verify_ssl
 
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
     # Set this to customize the certificate file to verify the peer.
     #
     # @return [String] the path to the certificate file
@@ -81,12 +114,21 @@ module ArtikCloud
     # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
     attr_accessor :ssl_ca_cert
 
+    ### TLS/SSL setting
     # Client certificate file (for client certificate)
     attr_accessor :cert_file
 
+    ### TLS/SSL setting
     # Client private key file (for client certificate)
     attr_accessor :key_file
 
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
     attr_accessor :inject_format
 
     attr_accessor :force_ending_format
@@ -99,6 +141,8 @@ module ArtikCloud
       @api_key_prefix = {}
       @timeout = 0
       @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
       @cert_file = nil
       @key_file = nil
       @debugging = false

data/lib/artikcloud/models/ack_envelope.rb

@@ -1,14 +1,23 @@
 =begin
-ARTIK Cloud API
+#ARTIK Cloud API
+
+#No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
 OpenAPI spec version: 2.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-License: MIT
-http://en.wikipedia.org/wiki/MIT_License
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
 
-Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -19,12 +28,11 @@ module ArtikCloud
   class AckEnvelope
     attr_accessor :data
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'data' => :'data'
-        
       }
     end
 
@@ -32,24 +40,38 @@ module ArtikCloud
     def self.swagger_types
       {
         :'data' => :'Acknowledgement'
-        
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
-      if attributes[:'data']
+      if attributes.has_key?(:'data')
         self.data = attributes[:'data']
       end
-      
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
     end
 
-    # Check equality by comparing each attribute.
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -57,35 +79,41 @@ module ArtikCloud
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
       [data].hash
     end
 
-    # build the object from hash
+    # 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|
         if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
             self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
-          else
-            #TODO show warning in debug mode
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
       end
 
       self
     end
 
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
       when :DateTime
@@ -119,21 +147,25 @@ module ArtikCloud
           end
         end
       else # model
-        _model = ArtikCloud.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = ArtikCloud.const_get(type).new
+        temp_model.build_from_hash(value)
       end
     end
 
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
     def to_s
       to_hash.to_s
     end
 
-    # to_body is an alias to to_body (backward compatibility))
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
     def to_body
       to_hash
     end
 
-    # return the object in the form of hash
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
     def to_hash
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
@@ -144,8 +176,10 @@ module ArtikCloud
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
         value.compact.map{ |v| _to_hash(v) }
@@ -161,4 +195,5 @@ module ArtikCloud
     end
 
   end
+
 end

data/lib/artikcloud/models/acknowledgement.rb

@@ -1,14 +1,23 @@
 =begin
-ARTIK Cloud API
+#ARTIK Cloud API
+
+#No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 
 OpenAPI spec version: 2.0.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-License: MIT
-http://en.wikipedia.org/wiki/MIT_License
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
 
-Terms of Service: http://www.samsung.com/global/business/mobile/info/terms-and-conditions.html
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
@@ -29,18 +38,14 @@ module ArtikCloud
     # Code
     attr_accessor :code
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'mid' => :'mid',
-        
         :'cid' => :'cid',
-        
         :'message' => :'message',
-        
         :'code' => :'code'
-        
       }
     end
 
@@ -51,36 +56,50 @@ module ArtikCloud
         :'cid' => :'String',
         :'message' => :'String',
         :'code' => :'String'
-        
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
-      if attributes[:'mid']
+      if attributes.has_key?(:'mid')
         self.mid = attributes[:'mid']
       end
-      
-      if attributes[:'cid']
+
+      if attributes.has_key?(:'cid')
         self.cid = attributes[:'cid']
       end
-      
-      if attributes[:'message']
+
+      if attributes.has_key?(:'message')
         self.message = attributes[:'message']
       end
-      
-      if attributes[:'code']
+
+      if attributes.has_key?(:'code')
         self.code = attributes[:'code']
       end
-      
+
     end
 
-    # Check equality by comparing each attribute.
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -91,35 +110,41 @@ module ArtikCloud
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
       [mid, cid, message, code].hash
     end
 
-    # build the object from hash
+    # 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|
         if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
             self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
-          else
-            #TODO show warning in debug mode
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
       end
 
       self
     end
 
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
       when :DateTime
@@ -153,21 +178,25 @@ module ArtikCloud
           end
         end
       else # model
-        _model = ArtikCloud.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = ArtikCloud.const_get(type).new
+        temp_model.build_from_hash(value)
       end
     end
 
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
     def to_s
       to_hash.to_s
     end
 
-    # to_body is an alias to to_body (backward compatibility))
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
     def to_body
       to_hash
     end
 
-    # return the object in the form of hash
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
     def to_hash
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
@@ -178,8 +207,10 @@ module ArtikCloud
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
         value.compact.map{ |v| _to_hash(v) }
@@ -195,4 +226,5 @@ module ArtikCloud
     end
 
   end
+
 end