susies 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0608b19bce844246bc61e260d3f8aa292b932947
+  data.tar.gz: c7d13219a9691883ab1b91939e3a4b0f752bca40
+SHA512:
+  metadata.gz: e38b896a71269ee1eeb55400bdd3c4ea3236f7fef021267e06ec7ad64f77e9af21f638b5019db9b8f79d1df6062f7d3c61adc65ffafdbcf80b99a9f32803f7aa
+  data.tar.gz: 9aef30c9f378ac421db0c86adaa6848e5f5c09b1b843b9b4401de252142a6888b84ccfe587a5293d8d1a2ed1e4724a338ecf9219acfdcfb36c133abb877354dd

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'active_support'

data/MIT_LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Simon Ninon
+
+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,35 @@
+# Susies
+
+## Description
+
+Susies is a Ruby Gem intended for Epitech Students.
+
+It's a simple piece of code allowing students to easily find and register to a Susie Class.
+
+
+## Usage
+
+## Cron Task
+
+## Enhancements
+
+## Doc
+
+You can generate documentation by executing: `sdoc`
+Don't forget to install the sdoc gem (`gem install sdoc`)
+
+## Contributing
+
+1. Fork
+2. Create your branch (`git checkout -b my-branch`)
+3. Commit your new features (`git commit -am 'New features'`)
+4. Push (`git push origin my-branch`)
+5. Make a `Pull request`
+
+## License
+
+[MIT License](MIT_LICENSE.txt)
+
+## Author
+
+[Simon Ninon](http://sninon.fr) aka [ninon_s](http://intra.epitech.eu/user/ninon_s) aka [Cylix](http://github.com/Cylix)

data/example/susies.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby
+
+require 'susies'
+
+data = {
+	login:        			%w[login_x],
+	maxStudent:   			6,
+	autologinURL: 			'https://intra.epitech.eu/my_autologin_url',
+	mailServer: 				'smtp.gmail.com',
+	mailPort: 					587,
+	mailUname: 					'mail@gmail.com',
+	mailPasswd: 				'password',
+	mailTargets: 				%w[mylogin_x@epitech.eu buddy_login@epitech.eu],
+	buddiesAutologins: 	%w[https://intra.epitech.eu/buddy_autologin_url]
+}
+
+Susies.new( data ).check!

data/lib/constants.rb

@@ -0,0 +1,57 @@
+require 'active_support/time'
+
+class Susies
+  # Susie login
+  DEFAULT_LOGIN         = "clark_s"
+  # Maximum already registered students
+  DEFAULT_MAX_STUDENT   = 9
+  # Minimum start hour
+  DEFAULT_MIN_HOUR      = 17
+  # Default Autologin
+  DEFAULT_AUTOLOGIN_URL = ''
+  # Default mail server
+  DEFAULT_MAIL_SERVER   = ''
+  # Default mail port
+  DEFAULT_MAIL_PORT     = 0
+  # Default mail user name
+  DEFAULT_MAIL_UNAME    = ''
+  # Default mail password
+  DEFAULT_MAIL_PASSWD   = ''
+  # default start week
+  DEFAULT_START_WEEK    = Date.today.beginning_of_week
+  # default end week
+  DEFAULT_END_WEEK      = Date.today.end_of_week
+
+  # Susie JSON API
+  SUSIES_URL            = "https://intra.epitech.eu/planning/587/events"
+  # Susie Register link
+  REGISTER_URL          = "https://intra.epitech.eu/planning/587"
+
+  # Cookie File
+  COOKIE_FILE           = "cookies.txt"
+  # Buddies Cookie File
+  BUDDIES_COOKIE_FILE   = "buddies_cookie_file.txt"
+
+  # Encapsulation
+  BASE_JSON             = "activities"
+  # Register status to a Susie Class
+  EVENT_REGISTERED_JSON = "event_registered"
+  # Nb of people already registered to a Susie Class
+  REGISTERED_JSON       = "registered"
+  # Susie data
+  MAKER_JSON            = "maker"
+  # Susie login
+  MAKER_LOGIN_JSON      = "login"
+  # Susie Class ID
+  ID_JSON               = "id"
+  # Susie Class Start
+  START_JSON            = "start"
+  # Susie Class End
+  END_JSON              = "end"
+  # Susie Class Type
+  TYPE_JSON             = "type"
+  # Susie Class Title
+  TITLE_JSON            = "title"
+  # Susie Class Desc
+  DESC_JSON             = "description"
+end

data/lib/susies.rb

@@ -0,0 +1,285 @@
+# Constants
+require 'constants.rb'
+# Dependencies
+require 'active_support/time'
+require 'net/smtp'
+require 'json'
+
+##
+# Susies Class
+##
+class Susies
+
+	##
+	# Initialize
+	#
+	# @login        Asked Susie Login                      Default: clark_s
+	# @maxStudent   Maximum already registered students    Default: 9
+	#
+	# @autologinURL Intranet Autologin URL                 No default
+	# @mailServer   Mail Server                            No default
+	# @mailPort     Mail Port                              No default
+	# @mailUname    Mail UserName                          No default
+	# @mailPasswd   Mail Password                          No default
+	# @mailTargets  People to inform by mail about sub.    Default: @mailUname
+	#
+	# @buddiesAuto. Buddies autologins 										 No default
+	#
+	# @startWeek    Beginning of week                      Default: beginning of current week
+	# @endWeek      End of week                            Default: end of current week
+	##
+	def initialize(data={})
+		@login        			= data[:login]       				|| [DEFAULT_LOGIN]
+		@maxStudent   			= data[:maxStudent]  				|| DEFAULT_MAX_STUDENT
+		@minHour						= data[:minHour]						|| DEFAULT_MIN_HOUR
+		@autologinURL 			= data[:autologinURL] 			|| DEFAULT_AUTOLOGIN_URL
+
+		@mailServer   			= data[:mailServer]					|| DEFAULT_MAIL_SERVER
+		@mailPort     			= data[:mailPort]						|| DEFAULT_MAIL_PORT
+		@mailUname    			= data[:mailUname]					|| DEFAULT_MAIL_UNAME
+		@mailPasswd   			= data[:mailPasswd]  				|| DEFAULT_MAIL_PASSWD
+		@mailTargets  			= data[:mailTargets] 				|| [@mailUname]
+
+		@buddiesAutologins 	= data[:buddiesAutologins] 	|| []
+
+		@startWeek    			= DEFAULT_START_WEEK
+		@endWeek      			= DEFAULT_END_WEEK
+	end
+
+
+	##
+	# Check!
+	#
+	# Iterate throw weeks, until there is no Susie in a week.
+	# For each week, check if the current user is already registered to a Susie Class.
+	# If user has not already been registered to a Susie Class, try to find an available Susie following criterias (maxStudent and Susie Login).
+	# If a Susie class is found, try to register to this Susie Class and send a mail to user's friends.
+	##
+	def check!
+		log 'Start Checking'
+		setAuthCookie COOKIE_FILE, @autologinURL
+
+		while true
+			susiesData = getSusiesData
+
+			break if noSusie? susiesData
+
+			findSusie susiesData unless registeredThisWeek? susiesData
+
+			nextWeek!
+		end
+
+		log 'End Checking'
+	end
+
+
+	private
+	
+
+	##
+	# findSusie
+	#
+	# Try to find and register to a Susie Class.
+	# Send Mail to user's friends in case of success. 
+	##
+	def findSusie(susiesData)
+		log "Trying to register susie class with #{ @login } for week: #{ formatDate @startWeek } #{ formatDate @endWeek }."
+
+		susiesData[BASE_JSON].each do |susie|
+			if matchCriterias? susie
+				registerSusie 	susie, COOKIE_FILE
+				registerBuddies	susie
+				informBuddies 	susie
+				
+				return true
+			end
+		end
+		
+		log "No susie class found following criterias."
+		return false
+	end
+
+
+	##
+	# formatDate
+	#
+	# Take Date Object as parameter
+	# Return formated Date (YYY-MM-DD)
+	##
+	def formatDate(date)
+		date.strftime '%Y-%m-%d'
+	end
+
+
+	##
+	# formatTime
+	#
+	# Take Time Object as parameter
+	# Return formated Time (HH:MM YYY-MM-DD)
+	##
+	def formatTime(time)
+		time.strftime '%H:%M %Y-%m-%d'
+	end
+
+
+	##
+	# getSusiesData
+	#
+	# Return Susie Classes JSON Data
+	#
+	def getSusiesData
+		JSON.parse  `curl -s -L -b #{ COOKIE_FILE } '#{ SUSIES_URL }?start=#{ formatDate @startWeek }&end=#{ formatDate @endWeek }&format=json'`
+	end
+
+
+	##
+	# getRegisterMail
+	#
+	# Generate mail which will be send to user's friends.
+	##
+	def getRegisterMail(susie)
+		<<-MESSAGE
+Hey,
+
+I've just registered to a susie class with #{ susie[MAKER_JSON][MAKER_LOGIN_JSON] }.
+
+Title:        #{ susie[TITLE_JSON] }
+Type:         #{ susie[TYPE_JSON] }
+
+Description:
+	#{ susie[DESC_JSON] }
+
+Start:        #{ susie[START_JSON] }.
+End:          #{ susie[END_JSON] }.
+Place left:   #{ 9 - susie[REGISTERED_JSON] }.
+
+Register here: #{ REGISTER_URL }/#{ susie[ID_JSON] }.
+
+		MESSAGE
+	end
+
+
+	##
+	# informBuddies
+	#
+	# send mail to user's friends
+	##
+	def informBuddies(susie)
+		message = getRegisterMail susie
+
+		for email in @mailTargets
+			log "Send mail to #{ email }"
+			sendMail email, message
+		end
+	end
+
+
+	##
+	# log
+	#
+	# Write log info
+	##
+	def log(message)
+		puts "[#{ formatTime Time.now }]> #{ message }"
+	end
+
+
+	##
+	# matchCriterias
+	#
+	# Does Susie match defined criterias?
+	##
+	def matchCriterias?(susie)
+		@login.each do |login|
+			return true if susie[MAKER_JSON][MAKER_LOGIN_JSON] == login and susie[REGISTERED_JSON] <= @maxStudent and Time.parse(susie[START_JSON]).hour >= @minHour
+		end
+		false
+	end
+
+
+	##
+	# nextWeek!
+	#
+	# Go to next week
+	##
+	def nextWeek!
+		@startWeek += 1.week
+		@endWeek   += 1.week
+	end
+
+
+	##
+	# noSusie?
+	#
+	# Check if there are SusieClasses in the given JSON data
+	##
+	def noSusie?(susiesData)
+		!susiesData[BASE_JSON] or susiesData[BASE_JSON].length == 0
+	end
+
+
+	##
+	# registerBuddies
+	#
+	# register buddies with given autologins
+	##
+	def registerBuddies(susie)
+		@buddiesAutologins.each do |autologin|
+			setAuthCookie BUDDIES_COOKIE_FILE, autologin
+			registerSusie susie, BUDDIES_COOKIE_FILE
+		end
+	end
+
+
+	##
+	# registerSusie
+	#
+	# register to given SusieClass
+	##
+	def registerSusie(susie, cookie_file)
+		`curl -s -b #{ cookie_file } -L -X POST #{ REGISTER_URL }/#{ susie[ID_JSON] }/subscribe?format=json`
+		log "Succesfully registered to susie class."
+	end
+
+
+	##
+	# registeredThisWeek?
+	#
+	# Determine if user is already registered to a Susie Class during the given week.
+	##
+	def registeredThisWeek?(weekSusies)
+		weekSusies[BASE_JSON].each do |susie|
+			if susie[EVENT_REGISTERED_JSON]
+				log "Already registered to a susie class with #{ susie[MAKER_JSON][MAKER_LOGIN_JSON] } for week: #{ formatDate @startWeek } #{ formatDate @endWeek }."
+				return true
+			end
+		end
+		
+		log "Not registered to a susie class for week: #{ formatDate @startWeek } #{ formatDate @endWeek }."
+		return false
+	end
+
+
+	##
+	# sendMail
+	#
+	# send mail from user to a buddy.
+	##
+	def sendMail(email, message)
+		smtp = Net::SMTP.new @mailServer, @mailPort
+		smtp.enable_starttls_auto
+		smtp.start @mailServer, @mailUname, @mailPasswd, :plain
+		smtp.send_message message, @mailUname, email
+	end
+
+
+	##
+	# setAuthCookie
+	#
+	# Log on the intra and save user's cookie in COOKIE_FILE
+	##
+	def setAuthCookie(cookie_file, autologin)
+		`curl -s -L -c #{ cookie_file } #{ autologin }`
+	end
+
+end

data/susies.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+	s.name        = 'susies'
+	s.version     = '0.0.2'
+	s.date        = '2013-04-11'
+	s.summary     = 'Epitech Susie Classes Bot'
+	s.description = 'Susies is a Gem to register easily for Epitech Susie Classes'
+	s.has_rdoc    = true
+	s.authors     = ['Simon Ninon']
+	s.email       = 'simon.ninon@gmail.com'
+	s.files       = `git ls-files`.split("\n")
+	s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+	s.license     = 'MIT'
+	s.homepage		= 'https://github.com/Cylix/Susies'
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: susies
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Simon Ninon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies: []
+description: Susies is a Gem to register easily for Epitech Susie Classes
+email: simon.ninon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- MIT_LICENSE.txt
+- README.md
+- example/susies.rb
+- lib/constants.rb
+- lib/susies.rb
+- susies.gemspec
+homepage: https://github.com/Cylix/Susies
+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.1
+signing_key: 
+specification_version: 4
+summary: Epitech Susie Classes Bot
+test_files: []