rustici_software_cloud_v2 1.0.0beta

data/lib/rustici_software_cloud_v2/models/xapi_activity_definition.rb

@@ -0,0 +1,301 @@
+=begin
+#SCORM Cloud Rest API
+
+#REST API used for SCORM Cloud integrations.
+
+OpenAPI spec version: 2.0 beta
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.3
+
+=end
+
+require 'date'
+
+module RusticiSoftwareCloudV2
+  # https://github.com/adlnet/xAPI-Spec/blob/1.0.2/xAPI.md#activity-definition
+  class XapiActivityDefinition
+    attr_accessor :name
+
+    attr_accessor :description
+
+    attr_accessor :type
+
+    attr_accessor :more_info
+
+    attr_accessor :interaction_type
+
+    attr_accessor :correct_responses_pattern
+
+    attr_accessor :choices
+
+    attr_accessor :scale
+
+    attr_accessor :source
+
+    attr_accessor :target
+
+    attr_accessor :steps
+
+    attr_accessor :extensions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'description' => :'description',
+        :'type' => :'type',
+        :'more_info' => :'moreInfo',
+        :'interaction_type' => :'interactionType',
+        :'correct_responses_pattern' => :'correctResponsesPattern',
+        :'choices' => :'choices',
+        :'scale' => :'scale',
+        :'source' => :'source',
+        :'target' => :'target',
+        :'steps' => :'steps',
+        :'extensions' => :'extensions'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'Hash<String, String>',
+        :'description' => :'Hash<String, String>',
+        :'type' => :'String',
+        :'more_info' => :'String',
+        :'interaction_type' => :'String',
+        :'correct_responses_pattern' => :'Array<String>',
+        :'choices' => :'Array<XapiInteractionComponent>',
+        :'scale' => :'Array<XapiInteractionComponent>',
+        :'source' => :'Array<XapiInteractionComponent>',
+        :'target' => :'Array<XapiInteractionComponent>',
+        :'steps' => :'Array<XapiInteractionComponent>',
+        :'extensions' => :'Hash<String, Object>'
+      }
+    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.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'name')
+        if (value = attributes[:'name']).is_a?(Hash)
+          self.name = value
+        end
+      end
+
+      if attributes.has_key?(:'description')
+        if (value = attributes[:'description']).is_a?(Hash)
+          self.description = value
+        end
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'moreInfo')
+        self.more_info = attributes[:'moreInfo']
+      end
+
+      if attributes.has_key?(:'interactionType')
+        self.interaction_type = attributes[:'interactionType']
+      end
+
+      if attributes.has_key?(:'correctResponsesPattern')
+        if (value = attributes[:'correctResponsesPattern']).is_a?(Array)
+          self.correct_responses_pattern = value
+        end
+      end
+
+      if attributes.has_key?(:'choices')
+        if (value = attributes[:'choices']).is_a?(Array)
+          self.choices = value
+        end
+      end
+
+      if attributes.has_key?(:'scale')
+        if (value = attributes[:'scale']).is_a?(Array)
+          self.scale = value
+        end
+      end
+
+      if attributes.has_key?(:'source')
+        if (value = attributes[:'source']).is_a?(Array)
+          self.source = value
+        end
+      end
+
+      if attributes.has_key?(:'target')
+        if (value = attributes[:'target']).is_a?(Array)
+          self.target = value
+        end
+      end
+
+      if attributes.has_key?(:'steps')
+        if (value = attributes[:'steps']).is_a?(Array)
+          self.steps = value
+        end
+      end
+
+      if attributes.has_key?(:'extensions')
+        if (value = attributes[:'extensions']).is_a?(Hash)
+          self.extensions = value
+        end
+      end
+    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 = Array.new
+      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?
+      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 &&
+          name == o.name &&
+          description == o.description &&
+          type == o.type &&
+          more_info == o.more_info &&
+          interaction_type == o.interaction_type &&
+          correct_responses_pattern == o.correct_responses_pattern &&
+          choices == o.choices &&
+          scale == o.scale &&
+          source == o.source &&
+          target == o.target &&
+          steps == o.steps &&
+          extensions == o.extensions
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [name, description, type, more_info, interaction_type, correct_responses_pattern, choices, scale, source, target, steps, extensions].hash
+    end
+
+    # 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 =~ /\AArray<(.*)>/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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        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
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        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) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = RusticiSoftwareCloudV2.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_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # 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|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # 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) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/rustici_software_cloud_v2/models/xapi_agent_group.rb

@@ -0,0 +1,279 @@
+=begin
+#SCORM Cloud Rest API
+
+#REST API used for SCORM Cloud integrations.
+
+OpenAPI spec version: 2.0 beta
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.3
+
+=end
+
+require 'date'
+
+module RusticiSoftwareCloudV2
+  # YAML 2.0 does not support oneOf so this is used when object can be an Agent or a Group.
+  class XapiAgentGroup
+    attr_accessor :object_type
+
+    attr_accessor :name
+
+    attr_accessor :mbox
+
+    attr_accessor :mbox_sha1sum
+
+    attr_accessor :openid
+
+    attr_accessor :account
+
+    attr_accessor :member
+
+    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
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'object_type' => :'objectType',
+        :'name' => :'name',
+        :'mbox' => :'mbox',
+        :'mbox_sha1sum' => :'mbox_sha1sum',
+        :'openid' => :'openid',
+        :'account' => :'account',
+        :'member' => :'member'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'object_type' => :'String',
+        :'name' => :'String',
+        :'mbox' => :'String',
+        :'mbox_sha1sum' => :'String',
+        :'openid' => :'String',
+        :'account' => :'XapiAccount',
+        :'member' => :'Array<XapiAgentGroup>'
+      }
+    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.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'objectType')
+        self.object_type = attributes[:'objectType']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'mbox')
+        self.mbox = attributes[:'mbox']
+      end
+
+      if attributes.has_key?(:'mbox_sha1sum')
+        self.mbox_sha1sum = attributes[:'mbox_sha1sum']
+      end
+
+      if attributes.has_key?(:'openid')
+        self.openid = attributes[:'openid']
+      end
+
+      if attributes.has_key?(:'account')
+        self.account = attributes[:'account']
+      end
+
+      if attributes.has_key?(:'member')
+        if (value = attributes[:'member']).is_a?(Array)
+          self.member = value
+        end
+      end
+    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 = Array.new
+      if @object_type.nil?
+        invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
+      end
+
+      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 false if @object_type.nil?
+      object_type_validator = EnumAttributeValidator.new('String', ['Agent', 'Group'])
+      return false unless object_type_validator.valid?(@object_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] object_type Object to be assigned
+    def object_type=(object_type)
+      validator = EnumAttributeValidator.new('String', ['Agent', 'Group'])
+      unless validator.valid?(object_type)
+        fail ArgumentError, 'invalid value for "object_type", must be one of #{validator.allowable_values}.'
+      end
+      @object_type = object_type
+    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 &&
+          object_type == o.object_type &&
+          name == o.name &&
+          mbox == o.mbox &&
+          mbox_sha1sum == o.mbox_sha1sum &&
+          openid == o.openid &&
+          account == o.account &&
+          member == o.member
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [object_type, name, mbox, mbox_sha1sum, openid, account, member].hash
+    end
+
+    # 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 =~ /\AArray<(.*)>/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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        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
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        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) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = RusticiSoftwareCloudV2.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_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # 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|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # 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) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end