mypage_tools 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22802225cc96365c393cd16775b504bf8e49d37c
+  data.tar.gz: 3d585f0cc41fcee1a98a27c6d4b7c87b17e96c61
+SHA512:
+  metadata.gz: 756f3a6075e5d983063c5a4b9c15ba85061dd075450e09c29fc8c109e2833e973d6545d7875ecfa3d539cd31f3c260b8342ce241953bde8b7416f12fa4a12477
+  data.tar.gz: ff404bc6df53c0d386efd83d7a8681bce39beca95488dba96174eaa107c6d5a01211722ed95bb189aa8db0f49103e0bd06e513b15fc721c1586d5d66af16c702

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mypage_tools.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brown Mike
+
+MIT License
+
+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

@@ -0,0 +1,42 @@
+# MypageTools
+
+A work in progress. Very primitive right now.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mypage_tools'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mypage_tools
+
+## Requirements
+
+For now you need [PhantomJS](http://phantomjs.org) and [Ruby 2.0](http://www.ruby-lang.org/en/downloads/) or greater installed.
+
+If you have [Homebrew](http://brew.sh) installed you can just
+
+		$ brew install phantomjs
+
+## Usage
+
+		$ mypage
+
+## TODO:
++ Automagically handle PhantomJS dependency
++ Output to one .ics file starting from the first day you don't have a schedule for
++ Write tests! :-X
+
+## 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. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/mypage

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "mypage_tools"
+
+MypageTools::CLI.parse_options

data/lib/capybara_with_phantom_js.rb

@@ -0,0 +1,25 @@
+# Voodoo to make Capybara do what I want.
+# Ripped off nearly wholesale from a random blog after hours of Googling.
+module CapybaraWithPhantomJs
+	include Capybara::DSL
+
+	def new_session
+		Capybara.register_driver :poltergeist do |app|
+			Capybara::Poltergeist::Driver.new(app)
+		end
+
+		Capybara.configure do |config|
+			config.run_server = false # Aparrently I have to do this if I'm not locally testing
+			config.default_driver = :poltergeist
+			config.default_selector = :xpath
+			config.ignore_hidden_elements = true
+			config.app_host = "https://mypage.apple.com"
+		end
+
+		@session = Capybara::Session.new(:poltergeist)
+
+		@session.driver.headers = { "User-Agent" => "Mozilla/5.0 (Macintosh; Intel Mac OS X" }
+
+		@session
+	end
+end

data/lib/mypage_tools.rb

@@ -0,0 +1,48 @@
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+# 																												#
+# USELESS COMMENT BOX BY: 																#
+# 																												#
+#	 ___    ___     _   _ 																	#
+#	|   \  /   | o | | / /____ 															#
+#	| |\ \/ /| | _ | |/ // __ \ 														#
+#	| | \__/ | || ||   (/  ____\ 														#
+#	| |      | || || |\ \  \___ 														#
+#	|_|      |_||_||_| \_\_____\ 														#
+#	           ____ 																				#
+#	          |    \ 																				#
+#	          |  -  ) _____    ___  __            __  __ 		#
+#	          |  __/ |  ___\ /  _  \\ \    __    / //    \	#
+#	          |    \ | |    |  | |  |\ \  /  \  / /|  /\  |	#
+#	          |  -  )| |    |  |_|  | \ \/ /\ \/ / | |  | |	#
+#	          |____/ |_|     \ ___ /   \__/  \__/  |_|  |_| #
+# 																												#
+# 																												#
+#	TODO: Compare gathered data to existing .ics files			#
+# 			and inform of any changes to schedule	 						#
+#  																												#
+# TODO: Add ability to automagically import to  					#
+# 			Calendar application 															#
+# 																												#
+# TODO: GUI? Bah. Probably not.														#
+# 																												#
+# TODO: Check timecard against schedule for possible			#
+# 			missing punches?																	#
+# 																												#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+require "capybara/dsl"
+require "capybara/poltergeist"
+require "icalendar"
+require "io/console"
+require "active_support/core_ext"
+require "mypage_tools/version"
+require "capybara_with_phantom_js"
+require "mypage_tools/shift"
+require "mypage_tools/weekly_schedule"
+require "mypage_tools/schedule_scraper"
+require "mypage_tools/schedule_page"
+require "mypage_tools/cli"
+
+module MypageTools
+	SCHEDULE_DIR = File.join(Dir.home, "myPage Schedule")
+end

data/lib/mypage_tools/cli.rb

@@ -0,0 +1,56 @@
+module MypageTools
+	class CLI
+		def self.parse_options args=ARGV
+			case args[0]
+			when "schedule"
+				schedule
+			when "help"
+				self.help
+			else
+				puts "\nUnkown Argument\n"
+				self.help
+			end
+		end
+
+		def self.schedule
+			print `clear`
+			puts "In order to get your work schedule you need to provide your login and password for myPage."
+			print "Login: "
+			ARGV.clear
+			login = gets.chomp
+			password = get_password
+			puts "\n"
+			scrape_session = ScheduleScraper.new login, password
+			scrape_session.schedule_page
+			while scrape_session.schedule_available?
+				scrape_session.generate_schedule
+				scrape_session.next_week
+				break if scrape_session.no_schedule_available? # Loop not breaking w/out this line. Need to investigate.
+			end
+			puts "\nNo further schedules available."
+			print `open #{Dir.home}/myPage\\ Schedule`
+		end
+
+		def self.help # hahaha
+			puts ""
+			puts "The only implemented feature currently is getting your schedule"
+			puts ""
+			puts "USAGE:"
+			puts "\tmypage schedule"
+			puts ""
+		end
+
+		private
+			if STDIN.respond_to?(:noecho)
+				def self.get_password
+					print "Password: "
+					STDIN.noecho(&:gets).chomp
+				end
+			else
+				# Legacy support for Ruby < 1.9
+				def self.get_password
+					`read -s -p "Password: " password; echo $password`.chomp
+				end
+			end
+	end
+end

data/lib/mypage_tools/schedule_page.rb

@@ -0,0 +1,74 @@
+module MypageTools
+	class SchedulePage
+		# Expects the myPage schedule page as a Nokogiri HTML object
+		def initialize page
+			@page = page
+		end
+
+		# Return string containing the date the week begins, i.e. "Sep 14, 2013"
+		# Matches from the raw_schedule_text using a regex
+		# http://rubular.com/r/OjRZ0q6cko
+		def week_begins
+			unless @week_begins
+				@week_begins = raw_schedule_text.scan(/\w+\s\d{1,2},\s\d{4}/)[0]
+			end
+			@week_begins
+		end
+
+		# Gross & Ugly.
+		# Returns an array where every item is a Shift object
+		def shift_array
+			unless @shift_array
+				@shift_array = []
+				days_of_week = %w[Saturday Sunday Monday Tuesday Wednesday Thursday Friday]
+
+				# Establishing variable scope
+				current_day = nil
+				current_date = nil
+				index_counter = 0
+				shift = nil
+
+				# Finds a day then creates shifts for that day from each following pair of times
+				raw_schedule_array.each do |item|
+					if days_of_week.member?(item)
+						current_day = item
+						# Figure out the date of the shift based on the day of the week & start date of the week
+						current_date = Date.parse(week_begins) + days_of_week.index(item)
+						index_counter = 0
+					elsif index_counter == 0
+						shift = Shift.new
+						shift.day_of_week = current_day
+						shift.date = current_date
+						shift.start = item
+						index_counter += 1
+					elsif index_counter == 1
+						shift.stop = item
+						index_counter = 0
+						@shift_array << shift
+					end
+				end
+			end
+			@shift_array
+		end
+
+		private
+			# Returns a string with all the necessary information to extract that week's schedule
+			def raw_schedule_text
+				unless @raw_schedule_text
+					xpath_to_schedule = "//div[@id = 'contentTimecard']/div/table/tbody/tr/td/table/tbody"
+					@raw_schedule_text = @page.search(xpath_to_schedule).text
+				end
+				@raw_schedule_text
+			end
+
+			# Data structure for schedule: [Day, Start, End, Day, Start, End, (Start), (End), etc...]
+			# Matched from the raw_schedule_text with a regex
+			# http://rubular.com/r/xOOFBOKFMM
+			def raw_schedule_array
+				unless @raw_schedule_array
+					@raw_schedule_array = raw_schedule_text.scan /[SMTWF]\w{2,5}day|\d{1,2}:\d{2}[A|P]M/
+				end
+				@raw_schedule_array
+			end
+	end
+end

data/lib/mypage_tools/schedule_scraper.rb

@@ -0,0 +1,103 @@
+module MypageTools
+	class ScheduleScraper
+		include CapybaraWithPhantomJs
+
+		def initialize username, password
+			@username = username
+			@password = password
+		end
+
+		def schedule_page
+			unless @schedule_page
+				new_session
+				visit "/"
+				wait_for(:wait_message => "Loading Login Page") { page.has_content? "Account Name" }
+				login
+				click_link "myTime"
+				wait_for(:wait_message => "Loading Timecard") { page.has_content? "Current Timecard" }
+				click_link "Schedule"
+				wait_for(:wait_message => "Checking for available schedule") { schedule_available? }
+				@schedule_page = SchedulePage.new(Nokogiri::HTML.parse(page.html))
+			end
+			@schedule_page
+		end
+
+		def schedule_available?
+			page.has_text? /Schedule\sbegins\s\w+\s\d{1,2},\s\d{4}/
+		end
+
+		def no_schedule_available?
+			page.has_text? "Schedule is not available for the selected week"
+		end
+
+		def generate_schedule
+			schedule = WeeklySchedule.new @schedule_page.week_begins, @schedule_page.shift_array
+			schedule.to_ics
+		end
+
+		def next_week
+			next_week_begins_date = Date.parse(@schedule_page.week_begins) + 7
+			if date_in_current_month? next_week_begins_date
+				click_calendar_day(next_week_begins_date)
+				@schedule_page = SchedulePage.new(Nokogiri::HTML.parse(page.html))
+			else
+				click_next_month next_week_begins_date
+				click_calendar_day(next_week_begins_date)
+				@schedule_page = SchedulePage.new(Nokogiri::HTML.parse(page.html))
+			end
+		end
+
+		private
+			def login
+				fill_in "appleId", with: @username
+				fill_in "accountPassword", with: @password
+				click_on "submitButton2"
+				wait_for(:wait_message => "Logging in") { page.has_button? "Sign Out" }
+			end
+
+			def date_in_current_month? date
+				Date.parse(@schedule_page.week_begins).month == date.month
+			end
+
+			def click_calendar_day date
+				day_number = date.day.to_s
+				within("//div[@id = 'calendar-#{date.year}-#{date.month - 1}']") do
+	        # BUG FIX -> capybara finding multiple elements, use regex to exact match date
+					find("//td[@class = 'weekend']", text: /\A#{day_number}\z/).click
+				end
+				wait_for(:wait_message => "Loading next week") do
+					page.has_content?("Schedule begins #{date.strftime("%b %d, %Y")}") || no_schedule_available?
+				end
+			end
+
+			# Clicks on the little arrow on the calendar to load the next month
+			def click_next_month date
+				find("//img[@id = 'right' and @class = 'arrow']").click
+				wait_for { page.has_content? "#{date.strftime("%B %Y")}" }
+			end
+
+			# Helper method to allow waiting for a specific thing on the page to load
+			# Times out after 10 seconds (1+2+3+4)
+			# Expects a block that returns a boolean value
+			def wait_for options={}
+				options.reverse_merge!({fail_message: "Request Timed Out"})
+				wait_message = options[:wait_message]
+				latency = 0
+				print "\n" << wait_message << "..." if wait_message
+				while latency < 6
+					latency.times { print "." } if wait_message
+					sleep latency
+					if yield
+						print "\n" if wait_message
+						return true
+					end
+					latency += 1
+				end
+				abort format_failure(options[:fail_message])
+			end
+
+			def format_failure message
+				"\n" + ("#" * message.length) + "\n\n#{message}\n\n" + ("#" * message.length) + "\n\n"
+			end
+	end
+end

data/lib/mypage_tools/shift.rb

@@ -0,0 +1,40 @@
+module MypageTools
+	# Data structure to represent a single shift on a single day
+	class Shift
+		include Icalendar
+		attr_accessor :day_of_week, :date, :start, :stop
+
+		def initialize day_of_week=nil, date=nil, start=nil, stop=nil
+			@day_of_week = day_of_week
+			@date = date
+			@start = start
+			@stop = stop
+		end
+
+		def date
+			@date.strftime("%b %d, %Y")
+		end
+
+		def start
+			Time.parse(@start).strftime("%H:%M")
+		end
+
+		def stop
+			Time.parse(@stop).strftime("%H:%M")
+		end
+
+		def not_scheduled?
+			@start == "00:00AM" && @stop == "00:00AM"
+		end
+
+		def to_ical_event
+			event = Event.new
+			event.start = DateTime.parse(self.date + " " + self.start + " PST")
+			event.end = DateTime.parse(self.date + " " + self.stop + " PST")
+			event.description = "Work at Apple"
+			event.summary = "Work (Apple)"
+			event.location = "Apple Store University Village, 2656 Northeast University Village Street, Seattle, WA, US"
+			event
+		end
+	end
+end

data/lib/mypage_tools/version.rb

@@ -0,0 +1,3 @@
+module MypageTools
+  VERSION = "0.0.2"
+end

data/lib/mypage_tools/weekly_schedule.rb

@@ -0,0 +1,27 @@
+module MypageTools
+	# Data structure to represent 1 week's Shifts
+	class WeeklySchedule
+		include Icalendar
+		attr_reader :week_begins
+
+		def initialize week_begins, shift_array
+			@week_begins = week_begins
+			@shift_array = shift_array
+		end
+
+		def to_ics
+			cal = Calendar.new
+			@shift_array.each do |shift|
+				cal.add_event shift.to_ical_event unless shift.not_scheduled?
+			end
+			cal.publish
+			cal_string = cal.to_ical
+
+			# TODO: Extract this elsewhere
+			FileUtils.mkdir(SCHEDULE_DIR) unless File.directory?(SCHEDULE_DIR)
+			file_name = File.join(SCHEDULE_DIR, "Schedule from #{@week_begins}.ics")
+			File.open(file_name, "w") { |io| io.write cal_string }
+			print "\nSaving schedule to:\n#{file_name}\n"
+		end
+	end
+end

data/mypage_tools.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mypage_tools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mypage_tools"
+  spec.version       = MypageTools::VERSION
+  spec.authors       = ["Brown Mike"]
+  spec.email         = ["thebrownmike@me.com"]
+  spec.description   = %q{myPage tools for Apple Retail employees}
+  spec.summary       = %q{myPage tools for Apple Retail employees}
+  spec.homepage      = "https://www.github.com/brownmike/mypage_tools"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency "capybara", "~> 2.2.1"
+  spec.add_runtime_dependency "poltergeist", "~> 1.5.0"
+  spec.add_runtime_dependency "icalendar", "~> 1.5.0"
+  spec.add_runtime_dependency "active_support", "~> 3.0.0"
+  spec.add_runtime_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: mypage_tools
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Brown Mike
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: myPage tools for Apple Retail employees
+email:
+- thebrownmike@me.com
+executables:
+- mypage
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mypage
+- lib/capybara_with_phantom_js.rb
+- lib/mypage_tools.rb
+- lib/mypage_tools/cli.rb
+- lib/mypage_tools/schedule_page.rb
+- lib/mypage_tools/schedule_scraper.rb
+- lib/mypage_tools/shift.rb
+- lib/mypage_tools/version.rb
+- lib/mypage_tools/weekly_schedule.rb
+- mypage_tools.gemspec
+homepage: https://www.github.com/brownmike/mypage_tools
+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.0.3
+signing_key: 
+specification_version: 4
+summary: myPage tools for Apple Retail employees
+test_files: []