uqam_grade_notification 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97e755342551caf2762a98a11889f81b56f3addd
+  data.tar.gz: e028c7df8d5b381306942ea2334de26a3a5e2fb9
+SHA512:
+  metadata.gz: 0509ebd51bcdded0330be624a91166928d9e3eab496f6246afcb3317e42ed1fad49cd330610fbef5254bdef0ca71ed43aefae41a427f41b153c83cfb41b69606
+  data.tar.gz: 5dd65951a86789cc07a76279bfc6538e3d109ae6d94ef3670c8db364309d6d31d0087a1c78390e4a8d4b4dabd782a5a56a4939646c3d650852e8b38e0d282f90

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uqam_grade_notification.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexandre Croteau-Pothier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+# Uqam Grade Notification
+
+This utility will send you an sms alert when your grades have been updated.
+
+## Installation
+
+Install it with:
+
+    $ gem install uqam_grade_notification
+
+## Usage
+
+The first time you execute you will be prompt to enter these informations:
+
+* Code Permanent
+* NIP
+* Phone Number
+* Twilio Account ID
+* Twilio Auth Token
+* Twilio Phone Number

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uqam_grade_notification"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/uqam_grade_notification

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'uqam_grade_notification'
+
+UqamGradeNotification.perform

data/lib/uqam_grade_notification.rb

@@ -0,0 +1,71 @@
+require 'fileutils'
+require 'json'
+require 'highline'
+require 'digest'
+require 'uqam_grade_notification/version'
+require 'uqam_grade_notification/student'
+require 'uqam_grade_notification/notifier'
+
+module UqamGradeNotification
+  APP_DIR = "#{ENV["HOME"]}/.uqam_grade_notification"
+  USER_FILE = "#{APP_DIR}/user.json"
+  GRADES_FILE = "#{APP_DIR}/grades.json"
+
+  def self.perform
+    current_grades = student.grades.to_json
+    if grades_are_equals?(current_grades)
+      p "Grades have not changed since last checked."
+    else
+      message = "Your grades have been updated!"
+      p message
+      File.write(GRADES_FILE, current_grades)
+      Notifier.new(user_info).sms(message)
+    end
+  end
+
+  def self.student
+    UqamGradeNotification::Student.new(user_info)
+  end
+
+  def self.grades_are_equals?(grades)
+    md5 = Digest::MD5.new
+    md5.hexdigest(grades) == md5.hexdigest(last_grades)
+  end
+
+  def self.last_grades
+    @last_grades ||=
+      if File.exist?(GRADES_FILE)
+        File.open(GRADES_FILE, "rb").read
+      else
+        ""
+      end
+  end
+
+  def self.user_info
+    @user_info ||=
+      if File.exist?(USER_FILE)
+        JSON.parse(File.open(USER_FILE).read)
+      else
+        setup_user_data
+      end
+  end
+
+  def self.setup_user_data
+    unless Dir.exists?(APP_DIR)
+      p "Running first time setup."
+      Dir.mkdir(APP_DIR)
+    end
+
+    cli = HighLine.new
+    code = cli.ask("Code Permanent")
+    password = cli.ask("NIP")
+    phone = cli.ask("Phone Number")
+    twilio_account_id = cli.ask("Twilio Account ID")
+    twilio_token = cli.ask("Twilio Token")
+    twilio_phone = cli.ask("Twilio Phone Number")
+
+    info = {"code" => code, "password" => password, "phone" => phone, "twilio_account_id" => twilio_account_id, "twilio_token" => twilio_token, "twilio_phone" => twilio_phone}
+    File.write(USER_FILE, info.to_json)
+    info
+  end
+end

data/lib/uqam_grade_notification/notifier.rb

@@ -0,0 +1,24 @@
+require 'twilio-ruby'
+
+module UqamGradeNotification
+  class Notifier
+    attr_reader :phone
+
+    def initialize user_info
+      @phone = user_info.fetch("phone")
+      @twilio_account_id = user_info.fetch("twilio_account_id")
+      @twilio_token = user_info.fetch("twilio_token")
+      @twilio_phone = user_info.fetch("twilio_phone")
+    end
+
+    def sms(message)
+      client = Twilio::REST::Client.new @twilio_account_id, @twilio_token
+
+      client.account.messages.create({
+        from: @twilio_phone,
+        to: @phone,
+        body: message
+      })
+    end
+  end
+end

data/lib/uqam_grade_notification/student.rb

@@ -0,0 +1,75 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday-cookie_jar'
+
+module UqamGradeNotification
+  class Student
+    attr_reader :code, :password
+
+    def initialize user_info
+      @code = user_info.fetch("code")
+      @password = user_info.fetch("password")
+    end
+
+    def grades
+      @grades ||= semesters[0..1].map do |semester|
+        courses = semester["programmes"][0]["activites"]
+        courses.map do |course|
+          get_results(course)
+        end
+      end
+    end
+
+    private
+
+    def semesters
+      @semesters ||= connection.get do |req|
+        req.url "/apis/resumeResultat/identifiant"
+        req.headers['Authorization'] = "Bearer #{token}"
+      end.body["data"]["resultats"]
+    end
+
+    def connection
+      Faraday.new(url: "https://portailetudiant.uqam.ca") do |c|
+        c.request :json
+        c.response :json, content_type: /\bjson$/
+        c.use :cookie_jar
+        c.adapter :net_http
+      end
+    end
+
+    def get_results course
+      data = connection.get do |req|
+        req.url "/apis/resultatActivite/identifiant/#{course['trimestre']}/#{course['sigle']}/#{course['groupe']}"
+        req.headers['Authorization'] = "Bearer #{token}"
+      end.body["data"]["resultats"][0]["programmes"][0]["activites"][0]
+
+      {
+        "name" => data["titreActivite"],
+        "note" => data["note"],
+        "evaluations" => data["evaluations"]
+      }
+    end
+
+    def informations
+      @informations ||= connection.get do |req|
+        req.url "/apis/resume/identifiant"
+        req.headers['Authorization'] = "Bearer #{token}"
+      end.body["data"]["resume"]
+    end
+
+    def token
+      @token ||= login.body["token"]
+    end
+
+    def login
+      connection.post do |req|
+        req.url "/authentification"
+        req.headers['Content-Type'] = 'application/json;charset=UTF-8'
+        req.headers['Origin'] = 'https://portailetudiant.uqam.ca'
+        req.headers['Referer'] = 'https://portailetudiant.uqam.ca'
+        req.body = {identifiant: code, motDePasse: password}.to_json
+      end
+    end
+  end
+end

data/lib/uqam_grade_notification/version.rb

@@ -0,0 +1,3 @@
+module UqamGradeNotification
+  VERSION = "0.1.0"
+end

data/uqam_grade_notification.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uqam_grade_notification/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uqam_grade_notification"
+  spec.version       = UqamGradeNotification::VERSION
+  spec.authors       = ["Alexandre Croteau-Pothier"]
+  spec.email         = ["alex@alexcp.com"]
+  spec.homepage      = "https://github.com/alexcp/Uqam-Grade-Notification"
+
+  spec.summary       = %q{Sends notification when notes are added.}
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = ["uqam_grade_notification"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "faraday-cookie_jar"
+  spec.add_dependency "highline"
+  spec.add_dependency "twilio-ruby"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: uqam_grade_notification
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexandre Croteau-Pothier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- alex@alexcp.com
+executables:
+- uqam_grade_notification
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/uqam_grade_notification
+- lib/uqam_grade_notification.rb
+- lib/uqam_grade_notification/notifier.rb
+- lib/uqam_grade_notification/student.rb
+- lib/uqam_grade_notification/version.rb
+- uqam_grade_notification.gemspec
+homepage: https://github.com/alexcp/Uqam-Grade-Notification
+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.4.7
+signing_key: 
+specification_version: 4
+summary: Sends notification when notes are added.
+test_files: []