clever-ruby 1.2.1 → 1.2.2

data/lib/clever-ruby/models/student_contacts_for_student_response.rb

@@ -0,0 +1,190 @@
+=begin
+#Clever API
+
+#The Clever API
+
+OpenAPI spec version: 1.2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'date'
+
+module Clever
+
+  class StudentContactsForStudentResponse
+    attr_accessor :data
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'data' => :'Array<StudentContact>'
+      }
+    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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data
+    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
+      [data].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 = Clever.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/clever-ruby/models/student_contacts_response.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 

data/lib/clever-ruby/models/student_object.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 

data/lib/clever-ruby/models/student_response.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 

data/lib/clever-ruby/models/students_created.rb

@@ -22,6 +22,8 @@ module Clever
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'type' => :'type',
+        :'id' => :'id',
         :'data' => :'data'
       }
     end
@@ -29,6 +31,8 @@ module Clever
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'type' => :'String',
+        :'id' => :'String',
         :'data' => :'StudentObject'
       }
     end
@@ -41,6 +45,14 @@ module Clever
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.has_key?(:'data')
         self.data = attributes[:'data']
       end

data/lib/clever-ruby/models/students_response.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 

data/lib/clever-ruby/models/teacher.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 

data/lib/clever-ruby/models/teacher_object.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 

data/lib/clever-ruby/models/teacher_response.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 

data/lib/clever-ruby/models/teachers_response.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 

data/lib/clever-ruby/models/term.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 

data/lib/clever-ruby/version.rb

@@ -6,9 +6,10 @@
 OpenAPI spec version: 1.2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
 
 =end
 
 module Clever
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/override/models/students_created.rb

@@ -22,6 +22,8 @@ module Clever
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'type' => :'type',
+        :'id' => :'id',
         :'data' => :'data'
       }
     end
@@ -29,6 +31,8 @@ module Clever
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'type' => :'String',
+        :'id' => :'String',
         :'data' => :'StudentObject'
       }
     end
@@ -41,6 +45,14 @@ module Clever
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.has_key?(:'data')
         self.data = attributes[:'data']
       end

data/override/override.sh

@@ -5,8 +5,10 @@ cp models/* ../lib/clever-ruby/models/
 # Override the parsing library with one that's aware of the inheritence
 cp api_client.rb ../lib/clever-ruby/
 
-# The tests don't do anything so let's remove them
-rm -r ../spec || true
+# The generated tests don't do anything so let's remove them
+rm -r ../spec/api || true
+rm -r ../spec/models || true
+rm -r ../spec/api_client_spec.rb || true
 
 # Add the extension to the readme if it's not already there
 if ! grep -q -i '## Previous Versions' ../README.md; then

data/spec/data_api_spec.rb

@@ -0,0 +1,32 @@
+require "clever-ruby"
+require 'webmock/rspec'
+
+describe Clever::DataApi do
+  before(:each) do
+    WebMock.allow_net_connect!
+    @api_instance = Clever::DataApi.new
+    Clever.configure do |config|
+      config.access_token = 'DEMO_TOKEN'
+    end
+  end
+
+  describe ".get_contacts_for_student" do
+    it "returns array of StudentContacts" do
+      student_id = "530e5961049e75a9262cffe4"
+      contacts = @api_instance.get_contacts_for_student(student_id).data
+      expect(contacts.length).to eq(1)
+      expect(contacts.first.class).to eq(Clever::StudentContact)
+      expect(contacts.first.id).not_to be nil
+    end
+  end
+
+  describe ".get_contacts" do
+    it "returns array of StudentContactResponses" do
+      contacts = @api_instance.get_contacts.data
+      expect(contacts).not_to be_empty
+      expect(contacts.first.class).to eq(Clever::StudentContactResponse)
+      expect(contacts.first.data.class).to eq(Clever::StudentContact)
+      expect(contacts.first.data.id).not_to be nil
+    end
+  end
+end

data/spec/events.json

@@ -129,87 +129,84 @@
         },
         {
             "data": {
-                "created": "2017-06-15T21:54:10.030Z",
+                "created": "2017-07-13T16:28:38.377Z",
                 "data": {
                     "object": {
-                        "district": "56e07f73944b620100000175",
-                        "ell_status": "N",
-                        "id": "58c81dcea3627927150003f0"
-                    },
-                    "previous_attributes": {
-                        "created": "2017-03-14T16:43:58.153Z",
+                        "created": "2017-07-11T16:05:51.740Z",
                         "credentials": {
-                            "district_username": "evalynb40"
+                            "district_username": "marthag20marthag20marthag20marthag20marthag20martha"
                         },
-                        "dob": "8/10/2006",
-                        "email": "b_evalyn@example.org",
+                        "district": "58da8a43cc70ab00017a1a87",
+                        "dob": "4/2/1998",
+                        "email": "g_martha@example.org",
                         "gender": "F",
-                        "grade": "1",
+                        "grade": "9",
                         "hispanic_ethnicity": "N",
+                        "id": "59496080827927905b00076d",
+                        "last_modified": "2017-07-11T16:05:51.740Z",
                         "location": {
-                            "zip": "10029"
+                            "zip": "11694"
                         },
                         "name": {
-                            "first": "Evalyn",
-                            "last": "Bradtke",
-                            "middle": "J"
+                            "first": "Martha",
+                            "last": "Greenholt",
+                            "middle": "T"
                         },
-                        "race": "Black or African American",
-                        "school": "58c81db226d0809114000007",
+                        "race": "Asian",
+                        "school": "58da8c58155b940248000006",
                         "schools": [
-                            "58c81db226d0809114000007"
+                            "58da8c58155b940248000006",
+                            "58da8c58155b940248000007"
                         ],
-                        "sis_id": "106091540",
-                        "state_id": "552729322",
-                        "student_number": "106091540"
+                        "sis_id": "9131139200",
+                        "state_id": "975729843",
+                        "student_number": "913113920"
                     }
                 },
-                "id": "594301ff7f264e3ca45e568e",
-                "type": "students.updated"
+                "id": "59679fb5893d055bc095ede7",
+                "type": "students.deleted"
             },
-            "uri": "/v1.2/events/594301ff7f264e3ca45e568e"
+            "uri": "/v1.2/events/59679fb5893d055bc095ede7"
         },
         {
             "data": {
-                "created": "2017-06-15T21:54:10.031Z",
+                "created": "2017-06-27T21:58:00.811Z",
                 "data": {
                     "object": {
-                        "district": "56e07f73944b620100000175",
-                        "ell_status": "Y",
-                        "id": "58c81dcea3627927150003f1"
-                    },
-                    "previous_attributes": {
-                        "created": "2017-03-14T16:43:58.154Z",
+                        "created": "2017-03-28T16:16:35.369Z",
                         "credentials": {
-                            "district_username": "coryt00"
+                            "district_username": "mial61"
                         },
-                        "dob": "7/21/1997",
-                        "email": "cory_t@example.net",
-                        "gender": "M",
-                        "grade": "10",
-                        "hispanic_ethnicity": "Y",
+                        "district": "58da8a43cc70ab00017a1a87",
+                        "dob": "11/10/2002",
+                        "email": "l_mia@example.org",
+                        "gender": "F",
+                        "grade": "5",
+                        "hispanic_ethnicity": "N",
+                        "id": "58da8c63d7dc0ca068000450",
+                        "last_modified": "2017-03-28T16:16:35.369Z",
                         "location": {
-                            "zip": "10038"
+                            "zip": "10002"
                         },
                         "name": {
-                            "first": "Cory",
-                            "last": "Thompson",
-                            "middle": "V"
+                            "first": "Mia",
+                            "last": "Lindgren",
+                            "middle": "J"
                         },
                         "race": "Black or African American",
-                        "school": "58c81db226d0809114000006",
+                        "school": "58da8c58155b940248000007",
                         "schools": [
-                            "58c81db226d0809114000006"
+                            "58da8c58155b940248000007"
                         ],
-                        "sis_id": "106867300",
-                        "state_id": "863433981",
-                        "student_number": "106867300"
+                        "sis_id": "189492161",
+                        "state_id": "661166974",
+                        "student_number": "189492161"
                     }
                 },
-                "id": "594301ff7f264e3ca45e568f",
-                "type": "students.updated"
+                "id": "5952d4e3ed859521b85c6283",
+                "type": "students.created"
             },
-            "uri": "/v1.2/events/594301ff7f264e3ca45e568f"
+            "uri": "/v1.2/events/5952d4e3ed859521b85c6283"
         }
     ],
     "links": [