mooc-data-parser 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23122ed3f4e7051ac6a952ff2adf73eb2baf8272
-  data.tar.gz: 770b789ec3c408141a70f28f7aaaafcb496f0997
+  metadata.gz: b10527539a617caf47b8b4e10a441fa82473d6cb
+  data.tar.gz: 4ea29ecdefc4f79259d488e0ad49af5964a8eedf
 SHA512:
-  metadata.gz: 92d0ed65d8546d19fe4158a75103675700e99b7e7655fb4b0183b275a11e06fc198f1b40efddf3d0982e60593a677b196d9e1e600202f1069c14a3249cf98665
-  data.tar.gz: 82c2cf673b4aa5ec4462e1d86eb4b918372ad3dbe8a9bae078b8a025b16f81ac09ceb2e7415829eff493a1367120e98c5b33b248cb9d78e64a44f84dcdc990f5
+  metadata.gz: f5b3ab28a7cc01efb5b2e6330c56a856babaf4f904ffa058f6b0cd9f55676919e165b458193c92ddfdeb95cf2c8d60b83629660e2158435bdd5f866e97248b50
+  data.tar.gz: 828f9ab0f05d60202b576f2c559ff01b0e826fc8cc0e8b20e017c30ebe3e418cca19d2450dc4a8c8cc20e8eb2944c144a3f49a38b68acfe2f6674c431b9d75ac

data/Readme.md

@@ -1,5 +1,7 @@
 # Mooc Data Parser
 
+[![CodeClimate](https://codeclimate.com/github/jamox/mooc-data-parser.png)](https://codeclimate.com/github/jamox/mooc-data-parser)
+
 ## Installation
 
 Or install it yourself as:
@@ -10,7 +12,7 @@ Scripts made to process some data for our Massive Open Online Courses.
 ## Usage
 
 ```bash
-Usage: show-mooc-details.rb [options]
+Usage: show-mooc-details [options]
     -f, --force                      Reload data from server
     -u, --user username              Show details for user
     -m, --missing-points             Show missing compulsary points
@@ -30,33 +32,33 @@ To get fresh data, use `-f` command line parameter.
 
 Show basic info for applicants
 ```bash
-./show-mooc-data.rb -l
+mooc-data-parser -l
 ```
 
 Show basic info for applicants and percents for each week
 ```bash
-./show-mooc-data.rb -l -c
+mooc-data-parser -l -c
 ```
 
 Show basic info for applicants and missing points
 ```bash
-./show-mooc-data.rb -l -m
+mooc-data-parser -l -m
 ```
 
 Show basic info for applicants and percents for each week and missing points
 ```bash
-./show-mooc-data.rb -l -c -m
+mooc-data-parser -l -c -m
 ```
 
 Find info about a user
 * by email:
 ```bash
-./show-mooc-data.rb -e <email>
+mooc-data-parser -e <email>
 ```
 
 * by username:
 ```bash
-./show-mooc-data.rb -u <username>
+mooc-data-parser -u <username>
 ```
 
 Flags `-c` and `-l` can be used with these too.

data/lib/mooc_data_parser.rb

@@ -1,11 +1,9 @@
-require "mooc_data_parser/app"
 require "mooc_data_parser/dummy_cacher"
+require "mooc_data_parser/app"
+require "mooc_data_parser/auth_coordinator"
+require "mooc_data_parser/options_parser_logic"
+require "mooc_data_parser/data_downloader"
 require "mooc_data_parser/version"
 module MoocDataParser
-    require 'optparse'
-    require 'ostruct'
-    require 'httparty'
-    require 'json'
-    require 'io/console'
 end
 

data/lib/mooc_data_parser/app.rb

@@ -0,0 +1,220 @@
+module MoocDataParser
+  require 'json'
+  class App
+
+    def run(args)
+      init_variables()
+      parse_options(args)
+      decide_what_to_do(maybe_fetch_json())
+      $cache.write_file_to_cache('data.json', @notes.to_json)
+    end
+
+    def decide_what_to_do(json)
+      if @options.user
+        show_info_about(@options.user, 'username', json)
+      elsif @options.user_email
+        show_info_about(@options.user_email, 'email', json)
+      elsif @options.user_tmc_username
+        show_info_about(@options.user_tmc_username, 'username', json)
+      elsif @options.list
+        list_and_filter_participants(json)
+      else
+        $cache.write_file_to_cache('data.json', @notes.to_json)
+        puts @opt
+        abort
+      end
+    end
+
+    def init_variables
+      $cache ||= MoocDataParser::DummyCacher.new
+      @notes = begin JSON.parse($cache.read_file_from_cache('data.json')) rescue  {} end
+    end
+
+    def parse_options(args)
+      @options, @opt = MoocDataParser::OptionsParserLogic.new(args).parse
+    end
+
+    def maybe_fetch_json()
+      if @options.reload or @notes['user_info'].nil? or @notes['week_data'].nil?
+        download_data()
+      else
+        {participants: @notes['user_info'].clone, week_data: @notes['week_data'].clone}
+      end
+    end
+
+    def download_data
+      MoocDataParser::DataDownloader.new(@notes).download!
+    end
+
+    def show_info_about(user, user_field = 'username', json)
+      participants = json[:participants]
+      week_data = json[:week_data]
+      my_user = participants.find{|a| a[user_field] == user }
+
+      abort "User not found" if my_user.nil?
+
+      show_user_print_basic_info(my_user)
+      show_user_print_completion_percentage(my_user, week_data, participants)  if @options.show_completion_percentige
+      show_user_print_missing_points(my_user, week_data) if @options.show_missing_compulsory_points
+    end
+
+    def show_user_print_basic_info(my_user)
+      formatted_print_user_details ["Username", my_user['username']]
+      formatted_print_user_details ["Email", my_user['email']]
+      formatted_print_user_details ["Hakee yliopistoon", my_user['hakee_yliopistoon_2014']]
+      formatted_print_user_details ["Koko nimi", my_user['koko_nimi']]
+    end
+
+    def show_user_print_missing_points(my_user, week_data)
+      formatted_print_user_details ["Compulsory points"]
+      get_points_info_for_user(my_user, week_data).each do |k,v|
+        formatted_print_user_details [k, v.join(", ")]
+      end
+    end
+
+    def show_user_print_completion_percentage(my_user, week_data, participants)
+      formatted_print_user_details ["Points per week"]
+      done_exercise_percents(my_user, participants).each do |k|
+        begin
+          k = k.first
+          formatted_print_user_details [k[0], k[1]]
+        rescue
+          nil
+        end
+      end
+    end
+
+    def formatted_print_user_details(details)
+      case details.size
+      when 1
+        puts "%18s" % details
+      when 2
+        puts "%18s: %-20s" % details
+      end
+    end
+
+
+    def wanted_fields
+      %w(username email koko_nimi)
+    end
+
+    def list_and_filter_participants(json)
+      participants = json[:participants]
+      week_data = json[:week_data]
+      everyone_in_course = participants.size
+      only_applying!(participants)
+      hakee_yliopistoon = participants.size
+
+      print_headers()
+      process_participants(participants, week_data)
+      print_list_stats(everyone_in_course, hakee_yliopistoon)
+    end
+
+    def print_headers
+      puts "%-20s %-35s %-25s %-120s" % ["Username", "Email", "Real name", "Missing points"]
+      puts '-'*200
+    end
+
+    def print_list_stats(everyone_in_course, hakee_yliopistoon)
+      puts "\n"
+      puts "Stats: "
+      puts "%25s: %4d" % ["Kaikenkaikkiaan kurssilla", everyone_in_course]
+      puts "%25s: %4d" % ["Hakee yliopistoon", hakee_yliopistoon]
+    end
+
+    def process_participants(participants, week_data)
+      participants.each do |participant|
+        nice_string_in_array = wanted_fields.map do |key|
+          participant[key]
+        end
+
+        to_be_printed = "%-20s %-35s %-25s "
+
+        maybe_add_extra_fields(nice_string_in_array, to_be_printed, participants, participant, week_data)
+
+        puts to_be_printed % nice_string_in_array
+      end
+    end
+
+    def maybe_add_extra_fields(nice_string_in_array, to_be_printed, participants, participant, week_data)
+      if @options.show_completion_percentige
+        nice_string_in_array << format_done_exercises_percents(done_exercise_percents(participant, participants))
+        to_be_printed << "%-180s "
+      end
+      if @options.show_missing_compulsory_points
+        nice_string_in_array << missing_points_to_list_string(get_points_info_for_user(participant, week_data))
+        to_be_printed << "%-120s"
+      end
+    end
+
+    def format_done_exercises_percents(hash)
+      hash.map do |k|
+        begin
+          k = k.first
+          "#{k[0].scan(/\d+/).first}: #{k[1]}"
+        rescue
+          nil
+        end
+      end.compact.join(", ")
+    end
+
+    def done_exercise_percents(participant, participants_data)
+      user_info = participants_data.find{ |p| p['username'] == participant['username'] }
+      map_week_keys(user_info)
+    end
+
+    def week_keys
+      (1..12).map{|i| "viikko#{i}"}
+    end
+
+    def map_week_keys(user_info)
+      exercise_weeks = user_info['groups']
+      week_keys.map do |week|
+        details = exercise_weeks[week]
+        unless details.nil?
+          {week => ("%3.1f%" % [(details['points'].to_f / details['total'].to_f) * 100])}
+        end
+      end
+    end
+
+    def missing_points_to_list_string(missing_by_week)
+      str = ""
+      missing_by_week.keys.each do |week|
+        missing = missing_by_week[week]
+        unless missing.nil? or missing.length == 0
+          str << week
+          str << ": "
+          str << missing.join(",")
+          str << "  "
+        end
+      end
+
+      str
+    end
+
+    def compulsory_exercises
+      # TODO: täydennä data viikolle 12
+      {'6' => %w(102.1 102.2 102.3 103.1 103.2 103.3), '7' => %w(116.1 116.2 116.3), '8' => %w(124.1 124.2 124.3 124.4),
+       '9' => %w(134.1 134.2 134.3 134.4 134.5), '10' => %w(141.1 141.2 141.3 141.4), '11' => %w(151.1 151.2 151.3 151.4), '12' => %w()}
+    end
+
+    def get_points_info_for_user(participant, week_data)
+      points_by_week = week_data.keys.each_with_object({}) do |week, points_by_week|
+        points_by_week[week] = week_data[week][participant['username']]
+      end
+
+      points_by_week.keys.each_with_object({})  do |week, missing_by_week|
+        weeks_points = points_by_week[week] || [] #palauttaa arrayn
+        weeks_compulsory_points = compulsory_exercises[week] || []
+        missing_by_week[week] = weeks_compulsory_points - weeks_points
+      end
+    end
+
+    def only_applying!(participants)
+      participants.select! do |participant|
+        participant['hakee_yliopistoon_2014']
+      end
+    end
+
+  end
+end

data/lib/mooc_data_parser/auth_coordinator.rb

@@ -0,0 +1,15 @@
+module MoocDataParser
+  require 'io/console'
+  class AuthCoordinator
+
+    def auth
+      print 'username: '
+      username = $stdin.gets.strip
+      print 'password: '
+      password = $stdin.noecho(&:gets).strip
+      puts
+      {username: username, password: password}
+    end
+
+  end
+end

data/lib/mooc_data_parser/data_downloader.rb

@@ -0,0 +1,49 @@
+
+module MoocDataParser
+  require 'httparty'
+  require 'json'
+  class DataDownloader
+
+    def initialize(notes)
+      @notes = notes
+    end
+
+    def download!
+      auth = get_auth()
+      thread = get_process_thread()
+      url = "http://tmc.mooc.fi/mooc/participants.json?api_version=7&utf8=%E2%9C%93&filter_koko_nimi=&column_username=1&column_email=1&column_koko_nimi=1&column_hakee_yliopistoon_2014=1&group_completion_course_id=18"
+      user_info = JSON.parse(HTTParty.get(url, basic_auth: auth).body)['participants']
+      week_data = fetch_week_datas(auth)
+      @notes['user_info'] = user_info.clone
+      @notes['week_data'] = week_data.clone
+      thread.kill
+      puts
+      {participants: user_info, week_data: week_data}
+    end
+
+    def get_auth
+      AuthCoordinator.new.auth
+    end
+
+    def get_process_thread
+      t = -> do
+        loop do
+          print '.'
+          sleep 0.5
+        end
+      end
+      Thread.new(&t)
+    end
+
+    def fetch_week_datas(auth)
+      base_url = "http://tmc.mooc.fi/mooc/courses/18/points/"
+      weeks = %w(1 2 3 4 5 6 7 8 9 10 11 12)
+      rest = ".json?api_version=7"
+      week_data = {}
+      weeks.each do |week|
+        week_data[week] = JSON.parse(HTTParty.get(base_url + week + rest, basic_auth: auth).body)['users_to_points']
+      end
+      week_data
+    end
+  end
+end

data/lib/mooc_data_parser/options_parser_logic.rb

@@ -0,0 +1,45 @@
+module MoocDataParser
+  require 'optparse'
+  require 'ostruct'
+  class OptionsParserLogic
+
+    def initialize(args)
+      @args = args
+    end
+
+    def parse
+      options = OpenStruct.new
+      opt = OptionParser.new do |opts|
+        opts.banner = "Usage: show-mooc-details.rb [options]"
+
+        opts.on("-f", "--force", "Reload data from server") do |v|
+          options.reload = true
+        end
+        opts.on("-u", "--user username", "Show details for user") do |v|
+          options.user = v
+        end
+        opts.on("-m", "--missing-points", "Show missing compulsary points") do |v|
+          options.show_missing_compulsory_points = true
+        end
+        opts.on("-c", "--completion-precentige", "Show completition percentige") do |v|
+          options.show_completion_percentige = true
+        end
+        opts.on("-e", "--email emailaddress", "Show details for user") do |v|
+          options.user_email = v
+        end
+        opts.on("-t", "--tmc-account tmc-account", "Show details for user") do |v|
+          options.user_tmc_username = v
+        end
+        opts.on("-l", "--list", "Show the basic list") do |v|
+          options.list = true
+        end
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+      end
+      opt.parse!(@args)
+      [options, opt]
+    end
+  end
+end

data/lib/mooc_data_parser/version.rb

@@ -1,3 +1,3 @@
 module MoocDataParser
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mooc-data-parser
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jarmo Isotalo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -67,8 +67,11 @@ files:
 - Readme.md
 - bin/mooc-data-parser
 - lib/mooc_data_parser.rb
-- lib/mooc_data_parser/App.rb
+- lib/mooc_data_parser/app.rb
+- lib/mooc_data_parser/auth_coordinator.rb
+- lib/mooc_data_parser/data_downloader.rb
 - lib/mooc_data_parser/dummy_cacher.rb
+- lib/mooc_data_parser/options_parser_logic.rb
 - lib/mooc_data_parser/version.rb
 - mooc-data-parser.gemspec
 homepage: https://github.com/jamox/mooc-data-parser

data/lib/mooc_data_parser/App.rb

@@ -1,257 +0,0 @@
-#!/usr/bin/env ruby -w
-module MoocDataParser
-  require 'optparse'
-  require 'ostruct'
-  require 'httparty'
-  require 'json'
-  require 'io/console'
-  class App
-    def run(args)
-      $cache ||= MoocDataParser::DummyCacher.new
-      @notes = begin JSON.parse($cache.read_file_from_cache('data.json')) rescue  {} end
-
-      @options = OpenStruct.new
-      opt = OptionParser.new do |opts|
-        opts.banner = "Usage: show-mooc-details.rb [options]"
-
-        opts.on("-f", "--force", "Reload data from server") do |v|
-          @options.reload = true
-        end
-        opts.on("-u", "--user username", "Show details for user") do |v|
-          @options.user = v
-        end
-        opts.on("-m", "--missing-points", "Show missing compulsary points") do |v|
-          @options.show_missing_compulsory_points = true
-        end
-        opts.on("-c", "--completion-precentige", "Show completition percentige") do |v|
-          @options.show_completion_percentige = true
-        end
-        opts.on("-e", "--email emailaddress", "Show details for user") do |v|
-          @options.user_email = v
-        end
-        opts.on("-t", "--tmc-account tmc-account", "Show details for user") do |v|
-          @options.user_tmc_username = v
-        end
-        opts.on("-l", "--list", "Show the basic list") do |v|
-          @options.list = true
-        end
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          exit
-        end
-      end
-      opt.parse!(args)
-
-      json = maybe_fetch_json()
-      if @options.user
-        show_info_about(@options.user, 'username', json)
-      elsif @options.user_email
-        show_info_about(@options.user_email, 'email', json)
-      elsif @options.user_tmc_username
-        show_info_about(@options.user_tmc_username, 'username', json)
-      elsif @options.list
-        list_and_filter_participants(json)
-      else
-        $cache.write_file_to_cache('data.json', @notes.to_json)
-        puts opt
-        abort
-      end
-      $cache.write_file_to_cache('data.json', @notes.to_json)
-    end
-
-    def get_auth
-      print 'username: '
-      username = $stdin.gets.strip
-      print 'password: '
-      password = $stdin.noecho(&:gets).strip
-      puts
-      {username: username, password: password}
-    end
-
-    def maybe_fetch_json()
-      if @options.reload or @notes['user_info'].nil? or @notes['week_data'].nil?
-
-        t = -> do
-          loop do
-            print '.'
-            sleep 0.5
-          end
-          puts
-        end
-
-        auth = get_auth()
-        th = Thread.new(&t)
-
-        url = "http://tmc.mooc.fi/mooc/participants.json?api_version=7&utf8=%E2%9C%93&filter_koko_nimi=&column_username=1&column_email=1&column_koko_nimi=1&column_hakee_yliopistoon_2014=1&group_completion_course_id=18"
-        user_info = JSON.parse(HTTParty.get(url, basic_auth: auth).body)['participants']
-        week_data = fetch_week_datas(auth)
-        @notes['user_info'] = user_info.clone
-        @notes['week_data'] = week_data.clone
-        th.kill
-        puts
-        {participants: user_info, week_data: week_data}
-      else
-        {participants: @notes['user_info'].clone, week_data: @notes['week_data'].clone}
-      end
-    end
-
-    def show_info_about(user, user_field = 'username', json)
-      participants = json[:participants]
-      week_data = json[:week_data]
-      my_user = participants.find{|a| a[user_field] == user }
-      if my_user.nil?
-        abort "User not found"
-      end
-      formatted_print_user_details ["Username", my_user['username']]
-      formatted_print_user_details ["Email", my_user['email']]
-      formatted_print_user_details ["Hakee yliopistoon", my_user['hakee_yliopistoon_2014']]
-      formatted_print_user_details ["Koko nimi", my_user['koko_nimi']]
-
-      if @options.show_completion_percentige
-        formatted_print_user_details ["Points per week"]
-        done_exercise_percents(my_user, participants).each do |k|
-          begin
-            k = k.first
-            formatted_print_user_details [k[0], k[1]]
-          rescue
-            nil
-          end
-        end
-      end
-
-      if @options.show_missing_compulsory_points
-        formatted_print_user_details ["Compulsory points"]
-        get_points_info_for_user(my_user, week_data).each do |k,v|
-          formatted_print_user_details [k, v.join(", ")]
-        end
-      end
-
-    end
-
-    def formatted_print_user_details(details)
-      case details.size
-      when 1
-        puts "%18s" % details
-      when 2
-        puts "%18s: %-20s" % details
-      end
-    end
-
-    def fetch_week_datas(auth)
-      base_url = "http://tmc.mooc.fi/mooc/courses/18/points/"
-      weeks = %w(1 2 3 4 5 6 7 8 9 10 11 12)
-      rest = ".json?api_version=7"
-      week_data = {}
-      weeks.each do |week|
-        week_data[week] = JSON.parse(HTTParty.get(base_url + week + rest, basic_auth: auth).body)['users_to_points']
-      end
-      week_data
-    end
-
-    def list_and_filter_participants(json)
-      wanted_fields = %W(username email koko_nimi)
-
-      participants = json[:participants]
-      week_data = json[:week_data]
-      everyone_in_course = participants.size
-      only_applying!(participants)
-      hakee_yliopistoon = participants.size
-
-      puts "%-20s %-35s %-25s %-120s" % ["Username", "Email", "Real name", "Missing points"]
-      puts '-'*200
-      participants.each do |participant|
-        nice_string_in_array = wanted_fields.map do |key|
-          participant[key]
-        end
-        if @options.show_completion_percentige
-          nice_string_in_array << format_done_exercises_percents(done_exercise_percents(participant, participants))
-        end
-        if @options.show_missing_compulsory_points
-          nice_string_in_array << missing_points_to_list_string(get_points_info_for_user(participant, week_data))
-        end
-
-
-        to_be_printed = "%-20s %-35s %-25s "
-        to_be_printed << "%-180s " if @options.show_completion_percentige
-        to_be_printed << "%-120s" if @options.show_missing_compulsory_points
-
-        puts to_be_printed % nice_string_in_array
-      end
-
-      puts
-      puts
-      puts "Stats: "
-      puts "%25s: %4d" % ["Kaikenkaikkiaan kurssilla", everyone_in_course]
-      puts "%25s: %4d" % ["Hakee yliopistoon", hakee_yliopistoon]
-
-    end
-
-
-    def format_done_exercises_percents(hash)
-      hash.map do |k|
-        begin
-          k = k.first
-          "#{k[0].scan(/\d+/).first}: #{k[1]}"
-        rescue
-          nil
-        end
-      end.compact.join(", ")
-    end
-
-
-    def done_exercise_percents(participant, participants_data)
-      user_info = participants_data.find{ |p| p['username'] == participant['username'] }
-      exercise_weeks = user_info['groups']
-      week_keys = (1..12).map{|i| "viikko#{i}"}
-
-      week_keys.map do |week|
-        details = exercise_weeks[week]
-        unless details.nil?
-          {week => ("%3.1f%" % [(details['points'].to_f / details['total'].to_f) * 100])}
-        end
-      end
-    end
-
-    def missing_points_to_list_string(missing_by_week)
-      str = ""
-      missing_by_week.keys.each do |week|
-        missing = missing_by_week[week]
-        unless missing.nil? or missing.length == 0
-          str << week
-          str << ": "
-          str << missing.join(",")
-          str << "  "
-        end
-      end
-
-      str
-
-    end
-
-    def get_points_info_for_user(participant, week_data)
-      # TODO: täydennä data viikolle 12
-      compulsory_exercises = {'6' => %w(102.1 102.2 102.3 103.1 103.2 103.3), '7' => %w(116.1 116.2 116.3), '8' => %w(124.1 124.2 124.3 124.4),
-                              '9' => %w(134.1 134.2 134.3 134.4 134.5), '10' => %w(141.1 141.2 141.3 141.4), '11' => %w(151.1 151.2 151.3 151.4), '12' => %w()}
-      points_by_week = {}
-      week_data.keys.each do |week|
-        points_by_week[week] = week_data[week][participant['username']]
-      end
-
-
-      missing_by_week = {}
-      points_by_week.keys.each  do |week|
-        weeks_points = points_by_week[week] || [] #palauttaa arrayn
-        weeks_compulsory_points = compulsory_exercises[week] || []
-        missing_by_week[week] = weeks_compulsory_points - weeks_points
-      end
-
-      missing_by_week
-    end
-
-    def only_applying!(participants)
-      participants.select! do |participant|
-        participant['hakee_yliopistoon_2014']
-      end
-    end
-  end
-end