osdn-client 0.0.20160304 → 0.0.20160711

data/lib/osdn-client/models/skill.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 Skill
     attr_accessor :name
 
@@ -10,18 +34,14 @@ module OSDNClient
 
     attr_accessor :hate_like
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'name' => :'name',
-        
         :'level' => :'level',
-        
         :'experience' => :'experience',
-        
         :'hate_like' => :'hate_like'
-        
       }
     end
 
@@ -32,36 +52,50 @@ module OSDNClient
         :'level' => :'Integer',
         :'experience' => :'String',
         :'hate_like' => :'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[:'name']
+      if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
-      
-      if attributes[:'level']
+
+      if attributes.has_key?(:'level')
         self.level = attributes[:'level']
       end
-      
-      if attributes[:'experience']
+
+      if attributes.has_key?(:'experience')
         self.experience = attributes[:'experience']
       end
-      
-      if attributes[:'hate_like']
+
+      if attributes.has_key?(:'hate_like')
         self.hate_like = attributes[:'hate_like']
       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 &&
@@ -72,35 +106,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
       [name, level, experience, hate_like].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,6 +159,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) }
@@ -131,21 +174,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|
@@ -156,8 +203,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) }
@@ -173,4 +222,5 @@ module OSDNClient
     end
 
   end
+
 end

data/lib/osdn-client/models/token.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 Token
     attr_accessor :access_token
 
@@ -12,20 +36,15 @@ module OSDNClient
 
     attr_accessor :refresh_token
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'access_token' => :'access_token',
-        
         :'expires_in' => :'expires_in',
-        
         :'token_type' => :'token_type',
-        
         :'scope' => :'scope',
-        
         :'refresh_token' => :'refresh_token'
-        
       }
     end
 
@@ -37,40 +56,54 @@ module OSDNClient
         :'token_type' => :'String',
         :'scope' => :'String',
         :'refresh_token' => :'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[:'access_token']
+      if attributes.has_key?(:'access_token')
         self.access_token = attributes[:'access_token']
       end
-      
-      if attributes[:'expires_in']
+
+      if attributes.has_key?(:'expires_in')
         self.expires_in = attributes[:'expires_in']
       end
-      
-      if attributes[:'token_type']
+
+      if attributes.has_key?(:'token_type')
         self.token_type = attributes[:'token_type']
       end
-      
-      if attributes[:'scope']
+
+      if attributes.has_key?(:'scope')
         self.scope = attributes[:'scope']
       end
-      
-      if attributes[:'refresh_token']
+
+      if attributes.has_key?(:'refresh_token')
         self.refresh_token = attributes[:'refresh_token']
       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 &&
@@ -82,35 +115,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
       [access_token, expires_in, token_type, scope, refresh_token].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
@@ -129,6 +168,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) }
@@ -141,21 +183,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|
@@ -166,8 +212,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) }
@@ -183,4 +231,5 @@ module OSDNClient
     end
 
   end
+
 end

data/lib/osdn-client/models/user.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 User
     attr_accessor :id
 
@@ -28,36 +52,23 @@ module OSDNClient
 
     attr_accessor :skills
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'id' => :'id',
-        
         :'name' => :'name',
-        
         :'display_name' => :'display_name',
-        
         :'unix_status' => :'unix_status',
-        
         :'unix_uid' => :'unix_uid',
-        
         :'authorized_keys' => :'authorized_keys',
-        
         :'timezone' => :'timezone',
-        
         :'last_update' => :'last_update',
-        
         :'add_date' => :'add_date',
-        
         :'language' => :'language',
-        
         :'groups' => :'groups',
-        
         :'chambers' => :'chambers',
-        
         :'skills' => :'skills'
-        
       }
     end
 
@@ -77,78 +88,92 @@ module OSDNClient
         :'groups' => :'Array<SimpleGroup>',
         :'chambers' => :'Array<SimpleChamber>',
         :'skills' => :'Array<Skill>'
-        
       }
     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[:'display_name']
+
+      if attributes.has_key?(:'display_name')
         self.display_name = attributes[:'display_name']
       end
-      
-      if attributes[:'unix_status']
+
+      if attributes.has_key?(:'unix_status')
         self.unix_status = attributes[:'unix_status']
       end
-      
-      if attributes[:'unix_uid']
+
+      if attributes.has_key?(:'unix_uid')
         self.unix_uid = attributes[:'unix_uid']
       end
-      
-      if attributes[:'authorized_keys']
+
+      if attributes.has_key?(:'authorized_keys')
         self.authorized_keys = attributes[:'authorized_keys']
       end
-      
-      if attributes[:'timezone']
+
+      if attributes.has_key?(:'timezone')
         self.timezone = attributes[:'timezone']
       end
-      
-      if attributes[:'last_update']
+
+      if attributes.has_key?(:'last_update')
         self.last_update = attributes[:'last_update']
       end
-      
-      if attributes[:'add_date']
+
+      if attributes.has_key?(:'add_date')
         self.add_date = attributes[:'add_date']
       end
-      
-      if attributes[:'language']
+
+      if attributes.has_key?(:'language')
         self.language = attributes[:'language']
       end
-      
-      if attributes[:'groups']
+
+      if attributes.has_key?(:'groups')
         if (value = attributes[:'groups']).is_a?(Array)
           self.groups = value
         end
       end
-      
-      if attributes[:'chambers']
+
+      if attributes.has_key?(:'chambers')
         if (value = attributes[:'chambers']).is_a?(Array)
           self.chambers = value
         end
       end
-      
-      if attributes[:'skills']
+
+      if attributes.has_key?(:'skills')
         if (value = attributes[:'skills']).is_a?(Array)
           self.skills = value
         end
       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 &&
@@ -168,35 +193,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, display_name, unix_status, unix_uid, authorized_keys, timezone, last_update, add_date, language, groups, chambers, skills].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
@@ -215,6 +246,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) }
@@ -227,21 +261,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|
@@ -252,8 +290,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) }
@@ -269,4 +309,5 @@ module OSDNClient
     end
 
   end
+
 end