commonlit-clever-ruby 2.1.4 → 2.1.6.beta1

data/spec/api_client_spec.rb

@@ -0,0 +1,225 @@
+=begin
+#Data API
+
+#Serves the Clever Data API
+
+OpenAPI spec version: 2.1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.51
+=end
+
+require 'spec_helper'
+
+describe Clever::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          Clever.configure { |c| c.host = 'http://example.com' }
+          expect(Clever::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          Clever.configure { |c| c.host = 'https://wookiee.com' }
+          expect(Clever::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          Clever.configure { |c| c.host = 'hobo.com/v4' }
+          expect(Clever::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Clever.configure { |c| c.base_path = 'v4/dog' }
+          expect(Clever::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          Clever.configure { |c| c.base_path = '/v4/dog' }
+          expect(Clever::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          Clever.configure { |c| c.base_path = nil }
+          expect(Clever::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { Clever::Configuration.new }
+    let(:api_client) { Clever::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(Clever::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { Clever::Configuration.new }
+    let(:api_client) { Clever::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(Clever::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = Clever::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = Clever::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = Clever::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = Clever::ApiClient.new
+      # _model = Clever::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { Clever::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { Clever::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { Clever::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { Clever::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { Clever::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,18 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
+=begin
+#Data API
+
+#Serves the Clever Data API
+
+OpenAPI spec version: 2.1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.51
+=end
+
+# load the gem
+require 'clever-ruby'
+
+# The following  was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause
 # this file to always be loaded, without a need to explicitly require it in any
@@ -12,10 +26,10 @@
 # the additional setup, and require it from the spec files that actually need
 # it.
 #
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-
-require "clever-ruby"
-
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
@@ -40,22 +54,15 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
-  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
-  # have no way to turn it off -- the option exists only for backwards
-  # compatibility in RSpec 3). It causes shared context metadata to be
-  # inherited by the metadata hash of host groups and examples, rather than
-  # triggering implicit auto-inclusion in groups with matching metadata.
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin
-  # This allows you to limit a spec run to individual examples or groups
-  # you care about by tagging them with `:focus` metadata. When nothing
-  # is tagged with `:focus`, all examples get run. RSpec also provides
-  # aliases for `it`, `describe`, and `context` that include `:focus`
-  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  config.filter_run_when_matching :focus
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
 
   # Allows RSpec to persist some state between runs in order to support
   # the `--only-failures` and `--next-failure` CLI options. We recommend
@@ -80,7 +87,7 @@ RSpec.configure do |config|
     # Use the documentation formatter for detailed output,
     # unless a formatter has already been configured
     # (e.g. via a command-line flag).
-    config.default_formatter = "doc"
+    config.default_formatter = 'doc'
   end
 
   # Print the 10 slowest examples and example groups at the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commonlit-clever-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.6.beta1
 platform: ruby
 authors:
 - Swagger-Codegen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-27 00:00:00.000000000 Z
+date: 2023-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -34,62 +34,62 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.6.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -210,7 +210,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.12
-description: The Clever API
+description: Serves the Clever Data API
 email:
 - ''
 executables: []
@@ -225,12 +225,12 @@ files:
 - README.md
 - Rakefile
 - clever-ruby.gemspec
-- commonlit-clever-ruby-2.1.3.gem
 - docs/AdminName.md
 - docs/BadRequest.md
 - docs/Contact.md
 - docs/ContactObject.md
 - docs/ContactResponse.md
+- docs/ContactsApi.md
 - docs/ContactsCreated.md
 - docs/ContactsDeleted.md
 - docs/ContactsResponse.md
@@ -238,22 +238,24 @@ files:
 - docs/Course.md
 - docs/CourseObject.md
 - docs/CourseResponse.md
+- docs/CoursesApi.md
 - docs/CoursesCreated.md
 - docs/CoursesDeleted.md
 - docs/CoursesResponse.md
 - docs/CoursesUpdated.md
 - docs/Credentials.md
-- docs/DataApi.md
 - docs/District.md
 - docs/DistrictAdmin.md
 - docs/DistrictAdminObject.md
 - docs/DistrictAdminResponse.md
+- docs/DistrictAdminsApi.md
 - docs/DistrictAdminsResponse.md
 - docs/DistrictObject.md
 - docs/DistrictResponse.md
 - docs/DistrictadminsCreated.md
 - docs/DistrictadminsDeleted.md
 - docs/DistrictadminsUpdated.md
+- docs/DistrictsApi.md
 - docs/DistrictsCreated.md
 - docs/DistrictsDeleted.md
 - docs/DistrictsResponse.md
@@ -272,6 +274,7 @@ files:
 - docs/SchoolAdmin.md
 - docs/SchoolAdminObject.md
 - docs/SchoolAdminResponse.md
+- docs/SchoolAdminsApi.md
 - docs/SchoolAdminsResponse.md
 - docs/SchoolEnrollment.md
 - docs/SchoolObject.md
@@ -279,6 +282,7 @@ files:
 - docs/SchooladminsCreated.md
 - docs/SchooladminsDeleted.md
 - docs/SchooladminsUpdated.md
+- docs/SchoolsApi.md
 - docs/SchoolsCreated.md
 - docs/SchoolsDeleted.md
 - docs/SchoolsResponse.md
@@ -286,6 +290,7 @@ files:
 - docs/Section.md
 - docs/SectionObject.md
 - docs/SectionResponse.md
+- docs/SectionsApi.md
 - docs/SectionsCreated.md
 - docs/SectionsDeleted.md
 - docs/SectionsResponse.md
@@ -293,6 +298,7 @@ files:
 - docs/Student.md
 - docs/StudentObject.md
 - docs/StudentResponse.md
+- docs/StudentsApi.md
 - docs/StudentsCreated.md
 - docs/StudentsDeleted.md
 - docs/StudentsResponse.md
@@ -300,6 +306,7 @@ files:
 - docs/Teacher.md
 - docs/TeacherObject.md
 - docs/TeacherResponse.md
+- docs/TeachersApi.md
 - docs/TeachersCreated.md
 - docs/TeachersDeleted.md
 - docs/TeachersResponse.md
@@ -307,14 +314,24 @@ files:
 - docs/Term.md
 - docs/TermObject.md
 - docs/TermResponse.md
+- docs/TermsApi.md
 - docs/TermsCreated.md
 - docs/TermsDeleted.md
 - docs/TermsResponse.md
 - docs/TermsUpdated.md
-- git_push.sh
+- full-v2.yml
 - lib/clever-ruby.rb
-- lib/clever-ruby/api/data_api.rb
+- lib/clever-ruby/api/contacts_api.rb
+- lib/clever-ruby/api/courses_api.rb
+- lib/clever-ruby/api/district_admins_api.rb
+- lib/clever-ruby/api/districts_api.rb
 - lib/clever-ruby/api/events_api.rb
+- lib/clever-ruby/api/school_admins_api.rb
+- lib/clever-ruby/api/schools_api.rb
+- lib/clever-ruby/api/sections_api.rb
+- lib/clever-ruby/api/students_api.rb
+- lib/clever-ruby/api/teachers_api.rb
+- lib/clever-ruby/api/terms_api.rb
 - lib/clever-ruby/api_client.rb
 - lib/clever-ruby/api_error.rb
 - lib/clever-ruby/configuration.rb
@@ -436,9 +453,19 @@ files:
 - override/models/terms_updated.rb
 - override/override.sh
 - sample/sample.rb
-- spec/events.json
+- spec/api/contacts_api_spec.rb
+- spec/api/courses_api_spec.rb
+- spec/api/district_admins_api_spec.rb
+- spec/api/districts_api_spec.rb
+- spec/api/events_api_spec.rb
+- spec/api/school_admins_api_spec.rb
+- spec/api/schools_api_spec.rb
+- spec/api/sections_api_spec.rb
+- spec/api/students_api_spec.rb
+- spec/api/teachers_api_spec.rb
+- spec/api/terms_api_spec.rb
+- spec/api_client_spec.rb
 - spec/spec_helper.rb
-- tags
 homepage: https://github.com/swagger-api/swagger-codegen
 licenses:
 - Unlicense
@@ -451,17 +478,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
-summary: Clever API Ruby Gem
+summary: Data API Ruby Gem
 test_files:
-- spec/events.json
+- spec/api/sections_api_spec.rb
+- spec/api/courses_api_spec.rb
+- spec/api/teachers_api_spec.rb
+- spec/api/schools_api_spec.rb
+- spec/api/school_admins_api_spec.rb
+- spec/api/students_api_spec.rb
+- spec/api/events_api_spec.rb
+- spec/api/districts_api_spec.rb
+- spec/api/district_admins_api_spec.rb
+- spec/api/terms_api_spec.rb
+- spec/api/contacts_api_spec.rb
+- spec/api_client_spec.rb
 - spec/spec_helper.rb