academical-api-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f12096992031836a22c3e9f50a22ab4f3b93235
+  data.tar.gz: 44b0dd7aca9efa9a9f3b3957a5e8e0bc851ebe01
+SHA512:
+  metadata.gz: 0d0bbfcee9b30be69eac31dfcadba5f29365a020767e136b593196168e83fa697ff497396635e211db68182fbfc4b3e8b6da83f5a83375b9fe7b107b2fdc9cd9
+  data.tar.gz: b951d46ee97b50c9628d1249821f76eb09dfae5d6c4a80b0465e0fed5247677c137965f037e3bf029c3a581d47fe5e03b4899e153805d58750b689625f447666

data/lib/academical-api-client.rb

@@ -0,0 +1,8 @@
+require "rubygems"
+
+require "academical/client"
+require "academical/error"
+require "academical/http_client"
+
+module Academical
+end

data/lib/academical/api/schools.rb

@@ -0,0 +1,135 @@
+module Academical
+
+  module Api
+
+    # All schools that are using Academical
+    class Schools
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns a school object given its ID
+      #
+      # '/schools/:id' GET
+      #
+      # id - ID of the school
+      def get(id, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/schools/#{id}", body, options)
+      end
+
+      # Delete a school from the API given its ID
+      #
+      # '/schools/:id' DELETE
+      #
+      # id - ID of the school
+      def delete(id, options = {})
+        body = options.fetch(:body, {})
+
+        @client.delete("/schools/#{id}", body, options)
+      end
+
+      # Returns a list of schedules that have been created in a given school
+      #
+      # '/schools/:id/schedules' GET
+      #
+      # id - ID of the school
+      def schedules(id, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/schools/#{id}/schedules", body, options)
+      end
+
+      # Returns a list of students for a given school
+      #
+      # '/schools/:id/students' GET
+      #
+      # id - ID of the school
+      def students(id, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/schools/#{id}/students", body, options)
+      end
+
+      # Returns a list of sections for a given school
+      #
+      # '/schools/:id/sections' GET
+      #
+      # id - ID of the school
+      def sections(id, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/schools/#{id}/sections", body, options)
+      end
+
+      # Return a list of teachers for a given school
+      #
+      # '/schools/:id/teachers' GET
+      #
+      # id - ID of the school
+      def teachers(id, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/schools/#{id}/teachers", body, options)
+      end
+
+      # Creates a new school object in Academical. All required parameters must be provided
+      #
+      # '/schools/' POST
+      #
+      # name - Name of the school
+      # nickname - Nickname of the school
+      # locale - Locale of the school
+      # timezone - Timezone of the school
+      # departments - A list of Department objects. Each department should specify a name and faculty_name
+      # identity_providers - A list of Identify Providers to use with this school
+      # app_ui - Object describing UI specific parameters for our planner app
+      # terms - A list containing Term objects. Each term should define a name, a start date and end date.
+      def create(name, nickname, locale, timezone, departments, identity_providers, app_ui, terms, options = {})
+        body = options.fetch(:body, {})
+        body[:name] = name
+        body[:nickname] = nickname
+        body[:locale] = locale
+        body[:timezone] = timezone
+        body[:departments] = departments
+        body[:identity_providers] = identity_providers
+        body[:app_ui] = app_ui
+        body[:terms] = terms
+
+        @client.post("/schools/", body, options)
+      end
+
+      # Update a new school in Academical. You must provide all of the required parameters
+      #
+      # '/schools/:id/' PUT
+      #
+      # id - Generated ID for the school
+      # name - Name of the school
+      # nickname - Nickname of the school
+      # locale - Locale of the school
+      # timezone - Timezone of the school
+      # departments - A list of Department objects. Each department should specify a name and faculty_name
+      # identity_providers - A list of Identify Providers to use with this school
+      # app_ui - Object describing UI specific parameters for our planner app
+      # terms - A list containing Term objects. Each term should define a name, a start date and end date.
+      def update(id, name, nickname, locale, timezone, departments, identity_providers, app_ui, terms, options = {})
+        body = options.fetch(:body, {})
+        body[:name] = name
+        body[:nickname] = nickname
+        body[:locale] = locale
+        body[:timezone] = timezone
+        body[:departments] = departments
+        body[:identity_providers] = identity_providers
+        body[:app_ui] = app_ui
+        body[:terms] = terms
+
+        @client.put("/schools/#{id}/", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/academical/api/sections.rb

@@ -0,0 +1,121 @@
+module Academical
+
+  module Api
+
+    # Represents the section of a course in a school
+    class Sections
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns a section object given its ID
+      #
+      # '/sections/:id' GET
+      #
+      # id - ID of the section
+      def get(id, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/sections/#{id}", body, options)
+      end
+
+      # Delete a section given its ID
+      #
+      # '/sections/:id' DELETE
+      #
+      # id - ID of the section
+      def delete(id, options = {})
+        body = options.fetch(:body, {})
+
+        @client.delete("/sections/#{id}", body, options)
+      end
+
+      # Creates a new section object in Academical. All required parameters must be provided.
+      #
+      # '/sections/' POST
+      #
+      # course_name - Name of the course
+      # course_code - The code of the course which this section belongs to
+      # section_number - Section number of the course. This is X of Y sections for course K
+      # section_id - Unique identifier for the section
+      # term - The term object this section will be taking place in
+      # seats - Object describing the number of available, taken and total seats for the section
+      # school_id - ID of the school this section belongs to
+      # events - A list of events this section takes place on
+      # departments - List of departments this section belongs to.
+      # credits - Number of credits this course is worth
+      def create(course_name, course_code, section_number, section_id, term, seats, school_id, events, departments, credits, options = {})
+        body = options.fetch(:body, {})
+        body[:course_name] = course_name
+        body[:course_code] = course_code
+        body[:section_number] = section_number
+        body[:section_id] = section_id
+        body[:term] = term
+        body[:seats] = seats
+        body[:school_id] = school_id
+        body[:events] = events
+        body[:departments] = departments
+        body[:credits] = credits
+
+        @client.post("/sections/", body, options)
+      end
+
+      # Update the attributes of a section given its ID as a part of the body of the request
+      #
+      # '/sections/:id' PUT
+      #
+      # id - ID of the section
+      # course_name - Name of the course
+      # course_code - The code of the course which this section belongs to
+      # section_number - Section number of the course. This is X of Y sections for course K
+      # section_id - Unique identifier for the section
+      # term - The term object this section will be taking place in
+      # seats - Object describing the number of available, taken and total seats for the section
+      # school_id - ID of the school this section belongs to
+      # events - A list of events this section takes place on
+      # departments - List of departments this section belongs to.
+      # credits - Number of credits this course is worth
+      def update(id, course_name, course_code, section_number, section_id, term, seats, school_id, events, departments, credits, options = {})
+        body = options.fetch(:body, {})
+        body[:course_name] = course_name
+        body[:course_code] = course_code
+        body[:section_number] = section_number
+        body[:section_id] = section_id
+        body[:term] = term
+        body[:seats] = seats
+        body[:school_id] = school_id
+        body[:events] = events
+        body[:departments] = departments
+        body[:credits] = credits
+
+        @client.put("/sections/#{id}", body, options)
+      end
+
+      # Returns the list of teachers given a section ID
+      #
+      # '/sections/:id/teachers' GET
+      #
+      # id - ID of the section
+      def teachers(id, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/sections/#{id}/teachers", body, options)
+      end
+
+      # List of all the schedules with a given section
+      #
+      # '/sections/:id/schedules' GET
+      #
+      # id - ID of the section
+      def schedules(id, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/sections/#{id}/schedules", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/academical/api/teachers.rb

@@ -0,0 +1,68 @@
+module Academical
+
+  module Api
+
+    # A teacher in a school.
+    class Teachers
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Get a teacher given its ID
+      #
+      # '/teachers/:id' GET
+      #
+      # id - ID of the teacher
+      def get(id, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/teachers/#{id}", body, options)
+      end
+
+      # Delete a teacher given its ID
+      #
+      # '/teachers/:id' DELETE
+      #
+      # id - ID of the teacher
+      def delete(id, options = {})
+        body = options.fetch(:body, {})
+
+        @client.delete("/teachers/#{id}", body, options)
+      end
+
+      # Create a new teacher in Academical. You must provide all of the required values
+      #
+      # '/teachers/' POST
+      #
+      # name - Object with the name of the teacher
+      # school_id - ID of the school which this teacher belongs to
+      def create(name, school_id, options = {})
+        body = options.fetch(:body, {})
+        body[:name] = name
+        body[:school_id] = school_id
+
+        @client.post("/teachers/", body, options)
+      end
+
+      # Update a teacher in Academical. You must provide all of the required parameters
+      #
+      # '/teachers/:id' PUT
+      #
+      # id - ID of the teacher
+      # name - Object with the name of the teacher
+      # school_id - ID of the school which this teacher belongs to
+      def update(id, name, school_id, options = {})
+        body = options.fetch(:body, {})
+        body[:id] = id
+        body[:name] = name
+        body[:school_id] = school_id
+
+        @client.put("/teachers/#{id}", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/academical/client.rb

@@ -0,0 +1,33 @@
+require "faraday"
+require "json"
+
+require "academical/api/schools"
+require "academical/api/sections"
+require "academical/api/teachers"
+
+module Academical
+
+  class Client
+
+    def initialize(auth = {}, options = {})
+      @http_client = Academical::HttpClient::HttpClient.new(auth, options)
+    end
+
+    # All schools that are using Academical
+    def schools()
+      Academical::Api::Schools.new(@http_client)
+    end
+
+    # Represents the section of a course in a school
+    def sections()
+      Academical::Api::Sections.new(@http_client)
+    end
+
+    # A teacher in a school.
+    def teachers()
+      Academical::Api::Teachers.new(@http_client)
+    end
+
+  end
+
+end

data/lib/academical/error.rb

@@ -0,0 +1,9 @@
+require "academical/error/client_error"
+
+module Academical
+
+  module Error
+
+  end
+
+end

data/lib/academical/error/client_error.rb

@@ -0,0 +1,18 @@
+module Academical
+
+  module Error
+
+    class ClientError < ::StandardError
+
+      attr_reader :code
+
+      def initialize(message, code)
+        @code = code
+        super message
+      end
+
+    end
+
+  end
+
+end

data/lib/academical/http_client.rb

@@ -0,0 +1,122 @@
+require "academical/http_client/auth_handler"
+require "academical/http_client/error_handler"
+require "academical/http_client/request_handler"
+require "academical/http_client/response"
+require "academical/http_client/response_handler"
+
+module Academical
+
+  module HttpClient
+
+    # Main HttpClient which is used by Api classes
+    class HttpClient
+
+      attr_accessor :options, :headers
+
+      def initialize(auth = {}, options = {})
+
+        if auth.is_a?(String)
+          auth = { :http_header => auth }
+        end
+
+        @options = {
+          :base => "https://api.academical.co",
+          :user_agent => "alpaca/0.2.1 (https://github.com/pksunkara/alpaca)"
+        }
+
+        @options.update(options)
+
+        @headers = {
+          "user-agent" => @options[:user_agent]
+        }
+
+        if @options.has_key?(:headers)
+          @headers.update(Hash[@options[:headers].map { |k, v| [k.downcase, v] }])
+          @options.delete(:headers)
+        end
+
+        @client = Faraday.new(@options[:base]) do |conn|
+          conn.use(Academical::HttpClient::AuthHandler, auth)
+          conn.use(Academical::HttpClient::ErrorHandler)
+
+          conn.adapter(Faraday.default_adapter)
+        end
+      end
+
+      def get(path, params = {}, options = {})
+        request(path, nil, "get", options.merge({ :query => params }))
+      end
+
+      def post(path, body = {}, options = {})
+        request(path, body, "post", options)
+      end
+
+      def patch(path, body = {}, options = {})
+        request(path, body, "patch", options)
+      end
+
+      def delete(path, body = {}, options = {})
+        request(path, body, "delete", options)
+      end
+
+      def put(path, body = {}, options = {})
+        request(path, body, "put", options)
+      end
+
+      # Intermediate function which does three main things
+      #
+      # - Transforms the body of request into correct format
+      # - Creates the requests with give parameters
+      # - Returns response body after parsing it into correct format
+      def request(path, body, method, options)
+        options = @options.merge(options)
+
+        options[:headers] = options[:headers] || {}
+        options[:headers] = @headers.merge(Hash[options[:headers].map { |k, v| [k.downcase, v] }])
+
+        options[:body] = body
+
+        if method != "get"
+          options[:body] = options[:body] || {}
+          options = set_body(options)
+        end
+
+        response = create_request(method, path, options)
+
+        body = get_body(response)
+
+        Academical::HttpClient::Response.new(body, response.status, response.headers)
+      end
+
+      # Creating a request with the given arguments
+      #
+      # If api_version is set, appends it immediately after host
+      def create_request(method, path, options)
+        version = options.has_key?(:api_version) ? "/#{options[:api_version]}" : ""
+
+        path = "#{version}#{path}"
+
+        instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+          @client.#{method}(path) do |req|
+            req.body = options[:body]
+            req.headers.update(options[:headers])
+            req.params.update(options[:query]) if options[:query]
+          end
+        RUBY
+      end
+
+      # Get response body in correct format
+      def get_body(response)
+        Academical::HttpClient::ResponseHandler.get_body(response)
+      end
+
+      # Set request body in correct format
+      def set_body(options)
+        Academical::HttpClient::RequestHandler.set_body(options)
+      end
+
+    end
+
+  end
+
+end

data/lib/academical/http_client/auth_handler.rb

@@ -0,0 +1,73 @@
+require "base64"
+
+module Academical
+
+  module HttpClient
+
+    # AuthHandler takes care of devising the auth type and using it
+    class AuthHandler < Faraday::Middleware
+
+      HTTP_HEADER = 1
+
+      def initialize(app, auth = {}, options = {})
+        @auth = auth
+        super(app)
+      end
+
+      def call(env)
+        if !@auth.empty?
+          auth = get_auth_type
+          flag = false
+
+          if auth == HTTP_HEADER
+            env = http_header(env)
+            flag = true
+          end
+
+          if !flag
+            raise StandardError.new "Unable to calculate authorization method. Please check"
+          end
+        else
+          raise StandardError.new "Server requires authentication to proceed further. Please check"
+        end
+
+        @app.call(env)
+      end
+
+      # Calculating the Authentication Type
+      def get_auth_type()
+
+        if @auth.has_key?(:http_header)
+          return HTTP_HEADER
+        end
+
+        return -1
+      end
+
+      # Authorization with HTTP header
+      def http_header(env)
+        env[:request_headers]["Authorization"] = "Bearer #{@auth[:http_header]}"
+
+        return env
+      end
+
+      def query_params(url)
+        if url.query.nil? or url.query.empty?
+          {}
+        else
+          Faraday::Utils.parse_query(url.query)
+        end
+      end
+
+      def merge_query(env, query)
+        query = query.update query_params(env[:url])
+
+        env[:url].query = Faraday::Utils.build_query(query)
+
+        return env
+      end
+    end
+
+  end
+
+end

data/lib/academical/http_client/error_handler.rb

@@ -0,0 +1,51 @@
+module Academical
+
+  module HttpClient
+
+    # ErrorHanlder takes care of selecting the error message from response body
+    class ErrorHandler < Faraday::Middleware
+
+      def initialize(app)
+        super(app)
+      end
+
+      def call(env)
+        @app.call(env).on_complete do |env|
+          code = env[:response].status
+          type = env[:response].headers["content-type"]
+
+          case code
+          when 500...599
+            raise Academical::Error::ClientError.new("Error #{code}", code)
+          when 400...499
+            body = Academical::HttpClient::ResponseHandler.get_body(env[:response])
+            message = ""
+
+            # If HTML, whole body is taken
+            if body.is_a?(String)
+              message = body
+            end
+
+            # If JSON, a particular field is taken and used
+            if type.include?("json") and body.is_a?(Hash)
+              if body.has_key?("message")
+                message = body["message"]
+              else
+                message = "Unable to select error message from json returned by request responsible for error"
+              end
+            end
+
+            if message == ""
+              message = "Unable to understand the content type of response returned by request responsible for error"
+            end
+
+            raise Academical::Error::ClientError.new message, code
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/academical/http_client/request_handler.rb

@@ -0,0 +1,32 @@
+module Academical
+
+  module HttpClient
+
+    # RequestHandler takes care of encoding the request body into format given by options
+    class RequestHandler
+
+      def self.set_body(options)
+        type = options.fetch(:request_type, "json")
+
+        # Encoding request body into JSON format
+        if type == "json"
+          request_wrapper = {}
+          request_wrapper[:data] = options[:body]
+          options[:body] = request_wrapper.to_json
+          options[:headers]["content-type"] = "application/json"
+        end
+
+        # Raw body
+        if type == "raw"
+          options[:body] = options[:body].is_a?(Hash) ? "" : options[:body]
+          options[:headers].delete("content-type")
+        end
+
+        return options
+      end
+
+    end
+
+  end
+
+end

data/lib/academical/http_client/response.rb

@@ -0,0 +1,20 @@
+module Academical
+
+  module HttpClient
+
+    # Response object contains the response returned by the client
+    class Response
+
+      attr_accessor :body, :code, :headers
+
+      def initialize(body, code, headers)
+        @body = body
+        @code = code
+        @headers = headers
+      end
+
+    end
+
+  end
+
+end

data/lib/academical/http_client/response_handler.rb

@@ -0,0 +1,24 @@
+module Academical
+
+  module HttpClient
+
+    # ResponseHandler takes care of decoding the response body into suitable type
+    class ResponseHandler
+
+      def self.get_body(response)
+        type = response.headers["content-type"]
+        body = response.body
+
+        # Response body is in JSON
+        if type.include?("json")
+          body = JSON.parse body
+        end
+
+        return body
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: academical-api-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Academical
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+description: Official Academical API library client for ruby
+email: support+developers@academical.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/academical-api-client.rb
+- lib/academical/api/schools.rb
+- lib/academical/api/sections.rb
+- lib/academical/api/teachers.rb
+- lib/academical/client.rb
+- lib/academical/error.rb
+- lib/academical/error/client_error.rb
+- lib/academical/http_client.rb
+- lib/academical/http_client/auth_handler.rb
+- lib/academical/http_client/error_handler.rb
+- lib/academical/http_client/request_handler.rb
+- lib/academical/http_client/response.rb
+- lib/academical/http_client/response_handler.rb
+homepage: https://api.academical.co
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Official Academical API library client for ruby
+test_files: []