shiftnote 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2b6656f26dac7e804d5913fc203623998e548e8af5ef23defc3ee2447d02e2a
-  data.tar.gz: 3b3e588761717222c407be99ee76219d9cfa7ed18383a81145eae5fe34205d54
+  metadata.gz: 24825e9ebbda63ba9faf0fd76c83750438962dbf410167c47fbc5ebe884020fe
+  data.tar.gz: 88e4cd763bf6a5cef2516eba9ccfccd9701c4fa48e3d5b8de3bbcf994f8e3705
 SHA512:
-  metadata.gz: e0f3b24ac76fd45f84f2a65817c2b4b57afb2d7d81d292f69231dba98fe27083bf2068e95212e6c5bf5e688147487551a30b90b5fcbe11f5d45f68bb8baa4b82
-  data.tar.gz: fc572be0e9db37eb992a7f7615332ecc29d12bcc284a3d4ecb330a9a0b751e136a6b198438e5973f688ce5267092e3eeafc846ec8a8ccc8aca42344047309ec2
+  metadata.gz: 24bd639a5fce56f0a580cc2ffb54ab868ef2ed52671b62632ba78d8425ef27383698b7f6a3a19ef2b8c0d0de42aa64f3e7077fc38d34868446ce321bda68b50f
+  data.tar.gz: 7dd67473ef2150cc5d821d8ee58335d047e7bdb03fd7235b1acef44fbb76002f51adfc1d0327f6c7c8aa1c5a198b3ce951992141b2d36e3454375f0541cbe37c

data/lib/shiftnote.rb

@@ -8,13 +8,18 @@ require 'rails'
 
 # All ShiftNote functionality, whether extended or just here.
 class ShiftNote
-  # Initialize a new ShiftNote variable, via a cookie.
-  # @param cookie [String] Cookie of an authenticated user.
-  def initialize(credentials = {})
-    @credentials = credentials
-    generate_cookie(credentials[:username], credentials[:password])
+  # Initialize a new ShiftNote variable, via login credentials.
+  # @param username [String] the username of the user.
+  # @param password [String] the password of the user.
+  def initialize(username: nil, password: nil)
+    @credentials = { username: username, password: password }
+    generate_cookie(username, password)
   end
 
+  # Generate a cookie, based on login credentials.
+  # @param username [String] the username of the user.
+  # @param password [String] the password of the user.
+  # @return [String] the cookie!
   def generate_cookie(username, password)
     uri = URI.parse('https://ww1.shiftnote.com/login')
     request = Net::HTTP::Post.new(uri)
@@ -41,9 +46,40 @@ class ShiftNote
     @cookie = response.header['Set-Cookie']
   end
 
-  # Initialize the Employee
-  # @return [ShiftNote::EmployeeOverviewViewModel] the employee
-  def employee
+  # Useful method (for the gem that is) that gets rid of stuff we don't need.
+  # @!visibility private
+  # @param string [String] a string to scrape the junk off
+  def scrapejunk(string)
+    string.gsub('<script>', '').delete(';').gsub('</script>', '').gsub('window.scheduleMinebindings = ShiftNote.Bind(window.scheduleMinemodel)', '').gsub('window.scheduleMinemodel = ', '')
+  end
+
+  # Method to find the next instance of the given date.
+  # @!visibility private
+  # @param day [String] what day to find
+  def date_of_next(day)
+    date  = Date.parse(day)
+    delta = date > Date.today ? 0 : 7
+    date + delta
+  end
+
+  # This is basically an API token.
+  # @return [String] the cookie of the authenticated user
+  def cookie
+    shiftnote = RestClient.get('https://ww1.shiftnote.com/BulletinBoard/', Cookie: @cookie)
+
+    doc = Nokogiri::HTML.parse(shiftnote.body)
+
+    begin
+      doc.search('div#MyScheduleDiv').at('script').text
+    rescue NoMethodError
+      generate_cookie(@credentials[:username], @credentials[:password])
+    end
+    @cookie
+  end
+
+  # Get the information of the currently logged in user.
+  # @return [User] the user
+  def user
     shiftnote = RestClient.get('https://ww1.shiftnote.com/BulletinBoard/', Cookie: @cookie)
 
     doc = Nokogiri::HTML.parse(shiftnote.body)
@@ -57,24 +93,45 @@ class ShiftNote
 
     data = data.gsub('<script>', '').delete(';').gsub('</script>', '').gsub('window.scheduleMinebindings = ShiftNote.Bind(window.scheduleMinemodel)', '').gsub('window.scheduleMinemodel = ', '')
 
-    @employee = EmployeeOverviewViewModel.new(JSON.parse(data))
+    User.new(JSON.parse(data))
+  end
+
+  # Get an employee (by id)
+  # @param id [Integer] the id of the employee
+  def employee(id)
+    Employee.new(id: id)
   end
 
-  # @param weeks [Integer]
-  def get_all_upcoming_shifts(_weeks = 0)
-    employee if @employee = nil?
-    week2 = RestClient.get("https://ww1.shiftnote.com/Schedules/ScheduleMine/?startDate=#{nextmonday.month}%2F#{nextmonday.day}%2F#{nextmonday.year}&noContainer=true&_=1559999273196", Cookie: @cookie)
+  # @param day [String] what day the week starts on.
+  # @return [ScheduleThisWeek] the schedule for next week.
+  def get_next_week_shifts(day = "Monday")
+    nextmonday = date_of_next(day)
+
+    week2 = RestClient.get("https://ww1.shiftnote.com/Schedules/ScheduleMine/?startDate=#{nextmonday.month}%2F#{nextmonday.day}%2F#{nextmonday.year}&noContainer=true&_=#{Time.now.to_i * 1000}", Cookie: cookie)
 
     week2doc = Nokogiri::HTML.parse(week2.body)
     dataweek2 = JSON.parse(scrapejunk(week2doc.at('script').text))
-    me2 = EmployeeOverviewViewModel.new(dataweek2)
+    User.new(dataweek2).schedule_this_week
+  end
+
+  # Send a message to a user (or group of them)
+  # @param recipients [Array<Integer>] who will receive this message
+  def send_message(recipients, subject, body, urgent)
+    data = {
+      "ToUserIDs" => recipients,
+      "Subject" => subject,
+      "Body" => body,
+      "Priority" => urgent
+    }
+    RestClient.post('https://ww1.shiftnote.com/Message/SendMessages', URI.encode_www_form(data), Cookie: @cookie)
   end
 end
 
 # Require files.
 require_relative 'shiftnote/days_of_week_shift'
 require_relative 'shiftnote/days_of_week_shifts'
-require_relative 'shiftnote/employee_overview_view_model'
+require_relative 'shiftnote/employee'
 require_relative 'shiftnote/errors'
-require_relative 'shiftnote/schedule_this_week_view_model'
-require_relative 'shiftnote/shift_view_model'
+require_relative 'shiftnote/schedule_this_week'
+require_relative 'shiftnote/shift'
+require_relative 'shiftnote/user'

data/lib/shiftnote/days_of_week_shift.rb

@@ -1,3 +1,4 @@
+# A specific day of a schedule.
 class ShiftNote::DaysOfWeekShift
   def initialize(data)
     @raw = data
@@ -5,23 +6,28 @@ class ShiftNote::DaysOfWeekShift
     @raw_shifts = data['Shifts']
   end
 
+  # @return [Time] the day
   attr_reader :date
 
+  # @return [Array<Shift>] the shifts this employee is working on this day.
   def shifts
     shifts = []
     @raw_shifts.each do |e|
-      shifts.push ShiftNote::ShiftViewModel.new(e)
+      shifts.push ShiftNote::Shift.new(e)
     end
     shifts
   end
 
+  # @return [Integer] the amount shifts this employee is working on this day.
   def amount_of_shifts
     @raw_shifts.length
   end
 
+  # @return [Shift] the first shift this employee is working on this day.
   def first_shift
-    ShiftNote::ShiftViewModel.new(@raw_shifts.first)
+    ShiftNote::Shift.new(@raw_shifts.first)
   end
 
+  # @return [JSON] the raw data returned by ShiftNote.
   attr_reader :raw
 end

data/lib/shiftnote/days_of_week_shifts.rb

@@ -1,8 +1,11 @@
+# The days of the week, their shifts.
 class ShiftNote::DaysOfWeekShifts
   def initialize(data)
     @data = data
   end
 
+  # The days in this week, whether working or not.
+  # @return [Array<DaysOfWeekShift>] the days in this schedule.
   def days
     dayz = []
     @data.each do |e|
@@ -11,6 +14,7 @@ class ShiftNote::DaysOfWeekShifts
     dayz
   end
 
+  # @return [Array<DaysOfWeekShift>] only the days this employee is working.
   def working_days
     dayz = []
     @data.each do |e|
@@ -19,6 +23,7 @@ class ShiftNote::DaysOfWeekShifts
     dayz
   end
 
+  # @return [JSON] the raw data returned by ShiftNote
   def raw
     @data
   end

data/lib/shiftnote/employee.rb

@@ -0,0 +1,26 @@
+# An employee.
+class ShiftNote::Employee 
+  def initialize(id: nil)
+    @id = id
+  end
+
+  # @return [Integer] the ID of the employee
+  attr_reader :id
+
+  # Deletes this employee
+  # Quote from the site
+  #   This employee may have scheduled shifts.
+  #   You can choose to have these assigned shifts converted to house shifts if they are on a published schedule, and template shifts if they are on a draft schedule.
+  #   If [false], you will have to manually reassign or delete any shifts assigned to this employee.
+  # [true] will convert assigned shifts to house and template shifts.
+  # @param convert_shifts [true, false] whether to convert these shifts
+  def delete(convert_shifts = false)
+    cooki = cookie
+    puts cooki
+    data = {
+      'EmployeeID' => @id,
+      'ConvertShifts' => convert_shifts,
+      '_' => Time.now.to_i * 1000
+    }
+  end
+end

data/lib/shiftnote/schedule_this_week.rb

@@ -0,0 +1,34 @@
+# The schedule for this week.
+class ShiftNote::ScheduleThisWeek
+  def initialize(data)
+    @raw = data
+    @start_date = Time.parse(data['StartDate'])
+    @end_date = Time.parse(data['EndDate'])
+    @hours = data['Hours']
+    @cost = data['Cost']
+    @shifts = data['Shifts']
+    @schedule = ShiftNote::DaysOfWeekShifts.new(data['DaysOfWeekShifts'])
+  end
+
+  # @return [Time] the start date of the schedule.
+  attr_reader :start_date
+
+  # @return [Time] the end date of the schedule.
+  attr_reader :end_date
+
+  # @return [Float] the total hours this employee is working this schedule
+  attr_reader :hours
+
+  # The cost is simply hours * rate.
+  # @return [Float] the amount of pay the employee will receive
+  attr_reader :cost
+
+  # @return [Float] the amount of shifts this person has this week.
+  attr_reader :shifts
+
+  # @return [ShiftNote::DaysOfWeekShifts] the schedule for this week
+  attr_reader :schedule
+
+  # @return [JSON] the raw data returned by ShiftNote.
+  attr_reader :raw
+end

data/lib/shiftnote/shift.rb

@@ -0,0 +1,144 @@
+# A shift, on the schedule. Woah!
+class ShiftNote::Shift
+  def initialize(data)
+    @raw = data
+    @schedule_id = data['ScheduleId']
+    @schedule_name = data['ScheduleName']
+    @schedule_status_id = data['ScheduleStatusId']
+    @shift_id = data['ShiftId']
+    @employee_id = data['EmployeeId']
+    @employee = data['Employee']
+    @shift_date = Time.parse(data['ShiftDate'])
+    @time_in = Time.parse(data['TimeIn'])
+    @time_out = Time.parse(data['TimeOut'])
+    @position = data['Position']
+    @position_color = data['PositionColor']
+    @internal_location = data['InternalLocation']
+    @open = data['Open']
+    @close = data['Close']
+    @on_call = data['OnCall']
+    @volume = data['Volume']
+    @note = data['Note']
+    @hours = data['Hours']
+    @cost = data['Cost']
+    @is_pending_pickup = data['IsPendingPickUp']
+    @is_pending_manager_approval = data['IsPendingManagerApproval']
+    @is_pending_swap = data['IsPendingSwap']
+    @is_pending_swap_manager_approval = data['IsPendingSwapManagerApproval']
+    @hide_end_times = data['HideEndTimes']
+  end
+
+  # @return [Integer] the shift's schedule's ID.
+  attr_reader :schedule_id
+
+  # @return [String] the shift's schedule's name
+  attr_reader :schedule_name
+
+  # I have absolutely no idea what the IDs mean.
+  # @return [Integer] the shift's schedule's status ID.
+  attr_reader :schedule_status_id
+
+  # @return [Integer] the shift's ID.
+  attr_reader :shift_id
+
+  # @return [Integer] the employee working this shift's ID.
+  attr_reader :employee_id
+
+  # @return [String] the name of the employee working this Shift.
+  attr_reader :employee
+
+  # @return [Time] the date of this shift.
+  attr_reader :shift_date
+
+  # @return [Time] the time this employee should clock in.
+  attr_reader :time_in
+
+  # @return [Time] the time this employee should clock out.
+  attr_reader :time_out
+
+  # @return [String] the position this employee is working.
+  attr_reader :position
+
+  # Probably used on the website.
+  # @return [String] the color of this position this employee is working.
+  attr_reader :position_color
+
+  # @return [String] the internal location of this shift.
+  attr_reader :internal_location
+
+  # I don't know what this means. Do they open? Is the shift open? What!
+  # It's true or false though.
+  # @return [true, false]
+  attr_reader :open
+
+  # I don't know what this means.
+  # @return [true, false]
+  attr_reader :close
+
+  # I don't know what this means.
+  # @return [true, false]
+  attr_reader :on_call
+
+  # I don't know what this means.
+  # @return [true, false]
+  attr_reader :volume
+
+  # I don't know what this means.
+  # @return [String]
+  attr_reader :note
+
+  # @return [Float] the duration of this shift in hours.
+  attr_reader :hours
+
+  # @return [Float] the cost of this shift for the company
+  attr_reader :cost
+
+  # This is true if this shift is dropped.
+  # This is false if it's been picked up or never was dropped.
+  # @return [true, false] whether this shift is pending pickup
+  def pending_pickup?
+    @is_pending_pickup
+  end
+
+  # If the shift is waiting for the manager to approve it.
+  # @return [true, false] whether this shift is pending manager approval
+  def pending_manager_approval?
+    @is_pending_manager_approval
+  end
+
+  # When a shift is swapped with someone, it waits for them to accept or deny.
+  # Until that happens, this is true.
+  # @return [true, false] is the shift is pending swap.
+  def pending_swap?
+    @is_pending_swap
+  end
+
+  # When the shift swap is approved, the manager needs to approve it.
+  # Until this happens, this is true.
+  # @return [true, false] is the shift is pending swap manager approval.
+  def pending_swap_manager_approval?
+    @is_pending_swap_manager_approval
+  end
+
+  # I wonder what happens when this is true. Hopefully it doesn't break.
+  # @return [true, false] to hide the end time of the shift.
+  def hide_end_times?
+    @hide_end_times
+  end
+
+  # @return [JSON] the raw data returned by ShiftNote
+  attr_reader :raw
+
+  # Releases the shift to an employee.
+  # @param [Integer] the employee ID of the employee to drop this to, leave blank for everyone.
+  # @param [String] the reason for dropping this shift.
+  def release(employee = 0, reason = nil)
+    data = {
+      "ShiftID" => shift_id,
+      "ScheduleID" => schedule_id,
+      "EmployeeId" => employee,
+      "Reason" => reason,
+      "X-Requested-With" => "XMLHttpRequest"
+    }
+  end
+end

data/lib/shiftnote/{employee_overview_view_model.rb → user.rb}

@@ -1,4 +1,5 @@
-class ShiftNote::EmployeeOverviewViewModel
+# An employee.
+class ShiftNote::User < ShiftNote::Employee
   def initialize(data)
     @raw = data
     @id = data['EmployeeId']
@@ -8,8 +9,8 @@ class ShiftNote::EmployeeOverviewViewModel
       'mobile' => data['MobilePhone']
     }
     @email = data['Email']
-    @birthday = Time.parse(data['BirthDate'])
-    @schedule_this_week = ShiftNote::ScheduleThisWeekViewModel.new(data['ScheduleThisWeekViewModel'])
+    @birthday = data['BirthDate'] ? Time.parse(data['BirthDate']) : nil
+    @schedule_this_week = ShiftNote::ScheduleThisWeek.new(data['ScheduleThisWeekViewModel'])
     @trade_shifts = data['TradeShifts']
     @trade_shifts_current_day = data['TradeShiftsCurrentDay']
     @positions = data['ThisEmployeePositions']
@@ -36,12 +37,33 @@ class ShiftNote::EmployeeOverviewViewModel
   attr_reader :birthday
 
   # The user's "Schedule This Week," consider the return type for info
-  # @return [ShiftNote::ScheduleThisWeekViewModel]
+  # @return [ScheduleThisWeek]
   attr_reader :schedule_this_week
-  attr_reader :raw
-  attr_reader :trade_shifts
-  attr_reader :trade_shifts_current_day
+
+  # Trading (or swapping) means the employee can trade shifts with other employees.
+  # @return [true, false] if this employee can trade (or swap) shifts at all.
+  def trade_shifts?
+    @trade_shifts
+  end
+
+  alias_method :can_swap?, :trade_shifts?
+
+  # Assuming trade_shifts? is true, this method returns if the user can trade shifts
+  # for the given day. Where I work, this is false. Should've thought of that first, Billy.
+  # @return [true, false] if this employee can trade shifts for today's shifts.
+  def trade_shifts_current_day?
+    @trade_shifts_current_day
+  end
+
+  # @return [Array<String>] the positions this employee is working.
   attr_reader :positions
+
+  # @return [Time, nil] the employee's last day, nil if they don't have one (good)
   attr_reader :last_day
+
+  # @return [Time, nil] the employee's hire date, nil if they don't have one set
   attr_reader :hire_day
+
+  # @return [JSON] the raw data returned by ShiftNote
+  attr_reader :raw
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiftnote
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-17 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -61,20 +61,30 @@ files:
 - lib/shiftnote.rb
 - lib/shiftnote/days_of_week_shift.rb
 - lib/shiftnote/days_of_week_shifts.rb
-- lib/shiftnote/employee_overview_view_model.rb
+- lib/shiftnote/employee.rb
 - lib/shiftnote/errors.rb
-- lib/shiftnote/schedule_this_week_view_model.rb
-- lib/shiftnote/shift_view_model.rb
+- lib/shiftnote/schedule_this_week.rb
+- lib/shiftnote/shift.rb
+- lib/shiftnote/user.rb
 homepage: https://github.com/Chew/ShiftNoteRB
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/Chew/ShiftNoteRB/issues
   changelog_uri: https://github.com/Chew/ShiftNoteRB/releases
+  documentation_uri: https://rubydocs.chew.pro/docs/shiftnote
   homepage_uri: http://github.com/Chew/ShiftNoteRB
   source_code_uri: http://github.com/Chew/ShiftNoteRB
   wiki_uri: http://github.com/Chew/ShiftNoteRB/wiki
-post_install_message: 
+post_install_message: |-
+  Hello! Thanks for using this ShiftNote gem. 0.2.0 introduced some major changes.
+  If this is your first version you can just ignore this message.
+
+   * ShiftNote#employee has been replaced with ShiftNote#user.
+   * "ViewModel" has been removed from all class names.
+
+  Check the documentation server (https://rubydocs.chew.pro/docs/shiftnote) and the GitHub Release (https://github.com/Chew/ShiftNoteRB/releases/tag/0.2.0) to see the full changes!
+  Enjoy :)
 rdoc_options: []
 require_paths:
 - lib

data/lib/shiftnote/schedule_this_week_view_model.rb

@@ -1,19 +0,0 @@
-class ShiftNote::ScheduleThisWeekViewModel
-  def initialize(data)
-    @raw = data
-    @start_date = Time.parse(data['StartDate'])
-    @end_date = Time.parse(data['EndDate'])
-    @hours = data['Hours']
-    @cost = data['Cost']
-    @shifts = data['Shifts']
-    @schedule = ShiftNote::DaysOfWeekShifts.new(data['DaysOfWeekShifts'])
-  end
-
-  attr_reader :start_date
-  attr_reader :end_date
-  attr_reader :hours
-  attr_reader :cost
-  attr_reader :shifts
-  attr_reader :schedule
-  attr_reader :raw
-end

data/lib/shiftnote/shift_view_model.rb

@@ -1,60 +0,0 @@
-class ShiftNote::ShiftViewModel
-  def initialize(data)
-    @raw = data
-    @schedule_id = data['ScheduleId']
-    @schedule_name = data['ScheduleName']
-    @schedule_status_id = data['ScheduleStatusId']
-    @shift_id = data['ShiftId']
-    @employee_id = data['EmployeeId']
-    @employee = data['Employee']
-    @shift_date = Time.parse(data['ShiftDate'])
-    @time_in = Time.parse(data['TimeIn'])
-    @time_out = Time.parse(data['TimeOut'])
-    @position = data['Position']
-    @position_color = data['PositionColor']
-    @internal_location = data['InternalLocation']
-    @open = data['Open']
-    @close = data['Close']
-    @on_call = data['OnCall']
-    @volume = data['Volume']
-    @note = data['Note']
-    @hours = data['Hours']
-    @cost = data['Cost']
-    @is_pending_pickup = data['IsPendingPickUp']
-    @is_pending_manager_approval = data['IsPendingManagerApproval']
-    @is_pending_swap = data['IsPendingSwap']
-    @is_pending_swap_manager_approval = data['IsPendingSwapManagerApproval']
-    @hide_end_times = data['HideEndTimes']
-  end
-
-  attr_reader :schedule_id
-  attr_reader :schedule_name
-  attr_reader :schedule_status_id
-  attr_reader :shift_id
-  attr_reader :employee_id
-  attr_reader :employee
-  attr_reader :shift_date
-  attr_reader :time_in
-  attr_reader :time_out
-  attr_reader :position
-  attr_reader :position_color
-  attr_reader :internal_location
-  attr_reader :open
-  attr_reader :close
-  attr_reader :on_call
-  attr_reader :volume
-  attr_reader :note
-  attr_reader :hours
-  attr_reader :cost
-  attr_reader :is_pending_pickup
-  attr_reader :is_pending_manager_approval
-  attr_reader :is_pending_swap
-  attr_reader :is_pending_swap_manager_approval
-  attr_reader :hide_end_times
-  attr_reader :raw
-
-  # Releases the shift
-  def release(employee = 0)
-
-  end
-end