osdn-client 0.0.20160304 → 0.0.20160711

data/lib/osdn-client/api/user_api.rb

@@ -1,3 +1,26 @@
+=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 "uri"
 
 module OSDNClient
@@ -9,30 +32,28 @@ module OSDNClient
     end
 
     # 
-    # Get user profile.
+    # Get user profile. 
     # @param id_or_name numeric user id or user name
     # @param [Hash] opts the optional parameters
     # @return [User]
     def get_user(id_or_name, opts = {})
-      data, status_code, headers = get_user_with_http_info(id_or_name, opts)
+      data, _status_code, _headers = get_user_with_http_info(id_or_name, opts)
       return data
     end
 
     # 
-    # Get user profile.
+    # Get user profile. 
     # @param id_or_name numeric user id or user name
     # @param [Hash] opts the optional parameters
     # @return [Array<(User, Fixnum, Hash)>] User data, response status code and response headers
     def get_user_with_http_info(id_or_name, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: UserApi#get_user ..."
+        @api_client.config.logger.debug "Calling API: UserApi.get_user ..."
       end
-      
       # verify the required parameter 'id_or_name' is set
-      fail "Missing the required parameter 'id_or_name' when calling get_user" if id_or_name.nil?
-      
+      fail ArgumentError, "Missing the required parameter 'id_or_name' when calling UserApi.get_user" if id_or_name.nil?
       # resource path
-      path = "/user/{id_or_name}".sub('{format}','json').sub('{' + 'id_or_name' + '}', id_or_name.to_s)
+      local_var_path = "/user/{id_or_name}".sub('{format}','json').sub('{' + 'id_or_name' + '}', id_or_name.to_s)
 
       # query parameters
       query_params = {}
@@ -41,22 +62,20 @@ module OSDNClient
       header_params = {}
 
       # HTTP header 'Accept' (if needed)
-      _header_accept = []
-      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+      local_header_accept = []
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
 
       # HTTP header 'Content-Type'
-      _header_content_type = ['application/x-www-form-urlencoded']
-      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+      local_header_content_type = ['application/x-www-form-urlencoded']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
 
       # form parameters
       form_params = {}
 
       # http body (model)
       post_body = nil
-      
-
-      auth_names = ['oauth2-implicit']
-      data, status_code, headers = @api_client.call_api(:GET, path,
+      auth_names = ['oauth2-code', 'oauth2-implicit']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -70,7 +89,3 @@ module OSDNClient
     end
   end
 end
-
-
-
-

data/lib/osdn-client/api_client.rb

@@ -1,3 +1,26 @@
+=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'
 require 'json'
 require 'logger'
@@ -15,9 +38,11 @@ module OSDNClient
     # @return [Hash]
     attr_accessor :default_headers
 
+    # Initializes the ApiClient
+    # @option config [Configuration] Configuraiton for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "ruby-swagger-#{VERSION}"
+      @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent
@@ -55,6 +80,15 @@ module OSDNClient
       return data, response.code, response.headers
     end
 
+    # Builds the HTTP request
+    #
+    # @param [String] http_method HTTP method/verb (e.g. POST)
+    # @param [String] path URL path (e.g. /account/new)
+    # @option opts [Hash] :header_params Header parameters
+    # @option opts [Hash] :query_params Query parameters
+    # @option opts [Hash] :form_params Query parameters
+    # @option opts [Object] :body HTTP body (JSON/XML)
+    # @return [Typhoeus::Request] A Typhoeus Request
     def build_request(http_method, path, opts = {})
       url = build_request_url(path)
       http_method = http_method.to_sym.downcase
@@ -63,22 +97,27 @@ module OSDNClient
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 
-      
       update_params_for_auth! header_params, query_params, opts[:auth_names]
-      
+
+      # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
+      _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
 
       req_opts = {
         :method => http_method,
         :headers => header_params,
         :params => query_params,
+        :params_encoding => @config.params_encoding,
         :timeout => @config.timeout,
         :ssl_verifypeer => @config.verify_ssl,
+        :ssl_verifyhost => _verify_ssl_host,
         :sslcert => @config.cert_file,
         :sslkey => @config.key_file,
-        :cainfo => @config.ssl_ca_cert,
         :verbose => @config.debugging
       }
 
+      # set custom cert, if provided
+      req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
+
       if [:post, :patch, :put, :delete].include?(http_method)
         req_body = build_request_body(header_params, form_params, opts[:body])
         req_opts.update :body => req_body
@@ -95,17 +134,23 @@ module OSDNClient
     #   application/json
     #   application/json; charset=UTF8
     #   APPLICATION/JSON
+    # @param [String] mime MIME
+    # @return [Boolean] True if the MIME is applicaton/json
     def json_mime?(mime)
-       !!(mime =~ /\Aapplication\/json(;.*)?\z/i)
+       !(mime =~ /\Aapplication\/json(;.*)?\z/i).nil?
     end
 
     # Deserialize the response to the given return type.
     #
+    # @param [Response] response HTTP response
     # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
     def deserialize(response, return_type)
       body = response.body
       return nil if body.nil? || body.empty?
 
+      # return response body directly for String return type
+      return body if return_type == 'String'
+
       # handle file downloading - save response body into a tmp file and return the File instance
       return download_file(response) if return_type == 'File'
 
@@ -128,6 +173,9 @@ module OSDNClient
     end
 
     # Convert data to the given return type.
+    # @param [Object] data Data to be converted
+    # @param [String] return_type Return type
+    # @return [Mixed] Data in a particular type
     def convert_to_type(data, return_type)
       return nil if data.nil?
       case return_type
@@ -146,7 +194,7 @@ module OSDNClient
         # parse date time (expecting ISO 8601 format)
         Date.parse data
       when 'Object'
-        # generic object, return directly
+        # generic object (usually a Hash), return directly
         data
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
@@ -173,7 +221,7 @@ module OSDNClient
     # @return [Tempfile] the file downloaded
     def download_file(response)
       content_disposition = response.headers['Content-Disposition']
-      if content_disposition
+      if content_disposition and content_disposition =~ /filename=/i
         filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
         prefix = sanitize_filename(filename)
       else
@@ -200,7 +248,7 @@ module OSDNClient
     # @param [String] filename the filename to be sanitized
     # @return [String] the sanitized filename
     def sanitize_filename(filename)
-      filename.gsub /.*[\/\\]/, ''
+      filename.gsub(/.*[\/\\]/, '')
     end
 
     def build_request_url(path)
@@ -209,6 +257,12 @@ module OSDNClient
       URI.encode(@config.base_url + path)
     end
 
+    # Builds the HTTP request body
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [Object] body HTTP body (JSON/XML)
+    # @return [String] HTTP body data in the form of string
     def build_request_body(header_params, form_params, body)
       # http form
       if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
@@ -232,6 +286,10 @@ module OSDNClient
     end
 
     # Update hearder and query params based on authentication settings.
+    #
+    # @param [Hash] header_params Header parameters
+    # @param [Hash] form_params Query parameters
+    # @param [String] auth_names Authentication scheme name
     def update_params_for_auth!(header_params, query_params, auth_names)
       Array(auth_names).each do |auth_name|
         auth_setting = @config.auth_settings[auth_name]
@@ -244,6 +302,9 @@ module OSDNClient
       end
     end
 
+    # Sets user agent in HTTP header
+    #
+    # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
     def user_agent=(user_agent)
       @user_agent = user_agent
       @default_headers['User-Agent'] = @user_agent
@@ -274,14 +335,14 @@ module OSDNClient
     # @param [Object] model object to be converted into JSON string
     # @return [String] JSON string representation of the object
     def object_to_http_body(model)
-      return if model.nil?
-      _body = nil
+      return model if model.nil? || model.is_a?(String)
+      local_body = nil
       if model.is_a?(Array)
-        _body = model.map{|m| object_to_hash(m) }
+        local_body = model.map{|m| object_to_hash(m) }
       else
-        _body = object_to_hash(model)
+        local_body = object_to_hash(model)
       end
-      _body.to_json
+      local_body.to_json
     end
 
     # Convert object(non-array) to hash.

data/lib/osdn-client/api_error.rb

@@ -1,3 +1,26 @@
+=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
+
 module OSDNClient
   class ApiError < StandardError
     attr_reader :code, :response_headers, :response_body

data/lib/osdn-client/configuration.rb

@@ -1,3 +1,26 @@
+=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 'uri'
 
 module OSDNClient
@@ -64,7 +87,7 @@ module OSDNClient
     # 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 OSDNClient
     # @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 OSDNClient
     # 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 OSDNClient
       @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/osdn-client/models/group.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 Group
     attr_accessor :id
 
@@ -34,42 +58,26 @@ module OSDNClient
 
     attr_accessor :members
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'id' => :'id',
-        
         :'name' => :'name',
-        
         :'display_name' => :'display_name',
-        
         :'last_update' => :'last_update',
-        
         :'description' => :'description',
-        
         :'description_html' => :'description_html',
-        
         :'start_date' => :'start_date',
-        
         :'license' => :'license',
-        
         :'license_other' => :'license_other',
-        
         :'url' => :'url',
-        
         :'homepage' => :'homepage',
-        
         :'logo_image' => :'logo_image',
-        
         :'banner_image' => :'banner_image',
-        
         :'thumbnail_image' => :'thumbnail_image',
-        
         :'tools' => :'tools',
-        
         :'members' => :'members'
-        
       }
     end
 
@@ -92,86 +100,100 @@ module OSDNClient
         :'thumbnail_image' => :'String',
         :'tools' => :'GroupToolFlags',
         :'members' => :'Array<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[:'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[:'last_update']
+
+      if attributes.has_key?(:'last_update')
         self.last_update = attributes[:'last_update']
       end
-      
-      if attributes[:'description']
+
+      if attributes.has_key?(:'description')
         self.description = attributes[:'description']
       end
-      
-      if attributes[:'description_html']
+
+      if attributes.has_key?(:'description_html')
         self.description_html = attributes[:'description_html']
       end
-      
-      if attributes[:'start_date']
+
+      if attributes.has_key?(:'start_date')
         self.start_date = attributes[:'start_date']
       end
-      
-      if attributes[:'license']
+
+      if attributes.has_key?(:'license')
         self.license = attributes[:'license']
       end
-      
-      if attributes[:'license_other']
+
+      if attributes.has_key?(:'license_other')
         self.license_other = attributes[:'license_other']
       end
-      
-      if attributes[:'url']
+
+      if attributes.has_key?(:'url')
         self.url = attributes[:'url']
       end
-      
-      if attributes[:'homepage']
+
+      if attributes.has_key?(:'homepage')
         self.homepage = attributes[:'homepage']
       end
-      
-      if attributes[:'logo_image']
+
+      if attributes.has_key?(:'logo_image')
         self.logo_image = attributes[:'logo_image']
       end
-      
-      if attributes[:'banner_image']
+
+      if attributes.has_key?(:'banner_image')
         self.banner_image = attributes[:'banner_image']
       end
-      
-      if attributes[:'thumbnail_image']
+
+      if attributes.has_key?(:'thumbnail_image')
         self.thumbnail_image = attributes[:'thumbnail_image']
       end
-      
-      if attributes[:'tools']
+
+      if attributes.has_key?(:'tools')
         self.tools = attributes[:'tools']
       end
-      
-      if attributes[:'members']
+
+      if attributes.has_key?(:'members')
         if (value = attributes[:'members']).is_a?(Array)
           self.members = 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 &&
@@ -194,35 +216,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, last_update, description, description_html, start_date, license, license_other, url, homepage, logo_image, banner_image, thumbnail_image, tools, members].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
@@ -241,6 +269,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) }
@@ -253,21 +284,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|
@@ -278,8 +313,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) }
@@ -295,4 +332,5 @@ module OSDNClient
     end
 
   end
+
 end