kosapi_client 0.5.0

data/lib/kosapi_client/entity/id.rb

@@ -0,0 +1,13 @@
+module KOSapiClient
+  module Entity
+    class Id < String
+
+      def self.parse(str)
+        id = str.split(':').last
+        new(id)
+      end
+
+    end
+  end
+end
+

data/lib/kosapi_client/entity/link.rb

@@ -0,0 +1,54 @@
+module KOSapiClient
+  module Entity
+    class Link
+
+      attr_reader :link_title, :link_href, :link_rel
+
+      def initialize(title, href, rel, client = nil)
+        @link_title = title
+        @link_href = escape_url(href)
+        @link_rel = rel
+        @client = client
+      end
+
+      def self.parse(contents)
+        href = contents[:xlink_href] || contents[:href]
+        new(contents[:__content__], href, contents[:rel])
+      end
+
+      def link_id
+        @link_href.split('/').last
+      end
+
+      def follow
+        raise "HTTP client not set, cannot send request to #{link_href}" unless @client
+        @client.send_request(:get, link_href)
+      end
+
+      def inject_client(client)
+        @client = client
+      end
+
+      def target
+        @target ||= follow
+      end
+
+      def to_hash
+        { href: link_href, rel: link_rel, title: link_title }
+      end
+
+      def method_missing(method, *args, &block)
+        target.send(method, *args, &block)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        target.respond_to?(method_name, include_private)
+      end
+
+      def escape_url(url)
+        url.gsub(';','%3B')
+      end
+
+    end
+  end
+end

data/lib/kosapi_client/entity/ml_string.rb

@@ -0,0 +1,42 @@
+module KOSapiClient
+  module Entity
+    class MLString
+
+      DEFAULT_LANGUAGE = :en
+      attr_reader :translations
+
+      def initialize(translations, default_language = DEFAULT_LANGUAGE)
+        @translations = translations
+        @default_language = default_language
+      end
+
+      def to_s(lang = :implicit)
+        if lang == :implicit
+          lang = select_lang
+        end
+        @translations[lang]
+      end
+
+      def self.parse(item)
+        unless item.is_a?(Array)
+          item = [item]
+        end
+        translations = {}
+        item.each do |it|
+          lang = it[:xml_lang].to_sym
+          value = it[:__content__]
+          translations[lang] = value
+        end
+
+        MLString.new(translations)
+      end
+
+      private
+      def select_lang
+        return @default_language if @translations.key?(@default_language)
+        @translations.keys.first
+      end
+
+    end
+  end
+end

data/lib/kosapi_client/entity/parallel.rb

@@ -0,0 +1,20 @@
+module KOSapiClient
+  module Entity
+    class Parallel < BaseEntity
+
+      map_data :capacity, Integer
+      map_data :capacity_overfill, Enum #, Permission
+      map_data :code, Integer
+      map_data :course, Link
+      map_data :parallel_type, Enum #, ParallelType
+      map_data :enrollment, Enum #, Permission
+      map_data :note, MLString
+      map_data :occupied, Integer
+      map_data :semester, Link
+      map_data :teachers, [Link], element: :teacher
+      map_data :timetable_slots, [TimetableSlot], element: :timetable_slot
+
+    end
+  end
+end
+

data/lib/kosapi_client/entity/person.rb

@@ -0,0 +1,10 @@
+module KOSapiClient
+  module Entity
+    class Person < BasePerson
+
+      #todo roles/student
+      #todo roles/teacher
+
+    end
+  end
+end

data/lib/kosapi_client/entity/result_page.rb

@@ -0,0 +1,46 @@
+module KOSapiClient
+  module Entity
+
+    # ResultPage instance is returned from requests to all paginated resources.
+    # It wraps returned objects, stores additional feed metadata and it also
+    # helps to do things like auto pagination and next / previous page callbacks.
+    class ResultPage
+
+      include Enumerable
+
+      attr_reader :items
+      attr_accessor :auto_paginate
+
+      def initialize(items, links, auto_paginate = true)
+        @items = items
+        @links = links
+        @auto_paginate = auto_paginate
+      end
+
+      def count
+        @items.count
+      end
+
+      def next
+        @links.next
+      end
+
+      def prev
+        @links.prev
+      end
+
+      def each(&block)
+        return to_enum(__method__) unless block_given?
+        items.each(&block)
+        return unless @auto_paginate
+        next_link = self.next
+        while next_link
+          next_page = next_link.follow
+          next_link = next_page.next
+          next_page.items.each(&block)
+        end
+      end
+
+    end
+  end
+end

data/lib/kosapi_client/entity/student.rb

@@ -0,0 +1,25 @@
+module KOSapiClient
+  module Entity
+    class Student < BasePerson
+
+      map_data :branch, Link
+      map_data :department, Link
+      map_data :email
+      map_data :start_date, Time
+      map_data :faculty, Link
+      map_data :grade, Integer
+      map_data :interrupted_until, Time
+      map_data :programme, Link
+      map_data :end_date, Time
+      map_data :study_form, Enum
+      map_data :study_group, Integer
+      map_data :study_plan, Link
+      map_data :study_state, Enum
+      map_data :supervisor, Link
+      map_data :supervisor_specialist, Link
+      map_data :study_termination_reason, Enum
+      map_data :code
+
+    end
+  end
+end

data/lib/kosapi_client/entity/teacher.rb

@@ -0,0 +1,14 @@
+module KOSapiClient
+  module Entity
+    class Teacher < BasePerson
+
+      map_data :division, Link
+      map_data :extern, Boolean
+      map_data :email
+      map_data :phone
+      map_data :stageName
+      map_data :supervision_phd_students, Enum, element: :supervision_ph_d_students
+
+    end
+  end
+end

data/lib/kosapi_client/entity/teacher_timetable_slot.rb

@@ -0,0 +1,16 @@
+module KOSapiClient
+  module Entity
+    class TeacherTimetableSlot
+
+      include DataMappings
+
+      map_data :id, Integer
+      map_data :day, Integer
+      map_data :duration, Integer
+      map_data :first_hour, Integer
+      map_data :parity, Enum
+      map_data :title, String
+
+    end
+  end
+end

data/lib/kosapi_client/entity/timetable_slot.rb

@@ -0,0 +1,16 @@
+module KOSapiClient
+  module Entity
+    class TimetableSlot
+
+      include DataMappings
+
+      map_data :id, Integer
+      map_data :day, Integer
+      map_data :duration, Integer
+      map_data :first_hour, Integer
+      map_data :parity, Enum
+      map_data :room, Link
+
+    end
+  end
+end

data/lib/kosapi_client/hash_utils.rb

@@ -0,0 +1,17 @@
+module KOSapiClient
+  module HashUtils
+
+    def self.deep_transform_hash_keys(item, &block)
+      return item unless item.is_a?(Hash)
+      copy = {}
+      item.each do |key, value|
+        new_value = deep_transform_hash_keys(value, &block) if value.is_a? Hash
+        new_value = value.map { |it| deep_transform_hash_keys(it, &block) }  if value.is_a? Array
+        new_value ||= value
+        copy[block.call(key)] = new_value
+      end
+      copy
+    end
+
+  end
+end

data/lib/kosapi_client/http_client.rb

@@ -0,0 +1,36 @@
+module KOSapiClient
+  class HTTPClient
+
+    def initialize(http_adapter, preprocessor = ResponsePreprocessor.new, converter = ResponseConverter.new(self))
+      @http_adapter = http_adapter
+      @preprocessor = preprocessor
+      @converter = converter
+    end
+
+    def send_request(verb, url, options = {})
+      absolute_url = get_absolute_url(url)
+      result = @http_adapter.send_request(verb, absolute_url, options)
+      process_response(result)
+    end
+
+    def process_response(result)
+      preprocessed = @preprocessor.preprocess(result)
+      response = KOSapiClient::KOSapiResponse.new(preprocessed)
+      @converter.convert(response)
+    end
+
+    def get_absolute_url(url)
+      if is_absolute(url)
+        url
+      else
+        "#{@http_adapter.base_url}/#{url}"
+      end
+    end
+
+    private
+    def is_absolute(url)
+      url.start_with?('http')
+    end
+
+  end
+end

data/lib/kosapi_client/kosapi_client.rb

@@ -0,0 +1,45 @@
+module KOSapiClient
+
+  singleton_class.class_eval do
+
+    def new(options = {})
+      ApiClient.new(Configuration.new(options))
+    end
+
+    def configure
+      reset
+      yield config
+      self
+    end
+
+    def client
+      @client ||= ApiClient.new(config)
+    end
+
+    # Calling this method clears stored ApiClient instance
+    # if configured previously.
+    def reset
+      @config = nil
+      @client = nil
+    end
+
+    def method_missing(method, *args, &block)
+      if client.respond_to?(method)
+        client.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      client.respond_to?(method_name, include_private)
+    end
+
+    private
+    def config
+      @config ||= Configuration.new
+    end
+
+  end
+
+end

data/lib/kosapi_client/kosapi_response.rb

@@ -0,0 +1,32 @@
+module KOSapiClient
+  class KOSapiResponse
+
+    attr_reader :contents
+
+    def initialize(contents)
+      @contents = contents
+    end
+
+    def is_paginated?
+      contents[:atom_feed]
+    end
+
+    def items
+      if is_paginated?
+        contents[:atom_feed][:atom_entry]
+      else
+        [contents[:atom_entry]]
+      end
+    end
+
+    def item
+      items.first
+    end
+
+    def links_hash
+      return nil unless contents[:atom_feed]
+      contents[:atom_feed][:atom_link]
+    end
+
+  end
+end

data/lib/kosapi_client/oauth2_http_adapter.rb

@@ -0,0 +1,36 @@
+require 'oauth2'
+
+module KOSapiClient
+  class OAuth2HttpAdapter
+
+    DEFAULT_AUTH_URL = 'https://auth.fit.cvut.cz/oauth/oauth/authorize'
+    DEFAULT_TOKEN_URL = 'https://auth.fit.cvut.cz/oauth/oauth/token'
+
+    attr_reader :base_url
+
+    def initialize(credentials, base_url, opts = {})
+      @base_url = base_url
+      @credentials = credentials
+      auth_url = opts[:auth_url] || DEFAULT_AUTH_URL
+      token_url = opts[:token_url] || DEFAULT_TOKEN_URL
+      MultiXml.parser = :ox # make sure to use Ox because of different namespace handling in other MultiXML parsers
+      @client = OAuth2::Client.new(credentials[:client_id], credentials[:client_secret], site: base_url, authorize_url: auth_url, token_url: token_url)
+    end
+
+    def send_request(verb, url, options = {})
+      raise 'No credentials set' if @credentials.empty?
+      token.request(verb, url, options)
+    end
+
+    private
+    def authenticate
+      @token = @client.client_credentials.get_token
+    end
+
+    def token
+      authenticate if !@token || @token.expired?
+      @token
+    end
+  end
+end
+

data/lib/kosapi_client/request_builder.rb

@@ -0,0 +1,59 @@
+module KOSapiClient
+  class RequestBuilder
+
+    attr_reader :response
+
+    def find(id)
+      @id = id
+      @url_builder.set_path(id)
+      self
+    end
+
+    def offset(num)
+      @url_builder.set_query_param(:offset, num)
+      self
+    end
+
+    def limit(num)
+      @url_builder.set_query_param(:limit, num)
+      self
+    end
+
+    def query(params = {})
+      raise 'Empty parameters to query are not allowed' if params.empty?
+      if params.instance_of?(String)
+        rsql = params
+      else
+        rsql = params.map { |k, v| "#{k}==#{v}" }.join(';')
+      end
+      @url_builder.set_query_param(:query, rsql)
+      self
+    end
+
+    alias where query
+
+    def initialize(resource_name, http_client, url_builder = URLBuilder.new(resource_name.to_s))
+      @base_url = resource_name
+      @http_client = http_client
+      @operation = :get
+      @body = nil
+      @headers = {}
+      @url_builder = url_builder
+      @id = nil
+    end
+
+    def finalize
+      options = {headers: @headers, body: @body }
+      @response = @http_client.send_request(@operation, @url_builder.url, options)
+    end
+
+    private
+    attr_reader :url_builder, :id
+
+    def id_set?
+      @id
+    end
+
+  end
+end
+