projector_pws 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45d785b1f6f1ff2701b369ef782874d78c1205c2
+  data.tar.gz: d09550953bff128a3ab30daf083a5e91af78ac01
+SHA512:
+  metadata.gz: dd771285d83de784fecd46c54ee9ba749c53a899b9ac097c4d285a45a3b3c45b01c33a0538dad3e0d8c6af99f919b5348c7c04f35d71dce93e9ba594103554ee
+  data.tar.gz: 7e414dfbaaab808c0a984b1c4e76c144e616348a6a0e5b10f729c9c3db95e54a7f745ae0f80eca76246c2448bd39b7651ab6cf36efe953e024c38017fb97fc00

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Paul Duncan
+
+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,213 @@
+# ProjectorPWS
+
+Client library for accessing Projector PSA\'s Web Services (PWS)
+
+## Presentation
+
+This library provides access to Projector PSA\'s Web Services (PWS).
+
+## Installation
+
+### Gemfile
+```ruby
+gem 'projector_pws'
+```
+
+### Terminal
+```bash
+gem install -V projector_pws
+```
+
+## Usage
+
+### Symbolize Keys
+
+A _sym_keys_ method is monkey-patched into the *Array* and *Hash* classes, and provides a way to recursively convert *keys* to *symbols*.
+This is mostly useful when loading Hashes from external resources (YAML, CSV, JSON, etc...), where keys will be stored as strings.
+
+```ruby
+a = { 'foo' => 'bar', 'nested' => [{ 'problems' => 'none' }] }
+a.sym_keys
+# => {:foo=>"bar", :nested=>[{:problems=>"none"}]}
+```
+
+### Deep-clone
+
+A _dclone_ method is monkey-patched into the *Array* and *Hash* classes, and provides a way to recursively *deep-clone* an instance.
+
+```ruby
+a = { foo: 'bar', bar: :kill_me, nested: [{ problems: 'none' }] }
+b = a.dclone
+b[:nested] << :foo
+b[:nested][:problems] = 'no way'
+b[:test] = :bork
+b[:foo] = nil
+b.delete :bar
+a
+# => {:foo=>nil, :nested=>[{:problems=>"no way"}, :foo], :test => :bork}
+b
+# => {:foo=>"bar", :nested=>[{:problems=>"none"}]}
+```
+
+### Right/Left Padding
+
+Two padding methods _rpad_ and _lpad_ are monkey-patched into the *String* class, and provide a way to pad any string to a given length using a given filler string.
+
+```ruby
+a = 'foo'
+a.rpad 10
+# => "foo       "
+a.rpad 10, '-'
+# => "foo-------"
+a.rpad 2, '-'
+# => "fo"
+a.lpad 10
+# => "       foo"
+a.lpad 10, '-'
+# => "-------foo"
+a.rpad 2, '-'
+# => "oo"
+```
+
+### Object Try (Undefined Method Call)
+
+A _try_ method is monkey-patched into the *Object* root class, providing a means to call undefined methods on objects without raising anything (returning *nil* instead).
+
+```ruby
+'foobar'.try :foo
+# => nil
+32.try :to_s
+# => '32'
+32.try :+, 3
+# => 35
+['foo', 'bar'].try(:collect) { |e| "-#{e}-" }
+# => ['-foo-', '-bar-']
+```
+
+### Get Non-Empty String
+
+A _nstr_ method is monkey-patched into the *String* class. This method returns nil when the String is empty, the String otherwise.
+
+```ruby
+''.nstr
+# => nil
+'foo'.nstr
+# => 'foo'
+nil.try :nstr
+# => nil
+'bar'.try :nstr
+# => 'bar'
+```
+
+### String Case Conversions
+
+Case-conversion methods are monkey-patched into the *String* class. The following methods are made available:
+* camelcase ('foo-bar' => 'FooBar')
+* snakecase ('FooBar' => 'foo-bar')
+* kebabcase ('FooBar' => 'foo_bar')
+
+```ruby
+'foo_bar'.camelcase
+# => 'FooBar'
+'foo-bar'.camelcase
+# => 'FooBar'
+
+'FooBar'.snakecase
+# => 'foo-bar'
+'foo_bar'.snakecase
+# => 'foo-bar'
+
+'FooBar'.kebabcase
+# => 'foo_bar'
+'foo-bar'.kebabcase
+# => 'foo_bar'
+```
+
+### Module utilities
+
+#### Get Module Name
+
+A _mod_name_ method is monkey-patched into the *Module* class. This allows obtaining the name of any module, without its hierarchical tree.
+
+```ruby
+module Foo
+	module Bar
+	end
+end
+
+Foo.name
+# => 'Foo'
+
+Foo.mod_name
+# => 'Foo'
+
+Foo::Bar.name
+# => 'Foo::Bar'
+
+Foo::Bar.mod_name # <= This is where it gets interesting
+# => 'Bar'
+```
+
+#### Get Module Parent Name
+
+A _mod_parent_name_ method is monkey-patched into the *Module* class. This allows obtaining the name of any module's parent.
+
+```ruby
+module Foo
+	module Bar
+		module Test
+		end
+	end
+end
+
+Foo.mod_parent_name
+# => ''
+
+Foo::Bar.mod_parent_name
+# => 'Foo'
+
+Foo::Bar::Test.mod_parent_name
+# => 'Foo::Bar'
+```
+
+#### Get Module Parent
+
+A _mod_parent_ method is monkey-patched into the *Module* class. This allows obtaining any module's parent.
+
+```ruby
+module Foo
+	module Bar
+		module Test
+		end
+	end
+end
+
+Foo.mod_parent
+# => nil
+
+Foo::Bar.mod_parent
+# => Foo
+
+Foo::Bar::Test.mod_parent_name
+# => Foo::Bar
+```
+
+### Time Duration
+
+A _duration_ method is monkey-patched into the 'Numeric' class. This method returns a textual string representation of the time duration.
+An optional *elements* argument allows setting the maximum number of time-elements (days, hours, minutes, ...) to display.
+
+```ruby
+86400.duration
+# => '1 Day'
+((3600 * 3) + 60 + 12).duration
+# => '3 Hours 1 Minute 12 Seconds'
+((3600 * 3) + 60 + 12).duration 1
+# => '3 Hours'
+((3600 * 3) + 60 + 12).duration 2
+# => '3 Hours 1 Minute'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+	t.pattern = 'test/**/test*.rb'
+end
+
+task :default => :test

data/lib/projector_pws/version.rb

@@ -0,0 +1,9 @@
+# ProjectorPWS
+# by Eresse <eresse@eresse.net>
+
+# ProjectorPWS Module
+module ProjectorPWS
+
+	# Version
+	VERSION = '0.1.0'
+end

data/lib/projector_pws.rb

@@ -0,0 +1,259 @@
+# ProjectorPWS
+# by Eresse <eresse@eresse.net>
+
+# External Includes
+require 'savon'
+require 'aromat'
+
+# Internal Includes
+require 'projector_pws/version'
+
+# ProjectorPWS Module:
+# Root Module for ProjectorPWS.
+module ProjectorPWS
+
+	# Service Definition
+	WSDL = 'https://secure.projectorpsa.com/OpsProjectorWcfSvc/PwsProjectorServices.svc?wsdl'
+
+	# Base URL
+	BASE_URL = 'https://secure.projectorpsa.com'
+
+	# URL Path
+	URL_PATH = 'OpsProjectorWcfSvc/PwsProjectorServices.svc'
+
+	# Namespaces
+	NAMESPACE = 'http://projectorpsa.com/PwsProjectorServices/'
+	EXTRA_NAMESPACES = {
+		'xmlns:req' => 'http://projectorpsa.com/DataContracts/Requests/',
+		'xmlns:tim' => 'http://projectorpsa.com/DataContracts/Shared/TimeAndCost/',
+		'xmlns:com' => 'http://projectorpsa.com/DataContracts/Shared/Common/'
+	}
+
+	# Work Week
+	WEEK_START = :monday
+	WEEK_END = :friday
+
+	# Days Per Week
+	DAYS_PER_WEEK = 5
+
+	# Hours Per Day
+	HOURS_PER_DAY = 8
+
+	# Real Hours Per Day
+	HOURS_PER_DAY_REAL = 24
+
+	# Minutes Per Hour
+	MINUTES_PER_HOUR = 60
+
+	# Minutes Per Day
+	MINUTES_PER_DAY = HOURS_PER_DAY * MINUTES_PER_HOUR
+
+	# Minutes Per Week
+	MINUTES_PER_WEEK = MINUTES_PER_DAY * DAYS_PER_WEEK
+
+	# Open Client
+	def self.open url = BASE_URL
+		c = Savon.client wsdl: WSDL, endpoint: service_url(url), namespace: NAMESPACE, env_namespace: :soapenv, namespace_identifier: :pws, namespaces: EXTRA_NAMESPACES
+		return yield c if block_given?
+		c
+	end
+
+	# Authenticate
+	def self.authenticate username, password, account_code = nil
+
+		# Prepare URLs
+		next_url = BASE_URL
+		last_url = ''
+
+		# Prepare Credentials
+		creds = {}
+		creds['req:AccountCode'] = account_code if account_code
+		creds['req:Password'] = password
+		creds['req:UserName'] = username
+
+		# Loop to obtain Ticket
+		c = nil
+		ticket = nil
+		until ticket
+
+			# Authenticate
+			begin
+				c = open next_url
+				r = c.call(:pws_authenticate, message: { 'pws:serviceRequest' => creds }).body[:pws_authenticate_response][:pws_authenticate_result]
+				last_url = next_url
+				next_url = r[:redirect_url]
+			rescue Savon::SOAPFault => e
+				raise "Authentication failed - #{e.to_hash[:fault][:detail][:pws_fault][:messages][:pws_message][:error_text]}"
+			end
+
+			raise 'API Error (redirect loop)' if next_url == last_url
+			ticket = r[:session_ticket]
+		end
+
+		# Yield if block given
+		if block_given?
+			r = yield c, ticket
+			unauthenticate c, ticket
+			return r
+		end
+
+		[c, ticket]
+	end
+
+	# Unauthenticate
+	def self.unauthenticate c, ticket
+
+		# Unauthenticate
+		c.call(:pws_unauthenticate, message: { 'pws:serviceRequest' => { 'req:SessionTicket' => ticket } }).body
+	end
+
+	# Get Resources
+	def self.get_resources c, ticket
+
+		# Fetch Resources
+		c.call(:pws_get_resource_list, message: { 'pws:serviceRequest' => { 'req:SessionTicket' => ticket } }).body[:pws_get_resource_list_response][:pws_get_resource_list_result][:resources][:pws_resource_summary]
+	end
+
+	# Get Resource Schedule
+	def self.get_resource_schedule c, ticket, resource_uid, start_date = current_week_start, end_date = current_week_end
+
+		# Prepare Params
+		params = { 'req:SessionTicket' => ticket }
+		params['tim:EndDate'] = end_date.strftime '%Y-%m-%dz'
+		params['tim:IncludeScheduledTimeFlag'] = :true
+		params['tim:IncludeTimeOffFlag'] = :true
+		params['tim:ResourceIdentity'] = { 'com:ResourceUid' => resource_uid }
+		params['tim:StartDate'] = start_date.strftime '%Y-%m-%dz'
+
+		# Fetch Resource Schedule
+		c.call(:pws_get_resource_schedule, message: { 'pws:serviceRequest' => params }).body[:pws_get_resource_schedule_response][:pws_get_resource_schedule_result][:resource_schedule]
+	end
+
+	# Get Resource Working Schedule
+	def self.get_resource_working_schedule c, ticket, resource_uid, start_date = current_week_start, end_date = current_week_end
+
+		# Prepare Params
+		params = { 'req:SessionTicket' => ticket }
+		params['tim:EndDate'] = end_date.strftime '%Y-%m-%dz'
+		params['tim:ResourceIdentity'] = { 'com:ResourceUid' => resource_uid }
+		params['tim:StartDate'] = start_date.strftime '%Y-%m-%dz'
+
+		# Fetch Resource Working Schedule
+		c.call(:pws_get_resource_working_schedule, message: { 'pws:serviceRequest' => params }).body[:pws_get_resource_working_schedule_response][:pws_get_resource_working_schedule_result][:working_schedule]
+	end
+
+	# Get Free Resources (non-busy) with associated minutes
+	def self.get_free_resources c, ticket, start_date = current_week_start, end_date = current_week_end
+
+		# Get all resources
+		res = ProjectorPWS.get_resources c, ticket
+
+		# Collect free time
+		res.collect { |r| {
+			resource: r,
+			free_hours: get_resource_free_hours(c, ticket, r, start_date, end_date).to_f
+		} }.select { |x| x[:free_hours] > 0 }
+	end
+
+	# Get Resource Free Hours
+	def self.get_resource_free_hours c, ticket, resource, start_date = current_week_start, end_date = current_week_end
+
+		# Get scheduled hours
+		scheduled_hours = get_resource_scheduled_hours c, ticket, resource, start_date, end_date
+
+		# Get active hours
+		active_hours = get_resource_active_hours c, ticket, resource, start_date, end_date
+
+		# Compute time off into active hours
+		active_hours = active_hours - scheduled_hours[:toff]
+
+		# Compute free time (active unscheduled time)
+		active_hours - scheduled_hours[:work]
+	end
+
+	# Get Resource Active Hours
+	def self.get_resource_active_hours c, ticket, resource, start_date = current_week_start, end_date = current_week_end
+
+		# Acquire working schedule for resource
+		wsched = ProjectorPWS.get_resource_working_schedule(c, ticket, resource[:resource_uid], start_date, end_date)[:pws_working_schedule_day] rescue(return(0))
+		wsched = [wsched] unless wsched.is_a? Array
+		wsched.compact!
+
+		# Extract Working Minutes
+		work = wsched.inject(0) { |a, e| a + e[:working_minutes].to_i }
+
+		# Determine Active Hours
+		work.to_f / MINUTES_PER_HOUR.to_f
+	end
+
+	# Get Resource Scheduled Hours
+	def self.get_resource_scheduled_hours c, ticket, resource, start_date = current_week_start, end_date = current_week_end
+
+		# Get schedule
+		sched = get_resource_schedule(c, ticket, resource[:resource_uid], start_date, end_date) rescue(return({ work: 0, toff: 0 }))
+
+		# Extract scheduled work
+		sched_work = sched[:roles][:pws_schedule_role] rescue []
+		sched_work = [sched_work] unless sched_work.is_a? Array
+		sched_work.compact!
+
+		# Extract scheduled time off
+		time_off = sched[:time_off][:pws_schedule_time_off] rescue []
+		time_off = [time_off] unless time_off.is_a? Array
+		time_off.compact!
+
+		# Run through time off { collect total minutes }
+		time_off_minutes = time_off.inject(0) do |a, e|
+
+			# Extract Dates
+			dates = e[:time_off_dates][:pws_schedule_time_off_date] rescue []
+			dates = [dates] unless dates.is_a? Array
+			dates.compact!
+
+			# Collect time off dates
+			a + dates.inject(0) { |da, de| da + time_off_minutes(de[:time_off_minutes].to_i) }
+		end
+
+		# Run through schedule { collect total minutes }
+		scheduled_minutes = sched_work.inject(0) do |a, e|
+
+			# Extract bookings
+			bookings = e[:bookings][:pws_schedule_booking] rescue []
+			bookings = [bookings] unless bookings.is_a? Array
+			bookings.compact!
+
+			# Collect 'busy' bookings
+			e[:project_descriptor][:engagement_descriptor][:engagement_type_descriptor][:busy_flag] ? a + (bookings.inject(0) { |ba, be| ba + be[:scheduled_minutes].to_i }) : a
+		end
+
+		{
+			work: scheduled_minutes.to_f / MINUTES_PER_HOUR.to_f,
+		    toff: time_off_minutes.to_f / MINUTES_PER_HOUR.to_f
+		}
+	end
+
+	# Generate Service URL
+	def self.service_url base_url
+		"#{base_url}/#{URL_PATH}"
+	end
+
+	# Current Week Start
+	def self.current_week_start
+		is_weekend? ? Date.today.wnext(WEEK_START) : Date.today.wlast(WEEK_START)
+	end
+
+	# Current Week End
+	def self.current_week_end
+		current_week_start.wnext(WEEK_END)
+	end
+
+	# Is Weekend
+	def self.is_weekend?
+		Date.today.friday? || Date.today.saturday? || Date.today.sunday?
+	end
+
+	# Time Off Minutes (adjust for full-day holidays)
+	def self.time_off_minutes x
+		(x == HOURS_PER_DAY_REAL * MINUTES_PER_HOUR) ? (HOURS_PER_DAY * MINUTES_PER_HOUR) : x
+	end
+end

data/projector_pws.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'projector_pws/version'
+
+Gem::Specification.new do |spec|
+	spec.name = 'projector_pws'
+	spec.version = ProjectorPWS::VERSION
+	spec.authors = ['Eresse']
+	spec.email = ['eresse@eresse.net']
+
+	spec.summary = 'Projector PWS Client Library'
+	spec.description = 'Provides access to Projector PSA\'s Web Services (PWS)'
+	spec.homepage = 'http://redmine.eresse.net/projects/projector_pws'
+	spec.license = 'MIT'
+
+	spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	spec.require_paths = ['lib']
+
+	spec.add_development_dependency 'bundler'
+	spec.add_development_dependency 'rake'
+	spec.add_runtime_dependency 'minitest'
+	spec.add_runtime_dependency 'aromat'
+	spec.add_runtime_dependency 'savon'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: projector_pws
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eresse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: aromat
+  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: savon
+  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'
+description: Provides access to Projector PSA's Web Services (PWS)
+email:
+- eresse@eresse.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/projector_pws.rb
+- lib/projector_pws/version.rb
+- projector_pws.gemspec
+homepage: http://redmine.eresse.net/projects/projector_pws
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Projector PWS Client Library
+test_files: []