codebadges 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68955f2962ad30ae0a1383f20570db988bcfc0d5
-  data.tar.gz: e63d0319bae4948256dc1bede00cccafaa8ae5c2
+  metadata.gz: 5c22abfa1d1de1379c39807dd72bd53b331a011b
+  data.tar.gz: 3674c115ef9068fb5152085a23d14d39d6a731ee
 SHA512:
-  metadata.gz: 21bd415f2d143fc070da51a01ee641fe532d236159e24734adfb3a046adbe876cd6c61af0ddcff021201c31d20b01380e22e663d840158fbbb26946dfc1bd7f8
-  data.tar.gz: 909c44137fb280380f5b2ac9719de8ef2f6907aeb5cb4f175b120cdf679ce8d1f2d6e6d0ed997b250ef0e10ca471d719994d1f667d3ba6f77d99d5477e5d7343
+  metadata.gz: 4715c01e03c0776b9f32b6be4a25f36c634feb3c07c52271fcafd1bdddf1e1938b60108b0de1253ee12fcabe4585ca06d3ffab280036961f57be66293f5c72e9
+  data.tar.gz: 94ba8ce903b4290bebffc9ece7cb31a9f2c7428176b7353d9660613960f52564fb3f9c3c995105086c13e67bd60380c9de75aabae1490bd300b6ca56930a8f23

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
   - ruby-head
+  - jruby-head
 branches:
   only:
     - master
+    - develop

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-	gem 'rake'
-end
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Soumya Ray, Chen Li-Zhan
+
+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

@@ -1,24 +1,31 @@
-CodeBadges
-===============
+# CodeBadges [![Build Status](https://travis-ci.org/ISS-SOA/Codecademy-Ruby.svg?branch=develop)](https://travis-ci.org/ISS-SOA/Codecademy-Ruby)
 
-CodeBadges. It tries to grabs some information on the Codecademy. What it grab? Badges!
+Codecademy is a great place to learn coding! Unfortunately, Codecademy's website
+doesn't provide an API to help us monitor our own coding.
+So we made the CodeBadges gem to scrape user achievements from Codecademy!
 
-## About
-
-Once you done a section of course on the Codecademy(The online programming tutorial), you will get a badges.
-The gem is to understand that what course and the level the user take on the Codecademy.
+Note that we respect Codecademy's `robots.txt`
 
 ## Usage
 
 Install it with the following command:
-````ruby
-gem install codebadges
-````
+```sh
+$ gem install codebadges
+```
 
-Then in your file:
+Or else put it in your `Gemfile` as:
+```ruby
+gem codebadges
+```
+
+Run it from the command line. For example, to get the achievements of user `chenlizhan`:
+```
+$ codebadges chenlizhan
+```
+
+Or use it from your Ruby code:
 ````ruby
-require "codebadges"
-CodecademyBadges.get_badges(username)
-````
-The argument username is the user's account who you want to check it out!
+require 'codebadges'
+lee = CodeBadges::CodecademyBadges.new('chenlizhan')
+badges = lee.badges
 ````

data/Rakefile

@@ -3,6 +3,6 @@ require 'rake/testtask'
 task :default => [:spec]
 
 desc 'Run specs'
-task :spec do
-  sh 'ruby -I lib spec/badges_test.rb'
+Rake::TestTask.new(name=:spec) do |t|
+  t.pattern = 'spec/*_spec.rb'
 end

data/bin/codebadges

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-# require '../lib/codebadges/badges.rb'     # for cmd line testing purposes
 require 'codebadges'                       # for production
+# require '../lib/codebadges/badges.rb'     # for cmd line testing purposes
 
 def get_users_array_from_file(file)
   users_array = []

data/codebadges.gemspec

@@ -1,21 +1,23 @@
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'codebadges/version'
 
 Gem::Specification.new do |s|
   s.name        =  'codebadges'
   s.version     =  CodeBadges::VERSION
+  s.date        =  CodeBadges::DATE
   s.executables << 'codebadges'
-  s.date        =  '2015-07-21'
-  s.summary     =  'Grab the badges information from the Codecademy'
-  s.description =  'Use username as an input, automatically give you the badges the user has.'
+  s.summary     =  'Access user and course information on Codecademy'
+  s.description =  'Get user achievements and course info from Codecademy'
   s.authors     =  ['Lee Chen', 'Soumya Ray']
-  s.email       =  'chung1350@hotmail.com'
+  s.email       =  ['chung1350@hotmail.com', 'soumya.ray@gmail.com']
   s.files       =  `git ls-files`.split("\n")
-  s.test_files  =  `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files  =  `git ls-files spec/*`.split("\n")
   s.homepage    =  'https://github.com/ISS-SOA/Codecademy-Ruby'
   s.license     =  'MIT'
 
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'minitest-rg'
-  s.add_runtime_dependency 'nokogiri', '>= 1.6.2'   # v.1.6.2 has documented problems
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+  s.add_runtime_dependency 'oga'
 end

data/lib/codebadges/badges.rb

@@ -1,44 +1,38 @@
-require 'nokogiri'
+require 'oga'
 require 'open-uri'
 require 'date'
-# Author:   Lee Chen (mailto: chung1350@hotmail.com)
-# License:  MIT
+
 module CodeBadges
   # This class get the user account as an input
   # return a hash of user's badges information
   class CodecademyBadges
-    TITLE_XPATH = "//div[@class = 'grid-row']//h5[@class = 'margin-top--1']"
-    DATE_XPATH  = "//small[@class = 'text--ellipsis']"
     USERS_URL = 'https://www.codecademy.com/users'
     ACHIEVEMENTS_DIR = 'achievements'
+    ACHIEVEMENT_XPATH = "//div[contains(@class,'achievement-card')]"
+    ACH_TITLE_XPATH = 'h5'
+    ACH_DATE_XPATH = 'small/small'
 
-    def self.get_badges(username)
-      doc = get_html(username)
-      titles = get_titles(doc)
-      dates = get_dates(doc)
-      integrate(titles, dates)
+    def initialize(username)
+      parse_html(username)
     end
 
-    def self.get_html(username)
-      url = "#{USERS_URL}/#{username}/#{ACHIEVEMENTS_DIR}"
-      Nokogiri::HTML(open(url))
+    def badges
+      @badges ||= extract_achievements
     end
 
-    def self.get_titles(document)
-      titles = document.xpath(TITLE_XPATH)
-      titles.map { |t| t.text }
-    end
+    private
 
-    def self.get_dates(document)
-      dates = document.xpath(DATE_XPATH)
-      dates.map { |d| Date.parse(d) }
+    def parse_html(username)
+      url = "#{USERS_URL}/#{username}/#{ACHIEVEMENTS_DIR}"
+      @document = Oga.parse_html(open(url))
     end
 
-    def self.integrate(titles, dates)
-      badge_array = titles.each_with_index.map do |_, index|
-        [titles[index], dates[index]]
-      end
-      Hash[badge_array]
+    def extract_achievements
+      @document.xpath(ACHIEVEMENT_XPATH).map do |achievement|
+        title = achievement.xpath(ACH_TITLE_XPATH).text
+        date = Date.parse(achievement.xpath(ACH_DATE_XPATH).text)
+        [title, date]
+      end.to_h
     end
   end
 end

data/lib/codebadges/courses.rb

@@ -0,0 +1,25 @@
+require 'oga'
+require 'open-uri'
+require 'date'
+
+module CodeBadges
+  # This class get the user account as an input
+  # return a hash of user's badges information
+  class CodecademyCourses
+    MAIN_URL = 'https://www.codecademy.com'
+    XPATH_COURSES = "//div[h5/strong/text()='Learn To Code']/div/div/ul/li/a"
+
+    def courses
+      @courses ||= extract_main_courses
+    end
+
+    private
+
+    def extract_main_courses
+      doc = Oga.parse_html(open(MAIN_URL))
+      doc.xpath(XPATH_COURSES).map do |course|
+        [course.text, URI.join(MAIN_URL, course.get('href'))]
+      end.to_h
+    end
+  end
+end

data/lib/codebadges/version.rb

@@ -1,4 +1,5 @@
 # Versioning
 module CodeBadges
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
+  DATE = '2015-10-11'
 end

data/lib/codebadges.rb

@@ -1 +1,2 @@
 require 'codebadges/badges.rb'
+require 'codebadges/courses.rb'

data/spec/badges_spec.rb

@@ -0,0 +1,30 @@
+require 'minitest/autorun'
+require 'minitest/rg'
+require 'yaml'
+require 'vcr'
+require 'webmock/minitest'
+require './lib/codebadges.rb'
+
+USERNAME = 'soumya.ray'
+badges_from_file = YAML.load(File.read('./spec/fixtures/badges.yml'))
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end
+
+VCR.use_cassette('badges') do
+  badges_found = CodeBadges::CodecademyBadges.new(USERNAME).badges
+
+  describe 'Get badges for one user' do
+    it 'has the right number of badges' do
+      badges_found.size.wont_be :<, badges_from_file[USERNAME].size
+    end
+
+    badges_from_file[USERNAME].map do |b_name, b_date|
+      it "finds '#{b_name}' badge" do
+        badges_found[b_name].must_equal Date.parse(b_date)
+      end
+    end
+  end
+end

data/spec/courses_spec.rb

@@ -0,0 +1,30 @@
+require 'minitest/autorun'
+require 'minitest/rg'
+require 'yaml'
+require 'vcr'
+require 'webmock/minitest'
+require './lib/codebadges.rb'
+
+test_courses = YAML.load(File.read('spec/fixtures/courses.yml'))
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end
+
+VCR.use_cassette('courses') do
+  codecademy = CodeBadges::CodecademyCourses.new
+  courses = codecademy.courses
+
+  describe 'Find all test courses' do
+    it 'has the right number of badges' do
+      courses.size.wont_be :<, test_courses.size
+    end
+
+    test_courses.map do |course_name|
+      it "finds course '#{course_name}'" do
+        codecademy.courses.keys.include? course_name
+      end
+    end
+  end
+end

data/spec/fixtures/badges.yml

@@ -0,0 +1,75 @@
+---
+soumya.ray:
+  Sorting Your Friends: May 18, 2014
+  100 Exercises: May 18, 2014
+  Max Streak Count of 3: May 11, 2014
+  Design a Button for Your Website: May  9, 2014
+  'CSS: An Overview': May  9, 2014
+  Build Your Own Webpage: May  9, 2014
+  50 Exercises: May  9, 2014
+  Clickable Photo Page: May  9, 2014
+  HTML Basics III: May  9, 2014
+  25 points earned in one day: May  9, 2014
+  HTML Basics: May  9, 2014
+  25 Exercises: May  9, 2014
+  10 Exercises: Dec 12, 2012
+  Max Streak Count of 1: Dec 12, 2012
+  First Lesson: Jun 20, 2012
+chenlizhan:
+  Animate Your Name: Sep 26, 2014
+  Banking on Ruby: Aug 25, 2014
+  Object-Oriented Programming II: Aug 25, 2014
+  Virtual Computer: Aug 25, 2014
+  500 Exercises: Aug 25, 2014
+  Object-Oriented Programming I: Aug 22, 2014
+  Blocks, Procs, and Lambdas: Aug 22, 2014
+  The Refactor Factory: Aug 21, 2014
+  The Zen of Ruby: Aug 21, 2014
+  150 points earned in one day: Aug 21, 2014
+  A Night at the Movies: Aug 21, 2014
+  Hashes and Symbols: Aug 21, 2014
+  125 points earned in one day: Aug 21, 2014
+  Ordering Your Library: Aug 21, 2014
+  Methods, Blocks, & Sorting: Aug 21, 2014
+  100 points earned in one day: Aug 21, 2014
+  Create a Histogram: Aug 21, 2014
+  Data Structures: Aug 21, 2014
+  Redacted!: Aug 21, 2014
+  Loops & Iterators: Aug 21, 2014
+  Thith Meanth War!: Aug 21, 2014
+  Control Flow in Ruby: Aug 21, 2014
+  Putting the Form in Formatter: Aug 21, 2014
+  Introduction to Ruby: Aug 21, 2014
+  File Input/Output: Jul 24, 2014
+  Max Streak Count of 5: Jul 24, 2014
+  Classes: Jul 24, 2014
+  Introduction to Classes: Jul 23, 2014
+  Introduction to Bitwise Operators: Jul 22, 2014
+  Advanced Topics in Python: Jul 22, 2014
+  Exam Statistics: Jul 22, 2014
+  Max Streak Count of 3: Jul 22, 2014
+  Practice Makes Perfect: Jul 21, 2014
+  200 Exercises: Jul 21, 2014
+  75 points earned in one day: Jul 21, 2014
+  Loops: Jul 21, 2014
+  Battleship!: Jul 20, 2014
+  Lists and Functions: Jul 20, 2014
+  Student Becomes the Teacher: Jul 20, 2014
+  PygLatin: Jul 20, 2014
+  A Day at the Supermarket: Jul 19, 2014
+  Python Lists and Dictionaries: Jul 19, 2014
+  100 Exercises: Jul 19, 2014
+  Taking a Vacation: Jul 19, 2014
+  Functions: Jul 19, 2014
+  Conditionals & Control Flow: Jul 18, 2014
+  50 points earned in one day: Jul 18, 2014
+  50 Exercises: Jul 18, 2014
+  Date and Time: Jul 18, 2014
+  Strings & Console Output: Jul 18, 2014
+  25 points earned in one day: Jul 18, 2014
+  25 Exercises: Jul 18, 2014
+  Tip Calculator: Jul 18, 2014
+  Python Syntax: Jul 18, 2014
+  First Lesson: Jul 18, 2014
+  10 Exercises: Jul 18, 2014
+  Max Streak Count of 1: Mar 29, 2014

data/spec/fixtures/courses.yml

@@ -0,0 +1,17 @@
+---
+- Make a Website
+- Make a Website Projects
+- Make an Interactive Website
+- Learn Rails
+- Learn AngularJS
+- Ruby on Rails Authentication
+- Learn the Command Line
+- Learn SQL
+- Learn Java
+- HTML & CSS
+- JavaScript
+- jQuery
+- PHP
+- Python
+- Ruby
+- Learn APIs