xteam_schedule 0.1.1 → 0.2.0

data/README.md

@@ -13,7 +13,7 @@ You can find a blog post explaining some of the thinking behind its implementati
 * **Read and write schedules** and interact with in-memory models through the ActiveRecord interface
 * **Customise everything**; resources, assignments, groups, colours, interface settings..
 * **Intuitive naming** of models, that correspond to what you see on screen
-* **Full test coverage**, giving confidence to highly dynamic businesses everywhere
+* **Full test coverage**, giving confidence to highly dynamic businesses everywhere [![Build Status](https://secure.travis-ci.org/cpatuzzo/xteam_schedule.png?branch=master)](http://travis-ci.org/cpatuzzo/xteam_schedule)
 
 ### Disclaimer
 
@@ -138,6 +138,8 @@ gmail_resource_names = resources.where('email like "%gmail%"').map(&:name)
 resources.each { |r| r.update_attribute(:displayed_in_planning, true) }
 ```
 
+A resource also has remote access attributes, that are explained below.
+
 ## Assignment Groups
 
 Assignment groups are almost identical to resource groups. Typical names might be 'Training' and 'Research'.
@@ -334,6 +336,57 @@ finished_holidays = schedule.resources.map(&:holidays).flatten.select { |h|
 }
 ```
 
+## Remote Access
+
+Remote access allows the xTeamView application on Mac OS X and iOS devices to view schedules remotely. A schedule has a remote_access object containing most of the setup, including the 'All' login option for the schedule.
+
+```ruby
+schedule.remote_access.update_attributes!(
+  :enabled => true,
+  :custom_url => 'http://xteambridge.example.com',
+  :custom_enabled => true,
+  :global_login => 'username',
+  :global_password => 'password',
+  :global_login_enabled => true
+)
+```
+
+When remote access is switched on in xTeam, there is a handshake process that takes place which assigns a server_id and name to the schedule. If either of these is missing or they become out of sync, the handshake will fail and you will be notified of an error in xTeam. Therefore, it is recommended that you do not change these attributes. Instead, you should enable remote in xTeam then read these attributes from that file. You can then re-use them as you please.
+
+```ruby
+schedule = XTeamSchedule.new('path/to/file/with/remote/enabled.xtps')
+server_id = schedule.remote_access.server_id
+name = schedule.remote_access.name
+
+# An example of re-using the remote configuration for an entirely new schedule
+schedule = XTeamSchedule.new
+schedule.remote_access.update_attributes!(
+  :server_id => server_id,
+  :name => name
+)
+```
+
+There are three additional attributes on each resource for configuring individual logins. It is worth noting that login details have to be plaintext, unfortunately.
+
+```ruby
+resource_group = schedule.resource_groups.create(:name => 'foo')
+resource = resource_group.resources.create!(
+  :name => 'bar',
+  :remote_login => 'foo',
+  :remote_password => 'bar',
+  :remote_login_enabled => true
+)
+```
+
+**Example queries:**
+
+```ruby
+global_login_details = [schedule.remote_access.global_login, schedule.remote_access.global_password]
+resources_without_logins = schedule.resources.reject { |r| r.remote_login }
+usernames = schedule.resources.map(&:remote_login).compact
+raise 'There are duplicated logins' if usernames.count > usernames.uniq.count
+```
+
 ## Under Development
 
 This gem is far from complete. The following is a list of features that are under development:
@@ -341,7 +394,6 @@ This gem is far from complete. The following is a list of features that are unde
 * Resource images
 * Sort by
 * Absences
-* Remote access
 * To assign
 * Advanced colour controls
 * Schedule splicing between dates

data/lib/xteam_schedule/facilitation/base.rb

@@ -49,6 +49,9 @@ class XTeamSchedule::Base < ActiveRecord::Base
         table.column :mobile, :string
         table.column :name, :string
         table.column :phone, :string
+        table.column :remote_login, :string
+        table.column :remote_password, :string
+        table.column :remote_login_enabled, :boolean
       end
 
       create_table :assignment_groups, :force => true do |table|
@@ -78,6 +81,18 @@ class XTeamSchedule::Base < ActiveRecord::Base
         table.column :end_date, :date
         table.column :name, :string
       end
+
+      create_table :remote_accesses, :force => true do |table|
+        table.column :schedule_id, :integer
+        table.column :server_id, :integer
+        table.column :enabled, :boolean
+        table.column :name, :string
+        table.column :custom_url, :string
+        table.column :custom_enabled, :boolean
+        table.column :global_login, :string
+        table.column :global_password, :string
+        table.column :global_login_enabled, :boolean
+      end
     end
   end
 end

data/lib/xteam_schedule/facilitation/composer.rb

@@ -9,7 +9,7 @@ class XTeamSchedule::Composer
   def initialize(schedule)
     schedule.save!
     self.schedule = schedule
-    self.hash = {}
+    self.hash = HashWithoutNilValues.new
   end
 
   def compose
@@ -21,6 +21,7 @@ class XTeamSchedule::Composer
     compose_interface!
     compose_weekly_working_schedule!
     compose_holidays!
+    compose_remote_access!
     compose_schedule!
     hash
   end
@@ -31,10 +32,10 @@ private
     hash['resource groups'] ||= []
     resource_groups = schedule.resource_groups
     resource_groups.each do |rg|
-      hash['resource groups'] << {
-        'name' => rg.name,
-        'expanded in library' => rg.expanded_in_library
-      }
+      hash['resource groups'] << {}
+      current = hash['resource groups'].last
+      current['name'] = rg.name
+      current['expanded in library'] = rg.expanded_in_library
     end
   end
 
@@ -43,15 +44,15 @@ private
     resources = schedule.resource_groups.map(&:resources).flatten
     resources.each do |r|
       image = Base64.decode64(r.image) if r.image
-      hash['resources'] << {
-        'displayedInPlanning' => r.displayed_in_planning,
-        'email' => r.email,
-        'image' => (StringIO.new(image) if image),
-        'mobile' => r.mobile,
-        'name' => r.name,
-        'phone' => r.phone,
-        'group' => r.resource_group.name
-      }
+      hash['resources'] << {}
+      current = hash['resources'].last
+      current['displayedInPlanning'] = r.displayed_in_planning
+      current['email'] = r.email
+      current['image'] = (StringIO.new(image) if image)
+      current['mobile'] = r.mobile
+      current['name'] = r.name
+      current['phone'] = r.phone
+      current['group'] = r.resource_group.name
     end
   end
 
@@ -59,10 +60,10 @@ private
     hash['task categories'] ||= []
     assignment_groups = schedule.assignment_groups
     assignment_groups.each do |ag|
-      hash['task categories'] << {
-        'name' => ag.name,
-        'expanded in library' => ag.expanded_in_library
-      }
+      hash['task categories'] << {}
+      current = hash['task categories'].last
+      current['name'] = ag.name
+      current['expanded in library'] = ag.expanded_in_library
     end
   end
 
@@ -70,12 +71,12 @@ private
     hash['tasks'] ||= []
     assignments = schedule.assignment_groups.map(&:assignments).flatten
     assignments.each do |a|
-      hash['tasks'] << {
-        'name' => a.name,
-        'category' => a.assignment_group.name,
-        'kind' => 0,
-        'color' => compose_colour(a.colour)
-      }
+      hash['tasks'] << {}
+      current = hash['tasks'].last
+      current['name'] = a.name
+      current['category'] = a.assignment_group.name
+      current['kind'] = 0
+      current['color'] = compose_colour(a.colour)
     end
   end
 
@@ -85,15 +86,15 @@ private
     resources.each do |r|
       working_times_with_parents = r.working_times.select { |wt| wt.resource and wt.assignment }
       next unless working_times_with_parents.any?
-      hash['objectsForResources'].merge!(r.name => [])
+      hash['objectsForResources'][r.name] = []
       working_times_with_parents.each do |wt|
-        hash['objectsForResources'][r.name] << {
-          'task' => wt.assignment.name,
-          'begin date' => compose_date(wt.begin_date),
-          'duration' => wt.duration,
-          'notes' => wt.notes,
-          'title' => ''
-        }
+        hash['objectsForResources'][r.name] << {}
+        current = hash['objectsForResources'][r.name].last
+        current['task'] = wt.assignment.name
+        current['begin date'] = compose_date(wt.begin_date)
+        current['duration'] = wt.duration
+        current['notes'] = wt.notes
+        current['title'] = ''
       end
     end
   end
@@ -107,7 +108,8 @@ private
     hash['display resource totals'] = interface.display_total_of_working_hours
     hash['display task notes'] = interface.display_assignments_notes
     hash['display absence cells'] = interface.display_absences
-    hash['interface status'] = { 'latest time navigation mode' => interface.time_granularity }
+    hash['interface status'] ||= {}
+    hash['interface status']['latest time navigation mode'] = interface.time_granularity
   end
 
   def compose_weekly_working_schedule!
@@ -120,23 +122,23 @@ private
 
     working_days.each do |day|
       day_name = day.name.downcase
-      hash['settings']['working schedule'][day_name] =
+      hash['settings']['working schedule'][day_name] = {}
+      current = hash['settings']['working schedule'][day_name]
       if day.day_begin.present?
-        { 'worked' => 'yes',
-          'begin' => compose_time(day.day_begin),
-          'end' => compose_time(day.day_end) }
+        current['worked'] = 'yes'
+        current['begin'] = compose_time(day.day_begin)
+        current['end'] = compose_time(day.day_end)
       else
-        { 'worked' => 'no' }
+        current['worked'] = 'no'
       end
 
-      hash['settings']['working schedule']["pause_#{day_name}"] =
+      hash['settings']['working schedule']["pause_#{day_name}"] = {}
+      current = hash['settings']['working schedule']["pause_#{day_name}"]
       if day.day_begin.present? and day.break_begin.present?
-        { 'worked' => 'yes',
-          'begin' => compose_time(day.break_begin),
-          'end' => compose_time(day.break_end),
-          'duration' => compose_time(day.break_end) - compose_time(day.break_begin) }
-      else
-        {}
+        current['worked'] = 'yes'
+        current['begin'] = compose_time(day.break_begin)
+        current['end'] = compose_time(day.break_end)
+        current['duration'] = compose_time(day.break_end) - compose_time(day.break_begin)
       end
     end
   end
@@ -154,11 +156,11 @@ private
 
     holidays.each do |h|
       h.end_date ||= h.begin_date
-      hash['settings']['days off'] << {
-        'begin date' => compose_date(h.begin_date),
-        'end date' => compose_date(h.end_date),
-        'name' => h.name
-      }
+      hash['settings']['days off'] << {}
+      current = hash['settings']['days off'].last
+      current['begin date'] = compose_date(h.begin_date)
+      current['end date'] = compose_date(h.end_date)
+      current['name'] = h.name
     end
   end
 
@@ -174,15 +176,51 @@ private
       hash['resources'][index]['settings']['use custom days off'] = 1
       r.holidays.each do |h|
         h.end_date ||= h.begin_date
-        hash['resources'][index]['settings']['days off'] << {
-          'begin date' => compose_date(h.begin_date),
-          'end date' => compose_date(h.end_date),
-          'name' => h.name
-        }
+        hash['resources'][index]['settings']['days off'] << {}
+        current = hash['resources'][index]['settings']['days off'].last
+        current['begin date'] = compose_date(h.begin_date)
+        current['end date'] = compose_date(h.end_date)
+        current['name'] = h.name
       end
     end
   end
 
+  def compose_remote_access!
+    remote_access = schedule.remote_access
+    hash['settings'] ||= {}
+
+    valid_setup = remote_access.server_id && remote_access.name
+    enable = valid_setup && remote_access.enabled
+
+    hash['settings']['remoteId'] = remote_access.server_id if valid_setup
+    hash['settings']['remoteEnable'] = enable
+    hash['settings']['remoteName'] = remote_access.name if valid_setup
+    hash['settings']['remoteCustomServerURL'] = remote_access.custom_url
+    hash['settings']['remoteUseCustomServer'] = remote_access.custom_enabled
+
+    if remote_access.global_login or remote_access.global_password
+      hash['settings']['remoteLoginInfo'] ||= {}
+      hash['settings']['remoteLoginInfo']['All'] ||= {}
+      hash['settings']['remoteLoginInfo']['All']['login'] = remote_access.global_login
+      hash['settings']['remoteLoginInfo']['All']['password'] = remote_access.global_password
+      hash['settings']['remoteLoginInfo']['All']['enable'] = remote_access.global_login_enabled
+    end
+
+    compose_remote_access_for_resources!
+  end
+
+  def compose_remote_access_for_resources!
+    hash['settings'] ||= {}
+    hash['settings']['remoteLoginInfo'] ||= {}
+
+    schedule.resources.each do |r|
+      hash['settings']['remoteLoginInfo'][r.name] = {}
+      hash['settings']['remoteLoginInfo'][r.name]['login'] = r.remote_login
+      hash['settings']['remoteLoginInfo'][r.name]['password'] = r.remote_password
+      hash['settings']['remoteLoginInfo'][r.name]['enable'] = r.remote_login_enabled
+    end
+  end
+
   def compose_schedule!
     hash['begin date'] = compose_date(schedule.begin_date)
     hash['end date'] = compose_date(schedule.end_date)

data/lib/xteam_schedule/facilitation/parser.rb

@@ -20,6 +20,7 @@ class XTeamSchedule::Parser
     parse_interface!
     parse_weekly_working_schedule!
     parse_holidays!
+    parse_remote_access!
     parse_schedule!
     schedule
   end
@@ -189,6 +190,40 @@ private
     end
   end
 
+  def parse_remote_access!
+    settings = hash['settings']
+    return unless settings.present?
+    remote_logins = settings['remoteLoginInfo']
+    return unless remote_logins.present?
+    global_login = remote_logins['All']
+    global_login ||= {}
+    schedule.remote_access.update_attributes!(
+      :server_id => settings['remoteId'],
+      :enabled => settings['remoteEnable'],
+      :name => settings['remoteName'],
+      :custom_url => settings['remoteCustomServerURL'],
+      :custom_enabled => settings['remoteUseCustomServer'],
+      :global_login => global_login['login'],
+      :global_password => global_login['password'],
+      :global_login_enabled => global_login['enable']
+    )
+    parse_remote_access_for_resources!
+  end
+
+  def parse_remote_access_for_resources!
+    settings = hash['settings']
+    remote_logins = settings['remoteLoginInfo']
+    remote_logins.each do |name, hash|
+      resource = schedule.resources.find_by_name(name)
+      next unless resource
+      resource.update_attributes!(
+        :remote_login => hash['login'],
+        :remote_password => hash['password'],
+        :remote_login_enabled => hash['enable']
+      )
+    end
+  end
+
   def parse_schedule!
     schedule.update_attributes!(
       :begin_date => parse_date(hash['begin date']),

data/lib/xteam_schedule/facilitation/qtn_patch.rb

@@ -0,0 +1,21 @@
+# Fixes dynamic find by method attempting to use the connection
+# on ActiveRecord::Base in activerecord versions 3.1.0 to 3.2.2
+# when it should be respecting the connection on its subclass
+class QuoteTableNamePatch
+  def self.quote_table_name(name)
+    name
+  end
+end
+
+module ActiveRecord
+  module Associations
+    class AliasTracker
+      private
+      def connection
+        ActiveRecord::Base.connection
+      rescue ActiveRecord::ConnectionNotEstablished
+        QuoteTableNamePatch
+      end
+    end
+  end
+end

data/lib/xteam_schedule/facilitation/without_nil.rb

@@ -0,0 +1,33 @@
+# hash = HashWithoutNilValues.new
+# hash[:a] = nil
+# hash # => {}
+#
+# hash[:a] = {}
+# hash[:a].class # => HashWithoutNilValues
+#
+# hash[:a] = []
+# hash[:a].class # => ArrayWithoutNilValues
+#
+# hash[:a] << nil
+# hash[:a] # => []
+#
+# hash[:a] << {}
+# hash[:a].first.class # => HashWithoutNilValues
+#
+class HashWithoutNilValues < Hash
+  def []=(key, value)
+    return if value.nil?
+    value = HashWithoutNilValues.new if value == {}
+    value = ArrayWithoutNilValues.new if value == []
+    super(key, value)
+  end
+end
+
+class ArrayWithoutNilValues < Array
+  def <<(value)
+    return if value.nil?
+    value = ArrayWithoutNilValues.new if value == []
+    value = HashWithoutNilValues.new if value == {}
+    super(value)
+  end
+end

data/lib/xteam_schedule/models/remote_access.rb

@@ -0,0 +1,20 @@
+class XTeamSchedule::RemoteAccess < XTeamSchedule::Base
+  belongs_to :schedule
+
+  validate :format_of_name
+  NAME_REGEX = /XTEAM-\d{8}-\d{4}/.freeze
+
+private
+
+  def format_of_name
+    return unless name
+    raise 'invalid' unless name =~ NAME_REGEX
+    xteam, date, time = name.split('-')
+    day, month, year = date[0..1], date[2..3], date[4..7]
+    hour, minute = time[0..1], time[2..3]
+    DateTime.new(year.to_i, month.to_i, day.to_i, hour.to_i, minute.to_i)
+  rescue
+    errors.add(:name, 'is not in the form XTEAM-DDMMYYYY-HHMM')
+  end
+
+end

data/lib/xteam_schedule/models/schedule.rb

@@ -8,13 +8,16 @@ class XTeamSchedule::Schedule < XTeamSchedule::Base
 
   has_one :interface
   has_one :weekly_working_schedule
+  has_one :remote_access
 
   ActiveSupport::Deprecation.silence do
     after_initialize :set_default_interface
     after_initialize :set_default_weekly_working_schedule
+    after_initialize :set_default_remote_access
     def after_initialize
       set_default_interface
       set_default_weekly_working_schedule
+      set_default_remote_access
     end
   end
 
@@ -33,4 +36,8 @@ private
     self.weekly_working_schedule ||= XTeamSchedule::WeeklyWorkingSchedule.new
   end
 
+  def set_default_remote_access
+    self.remote_access ||= XTeamSchedule::RemoteAccess.new
+  end
+
 end

data/lib/xteam_schedule.rb

@@ -1,5 +1,12 @@
+begin
+  require 'yaml'
+  YAML::ENGINE.yamler = 'syck'
+rescue
+end
+
 require 'plist'
 require 'active_record'
+require 'active_support/multibyte'
 require 'sqlite3'
 require 'xteam_schedule/core'
 
@@ -9,10 +16,13 @@ require 'xteam_schedule/facilitation/parser'
 require 'xteam_schedule/facilitation/composer'
 require 'xteam_schedule/facilitation/io'
 require 'xteam_schedule/facilitation/lmc_patch'
+require 'xteam_schedule/facilitation/qtn_patch'
+require 'xteam_schedule/facilitation/without_nil'
 
 require 'xteam_schedule/models/assignment'
 require 'xteam_schedule/models/assignment_group'
 require 'xteam_schedule/models/interface'
+require 'xteam_schedule/models/remote_access'
 require 'xteam_schedule/models/resource'
 require 'xteam_schedule/models/resource_group'
 require 'xteam_schedule/models/schedule'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xteam_schedule
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Christopher Patuzzo
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-14 00:00:00 Z
+date: 2012-04-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plist
@@ -107,11 +107,14 @@ files:
 - lib/xteam_schedule/facilitation/io.rb
 - lib/xteam_schedule/facilitation/lmc_patch.rb
 - lib/xteam_schedule/facilitation/parser.rb
+- lib/xteam_schedule/facilitation/qtn_patch.rb
 - lib/xteam_schedule/facilitation/schema.rb
+- lib/xteam_schedule/facilitation/without_nil.rb
 - lib/xteam_schedule/models/assignment.rb
 - lib/xteam_schedule/models/assignment_group.rb
 - lib/xteam_schedule/models/holiday.rb
 - lib/xteam_schedule/models/interface.rb
+- lib/xteam_schedule/models/remote_access.rb
 - lib/xteam_schedule/models/resource.rb
 - lib/xteam_schedule/models/resource_group.rb
 - lib/xteam_schedule/models/schedule.rb
@@ -148,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: XTeam Schedule