clever-ruby 0.14.0 → 1.0.0

data/docs/StudentcontactsDeleted.md

@@ -0,0 +1,10 @@
+# Clever::StudentcontactsDeleted
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**data** | [**StudentContactObject**](StudentContactObject.md) |  | [optional] 
+
+

data/docs/StudentcontactsUpdated.md

@@ -0,0 +1,10 @@
+# Clever::StudentcontactsUpdated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**data** | [**StudentContactObject**](StudentContactObject.md) |  | [optional] 
+
+

data/docs/StudentsCreated.md

@@ -0,0 +1,10 @@
+# Clever::StudentsCreated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**data** | [**StudentObject**](StudentObject.md) |  | [optional] 
+
+

data/docs/StudentsDeleted.md

@@ -0,0 +1,10 @@
+# Clever::StudentsDeleted
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**data** | [**StudentObject**](StudentObject.md) |  | [optional] 
+
+

data/docs/StudentsResponse.md

@@ -0,0 +1,8 @@
+# Clever::StudentsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<StudentResponse>**](StudentResponse.md) |  | [optional] 
+
+

data/docs/StudentsUpdated.md

@@ -0,0 +1,10 @@
+# Clever::StudentsUpdated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**data** | [**StudentObject**](StudentObject.md) |  | [optional] 
+
+

data/docs/Teacher.md

@@ -0,0 +1,19 @@
+# Clever::Teacher
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**created** | **String** |  | [optional] 
+**district** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**last_modified** | **String** |  | [optional] 
+**name** | [**Name**](Name.md) |  | [optional] 
+**school** | **String** |  | [optional] 
+**schools** | **Array<String>** |  | [optional] 
+**sis_id** | **String** |  | [optional] 
+**state_id** | **String** |  | [optional] 
+**teacher_number** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+
+

data/docs/TeacherObject.md

@@ -0,0 +1,8 @@
+# Clever::TeacherObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Teacher**](Teacher.md) |  | [optional] 
+
+

data/docs/TeacherResponse.md

@@ -0,0 +1,8 @@
+# Clever::TeacherResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Teacher**](Teacher.md) |  | [optional] 
+
+

data/docs/TeachersCreated.md

@@ -0,0 +1,10 @@
+# Clever::TeachersCreated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**data** | [**TeacherObject**](TeacherObject.md) |  | [optional] 
+
+

data/docs/TeachersDeleted.md

@@ -0,0 +1,10 @@
+# Clever::TeachersDeleted
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**data** | [**TeacherObject**](TeacherObject.md) |  | [optional] 
+
+

data/docs/TeachersResponse.md

@@ -0,0 +1,8 @@
+# Clever::TeachersResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<TeacherResponse>**](TeacherResponse.md) |  | [optional] 
+
+

data/docs/TeachersUpdated.md

@@ -0,0 +1,10 @@
+# Clever::TeachersUpdated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | 
+**id** | **String** |  | [optional] 
+**data** | [**TeacherObject**](TeacherObject.md) |  | [optional] 
+
+

data/docs/Term.md

@@ -0,0 +1,10 @@
+# Clever::Term
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**start_date** | **String** |  | [optional] 
+**end_date** | **String** |  | [optional] 
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git crediential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/instructions.md

@@ -0,0 +1,12 @@
+## Updating the Library
+
+1. Git clone swagger-codegen (https://github.com/swagger-api/swagger-codegen)
+
+2. Git clone Clever's swagger-api repo (https://github.com/Clever/swagger-api)
+
+3. Run this command in the swagger-codegen repo
+```
+java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i $PATH_TO_SWAGGER_API_REPO/v1.2-client.yml -c $PATH_TO_THIS_REPO/override/config.json -l ruby -o $PATH_TO_THIS_REPO
+```
+
+4. Run `make build` to copy over the override files

data/lib/clever-ruby.rb

@@ -1,334 +1,105 @@
-# rubocop:disable FileName
-require 'rest_client'
-require 'multi_json'
-require 'open-uri'
-require 'set'
-require 'uri'
-require 'cgi'
-require 'json'
+=begin
+#Clever API
 
-require 'clever-ruby/version'
+#The Clever API
 
-# API operations
-require 'clever-ruby/api_operations/list'
-require 'clever-ruby/api_operations/nested_list'
-require 'clever-ruby/api_operations/pagelist'
-require 'clever-ruby/api_operations/results_list'
-require 'clever-ruby/api_operations/page'
+OpenAPI spec version: 1.2.0
 
-# Helpers
-require 'clever-ruby/util'
-require 'clever-ruby/json'
-require 'clever-ruby/configuration'
+Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-# Resources
-require 'clever-ruby/clever_object'
-require 'clever-ruby/api_resource'
-require 'clever-ruby/nested_resource'
-require 'clever-ruby/district'
-require 'clever-ruby/school'
-require 'clever-ruby/student'
-require 'clever-ruby/section'
-require 'clever-ruby/teacher'
-require 'clever-ruby/event'
-require 'clever-ruby/school_admin'
-require 'clever-ruby/district_admin'
+=end
 
-# Errors
-require 'clever-ruby/errors/clever_error'
+# Common files
+require 'clever-ruby/api_client'
+require 'clever-ruby/api_error'
+require 'clever-ruby/version'
+require 'clever-ruby/configuration'
 
-require 'clever-ruby/errors/api_connection_error'
-require 'clever-ruby/errors/api_error'
-require 'clever-ruby/errors/authentication_error'
-require 'clever-ruby/errors/invalid_request_error'
+# Models
+require 'clever-ruby/models/bad_request'
+require 'clever-ruby/models/district'
+require 'clever-ruby/models/district_admin'
+require 'clever-ruby/models/district_admin_response'
+require 'clever-ruby/models/district_admins_response'
+require 'clever-ruby/models/district_object'
+require 'clever-ruby/models/district_response'
+require 'clever-ruby/models/district_status'
+require 'clever-ruby/models/district_status_response'
+require 'clever-ruby/models/districts_created'
+require 'clever-ruby/models/districts_deleted'
+require 'clever-ruby/models/districts_response'
+require 'clever-ruby/models/districts_updated'
+require 'clever-ruby/models/event'
+require 'clever-ruby/models/event_response'
+require 'clever-ruby/models/events_response'
+require 'clever-ruby/models/grade_levels_response'
+require 'clever-ruby/models/internal_error'
+require 'clever-ruby/models/location'
+require 'clever-ruby/models/name'
+require 'clever-ruby/models/not_found'
+require 'clever-ruby/models/principal'
+require 'clever-ruby/models/school'
+require 'clever-ruby/models/school_admin'
+require 'clever-ruby/models/school_admin_object'
+require 'clever-ruby/models/school_admin_response'
+require 'clever-ruby/models/school_admins_response'
+require 'clever-ruby/models/school_object'
+require 'clever-ruby/models/school_response'
+require 'clever-ruby/models/schooladmins_created'
+require 'clever-ruby/models/schooladmins_deleted'
+require 'clever-ruby/models/schooladmins_updated'
+require 'clever-ruby/models/schools_created'
+require 'clever-ruby/models/schools_deleted'
+require 'clever-ruby/models/schools_response'
+require 'clever-ruby/models/schools_updated'
+require 'clever-ruby/models/section'
+require 'clever-ruby/models/section_object'
+require 'clever-ruby/models/section_response'
+require 'clever-ruby/models/sections_created'
+require 'clever-ruby/models/sections_deleted'
+require 'clever-ruby/models/sections_response'
+require 'clever-ruby/models/sections_updated'
+require 'clever-ruby/models/student'
+require 'clever-ruby/models/student_contact'
+require 'clever-ruby/models/student_contact_object'
+require 'clever-ruby/models/student_contact_response'
+require 'clever-ruby/models/student_contacts_response'
+require 'clever-ruby/models/student_object'
+require 'clever-ruby/models/student_response'
+require 'clever-ruby/models/studentcontacts_created'
+require 'clever-ruby/models/studentcontacts_deleted'
+require 'clever-ruby/models/studentcontacts_updated'
+require 'clever-ruby/models/students_created'
+require 'clever-ruby/models/students_deleted'
+require 'clever-ruby/models/students_response'
+require 'clever-ruby/models/students_updated'
+require 'clever-ruby/models/teacher'
+require 'clever-ruby/models/teacher_object'
+require 'clever-ruby/models/teacher_response'
+require 'clever-ruby/models/teachers_created'
+require 'clever-ruby/models/teachers_deleted'
+require 'clever-ruby/models/teachers_response'
+require 'clever-ruby/models/teachers_updated'
+require 'clever-ruby/models/term'
+
+# APIs
+require 'clever-ruby/api/data_api'
+require 'clever-ruby/api/events_api'
 
-# Clever Ruby library
 module Clever
   class << self
-    # Global configuration for using Clever
-    # @api public
-    # @example Configure your API key
+    # Customize default settings for the SDK using block.
     #   Clever.configure do |config|
-    #     config.api_key = 'YOUR-API-KEY'
+    #     config.username = "xxx"
+    #     config.password = "xxx"
     #   end
-    # @return [Object]
+    # If no block given, return the default Configuration object.
     def configure
-      yield configuration
-    end
-
-    # Retrieve your stored API key
-    # @api private
-    # @return [String] API key
-    def api_key
-      configuration.api_key
-    end
-
-    # Retrieve the configured timeout
-    # @api private
-    # @return [Fixnum] Configuration timeout
-    def timeout
-      configuration.timeout
-    end
-
-    # Retrieve the configured open timeout
-    # @api private
-    # @return [Fixnum] Open timeout
-    def open_timeout
-      configuration.open_timeout
-    end
-
-    # Retrieve your stored API token
-    # @api private
-    # @return [String] API token
-    def token
-      configuration.token
-    end
-
-    # Retrieve the global Clever configuration object
-    # @api private
-    # @return [Hash] API configuration object
-    def configuration
-      @configuration ||= Clever::Configuration.new
-    end
-
-    # Retrieve the URL of the Clever API being used
-    # @api private
-    # @return [String] API url
-    def api_url(url = '')
-      configuration.api_base + url
-    end
-  end
-
-  # Convert a hash of params to a query string. Does not prepend the leading '?'
-  # @api private
-  # @param params [Hash] Parameters to stringify
-  # @return [String] Query string
-  def self.convert_to_query_string(params = nil)
-    if params && params.count
-      params_arr = Util.flatten_params(params).map do |p|
-        "#{URI.encode(p[0].to_s)}=#{URI.encode(p[1].to_s)}"
-      end
-      params_arr.join('&')
-    else
-      ''
-    end
-  end
-
-  # Generate the URL and payload for a request based on data about the request
-  # @api private
-  # @param method [Symbol] HTTP method used
-  # @param url [String] URL to send to
-  # @param params [Hash] Parameters to send
-  # @return [String, String] URL and payload to send via HTTP
-  def self.create_payload(method, url, params)
-    case method.to_s.downcase.to_sym
-    when :get, :head, :delete
-      url_obj = URI.parse(url)
-      if url_obj.query
-        params = CGI.parse(url_obj.query).map { |k, v| { k => v[0] } }.reduce(:merge).merge params
-      end
-      url_obj.query = convert_to_query_string params
-      url = url_obj.to_s
-      payload = nil
-    else
-      payload = params
-    end
-    [url, payload]
-  end
-
-  # Headers hash for user-agent tracking
-  # @api private
-  # @return [Hash] headers to add to request
-  def self.tracking_headers
-    {
-      bindings_version: Clever::VERSION,
-      lang: 'ruby',
-      lang_version: RUBY_VERSION.to_s + ' p' + RUBY_PATCHLEVEL.to_s,
-      platform: RUBY_PLATFORM.to_s,
-      publisher: 'clever',
-      uname: uname
-    }
-  end
-
-  # Retrieves system's uname
-  # @api private
-  # @return [String] uname with the system's uname
-  def self.uname
-    `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i
-  rescue SystemCallError
-    'cannot get uname'
-  end
-
-  # Create options hash that specifies an HTTP request from request data
-  # @api private
-  # @return [Hash] parameters for executing a request
-  def self.create_request_opts(method, url, params, headers)
-    params = Util.objects_to_ids params
-    url = api_url url
-    url, payload = create_payload method, url, params
-
-    headers[:Authorization] = 'Bearer ' + Clever.token if Clever.token
-    headers[:user_agent] = 'Clever/RubyBindings/' + Clever::VERSION
-    headers[:x_clever_client_user_agent] = tracking_headers.to_json
-
-    opts = {
-      method: method,
-      url: url,
-      headers: headers,
-      open_timeout: Clever.open_timeout,
-      payload: payload,
-      timeout: Clever.timeout
-    }
-    if Clever.api_key
-      opts[:user] = Clever.api_key
-      opts[:password] = ''
-    end
-    opts
-  end
-
-  # Confirm API key or token are globally configured
-  # @api private
-  # @return [nil]
-  # @raise [AuthenticationError] Error if no authentication present
-  def self.check_authorization(headers)
-    unless Clever.api_key || Clever.token || headers.key?(:Authorization)
-      fail AuthenticationError, 'No API key provided. (HINT: set your API key using '\
-        '"Clever.configure { |config| config.api_key = <API-KEY> }" or your token using '\
-        '"Clever.configure { |config| config.token = <TOKEN> }" '\
-        'or pass the district token as a second argument to retrieve)'
-    end
-  end
-
-  # Send an HTTP request to the Clever API
-  # @api private
-  # @param method [Symbol] HTTP method used
-  # @param url [String] URL to send to
-  # @param params [Hash] parameters to send with the request
-  # @param headers [Hash] headers to send with the request
-  # @return [Hash] parsed JSON response
-  # @raise [APIError] Error if API fails to return valid JSON
-  def self.request(method, url, params = nil, headers = {})
-    check_authorization(headers)
-    opts = create_request_opts method, url, params, headers
-    response = execute_request opts
-
-    rbody = response.body
-    rcode = response.code
-    begin
-      resp = Clever::JSON.load rbody
-    rescue MultiJson::DecodeError
-      raise APIError.new(
-        "Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})",
-        rcode, rbody)
-    end
-
-    resp
-  end
-
-  private
-
-  # Execute an HTTP request safely
-  # @api private
-  # @param opts [Hash] Definition of the request to make
-  # @return [String] Request results
-  # @raise [APIConnectionError] Request failure
-  def self.execute_request(opts)
-    begin
-      request = RestClient::Request.execute opts
-    rescue SocketError => e
-      handle_restclient_error e
-    rescue NoMethodError => e
-      # TODO: investigate
-      # Work around RestClient bug
-      if e.message =~ /\WRequestFailed\W/
-        handle_restclient_error APIConnectionError.new 'Unexpected HTTP response code'
-      else raise
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
       end
-    rescue RestClient::ExceptionWithResponse => e
-      rcode = e.http_code
-      rbody = e.http_body
-      if rcode && rbody
-        handle_api_error rcode, rbody
-      else handle_restclient_error e
-      end
-    rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      handle_restclient_error e
     end
-
-    request
-  end
-
-  # Translate errors thrown by RestClient into standardized APIConnectionErrors
-  # @api private
-  # @param e [Error] Error to handle
-  # @return [nil]
-  # @raise [APIConnectionError] Standardized error for request failures
-  def self.handle_restclient_error(e)
-    case e
-    when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
-      message = "Could not connect to Clever (#{configuration.api_base}). " \
-      'Please check your internet connection and try again.'
-    when SocketError
-      message = 'Unexpected error communicating when trying to connect to Clever. HINT: ' \
-        'You may be seeing this message because your DNS is not working. To check, try running ' \
-        "'host api.clever.com' from the command line."
-    else
-      message = 'Unexpected error communicating with Clever.'
-    end
-    message += "\n\n(Network error: #{e.message})"
-    fail APIConnectionError, message
-  end
-
-  # Translate errors returned as JSON by the Clever API into CleverErrors
-  # @api private
-  # @param rcode [Integer] response code
-  # @param rbody [String] response body
-  # @return [nil]
-  # @raise [CleverError] Clever error corresponding to the failure observed
-  def self.handle_api_error(rcode, rbody)
-    begin
-      error_obj = Clever::JSON.load rbody
-      error = error_obj[:error]
-      fail CleverError unless error # escape from parsing
-    rescue MultiJson::DecodeError, CleverError
-      raise APIError.new(
-        "Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})",
-        rcode, rbody)
-    end
-
-    case rcode
-    when 400, 404 then
-      fail invalid_request_error error, rcode, rbody, error_obj
-    when 401
-      fail authentication_error error, rcode, rbody, error_obj
-    else
-      fail api_error error, rcode, rbody, error_obj
-    end
-  end
-
-  # Generate an InvalidRequestError
-  # @api private
-  # @return [InvalidRequestError]
-  def self.invalid_request_error(error, rcode, rbody, error_obj)
-    if error.is_a? Hash
-      InvalidRequestError.new error[:message], error[:param], rcode, rbody, error_obj
-    else
-      InvalidRequestError.new error, '', rcode, rbody, error_obj
-    end
-  end
-
-  # Generate an AuthenticationError
-  # @api private
-  # @return [AuthenticationError]
-  def self.authentication_error(error, rcode, rbody, error_obj)
-    AuthenticationError.new(error, rcode, rbody, error_obj)
-  end
-
-  # Generate an APIError
-  # @api private
-  # @return [APIError]
-  def self.api_error(error, rcode, rbody, error_obj)
-    error_msg = error.is_a?(Hash) ? error[:message] : error
-    APIError.new(error_msg, rcode, rbody, error_obj)
   end
 end