mux_ruby 1.6.0 → 2.0.0.pre.rc.2

data/gen/templates/gem.mustache

@@ -0,0 +1,40 @@
+=begin
+{{> api_info}}
+=end
+
+# Common files
+require '{{gemName}}/api_client'
+require '{{gemName}}/api_error'
+require '{{gemName}}/version'
+require '{{gemName}}/configuration'
+
+# Models
+{{#models}}
+{{#model}}
+require '{{gemName}}/{{modelPackage}}/{{classFilename}}'{{/model}}
+{{/models}}
+
+# APIs
+{{#apiInfo}}
+{{#apis}}
+require '{{importPath}}'
+{{/apis}}
+{{/apiInfo}}
+
+module {{moduleName}}
+  class << self
+    # Customize default settings for the SDK using block.
+    #   {{moduleName}}.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/gen/templates/gemspec.mustache

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+{{> api_info}}
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "{{gemName}}/version"
+
+Gem::Specification.new do |s|
+  s.name        = "{{gemName}}{{^gemName}}{{{appName}}}{{/gemName}}"
+  s.version     = {{moduleName}}::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["{{gemAuthor}}{{^gemAuthor}}OpenAPI-Generator{{/gemAuthor}}"]
+  s.email       = ["{{gemAuthorEmail}}{{^gemAuthorEmail}}{{infoEmail}}{{/gemAuthorEmail}}"]
+  s.homepage    = "{{gemHomepage}}{{^gemHomepage}}https://openapi-generator.tech{{/gemHomepage}}"
+  s.summary     = "{{gemSummary}}{{^gemSummary}}{{{appName}}} Ruby Gem{{/gemSummary}}"
+  s.description = "{{gemDescription}}{{^gemDescription}}{{{appDescription}}}{{^appDescription}}{{{appName}}} Ruby Gem{{/appDescription}}{{/gemDescription}}"
+  s.license     = "{{{gemLicense}}}{{^gemLicense}}Unlicense{{/gemLicense}}"
+  s.required_ruby_version = "{{{gemRequiredRubyVersion}}}{{^gemRequiredRubyVersion}}>= 2.4{{/gemRequiredRubyVersion}}"
+
+  {{#isFaraday}}
+  s.add_runtime_dependency 'faraday', '~> 1.0', '>= 1.0.1'
+  {{/isFaraday}}
+  {{^isFaraday}}
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  {{/isFaraday}}
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/gen/templates/gitignore.mustache

@@ -0,0 +1,39 @@
+# Generated by: https://openapi-generator.tech
+#
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/gen/templates/model.mustache

@@ -0,0 +1,26 @@
+=begin
+{{> api_info}}
+=end
+
+require 'date'
+require 'time'
+
+module {{moduleName}}
+{{#models}}
+{{#model}}
+{{#isEnum}}
+{{>partial_model_enum_class}}
+{{/isEnum}}
+{{^isEnum}}
+{{#oneOf}}
+{{#-first}}
+{{>partial_oneof_module}}
+{{/-first}}
+{{/oneOf}}
+{{^oneOf}}
+{{>partial_model_generic}}
+{{/oneOf}}
+{{/isEnum}}
+{{/model}}
+{{/models}}
+end

data/gen/templates/model_doc.mustache

@@ -0,0 +1,12 @@
+{{#models}}
+{{#model}}
+{{#oneOf}}
+{{#-first}}
+{{>partial_oneof_module_doc}}
+{{/-first}}
+{{/oneOf}}
+{{^oneOf}}
+{{>partial_model_generic_doc}}
+{{/oneOf}}
+{{/model}}
+{{/models}}

data/gen/templates/model_test.mustache

@@ -0,0 +1,77 @@
+=begin
+{{> api_info}}
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for {{moduleName}}::{{classname}}
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+{{#models}}
+{{#model}}
+describe {{moduleName}}::{{classname}} do
+{{^oneOf}}
+  let(:instance) { {{moduleName}}::{{classname}}.new }
+
+  describe 'test an instance of {{classname}}' do
+    it 'should create an instance of {{classname}}' do
+      expect(instance).to be_instance_of({{moduleName}}::{{classname}})
+    end
+  end
+{{#vars}}
+  describe 'test attribute "{{{name}}}"' do
+    it 'should work' do
+      {{#isEnum}}
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('{{{dataType}}}', [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.{{name}} = value }.not_to raise_error
+      # end
+      {{/isEnum}}
+      {{^isEnum}}
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      {{/isEnum}}
+    end
+  end
+
+{{/vars}}
+{{/oneOf}}
+{{#oneOf}}
+{{#-first}}
+  describe '.openapi_one_of' do
+    it 'lists the items referenced in the oneOf array' do
+      expect(described_class.openapi_one_of).to_not be_empty
+    end
+  end
+
+  {{#discriminator}}
+  {{#propertyName}}
+  describe '.openapi_discriminator_name' do
+    it 'returns the value of the "discriminator" property' do
+      expect(described_class.openapi_discriminator_name).to_not be_empty
+    end
+  end
+
+  {{/propertyName}}
+  {{#mappedModels}}
+  {{#-first}}
+  describe '.openapi_discriminator_mapping' do
+    it 'returns the key/values of the "mapping" property' do
+      expect(described_class.openapi_discriminator_mapping.values.sort).to eq(described_class.openapi_one_of.sort)
+    end
+  end
+
+  {{/-first}}
+  {{/mappedModels}}
+  {{/discriminator}}
+  describe '.build' do
+    it 'returns the correct model' do
+    end
+  end
+{{/-first}}
+{{/oneOf}}
+end
+{{/model}}
+{{/models}}

data/gen/templates/partial_model_enum_class.mustache

@@ -0,0 +1,20 @@
+  class {{classname}}{{#allowableValues}}{{#enumVars}}
+    {{{name}}} = {{{value}}}.freeze{{/enumVars}}
+
+{{/allowableValues}}
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = {{classname}}.constants.select { |c| {{classname}}::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #{{{classname}}}" if constantValues.empty?
+      value
+    end
+  end

data/gen/templates/partial_model_generic.mustache

@@ -0,0 +1,371 @@
+  {{#description}}
+  # {{{description}}}
+  {{/description}}
+  class {{classname}}{{#parent}} < {{{.}}}{{/parent}}
+  {{#vars}}
+    {{#description}}
+    # {{{description}}}
+    {{/description}}
+    attr_accessor :{{{name}}}
+
+  {{/vars}}
+{{#hasEnums}}
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+{{/hasEnums}}
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        {{#vars}}
+        :'{{{name}}}' => :'{{{baseName}}}'{{^-last}},{{/-last}}
+        {{/vars}}
+      }
+    end
+
+    # Returns all the JSON keys this model knows about{{#parent}}, including the ones defined in its parent(s){{/parent}}
+    def self.acceptable_attributes
+      {{^parent}}
+      attribute_map.values
+      {{/parent}}
+      {{#parent}}
+      attribute_map.values.concat(superclass.acceptable_attributes)
+      {{/parent}}
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        {{#vars}}
+        :'{{{name}}}' => :'{{{dataType}}}'{{^-last}},{{/-last}}
+        {{/vars}}
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        {{#vars}}
+        {{#isNullable}}
+        :'{{{name}}}'{{^-last}},{{/-last}}
+        {{/isNullable}}
+        {{/vars}}
+      ])
+    end
+
+    {{#anyOf}}
+    {{#-first}}
+    # List of class defined in anyOf (OpenAPI v3)
+    def self.openapi_any_of
+      [
+    {{/-first}}
+      :'{{{.}}}'{{^-last}},{{/-last}}
+    {{#-last}}
+      ]
+    end
+
+    {{/-last}}
+    {{/anyOf}}
+    {{#allOf}}
+    {{#-first}}
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+    {{/-first}}
+      :'{{{.}}}'{{^-last}},{{/-last}}
+    {{#-last}}
+      ]
+    end
+
+    {{/-last}}
+    {{/allOf}}
+    {{#discriminator}}
+    {{#propertyName}}
+    # discriminator's property name in OpenAPI v3
+    def self.openapi_discriminator_name
+      :'{{{.}}}'
+    end
+
+    {{/propertyName}}
+    {{/discriminator}}
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `{{{moduleName}}}::{{{classname}}}` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `{{{moduleName}}}::{{{classname}}}`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+      {{#parent}}
+
+      # call parent's initialize
+      super(attributes)
+      {{/parent}}
+      {{#vars}}
+
+      if attributes.key?(:'{{{name}}}')
+        {{#isArray}}
+        if (value = attributes[:'{{{name}}}']).is_a?(Array)
+          self.{{{name}}} = value
+        end
+        {{/isArray}}
+        {{#isMap}}
+        if (value = attributes[:'{{{name}}}']).is_a?(Hash)
+          self.{{{name}}} = value
+        end
+        {{/isMap}}
+        {{^isContainer}}
+        self.{{{name}}} = attributes[:'{{{name}}}']
+        {{/isContainer}}
+      {{#defaultValue}}
+      else
+        self.{{{name}}} = {{{defaultValue}}}
+      {{/defaultValue}}
+      end
+      {{/vars}}
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = {{^parent}}Array.new{{/parent}}{{#parent}}super{{/parent}}
+      {{#vars}}
+      {{^isNullable}}
+      {{#required}}
+      if @{{{name}}}.nil?
+        invalid_properties.push('invalid value for "{{{name}}}", {{{name}}} cannot be nil.')
+      end
+
+      {{/required}}
+      {{/isNullable}}
+      {{#hasValidation}}
+      {{#maxLength}}
+      if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.to_s.length > {{{maxLength}}}
+        invalid_properties.push('invalid value for "{{{name}}}", the character length must be smaller than or equal to {{{maxLength}}}.')
+      end
+
+      {{/maxLength}}
+      {{#minLength}}
+      if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.to_s.length < {{{minLength}}}
+        invalid_properties.push('invalid value for "{{{name}}}", the character length must be great than or equal to {{{minLength}}}.')
+      end
+
+      {{/minLength}}
+      {{#maximum}}
+      if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}} >{{#exclusiveMaximum}}={{/exclusiveMaximum}} {{{maximum}}}
+        invalid_properties.push('invalid value for "{{{name}}}", must be smaller than {{^exclusiveMaximum}}or equal to {{/exclusiveMaximum}}{{{maximum}}}.')
+      end
+
+      {{/maximum}}
+      {{#minimum}}
+      if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}} <{{#exclusiveMinimum}}={{/exclusiveMinimum}} {{{minimum}}}
+        invalid_properties.push('invalid value for "{{{name}}}", must be greater than {{^exclusiveMinimum}}or equal to {{/exclusiveMinimum}}{{{minimum}}}.')
+      end
+
+      {{/minimum}}
+      {{#pattern}}
+      pattern = Regexp.new({{{pattern}}})
+      if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}} !~ pattern
+        invalid_properties.push("invalid value for \"{{{name}}}\", must conform to the pattern #{pattern}.")
+      end
+
+      {{/pattern}}
+      {{#maxItems}}
+      if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.length > {{{maxItems}}}
+        invalid_properties.push('invalid value for "{{{name}}}", number of items must be less than or equal to {{{maxItems}}}.'
+      end
+
+      {{/maxItems}}
+      {{#minItems}}
+      if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.length < {{{minItems}}}
+        invalid_properties.push('invalid value for "{{{name}}}", number of items must be greater than or equal to {{{minItems}}}.'
+      end
+
+      {{/minItems}}
+      {{/hasValidation}}
+      {{/vars}}
+      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?
+      {{#vars}}
+      {{^isNullable}}
+      {{#required}}
+      return false if @{{{name}}}.nil?
+      {{/required}}
+      {{/isNullable}}
+      {{#isEnum}}
+      {{^isContainer}}
+      {{{name}}}_validator = EnumAttributeValidator.new('{{{dataType}}}', [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}])
+      return false unless {{{name}}}_validator.valid?(@{{{name}}})
+      {{/isContainer}}
+      {{/isEnum}}
+      {{#hasValidation}}
+      {{#maxLength}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.to_s.length > {{{maxLength}}}
+      {{/maxLength}}
+      {{#minLength}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.to_s.length < {{{minLength}}}
+      {{/minLength}}
+      {{#maximum}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}} >{{#exclusiveMaximum}}={{/exclusiveMaximum}} {{{maximum}}}
+      {{/maximum}}
+      {{#minimum}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}} <{{#exclusiveMinimum}}={{/exclusiveMinimum}} {{{minimum}}}
+      {{/minimum}}
+      {{#pattern}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}} !~ Regexp.new({{{pattern}}})
+      {{/pattern}}
+      {{#maxItems}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.length > {{{maxItems}}}
+      {{/maxItems}}
+      {{#minItems}}
+      return false if {{^required}}!@{{{name}}}.nil? && {{/required}}@{{{name}}}.length < {{{minItems}}}
+      {{/minItems}}
+      {{/hasValidation}}
+      {{/vars}}
+      {{#anyOf}}
+      {{#-first}}
+      _any_of_found = false
+      self.class.openapi_any_of.each do |_class|
+        _any_of = {{moduleName}}.const_get(_class).build_from_hash(self.to_hash)
+        if _any_of.valid?
+          _any_of_found = true
+        end
+      end
+
+      if !_any_of_found
+        return false
+      end
+
+      {{/-first}}
+      {{/anyOf}}
+      true{{#parent}} && super{{/parent}}
+    end
+
+    {{#vars}}
+    {{#isEnum}}
+    {{^isContainer}}
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] {{{name}}} Object to be assigned
+    def {{{name}}}=({{{name}}})
+      validator = EnumAttributeValidator.new('{{{dataType}}}', [{{#allowableValues}}{{#enumVars}}{{{value}}}{{^-last}}, {{/-last}}{{/enumVars}}{{/allowableValues}}])
+      unless validator.valid?({{{name}}})
+        fail ArgumentError, "invalid value for \"{{{name}}}\", must be one of #{validator.allowable_values}."
+      end
+      @{{{name}}} = {{{name}}}
+    end
+
+    {{/isContainer}}
+    {{/isEnum}}
+    {{^isEnum}}
+    {{#hasValidation}}
+    # Custom attribute writer method with validation
+    # @param [Object] {{{name}}} Value to be assigned
+    def {{{name}}}=({{{name}}})
+      {{^isNullable}}
+      {{#required}}
+      if {{{name}}}.nil?
+        fail ArgumentError, '{{{name}}} cannot be nil'
+      end
+
+      {{/required}}
+      {{/isNullable}}
+      {{#maxLength}}
+      if {{^required}}!{{{name}}}.nil? && {{/required}}{{{name}}}.to_s.length > {{{maxLength}}}
+        fail ArgumentError, 'invalid value for "{{{name}}}", the character length must be smaller than or equal to {{{maxLength}}}.'
+      end
+
+      {{/maxLength}}
+      {{#minLength}}
+      if {{^required}}!{{{name}}}.nil? && {{/required}}{{{name}}}.to_s.length < {{{minLength}}}
+        fail ArgumentError, 'invalid value for "{{{name}}}", the character length must be great than or equal to {{{minLength}}}.'
+      end
+
+      {{/minLength}}
+      {{#maximum}}
+      if {{^required}}!{{{name}}}.nil? && {{/required}}{{{name}}} >{{#exclusiveMaximum}}={{/exclusiveMaximum}} {{{maximum}}}
+        fail ArgumentError, 'invalid value for "{{{name}}}", must be smaller than {{^exclusiveMaximum}}or equal to {{/exclusiveMaximum}}{{{maximum}}}.'
+      end
+
+      {{/maximum}}
+      {{#minimum}}
+      if {{^required}}!{{{name}}}.nil? && {{/required}}{{{name}}} <{{#exclusiveMinimum}}={{/exclusiveMinimum}} {{{minimum}}}
+        fail ArgumentError, 'invalid value for "{{{name}}}", must be greater than {{^exclusiveMinimum}}or equal to {{/exclusiveMinimum}}{{{minimum}}}.'
+      end
+
+      {{/minimum}}
+      {{#pattern}}
+      pattern = Regexp.new({{{pattern}}})
+      if {{^required}}!{{{name}}}.nil? && {{/required}}{{{name}}} !~ pattern
+        fail ArgumentError, "invalid value for \"{{{name}}}\", must conform to the pattern #{pattern}."
+      end
+
+      {{/pattern}}
+      {{#maxItems}}
+      if {{^required}}!{{{name}}}.nil? && {{/required}}{{{name}}}.length > {{{maxItems}}}
+        fail ArgumentError, 'invalid value for "{{{name}}}", number of items must be less than or equal to {{{maxItems}}}.'
+      end
+
+      {{/maxItems}}
+      {{#minItems}}
+      if {{^required}}!{{{name}}}.nil? && {{/required}}{{{name}}}.length < {{{minItems}}}
+        fail ArgumentError, 'invalid value for "{{{name}}}", number of items must be greater than or equal to {{{minItems}}}.'
+      end
+
+      {{/minItems}}
+      @{{{name}}} = {{{name}}}
+    end
+
+    {{/hasValidation}}
+    {{/isEnum}}
+    {{/vars}}
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class{{#vars}} &&
+          {{name}} == o.{{name}}{{/vars}}{{#parent}} && super(o){{/parent}}
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [{{#vars}}{{name}}{{^-last}}, {{/-last}}{{/vars}}].hash
+    end
+
+{{> base_object}}
+  end