haiku_grades 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdbd73188250edd455c807d94da8e130c6b4b41b
+  data.tar.gz: a6859d26ec24d7175f30ec333ae912f971331d92
+SHA512:
+  metadata.gz: dd0dcc3bddbe411c27b820faa1cd5bf6db13182e191227b9c57599013ce9c4bccb4d75a239ab9a64aec546cee481c2406b2face73935a03edbdb3a49b8fc8ef4
+  data.tar.gz: cba863912853fda1c038722ec927a664bc62656437dc64763cfe38c04308f994082e1fde826a0b1bddd7b3c9d4226348787415592e7e0c0afb0463e91b967963

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+config/*.yml
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem "hapi-client", git: "git@github.com:haikulearning/hapi-client.git"

data/README.md

@@ -0,0 +1,59 @@
+# Haiku Grades
+
+This Ruby Gem allows you to connect to your Haiku Learning domain and export grades for a specific teacher into csv format.
+
+## Installation
+
+Add this line to your Application's Gemfile:
+
+`gem 'haiku_grades'`
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install haiku_grades`
+
+## Usage
+
+Rename the authentication.yml.sample file to authentication.yml, adding in your domain's details, before running.
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## History
+
+TODO: Write history
+
+## Credits
+
+TODO: Write credits
+
+## License
+
+Copyright (c) 2015 Haiku Learning
+
+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/class_list.csv

@@ -0,0 +1,3 @@
+id,name,code,term,year,end_date,shortname,start_date,description,for_student_only,term_schedule_id,external_id,portal_color_selected,portal_color_unselected,allow_student_to_student_messages,teacher,sections,links
+5198679,Intro to English,ENG101,,2015-2016,,introtoenglish,,An Introduction to English,true,,eng101-2015,#bf3232,#e53939,false,"{""id""=>8974365, ""login""=>""andrew"", ""email""=>""Andrew@examplevillehs.com"", ""enabled""=>true, ""last_name""=>""Newman"", ""full_name""=>""Sketch Newman"", ""user_type""=>""Teacher"", ""domain_id""=>5677, ""display_id""=>""S233"", ""first_name""=>""Andrew"", ""avatar_url""=>""https://www.myhaikuclass.com/images/haiku_avatar_4.png"", ""display_login""=>""andrew"", ""time_zone_name""=>""Eastern Time (US & Canada)"", ""google_email_address""=>"""", ""external_id""=>""23986"", ""grade_levels""=>[]}",[],"[{""rel""=>""web_ui"", ""href""=>""https://no-real-data.haikulearning.com/andrew/introtoenglish""}]"
+5401925,Intro to English - Manually Added,"",,2015-2016,,introtoenglish-manuallyadded,,"",true,,,#bfab32,#ccba33,false,"{""id""=>8974365, ""login""=>""andrew"", ""email""=>""Andrew@examplevillehs.com"", ""enabled""=>true, ""last_name""=>""Newman"", ""full_name""=>""Sketch Newman"", ""user_type""=>""Teacher"", ""domain_id""=>5677, ""display_id""=>""S233"", ""first_name""=>""Andrew"", ""avatar_url""=>""https://www.myhaikuclass.com/images/haiku_avatar_4.png"", ""display_login""=>""andrew"", ""time_zone_name""=>""Eastern Time (US & Canada)"", ""google_email_address""=>"""", ""external_id""=>""23986"", ""grade_levels""=>[]}","[{""id""=>1320339, ""grouping_id""=>298266, ""name""=>""A""}, {""id""=>1320340, ""grouping_id""=>298266, ""name""=>""B""}]","[{""rel""=>""web_ui"", ""href""=>""https://no-real-data.haikulearning.com/andrew/introtoenglish-manuallyadded""}]"

data/config/authentication.yml.sample

@@ -0,0 +1,5 @@
+# Edit this file to enter your details
+
+haikugrades:
+	domain: no-real-data.haikulearning.com
+	api_key: 05378d310dc85a492df2200be254be7f # Replace this with your API key found in Manage Domain -> Settings -> Import API

data/entries_.csv

@@ -0,0 +1,2 @@
+id,points,user_id,comment,finalized,created_at,updated_at,sticky_note,entered_score,displayed_percent_score,displayed_score,displayed_points,displayed_letter_notation,eclass_user_id,gradebook_entry_id,special_score_notation_id
+88246478,98.0,8974327,,,2015-08-13T18:59:32Z,2015-08-13T18:59:32Z,,98.00,98.00,98.00,,A,147908846,6150046,

data/haiku_grades.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'haiku_grades/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "haiku_grades"
+  spec.version       = HaikuGrades::VERSION
+  spec.authors       = ["Sam"]
+  spec.email         = ["samf@haikulearning.com"]
+  spec.summary       = %q{Pulls grades and exports them from a teacher within a Haiku Learning domain.}
+  spec.description   = %q{Pulls grades and exports them from a teacher within a Haiku Learning domain.}
+  spec.homepage      = "http://rubygems.org/gems/haiku_grades"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'rubocop'
+  spec.add_dependency 'hapi-client' # , git: 'git@github.com:haikulearning/hapi-client.git'
+  spec.add_dependency 'highline'
+end

data/lib/class_export.rb

@@ -0,0 +1,27 @@
+class ClassExport
+  def self.class_list(client)
+    hash = client.user.eclasses_teaching['items']
+
+    # Pulls just the keys of the hash (the first values) to be used as
+    # column names
+    column_names = hash.first.keys
+
+    # Sets variable s to be a CSV, starts a loop
+    s = CSV.generate do |csv|
+      # For each item csv, adds a row (which is what '<<' does) with
+      # column_names (so one row)
+      csv << column_names
+      # For each item in hash (which is the list above that contains items
+      # within the classes the user teaches)
+      hash.each do |x|
+        # Add the values (remember, key-value pair in a hash) to a new row
+        # underneath the column headers
+        csv << x.values
+      end
+    end
+    # Writes the data (s) to a new file called "data.csv"
+    File.write('class_list.csv', s)
+    puts 'List exported to working directory.'
+    puts ''
+  end
+end

data/lib/full_grade.rb

@@ -0,0 +1,36 @@
+class FullGrade
+
+  def self.full_list(client)
+    entries_columns = ''
+    gradebook_entries = ''
+    class_selection = ''
+    client.user.eclasses_teaching['items'].each do |eclass|
+      # Starts a loop to go through each element of the "items" hash within the client.user.eclasses_teaching method in the API
+      client.user.eclasses_teaching['items'].each do |eclass|
+        # Sets variable gradebooks equal to all gradebooks, accepts argument that says the eclass_id is equal to an "id" within "items" - in other words, it loops through and grabs gradebooks from each class belonging to the user
+        gradebooks = client.gradebooks.all(eclass_id: eclass['id'])
+        # Now that we have a list of gradebooks from all classes, go through the items hash in those gradebooks
+        gradebooks['items'].each do |gradebook|
+          # And, for each one, define entries within
+          gradebook_entries = client.gradebooks.entries(eclass_id: eclass['id'], gradebook_id: gradebook['id'], include_scores: true)
+          # Now we want to go through each entry and look int he items hash
+          gradebook_entries['items'].each do |entry|
+            # And we want to define columns (for use in a csv) as the keys for gradebook_entries - items, in the first array, then in the gradebook_entry_scores hash, then in the first array within that hash (since we just need column names)
+            entries_columns = gradebook_entries['items'][0]['gradebook_entry_scores'][0].keys
+          end
+        end
+      end
+    # Now, we need to make a csv for entries - we are using the shortname of the class to name the file so the same file is not overwritten each time,
+    # instead, a new file is created for each class
+    CSV.open("entries_.csv", 'wb') do |csv|
+      # Add a row for the column names defined above
+      csv << entries_columns
+      gradebook_entries['items'].each do |y|
+        y['gradebook_entry_scores'].each do |y|
+          csv << y.values
+        end
+      end
+    end
+  end
+end
+end

data/lib/haiku_grades/version.rb

@@ -0,0 +1,3 @@
+module HaikuGrades
+  VERSION = "0.0.1"
+end

data/lib/haiku_grades.rb

@@ -0,0 +1,87 @@
+$LOAD_PATH << '.'
+
+require 'hapi-client'
+require 'csv'
+require 'highline/import'
+require 'yaml'
+require_relative 'full_grade'
+require_relative 'partial_grade'
+require_relative 'class_export'
+
+# Authentication information
+# USERNAME = 'andrew'
+# PASSWORD = 'test1234'
+
+# Commenting out for testing purposes
+# puts "Enter your domain URL without www or https://
+# (for example, test.haikulearning.com)"
+# input_domain = gets.chomp
+
+# puts "What is your API key?"
+# input_apikey = gets.chomp
+
+class HaikuGrades
+  
+attr_writer :config
+
+		def initialize
+			# path can be either from root or for debugging from the curent class
+			if File.exists?('../../config/authentication.yml')
+				@config = YAML.load(File.open('../../config/authentication.yml'))
+			elsif File.exists?('./config/authentication.yml')
+				@config = YAML.load(File.open('./config/authentication.yml'))
+			else
+				raise StandardError, 'Cannot find configuration file.  Please make sure you have edited authentication.yml.'
+			end
+		end
+    
+input_domain = @config['haikugrades']['domain']
+input_apikey = @config['haikugrades']['api_key']
+
+puts 'What is your Haiku Learning username?'
+input_username = gets.chomp
+
+input_password = ask('What is your Haiku Learning password? ' + "\n") { |q| q.echo = false }
+
+begin
+  # Instantiate a client using the information above
+  client = HapiClient::Client.new(api_key: input_apikey,
+                                  base_endpoint: "https://#{input_domain}", debug: 'true')
+rescue
+  raise 'You entered an incorrect API key or domain name - please try again!'
+end
+
+begin
+  # Login as a single user
+  session = client.login_as(username: input_username,
+                            password: input_password)
+rescue
+  raise 'You entered an incorrect username or password - please try again!' if session.nil?
+end
+
+puts 'Would you like a list of your classes exported to csv? (y/n)'
+export = gets.chomp
+if export == 'y'
+  ClassExport.class_list(client)
+else
+  puts ''
+end
+
+# Ask user which class they want grades for
+puts "Your classes are: " + "\n"
+client.user.eclasses_teaching['items'].each do |eclass|
+  puts "#{eclass['name']}" + " : #{eclass['id']} (id)"
+end
+
+puts ""
+puts "Please enter the id of the class whose grade entries you'd like exported to CSV.  If you'd like all classes, simply type 'all', without the single quotation marks."
+class_selection = gets.chomp
+
+if class_selection == 'all'
+  FullGrade.full_list(client)
+else
+  PartialGrade.partial_list(class_selection, client)
+end
+
+puts 'Ran successfully.'
+end

data/lib/partial_grade.rb

@@ -0,0 +1,37 @@
+class PartialGrade
+  
+  def self.partial_list(class_selection, client)
+    entries_columns = ''
+    gradebook_entries = ''
+    # class_selection = ''
+    # partial_list - eventually will just be a method
+    # client.user.eclasses_teaching["items"].each do |eclass|
+    # Starts a loop to go through each element of the "items"
+    # hash within the client.user.eclasses_teaching method in the API
+    # client.user.eclasses_teaching["items"].each do |eclass|
+    # Sets variable gradebooks equal to all gradebooks, accepts argument
+    # that says the eclass_id is equal to an "id" within "items" - in other words, it loops through and grabs gradebooks from each class belonging to the user
+    gradebooks = client.gradebooks.all(eclass_id: class_selection)
+    gradebooks['items'].to_a.each do |gradebook|
+      # And, for each one, define entries within
+      gradebook_entries = client.gradebooks.entries(eclass_id: class_selection, gradebook_id: gradebook['id'], include_scores: true)
+      # Still 4 entries at this point
+      # Now we want to go through each entry and look int he items hash
+      gradebook_entries['items'].each do |entry|
+        # And we want to define columns (for use in a csv) as the keys for gradebook_entries - items, in the first array, then in the gradebook_entry_scores hash, then in the first array within that hash (since we just need column names)
+        entries_columns = gradebook_entries['items'][0]['gradebook_entry_scores'][0].keys
+      end
+    end
+    # Now, we need to make a csv for entries - we are using the shortname of the class to name the file so the same file is not overwritten each time,
+    # instead, a new file is created for each class
+    CSV.open("entries_#{class_selection}.csv", 'wb') do |csv|
+      # Add a row for the column names defined above
+      csv << entries_columns
+      gradebook_entries['items'].each do |y|
+        y['gradebook_entry_scores'].each do |y|
+          csv << y.values
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: haiku_grades
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hapi-client
+  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'
+description: Pulls grades and exports them from a teacher within a Haiku Learning
+  domain.
+email:
+- samf@haikulearning.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- class_list.csv
+- config/authentication.yml.sample
+- entries_.csv
+- haiku_grades.gemspec
+- lib/class_export.rb
+- lib/full_grade.rb
+- lib/haiku_grades.rb
+- lib/haiku_grades/version.rb
+- lib/partial_grade.rb
+homepage: http://rubygems.org/gems/haiku_grades
+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.6
+signing_key: 
+specification_version: 4
+summary: Pulls grades and exports them from a teacher within a Haiku Learning domain.
+test_files: []