osdn-client 0.0.20160304 → 0.0.20160711

data/lib/osdn-client/models/rel_file.rb

@@ -1,6 +1,30 @@
+=begin
+#OSDN REST API v0 beta
+
+#OSDN REST API. Currently this API is experimental release. Pelase refer documentation on https://osdn.jp/projects/osdn-codes/wiki/APIGuide and you can get client libraries from https://osdn.jp/projects/osdn-codes/releases/p14859 . 
+
+OpenAPI spec version: 0.0.20160304
+Contact: admin@osdn.jp
+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 'date'
 
 module OSDNClient
+
   class RelFile
     attr_accessor :id
 
@@ -26,34 +50,22 @@ module OSDNClient
 
     attr_accessor :download_count
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'id' => :'id',
-        
         :'name' => :'name',
-        
         :'date' => :'date',
-        
         :'url' => :'url',
-        
         :'visibility' => :'visibility',
-        
         :'cascaded_visibility' => :'cascaded_visibility',
-        
         :'release_id' => :'release_id',
-        
         :'size' => :'size',
-        
         :'digest_md5' => :'digest_md5',
-        
         :'digest_sha1' => :'digest_sha1',
-        
         :'digest_sha256' => :'digest_sha256',
-        
         :'download_count' => :'download_count'
-        
       }
     end
 
@@ -72,68 +84,82 @@ module OSDNClient
         :'digest_sha1' => :'String',
         :'digest_sha256' => :'String',
         :'download_count' => :'Integer'
-        
       }
     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[:'id']
+      if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
-      
-      if attributes[:'name']
+
+      if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
-      
-      if attributes[:'date']
+
+      if attributes.has_key?(:'date')
         self.date = attributes[:'date']
       end
-      
-      if attributes[:'url']
+
+      if attributes.has_key?(:'url')
         self.url = attributes[:'url']
       end
-      
-      if attributes[:'visibility']
+
+      if attributes.has_key?(:'visibility')
         self.visibility = attributes[:'visibility']
       end
-      
-      if attributes[:'cascaded_visibility']
+
+      if attributes.has_key?(:'cascaded_visibility')
         self.cascaded_visibility = attributes[:'cascaded_visibility']
       end
-      
-      if attributes[:'release_id']
+
+      if attributes.has_key?(:'release_id')
         self.release_id = attributes[:'release_id']
       end
-      
-      if attributes[:'size']
+
+      if attributes.has_key?(:'size')
         self.size = attributes[:'size']
       end
-      
-      if attributes[:'digest_md5']
+
+      if attributes.has_key?(:'digest_md5')
         self.digest_md5 = attributes[:'digest_md5']
       end
-      
-      if attributes[:'digest_sha1']
+
+      if attributes.has_key?(:'digest_sha1')
         self.digest_sha1 = attributes[:'digest_sha1']
       end
-      
-      if attributes[:'digest_sha256']
+
+      if attributes.has_key?(:'digest_sha256')
         self.digest_sha256 = attributes[:'digest_sha256']
       end
-      
-      if attributes[:'download_count']
+
+      if attributes.has_key?(:'download_count')
         self.download_count = attributes[:'download_count']
       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 to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
     end
 
-    # Check equality by comparing each attribute.
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -152,35 +178,41 @@ module OSDNClient
     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
       [id, name, date, url, visibility, cascaded_visibility, release_id, size, digest_md5, digest_sha1, digest_sha256, download_count].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
@@ -199,6 +231,9 @@ module OSDNClient
         else
           false
         end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
       when /\AArray<(?<inner_type>.+)>\z/
         inner_type = Regexp.last_match[:inner_type]
         value.map { |v| _deserialize(inner_type, v) }
@@ -211,21 +246,25 @@ module OSDNClient
           end
         end
       else # model
-        _model = OSDNClient.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = OSDNClient.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|
@@ -236,8 +275,10 @@ module OSDNClient
       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) }
@@ -253,4 +294,5 @@ module OSDNClient
     end
 
   end
+
 end

data/lib/osdn-client/models/release.rb

@@ -1,6 +1,30 @@
+=begin
+#OSDN REST API v0 beta
+
+#OSDN REST API. Currently this API is experimental release. Pelase refer documentation on https://osdn.jp/projects/osdn-codes/wiki/APIGuide and you can get client libraries from https://osdn.jp/projects/osdn-codes/releases/p14859 . 
+
+OpenAPI spec version: 0.0.20160304
+Contact: admin@osdn.jp
+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 'date'
 
 module OSDNClient
+
   class Release
     attr_accessor :id
 
@@ -20,28 +44,19 @@ module OSDNClient
 
     attr_accessor :files
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'id' => :'id',
-        
         :'name' => :'name',
-        
         :'url' => :'url',
-        
         :'visibility' => :'visibility',
-        
         :'cascaded_visibility' => :'cascaded_visibility',
-        
         :'package_id' => :'package_id',
-        
         :'file_count' => :'file_count',
-        
         :'is_draft' => :'is_draft',
-        
         :'files' => :'files'
-        
       }
     end
 
@@ -57,58 +72,72 @@ module OSDNClient
         :'file_count' => :'Integer',
         :'is_draft' => :'BOOLEAN',
         :'files' => :'Array<RelFile>'
-        
       }
     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[:'id']
+      if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
-      
-      if attributes[:'name']
+
+      if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
-      
-      if attributes[:'url']
+
+      if attributes.has_key?(:'url')
         self.url = attributes[:'url']
       end
-      
-      if attributes[:'visibility']
+
+      if attributes.has_key?(:'visibility')
         self.visibility = attributes[:'visibility']
       end
-      
-      if attributes[:'cascaded_visibility']
+
+      if attributes.has_key?(:'cascaded_visibility')
         self.cascaded_visibility = attributes[:'cascaded_visibility']
       end
-      
-      if attributes[:'package_id']
+
+      if attributes.has_key?(:'package_id')
         self.package_id = attributes[:'package_id']
       end
-      
-      if attributes[:'file_count']
+
+      if attributes.has_key?(:'file_count')
         self.file_count = attributes[:'file_count']
       end
-      
-      if attributes[:'is_draft']
+
+      if attributes.has_key?(:'is_draft')
         self.is_draft = attributes[:'is_draft']
       end
-      
-      if attributes[:'files']
+
+      if attributes.has_key?(:'files')
         if (value = attributes[:'files']).is_a?(Array)
           self.files = value
         end
       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 &&
@@ -124,35 +153,41 @@ module OSDNClient
     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
       [id, name, url, visibility, cascaded_visibility, package_id, file_count, is_draft, files].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
@@ -171,6 +206,9 @@ module OSDNClient
         else
           false
         end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
       when /\AArray<(?<inner_type>.+)>\z/
         inner_type = Regexp.last_match[:inner_type]
         value.map { |v| _deserialize(inner_type, v) }
@@ -183,21 +221,25 @@ module OSDNClient
           end
         end
       else # model
-        _model = OSDNClient.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = OSDNClient.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|
@@ -208,8 +250,10 @@ module OSDNClient
       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) }
@@ -225,4 +269,5 @@ module OSDNClient
     end
 
   end
+
 end