uqam_grade_notification 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d776bac3ff844092ffe619f32226988cc2389c39
-  data.tar.gz: eb0ea4227c447a377303dd19ca56f54e0279221e
+  metadata.gz: d9e1f1a5c003b5f71c81c10f79096dabb6448898
+  data.tar.gz: c9885635447fe35996a2a55689a72fdab0400ef2
 SHA512:
-  metadata.gz: f105722f235b52a46aed418790c4330929010cccdf3ca7d381c8f3c6f2f9c5c5c3cadf5666cd3bd656a7367913b40c27ad3dd81856e0ed54d3dda01db121806c
-  data.tar.gz: e1a9eb0dd54b96b08c1d30df5a96f3efd5f6464310a319266351a726bd85b4b0cd4a98f4a71f948349fafc19093054047e559b0d9c4eae9ec2f435cd48abcf1e
+  metadata.gz: 0d0bce3c4ebe50f302b5672cb766bd2b1823c1fb5adf3c6b6b0899948ee65ba3631b4bb372d960abf5d8a49081a275176dc0ae011a8b10549ee4061883a6a1ca
+  data.tar.gz: 6c8041bc2a95ee3304b302ac549c95872814a7936b3bfa739f44229bf06c48fac92dc85a55af848f53e4e23f49a116f8e48872a0235c2d5be03b73b1e00dd947

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-version

data/exe/uqam_grade_notification

@@ -1,5 +1,37 @@
 #!/usr/bin/env ruby
 
 require 'uqam_grade_notification'
+require 'optparse'
 
-UqamGradeNotification.perform
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: uqam_grade_notification [options]"
+
+  opts.on("-v", "--version", "Show version") do
+    p UqamGradeNotification::VERSION
+    exit
+  end
+
+  opts.on("-c", "--configure", "Set configuration options") do
+    p "Configuring Uqam Grade Notification"
+    UqamGradeNotification.configuration_cli
+    exit
+  end
+
+  opts.on("-h", "--help", "Show this message") do
+    p "Configuration is saved in #{UqamGradeNotification::APP_DIR}"
+    puts opts
+    exit
+  end
+end.parse!
+
+configuration =
+  if File.exist?(UqamGradeNotification::CONFIG_FILE)
+    JSON.parse(File.open(UqamGradeNotification::CONFIG_FILE).read)
+  else
+    configuration_cli
+  end
+
+student = UqamGradeNotification::Student.new(configuration)
+notifier = UqamGradeNotification::Notifier.new(configuration)
+UqamGradeNotification.new(student, notifier).notify_of_changes

data/lib/uqam_grade_notification/client.rb

@@ -0,0 +1,36 @@
+module UqamGradeNotification
+  class Client
+    attr_reader :student, :notifier, :storage
+
+    def initialize(student, notifier, storage)
+      @student = student
+      @notifier = notifier
+      @storage = storage
+    end
+
+    def notify_of_changes
+      current_grades = student.grades.to_json
+      if grades_have_changed?
+        p "Grades have not changed since last checked."
+      else
+        message = "Your grades have been updated!"
+        p message
+        save_student_grades
+        notifier.sms(message)
+      end
+    end
+
+    def grades_have_changed?
+      md5 = Digest::MD5.new
+      md5.hexdigest(student.grades.to_json) == md5.hexdigest(student_last_grades.to_json)
+    end
+
+    def student_last_grades
+      @last_grades ||= storage.last_grades(student)
+    end
+
+    def save_student_grades
+      storage.save_grades(student)
+    end
+  end
+end

data/lib/uqam_grade_notification/storage.rb

@@ -0,0 +1,35 @@
+module UqamGradeNotification
+  class Storage
+    extend Forwardable
+    def_delegators :@storage, :last_grades, :save_grades
+
+    def initialize(storage=LocalStorage.new)
+      @storage = storage
+    end
+
+    class LocalStorage
+      attr_reader :base_path
+      def initialize(base_path=UqamGradeNotification::APP_DIR)
+        @base_path = base_path
+      end
+
+      def last_grades(student)
+        if File.exist?(grade_file(student))
+          JSON.parse File.open(grade_file(student), "rb").read
+        else
+          ""
+        end
+      end
+
+      def save_grades(student)
+        File.write(grade_file(student), student.grades.to_json)
+      end
+
+      private
+
+      def grade_file(student)
+        "#{base_path}/#{student.code}_grades.json"
+      end
+    end
+  end
+end

data/lib/uqam_grade_notification/student.rb

@@ -33,6 +33,7 @@ module UqamGradeNotification
       Faraday.new(url: "https://portailetudiant.uqam.ca") do |c|
         c.request :json
         c.response :json, content_type: /\bjson$/
+        c.use Faraday::Response::RaiseError
         c.use :cookie_jar
         c.adapter :net_http
       end

data/lib/uqam_grade_notification/version.rb

@@ -1,3 +1,3 @@
 module UqamGradeNotification
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/uqam_grade_notification.rb

@@ -5,67 +5,42 @@ require 'digest'
 require 'uqam_grade_notification/version'
 require 'uqam_grade_notification/student'
 require 'uqam_grade_notification/notifier'
+require 'uqam_grade_notification/client'
+require 'uqam_grade_notification/storage'
 
 module UqamGradeNotification
   APP_DIR = "#{ENV["HOME"]}/.uqam_grade_notification"
-  USER_FILE = "#{APP_DIR}/user.json"
-  GRADES_FILE = "#{APP_DIR}/grades.json"
+  CONFIG_FILE = "#{APP_DIR}/user.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)
+  class << self
+    def new(student, notifier, storage=UqamGradeNotification::Storage.new)
+      Client.new(student, notifier, storage)
     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
-        ""
+    def configuration_cli
+      unless Dir.exists?(APP_DIR)
+        p "Running first time setup."
+        Dir.mkdir(APP_DIR)
       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)
+      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(CONFIG_FILE, info.to_json)
+      info
     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

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: uqam_grade_notification
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexandre Croteau-Pothier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-10 00:00:00.000000000 Z
+date: 2016-01-12 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: 
@@ -130,9 +130,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,7 +141,9 @@ files:
 - bin/setup
 - exe/uqam_grade_notification
 - lib/uqam_grade_notification.rb
+- lib/uqam_grade_notification/client.rb
 - lib/uqam_grade_notification/notifier.rb
+- lib/uqam_grade_notification/storage.rb
 - lib/uqam_grade_notification/student.rb
 - lib/uqam_grade_notification/version.rb
 - uqam_grade_notification.gemspec
@@ -156,17 +158,17 @@ require_paths:
 - lib/uqam_grade_notification
 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.0.14
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Sends notification when notes are added.