osdn-client 0.0.20160304 → 0.0.20160711

data/lib/osdn-client/models/group_tool_flags.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 GroupToolFlags
     attr_accessor :cvs
 
@@ -22,30 +46,20 @@ module OSDNClient
 
     attr_accessor :ml
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'cvs' => :'cvs',
-        
         :'git' => :'git',
-        
         :'svn' => :'svn',
-        
         :'bzr' => :'bzr',
-        
         :'scm' => :'scm',
-        
         :'frs' => :'frs',
-        
         :'tikcet' => :'tikcet',
-        
         :'wiki' => :'wiki',
-        
         :'forum' => :'forum',
-        
         :'ml' => :'ml'
-        
       }
     end
 
@@ -62,60 +76,74 @@ module OSDNClient
         :'wiki' => :'BOOLEAN',
         :'forum' => :'BOOLEAN',
         :'ml' => :'BOOLEAN'
-        
       }
     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[:'cvs']
+      if attributes.has_key?(:'cvs')
         self.cvs = attributes[:'cvs']
       end
-      
-      if attributes[:'git']
+
+      if attributes.has_key?(:'git')
         self.git = attributes[:'git']
       end
-      
-      if attributes[:'svn']
+
+      if attributes.has_key?(:'svn')
         self.svn = attributes[:'svn']
       end
-      
-      if attributes[:'bzr']
+
+      if attributes.has_key?(:'bzr')
         self.bzr = attributes[:'bzr']
       end
-      
-      if attributes[:'scm']
+
+      if attributes.has_key?(:'scm')
         self.scm = attributes[:'scm']
       end
-      
-      if attributes[:'frs']
+
+      if attributes.has_key?(:'frs')
         self.frs = attributes[:'frs']
       end
-      
-      if attributes[:'tikcet']
+
+      if attributes.has_key?(:'tikcet')
         self.tikcet = attributes[:'tikcet']
       end
-      
-      if attributes[:'wiki']
+
+      if attributes.has_key?(:'wiki')
         self.wiki = attributes[:'wiki']
       end
-      
-      if attributes[:'forum']
+
+      if attributes.has_key?(:'forum')
         self.forum = attributes[:'forum']
       end
-      
-      if attributes[:'ml']
+
+      if attributes.has_key?(:'ml')
         self.ml = attributes[:'ml']
       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 &&
@@ -132,35 +160,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
       [cvs, git, svn, bzr, scm, frs, tikcet, wiki, forum, ml].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
@@ -179,6 +213,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) }
@@ -191,21 +228,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|
@@ -216,8 +257,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) }
@@ -233,4 +276,5 @@ module OSDNClient
     end
 
   end
+
 end

data/lib/osdn-client/models/news.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 News
     attr_accessor :id
 
@@ -16,24 +40,17 @@ module OSDNClient
 
     attr_accessor :submitter
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'id' => :'id',
-        
         :'url' => :'url',
-        
         :'title' => :'title',
-        
         :'body' => :'body',
-        
         :'body_html' => :'body_html',
-        
         :'last_update' => :'last_update',
-        
         :'submitter' => :'submitter'
-        
       }
     end
 
@@ -47,48 +64,62 @@ module OSDNClient
         :'body_html' => :'String',
         :'last_update' => :'DateTime',
         :'submitter' => :'SimpleUser'
-        
       }
     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[:'url']
+
+      if attributes.has_key?(:'url')
         self.url = attributes[:'url']
       end
-      
-      if attributes[:'title']
+
+      if attributes.has_key?(:'title')
         self.title = attributes[:'title']
       end
-      
-      if attributes[:'body']
+
+      if attributes.has_key?(:'body')
         self.body = attributes[:'body']
       end
-      
-      if attributes[:'body_html']
+
+      if attributes.has_key?(:'body_html')
         self.body_html = attributes[:'body_html']
       end
-      
-      if attributes[:'last_update']
+
+      if attributes.has_key?(:'last_update')
         self.last_update = attributes[:'last_update']
       end
-      
-      if attributes[:'submitter']
+
+      if attributes.has_key?(:'submitter')
         self.submitter = attributes[:'submitter']
       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 &&
@@ -102,35 +133,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, url, title, body, body_html, last_update, submitter].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
@@ -149,6 +186,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) }
@@ -161,21 +201,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|
@@ -186,8 +230,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) }
@@ -203,4 +249,5 @@ module OSDNClient
     end
 
   end
+
 end