codebadges 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41f4fabbea75edce70d7269d962a0efb385d9dc8
+  data.tar.gz: fa6cff513a7a7788667defedb1c16b73cd4dd66b
+SHA512:
+  metadata.gz: a0aabde0dd53666f092a1e37e3a18710d045c1608d2eaf5c1eee7e5249fc27da5a8b69d7981e1b3bf43e4a34c8952091b01e6ec56d17d15c5afe3ffeece3d826
+  data.tar.gz: 55e16b2cb8f15e7a9ab55dea145d1f4a365d387f5d09fbe5299c85215715d657ff382f547741b5ac710e3521de6308f677253492add10ca6a41226cee2533b3f

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+	gem 'rake'
+end

data/README.md

@@ -0,0 +1,24 @@
+CodeBadges
+===============
+
+CodeBadges. It tries to grabs some information on the Codecademy. What it grab? Badges!
+
+## 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.
+
+## Usage
+
+Install it with the following command:
+````ruby
+gem install codebadges
+````
+
+Then in your file:
+````ruby
+require "codebadges"
+CodecademyBadges.get_badges(username)
+````
+The argument username is the user's account who you want to check it out!
+````

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+task :default => [:spec]
+
+desc 'Run specs'
+task :spec do
+  sh 'ruby -I lib spec/badges_test.rb'
+end

data/bin/codebadges

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require '../lib/codebadges'
+
+fail ArgumentError, "Usage:  badges [username]\n" if ARGV.count == 0
+user_name = ARGV[0]
+
+badges_found = CodecademyBadges.get_badges(user_name)
+
+puts "#{user_name} has collected #{badges_found.size} badges."
+
+badges_found.each do |title, date|
+  puts "Earned '#{title}' on #{date}."
+end

data/codebadges.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'codebadges/version'
+
+Gem::Specification.new do |s|
+  s.name        =  'codebadges'
+  s.version     =  CodeBadges::VERSION
+  s.executables << 'codebadges'
+
+  s.date        =  '2014-09-03'
+  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.authors     =  ['Lee Chen', 'Soumya Ray']
+  s.email       =  'chung1350@hotmail.com'
+  s.files       =  `git ls-files`.split("\n")
+  s.test_files  =  `git ls-files -- {test,spec,features}/*`.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_runtime_dependency 'open-uri'
+end

data/lib/codebadges/badges.rb

@@ -0,0 +1,44 @@
+require 'nokogiri'
+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 = 'http://www.codecademy.com/users'
+    ACHIEVEMENTS_DIR = 'achievements'
+
+    def self.get_badges(username)
+      doc = get_html(username)
+      titles = get_titles(doc)
+      dates = get_dates(doc)
+      integrate(titles, dates)
+    end
+
+    def self.get_html(username)
+      url = "#{USERS_URL}/#{username}/#{ACHIEVEMENTS_DIR}"
+      Nokogiri::HTML(open(url))
+    end
+
+    def self.get_titles(document)
+      titles = document.xpath(TITLE_XPATH)
+      titles.map { |t| t.text }
+    end
+
+    def self.get_dates(document)
+      dates = document.xpath(DATE_XPATH)
+      dates.map { |d| Date.parse(d) }
+    end
+
+    def self.integrate(titles, dates)
+      badge_array = titles.each_with_index.map do |_, index|
+        [titles[index], dates[index]]
+      end
+      Hash[badge_array]
+    end
+  end
+end

data/lib/codebadges/version.rb

@@ -0,0 +1,4 @@
+# Versioning
+module CodeBadges
+  VERSION = '0.1.0'
+end

data/lib/codebadges.rb

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

data/spec/badges_test.rb

@@ -0,0 +1,36 @@
+require 'minitest/autorun'
+require 'minitest/rg'
+require './lib/codebadges.rb'
+
+badge = {
+  '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'
+}
+
+badges_found = CodeBadges::CodecademyBadges.get_badges('soumya.ray')
+
+describe 'Get all the badges' do
+
+  it 'has the right number of badges' do
+    badges_found.size.must_equal badge.size
+  end
+
+  badge.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

data/spec/badges_test_000.rb

@@ -0,0 +1,53 @@
+# NOTE: incomplete -- This style of testing is too slow and takes too long!
+#       look at badges_test.rb for more optimzed version
+
+require 'minitest/autorun'
+require 'minitest/rg'
+require './badges.rb'
+
+badge = {
+  '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'
+}
+
+describe "Get all the badges" do
+
+  before do
+    @badges_found = CodecademyBadges.get_badges('soumya.ray')
+  end
+
+  it 'has the right number of badges' do
+    @badges_found.size.must_equal badge.size
+  end
+
+  it 'finds "Sorting Your Friends" badge' do
+    @badges_found['Sorting Your Friends'].must_equal badge['Sorting Your Friends']
+  end
+
+  it 'finds "100 Exercises" badge' do
+    @badges_found['100 Exercises'].must_equal badge['100 Exercises']
+  end
+
+  it 'finds "Max Streak Count of 3" badge' do
+    @badges_found['Max Streak Count of 3'].must_equal badge['Max Streak Count of 3']
+  end
+
+  it 'finds "Design a Button for Your Website" badge' do
+    @badges_found['Design a Button for Your Website'].must_equal badge['Design a Button for Your Website']
+  end
+
+  # TODO: make writing these tests easier and running these tests faster!
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: codebadges
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lee Chen
+- Soumya Ray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-rg
+  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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+- !ruby/object:Gem::Dependency
+  name: open-uri
+  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: Use username as an input, automatically give you the badges the user
+  has.
+email: chung1350@hotmail.com
+executables:
+- codebadges
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/codebadges
+- codebadges.gemspec
+- lib/codebadges.rb
+- lib/codebadges/badges.rb
+- lib/codebadges/version.rb
+- spec/badges_test.rb
+- spec/badges_test_000.rb
+homepage: https://github.com/ISS-SOA/Codecademy-Ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Grab the badges information from the Codecademy
+test_files:
+- spec/badges_test.rb
+- spec/badges_test_000.rb
+has_rdoc: