codebadges 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54242705f83a6dadf672c4fe0ce820f3006dbe7b
-  data.tar.gz: 29dfc653ddb4432b5c53013fa0f93fa5aa59ad8f
+  metadata.gz: c0cc98b2e33fbeaa97d3d051504dd02780de3003
+  data.tar.gz: 585b3efee9ca4c07d320c5628caba2374cdd5611
 SHA512:
-  metadata.gz: 69193d21274ae16b60a5db2b3588f0077d75ee38bbfba8f7bc03c6f0e1175286c62944720fd99cb72e663d9cbadb71fa05a3e907e140f5595c99ec6b3e18b95a
-  data.tar.gz: 7af7e76a996ad85af191b66690adc751c449c9b71bad7229a1c1bfc1763995d844dea80e23126598ae83fbb8f58d768dd7e1bcc7a5b1fd1cdd78378cfe32acc5
+  metadata.gz: 3e4e3b8c75dabcf07f503dc0c8662739af9ae37156913da8447d79271ca8a7b43fdc744af3e68bb76cc99cbf9b32d3ad91cb86a904a7fbed651075367012c84d
+  data.tar.gz: 9b8f8910a88f9a41889b753c9596a6ddc5f7173e245af68ce312d08255a0ada72a09fc8649178d0415476e53f78c389da067c09e9e9d51056957a569874b997c

data/.travis.yml

@@ -1,8 +1,12 @@
 language: ruby
 rvm:
-  - ruby-head
-  - jruby-head
+  - 2.2.5
+  - 2.3.1
 branches:
   only:
     - master
     - develop
+before_install:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+  - sleep 3 # give xvfb some time to start

data/README.md

@@ -1,12 +1,13 @@
 # CodeBadges [![Gem Version](https://badge.fury.io/rb/codebadges.svg)](https://badge.fury.io/rb/codebadges)[![Build Status](https://travis-ci.org/ISS-SOA/Codecademy-Ruby.svg?branch=develop)](https://travis-ci.org/ISS-SOA/Codecademy-Ruby)
 
 Codecademy is a great place to learn coding! Unfortunately, Codecademy's website
-doesn't provide an API to help us monitor our own coding.
+doesn't provide an API.
+
 So we made the CodeBadges gem to scrape user achievements from Codecademy!
 
 Note that we respect Codecademy's `robots.txt`
 
-## Usage
+## Installation
 
 Install it with the following command:
 ```sh
@@ -17,15 +18,43 @@ Or else put it in your `Gemfile` as:
 ```ruby
 gem codebadges
 ```
+and run `bundle install`.
+
+## Usage
 
+### CLI: Finding user badges
 Run it from the command line. For example, to get the achievements of user `chenlizhan`:
 ```
 $ codebadges chenlizhan
 ```
 
-Or use it from your Ruby code:
+You will be required to enter username/password credentials to access codecademy user achievements.
+This gem *never* stores your credentials nor uses them for any other purpose.
+### Code: Finding user badges
+Use it from your Ruby code:
 ````ruby
 require 'codebadges'
-lee = CodeBadges::CodecademyBadges.new('chenlizhan')
-badges = lee.badges
+
+cademy_badges = CodeBadges::GetCodecademyBadges.new('my_username', 'my_password')
+badges = cademy_badges.call('chenlizhan')
 ````
+
+### Code: Finding full course list
+Use it from your Ruby code:
+```ruby
+courses = CodeBadges::GetCodecademyCourses.call
+```
+
+## Testing
+
+First, setup environment variables called `CC_USERNAME` and `CC_PASSWORD` with your Codecademy username and password.
+
+Then:
+```
+rake spec
+```
+
+Alternatively:
+```
+CC_USERNAME=myusername CC_PASSWORD=mypassword rake spec
+```

data/bin/codebadges

@@ -1,14 +1,22 @@
 #!/usr/bin/env ruby
 
-require 'codebadges'                       # for production
-# require '../lib/codebadges/badges.rb'     # for cmd line testing purposes
+require 'io/console'
+require 'codebadges' # for production
+# require '../lib/codebadges/badges.rb' # for cmd line testing purposes
 
-fail ArgumentError, "Usage:  codebadges [username]\n" if ARGV.count == 0
+abort "Usage:  codebadges [username]\n" if ARGV.count == 0
 
-username = ARGV[0]
-badges_found = CodeBadges::CodecademyBadges.new(username).badges
+print 'Login Username: '
+username = STDIN.gets.chomp
 
-puts "#{username} has collected #{badges_found.size} badges."
+print 'Login Password: '
+password = STDIN.noecho(&:gets).chomp
+
+cadet_name = ARGV[0]
+cademy = CodeBadges::GetCodecademyBadges.new(username, password)
+badges_found = cademy.call(cadet_name)
+
+puts "#{cadet_name} has collected #{badges_found.size} badges."
 badges_found.each do |title, date|
   puts "Earned '#{title}' on #{date}."
 end

data/codebadges.gemspec

@@ -7,17 +7,15 @@ Gem::Specification.new do |s|
   s.date        =  CodeBadges::DATE
   s.executables << 'codebadges'
   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', 'soumya.ray@gmail.com']
+  s.description =  'Get user user achievements and course lists from Codecademy'
+  s.authors     =  ['Soumya Ray', 'Lee Chen']
+  s.email       =  ['soumya.ray@gmail.com', 'chung1350@hotmail.com']
   s.files       =  `git ls-files`.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_development_dependency 'vcr'
-  s.add_development_dependency 'webmock'
-  s.add_runtime_dependency 'oga'
+  s.add_development_dependency 'minitest', '~> 5.9'
+  s.add_development_dependency 'minitest-rg', '~> 5.2'
+  s.add_runtime_dependency 'mechanize', '~> 2.7'
 end

data/lib/codebadges.rb

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

data/lib/codebadges/badges.rb

@@ -1,38 +1,23 @@
-require 'oga'
-require 'open-uri'
-require 'date'
+require_relative 'site'
 
 module CodeBadges
-  # This class get the user account as an input
-  # return a hash of user's badges information
-  class CodecademyBadges
-    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 initialize(username)
-      parse_html(username)
-    end
-
-    def badges
-      @badges ||= extract_achievements
+  # Service object class that takes credentials and username
+  # returns a hash of user's badges information
+  class GetCodecademyBadges
+    def initialize(username, password)
+      @username = username
+      @password = password
     end
 
-    private
-
-    def parse_html(username)
-      url = "#{USERS_URL}/#{username}/#{ACHIEVEMENTS_DIR}"
-      @document = Oga.parse_html(open(url))
-    end
+    def call(cadet)
+      CademySite.new do |site|
+        site.goto CademySite::LOGIN_URL
+        site.login(@username, @password)
+        site.goto CademySite.cadet_achievements_url(cadet)
+        @badges = site.extract_achievements
+      end
 
-    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
+      @badges
     end
   end
 end

data/lib/codebadges/courses.rb

@@ -1,25 +1,15 @@
-require 'oga'
-require 'open-uri'
-require 'date'
+require_relative 'site'
 
 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
+  # Service object class that returns all courses
+  class GetCodecademyCourses
+    def self.call
+      CademySite.new do |site|
+        site.goto CademySite::MAIN_URL
+        @courses = site.extract_main_courses
+      end
+
+      @courses
     end
   end
 end

data/lib/codebadges/site.rb

@@ -0,0 +1,60 @@
+require 'mechanize'
+require 'date'
+
+module CodeBadges
+  ## CodeCademy web automation and scraper
+  class CademySite
+    MAIN_URL = 'https://www.codecademy.com'.freeze
+    USERS_URL = "#{MAIN_URL}/users".freeze
+    ACHIEVEMENTS_DIR = 'achievements'.freeze
+
+    LOGIN_URL = "#{MAIN_URL}/login".freeze
+    USERNAME_TEXTFIELD_ID = 'user_login'.freeze
+    PASSWORD_TEXTFIELD_ID = 'user_password'.freeze
+    LOGIN_BUTTON_ID = 'user_submit'.freeze
+
+    ACHIEVEMENT_XPATH = "//div[contains(@class,'achievement-card')]".freeze
+    ACH_TITLE_XPATH = 'h5'.freeze
+    ACH_DATE_XPATH = 'small/small'.freeze
+
+    COURSES_XPATH = "//div[h5/strong/text()='Learn To Code']/div/div/ul/li/a".freeze
+
+    def initialize
+      @browser = Mechanize.new do |agent|
+        agent.user_agent_alias = 'Linux Firefox'
+      end
+
+      yield self if block_given?
+    end
+
+    def self.cadet_achievements_url(cadet)
+      "#{USERS_URL}/#{cadet}/#{ACHIEVEMENTS_DIR}"
+    end
+
+    def goto(url)
+      @browser.get(url)
+    end
+
+    def login(username, password)
+      @browser.page.form do |form|
+        form.field(id: USERNAME_TEXTFIELD_ID).value = username
+        form.field(id: PASSWORD_TEXTFIELD_ID).value = password
+        form.submit
+      end
+    end
+
+    def extract_achievements
+      @browser.page.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
+
+    def extract_main_courses
+      @browser.page.xpath(COURSES_XPATH).map do |course|
+        [course.text, URI.join(MAIN_URL, course.attribute('href').value)]
+      end.to_h
+    end
+  end
+end

data/lib/codebadges/version.rb

@@ -1,5 +1,5 @@
 # Versioning
 module CodeBadges
-  VERSION = '2.0.1'
-  DATE = '2015-10-11'
+  VERSION = '3.0.0'
+  DATE = '2016-07-10'
 end

data/spec/badges_spec.rb

@@ -1,30 +1,22 @@
 require 'minitest/autorun'
 require 'minitest/rg'
 require 'yaml'
-require 'vcr'
-require 'webmock/minitest'
-require './lib/codebadges.rb'
+require './lib/codebadges/badges.rb'
 
-USERNAME = 'soumya.ray'
+USERNAME = 'soumya.ray'.freeze
 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 cadet' do
+  cademy = CodeBadges::GetCodecademyBadges.new(ENV['CC_USERNAME'], ENV['CC_PASSWORD'])
+  badges_found = cademy.call('soumya.ray')
 
-  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
+  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
+  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

data/spec/courses_spec.rb

@@ -1,30 +1,20 @@
 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
+courses = CodeBadges::GetCodecademyCourses.call
 
-  describe 'Find all test courses' do
-    it 'has the right number of badges' do
-      courses.size.wont_be :<, test_courses.size
-    end
+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
+  test_courses.map do |course_name|
+    it "finds course '#{course_name}'" do
+      courses.keys.include? course_name
     end
   end
 end

metadata

@@ -1,90 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: codebadges
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
-- Lee Chen
 - Soumya Ray
+- Lee Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2016-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.9'
 - !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: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: mechanize
   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: oga
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Get user achievements and course info from Codecademy
+        version: '2.7'
+description: Get user user achievements and course lists from Codecademy
 email:
-- chung1350@hotmail.com
 - soumya.ray@gmail.com
+- chung1350@hotmail.com
 executables:
 - codebadges
 extensions: []
@@ -101,13 +73,12 @@ files:
 - lib/codebadges.rb
 - lib/codebadges/badges.rb
 - lib/codebadges/courses.rb
+- lib/codebadges/site.rb
 - lib/codebadges/version.rb
 - spec/badges_spec.rb
 - spec/courses_spec.rb
 - spec/fixtures/badges.yml
 - spec/fixtures/courses.yml
-- spec/fixtures/vcr_cassettes/badges.yml
-- spec/fixtures/vcr_cassettes/courses.yml
 homepage: https://github.com/ISS-SOA/Codecademy-Ruby
 licenses:
 - MIT
@@ -128,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Access user and course information on Codecademy
@@ -137,5 +108,3 @@ test_files:
 - spec/courses_spec.rb
 - spec/fixtures/badges.yml
 - spec/fixtures/courses.yml
-- spec/fixtures/vcr_cassettes/badges.yml
-- spec/fixtures/vcr_cassettes/courses.yml