kosapi_client 0.8.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2cbd06f389e0118e1f7c3e9366af9638ee643bbf
-  data.tar.gz: b4c7f3e7680653e4920a2c30876107c2dbf1ce2c
+SHA256:
+  metadata.gz: ebf21f664665d4883acd83607d526dfedcbfb5032673879e736e69c39e87fa8e
+  data.tar.gz: 6acaecd93f80e40fc4c9345fc0306edd1bb643b9f8de1d6c048c21dd7985e21d
 SHA512:
-  metadata.gz: dee4adbe8a2bdd0f8a975aaeb7797cdf61cc0230540b66666f8e30bf973b64d9ce919ab3d030981f45b8ce67fc5e590dd6252cdd24c74b44c7de36ba1f0c4d8b
-  data.tar.gz: 8f327d32b45559da7156b0ca039fffbb73e64bb77e366f59574d9fe8cdcc8ce7a8e748f12e25f1004e83d62fb0c50438e81b5ff66fc098a94a5f3ea34fcd6c53
+  metadata.gz: 8d3160b80ba8ad6bbef7bfc1696fc2a25c561d058c8915489efd9ab81dc277556175caa79017436bcff8a2492bdac7e1cd7f93da29e061f75a80aff139efa707
+  data.tar.gz: 9e5df05b73018490a895132ef24f5d3c38bbd28401cb5b29a65ee87613f910abe968e64f47cfdbedb56b0823e7ce8fc78d5c4339f526168afe98381a7842268f

data/kosapi_client.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-given'

data/lib/kosapi_client/api_client.rb

@@ -6,6 +6,7 @@ module KOSapiClient
     include ResourceMapper
 
     # accessible resources definition
+    resource :branches
     resource :courses
     resource :course_events
     resource :divisions
@@ -21,7 +22,7 @@ module KOSapiClient
     # Creates a new KOSapi client.
     #
     def initialize(config = Configuration.new)
-      http_adapter = OAuth2HttpAdapter.new(config.credentials, config.base_url)
+      http_adapter = OAuth2HttpAdapter.new(config.credentials, config.base_url, config.to_h)
       @http_client = HTTPClient.new(http_adapter)
     end
 

data/lib/kosapi_client/configuration.rb

@@ -1,5 +1,5 @@
 module KOSapiClient
-  class Configuration < Struct.new(:client_id, :client_secret, :base_url)
+  class Configuration < Struct.new(:client_id, :client_secret, :base_url, :token_url, :auth_url, :connection_opts)
 
     DEFAULT_OPTIONS = {
       base_url: 'https://kosapi.fit.cvut.cz/api/3'

data/lib/kosapi_client/entity.rb

@@ -21,3 +21,4 @@ require 'kosapi_client/entity/teacher'
 require 'kosapi_client/entity/semester'
 require 'kosapi_client/entity/student'
 require 'kosapi_client/entity/exam'
+require 'kosapi_client/entity/branch'

data/lib/kosapi_client/entity/branch.rb

@@ -0,0 +1,15 @@
+module KOSapiClient
+  module Entity
+    class Branch < BaseEntity
+      map_data :abbrev
+      map_data :capacity, Integer
+      map_data :code
+      map_data :description, MLString
+      map_data :diploma_name, MLString
+      map_data :division, Link
+      map_data :guarantor, Link
+      map_data :name, MLString
+      map_data :open_for_admission, Boolean
+    end
+  end
+end

data/lib/kosapi_client/entity/coursin.rb

@@ -1,18 +1,39 @@
 module KOSapiClient
   module Entity
     class Coursin < BaseEntity
-      # TODO: Add capacity
 
       # XXX: This is really ugly hack! The problem is that "semester" is both
       # element and attribute, and they are mapped into single Ruby attribute.
       map_data :semester, Link, element: 1, path: :semester
       map_data :capacity_overfill, Enum
       map_data :occupied, Integer
+      map_data :editors, [Link], element: :teacher, path: :editors
       map_data :examiners, [Link], element: :teacher, path: :examiners
       map_data :guarantors, [Link], element: :teacher, path: :guarantors
       map_data :instructors, [Link], element: :teacher, path: :instructors
       map_data :lecturers, [Link], element: :teacher, path: :lecturers
 
+      map_data :instance_capacity, Integer, reader: ->(source_hash, _key) do
+        retrieve_capacity('instance', source_hash)
+      end
+      map_data :tutorial_capacity, Integer, reader: ->(source_hash, _key) do
+        retrieve_capacity('tutorial', source_hash)
+      end
+
+      alias_method :capacity, :instance_capacity
+
+      class << self
+        private
+
+        def retrieve_capacity(type, source_hash)
+          capacity = source_hash[:capacity]
+          return unless capacity
+
+          capacity = [capacity] unless capacity.is_a? Array
+          element = capacity.find { |el| el[:of] == type }
+          element[:__content__] if element
+        end
+      end
     end
   end
 end

data/lib/kosapi_client/entity/data_mappings.rb

@@ -107,8 +107,11 @@ module KOSapiClient
         end
 
         def retrieve_value(source_hash, key, mapping_options)
-          path = mapping_options[:path]
-          if path
+          if (reader = mapping_options[:reader])
+            return reader.call(source_hash, key)
+          end
+
+          if (path = mapping_options[:path])
             parent_element = source_hash[path]
           else
             parent_element = source_hash

data/lib/kosapi_client/entity/teacher_timetable_slot.rb

@@ -10,6 +10,9 @@ module KOSapiClient
       map_data :first_hour, Integer
       map_data :parity, Enum
       map_data :title, String
+      map_data :start_time, Time
+      map_data :end_time, Time
+      map_data :weeks, String
 
     end
   end

data/lib/kosapi_client/entity/timetable_slot.rb

@@ -10,6 +10,9 @@ module KOSapiClient
       map_data :first_hour, Integer
       map_data :parity, Enum
       map_data :room, Link
+      map_data :start_time, Time
+      map_data :end_time, Time
+      map_data :weeks, String
 
     end
   end

data/lib/kosapi_client/oauth2_http_adapter.rb

@@ -13,6 +13,7 @@ module KOSapiClient
       @credentials = credentials
       auth_url = opts[:auth_url] || DEFAULT_AUTH_URL
       token_url = opts[:token_url] || DEFAULT_TOKEN_URL
+      connection_opts = opts[:connection_opts] || {}
       MultiXml.parser = :ox # make sure to use Ox because of different namespace handling in other MultiXML parsers
       @client = OAuth2::Client.new(
         credentials[:client_id],
@@ -20,7 +21,8 @@ module KOSapiClient
         auth_scheme: :basic_auth,
         site: base_url,
         authorize_url: auth_url,
-        token_url: token_url)
+        token_url: token_url,
+        connection_opts: connection_opts)
     end
 
     def send_request(verb, url, options = {})

data/lib/kosapi_client/resource.rb

@@ -1,4 +1,5 @@
 require 'kosapi_client/request_builder'
+require 'kosapi_client/resource/branches_builder'
 require 'kosapi_client/resource/courses_builder'
 require 'kosapi_client/resource/parallels_builder'
 require 'kosapi_client/resource/exams_builder'

data/lib/kosapi_client/resource/branches_builder.rb

@@ -0,0 +1,11 @@
+module KOSapiClient
+  module Resource
+    class BranchesBuilder < RequestBuilder
+      def study_plans
+        raise 'Call #find before asking for branch\'s study plans' unless id_set?
+        url_builder.set_path(id, 'studyPlans')
+        self
+      end
+    end
+  end
+end

data/lib/kosapi_client/resource/courses_builder.rb

@@ -3,17 +3,34 @@ module KOSapiClient
     class CoursesBuilder < RequestBuilder
 
       def detail(level = 1)
-        @url_builder.set_query_param(:detail, level)
+        url_builder.set_query_param(:detail, level)
         self
       end
 
       # Selects courses scheduled in the specified semester(s).
       def sem(*semesters)
-        @url_builder.set_query_param(:sem, semesters.join(','))
+        url_builder.set_query_param(:sem, semesters.join(','))
         self
       end
 
       alias semester sem
+
+      # XXX: This is quite insane, we need some support to DRY subresources.
+      %w[events exams parallels students instances branches].each do |resource|
+        define_method(resource) do |semester: 'current'|
+          raise "Call #find({course_code}) before asking for #{resource}" unless id_set?
+          url_builder.set_path(id, resource)
+          url_builder.set_query_param(:sem, semester)
+          self
+        end
+      end
+
+      def parallel(code, semester: 'current')
+        raise 'Call #find({course_code}) before asking for parallel' unless id_set?
+        url_builder.set_path(id, 'parallels', code)
+        url_builder.set_query_param(:sem, semester)
+        self
+      end
     end
   end
 end

data/lib/kosapi_client/version.rb

@@ -1,3 +1,3 @@
 module KOSapiClient
-  VERSION = '0.8.0'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kosapi_client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Tibor Szolár
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -265,6 +265,7 @@ files:
 - lib/kosapi_client/entity/base_entity.rb
 - lib/kosapi_client/entity/base_person.rb
 - lib/kosapi_client/entity/boolean.rb
+- lib/kosapi_client/entity/branch.rb
 - lib/kosapi_client/entity/course.rb
 - lib/kosapi_client/entity/course_event.rb
 - lib/kosapi_client/entity/coursin.rb
@@ -292,6 +293,7 @@ files:
 - lib/kosapi_client/request_builder.rb
 - lib/kosapi_client/request_builder_delegator.rb
 - lib/kosapi_client/resource.rb
+- lib/kosapi_client/resource/branches_builder.rb
 - lib/kosapi_client/resource/course_events_builder.rb
 - lib/kosapi_client/resource/courses_builder.rb
 - lib/kosapi_client/resource/exams_builder.rb
@@ -323,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Simple Ruby client library for accessing KOSapi service resources