projectal

  1"""
  2A python client for the [Projectal API](https://projectal.com/docs/latest).
  3
  4## Getting started
  5
  6```
  7import projectal
  8import os
  9
 10# Supply your Projectal server URL and account credentials
 11projectal.api_base = 'https://yourcompany.projectal.com'
 12projectal.api_username = os.environ.get('PROJECTAL_USERNAME')
 13projectal.api_password = os.environ.get('PROJECTAL_PASSWORD')
 14
 15# Test communication with server
 16status = projectal.status()
 17
 18# Test account credentials
 19projectal.login()
 20details = projectal.auth_details()
 21```
 22
 23----
 24
 25## Changelog
 26
 27### 5.3.1
 28- Add Entity.create flag parameters to overriding methods.
 29
 30### 5.3.0
 31- parameters: disable_system_features(Default: True), enable_system_features_on_exit(Default: True)
 32  for Entity.create() and Entity.update().
 33  Allows for better performance during entity linking steps. With default flags, system features will be disabled
 34  and re-enabled after each internal query chunk. Better performance can be achieved by setting
 35  enable_system_features_on_exit to false, but system features must be manually re-enabled afterwards.
 36- Parameter for Entity.query() to configure request timeout, default is 30 seconds.
 37
 38### 5.2.0
 39- Supported handling for new Projectal API rate limiting. When a request is rate limited,
 40  will pause for the required waiting period before retrying the request.
 41
 42### 5.1.0
 43- Added new Staff function: `projectal.Staff.create_contract()`.
 44  Allows creation of a new contract for the given Staff uuId. It's recommended to set a different
 45  Department, Position, Start/End Date or Pay Amount for new Contracts to differentiate them.
 46
 47  Parameters:
 48  - UUID: uuId of the Source Staff
 49  - payload: Optional payload to specify updated fields for the new Staff contract
 50  - end_current_contract (Default=False): Source Staff Contract will have its End Date set to Current Date.
 51    Source Staff Start Date must be before Current Date.
 52  - start_new_contract (Default=False): New Staff Contract will have its Start Date set to Current Date.
 53
 54- Allow fetching Staff entities with "CONTRACT" link. Will return list of all Contracts for each Staff.
 55
 56### 5.0.0
 57- Updated `projectal.login()` to use a basic Dict to store the login cookie instead of an instance
 58  of the RequestsCookieJar object from the Python Requests library. This fixes an issue where an
 59  indefinite loop can occur when the stored cookie is cleared unexpectedly after attempting to login
 60  again after a token expired.
 61- Update the stored cookie whenever a new cookie is returned by a successful request. This takes
 62  advantage of an updated Projectal implementation that refreshes the login cookie periodically.
 63  This should avoid the re-authentication procedure in most cases for scripts with long execution
 64  times.
 65
 66### 4.3.2
 67- Added CompanyType.Division enum, matching new system defaults.
 68
 69### 4.3.1
 70- Fixed typo in "Getting started" example.
 71- Fixed typo in 4.3.0 Changelog.
 72
 73### 4.3.0
 74
 75**Breaking changes:**
 76
 77- Added "PREDECESSOR_TASK" option when fetching projectal.Task with links
 78- Predecessor tasks will be returned as a list of tasks under the taskList attribute
 79- This attribute name is different to what you would see when using the REST API directly
 80  (planList). This change was necessary to allow for directly manipulating
 81  the list of links and then saving the task entity to commit any changes,
 82  since the REST API is expecting a different key for linking calls (taskList).
 83- Existing Predecessor Task linking methods were also updated to match the new linking functionality.
 84  They now work as a reverse linker, automatically inverting the link relationship between
 85  the task entities. This more closely matches what you would expect to see based on the Web UI.
 86  I.e. When previously calling `some_task.link_predecessor_task(another_task)`,
 87  some_task would be set as a predecessor for another_task instead of the other way around.
 88  Now another_task would be set as the predecessor for some_task.
 89
 90### 4.2.2
 91- `projectal.User.current_user_permissions()` fixed incorrect query.
 92- `projectal.Webhook.list()` default limit increased to 1000.
 93
 94### 4.2.1
 95- Added classes allowing for the management of dynamic enums. The user must have the "List Management"
 96  permission to update enums.
 97
 98  New classes:
 99  - `projectal.CompanyTypes`
100  - `projectal.SkillLevels`
101  - `projectal.StaffTypes`
102  - `projectal.PriorityLevels`
103  - `projectal.ComplexityLevels`
104  - `projectal.CurrencyList`
105
106  The current enum can be retrieved with get(), and updated with set().
107  For example, to return the current SkillLevels enum:
108
109  ```
110  projectal.SkillLevels.get()
111  ```
112
113  For each enum the entire list of key value pairs must be provided when calling set(),
114  any existing values that are omitted from the dictionary will be removed,
115  and any additional values will be added.
116
117  To update the SkillLevels enum with a new value:
118
119  ```
120  new_value_added = {
121      "Senior": 10,
122      "Mid": 20,
123      "Junior": 30,
124      # new SkillLevel value "Beginner"
125      "Beginner": 40,
126  }
127  projectal.SkillLevels.set(new_value_added)
128  ```
129
130  To change the name of a value, set a new key name for the original value:
131
132  ```
133  updated_value_name = {
134      # changing "Senior" SkillLevel to "Expert"
135      "Expert": 10,
136      "Mid": 20,
137      "Junior": 30,
138  }
139  projectal.SkillLevels.set(updated_value_name)
140  ```
141
142  To remove an existing value, call set on a dictionary with that value removed:
143
144  ```
145  value_removed = {
146      "Senior": 10,
147      "Mid": 20,
148      # "Junior" SkillLevel removed
149  }
150  projectal.SkillLevels.set(new_value_added)
151  ```
152
153  Updating the CurrencyList works differently to the other enums, since the
154  names of values must match the alphabetic currency code and the value must
155  match the numeric currency code.
156  This will cause an exception if you try to change the name for any values.
157
158  Adding a new currency:
159
160  ```
161  new_currency_added = {
162    "AED": 784
163    ...
164    # rest of the existing currencies
165    ...
166    # new currency to add with the alphabetic and numeric code
167    "ZWL": 932,
168  }
169  projectal.CurrencyList.set(new_currency_added)
170  ```
171
172  Removing an existing currency requires you to provide the numeric code for
173  the currency as a negative value.
174
175  ```
176  currency_removed = {
177    # this currency will be removed
178    "AED": -784
179    ...
180    # rest of the existing currencies
181    ...
182  }
183  projectal.CurrencyList.set(currency_removed)
184  ```
185
186### 4.2.0
187Version 4.2.0 accompanies the release of Projectal 4.1.0
188
189- Minimum Projectal version is now 4.1.0.
190
191- Changed order of applying link types when an entity is initialized,
192prevents a type error with reverse linking in certain situations.
193
194- `projectal.Task.reset_duration()` now supports adjustments with multi day calendar exceptions.
195
196- `projectal.Task.reset_duration()` location working days override base exceptions.
197
198- `projectal.TaskTemplate.list()` fixed incorrect query when using inherited method.
199
200### 4.1.0
201- DateLimit.Max enum value changed from "9999-12-31" to "3000-01-01". This reflects changes to the Projectal
202backend that defines this as the maximum allowable date value. The front end typically considers this value as
203equivalent with having no end date.
204
205- Updated requirements.txt version for requests package
206
207- Minimum Projectal version is now 4.0.40
208
209### 4.0.3
210- When a dict object is passed to the update class method, it will be converted to the corresponding Entity type.
211  Allows for proper handling of keys that require being treated as links.
212
213### 4.0.2
214- Booking entity is now fetched with project field and either staff or resource field.
215
216- Added missing link methods for 'Booking' entity (Note, File)
217
218- Added missing link methods for 'Activity' entity (Booking, Note, File, Rebate)
219
220- Reduced maximum number of link methods to 100 for a single batch request to prevent timeouts
221under heavy load.
222
223### 4.0.1
224- Minimum Projectal version is now 4.0.0.
225
226### 4.0.0
227
228Version 4.0.0 accompanies the release of Projectal 4.0.
229
230- Added the `Activity` entity, new in Projectal 4.0.
231
232- Added the `Booking` entity, new in Projectal 4.0.
233
234### 3.1.1
235- Link requests generated by 'projectal.Entity.create()' and 'projectal.Entity.update()' are now
236  executed in batches. This is enabled by default with the 'batch_linking=True' parameter and can
237  be disabled to execute each link request individually. It is recommended to leave this parameter
238  enabled as this can greatly reduce the number of network requests.
239
240### 3.1.0
241- Minimum Projectal version is now 3.1.5.
242
243- Added `projectal.Webhook.list_events()`. See API doc for details on how to use.
244
245- Added `deleted_at` parameter to `projectal.Entity.get()`. This value should be a UTC timestamp
246  from a webhook delete event.
247
248- Added `projectal.ldap_sync()` to initiate a user sync with the LDAP/AD service configured in
249  the Projectal server settings.
250
251- Enhanced output of `projectal.Entity.changes()` function when reporting link changes.
252  It no longer dumps the entire before-and-after list with the full content of each linked entity.
253  Now reports three lists: `added`, `updated`, `removed`. Entities within the `updated` list
254  follow the same `old` vs `new` dictionary model for the data attributes within them. E.g:
255
256    ```
257    resourceList: [
258        'added': [],
259        'updated': [
260            {'uuId': '14eb4c31-0f92-49d1-8b4d-507ab939003e', 'resourceLink': {'utilization': {'old': 0.1, 'new': 0.9}}},
261        ],
262        'removed': []
263    ]
264    ```
265  This should result in slimmer logs that are much easier to understand as the changes are
266  clearly indicated.
267
268### 3.0.2
269- Added `projectal.Entity.get_link_definitions()`. Exposes entity link definition dictionary.
270  Consumers can inspect which links an Entity knows about and their internal settings.
271  Link definitions that appear here are the links valid for `links=[]` parameters.
272
273### 3.0.1
274- Fixed fetching project with links=['task'] not being available.
275
276- Improved Permission.list(). Now returns a dict with the permission name as
277  key with Permission objects as the value (instead of list of uuIds).
278
279- Added a way to use the aliasing feature of the API (new in Projectal 3.0).
280Set `projectal.api_alias = 'uuid'` to the UUID of a User object and all
281requests made will be done as that user. Restore this value to None to resume
282normal operation. (Some rules and limitations apply. See API for more details.)
283
284- Added complete support for the Tags entity (including linkers).
285
286### 3.0
287
288Version 3.0 accompanies the release of Projectal 3.0.
289
290**Breaking changes**:
291
292- The `links` parameter on `Entity` functions now consumes a list of entity
293  names instead of a comma-separated string. For example:
294
295    ```
296    # Before:
297    projectal.Staff.get('<uuid>', links='skill,location')  # No longer valid
298    # Now:
299    projectal.Staff.get('<uuid>', links=['skill', 'location'])
300    ```
301
302- The `projectal.enums.SkillLevel` enum has had all values renamed to match the new values
303  used in Projectal (Junior, Mid, Senior). This includes the properties on
304  Skill entities indicating work time for auto-scheduling (now `juniorLevel`,
305  `midLevel`, `seniorLevel`).
306
307**Other changes**:
308
309- Working with entity links has changed in this release. The previous methods
310  are still available and continue to work as before, but there is no need
311  to interact with the `projectal.linkers` methods yourself anymore.
312
313  You can now modify the list of links within an entity and save the entity
314  directly. The library will automatically determine how the links have been
315  modified and issue the correct linker methods on your behalf. E.g.,
316  you can now do:
317
318    ```
319    staff = projectal.Staff.get('<uuid>', links=['skill'])
320    staff['firstName'] = "New name"  # Field update
321    staff['skillList'] = [skill1, skill2, skill3]  # Link update
322    staff.save()  # Both changes are saved
323
324    task = projectal.Task.get('<uuid>', links=['stage'])
325    task['stage'] = stage1  # Uses a single object instead of list
326    task.save()
327    ```
328
329  See `examples/linking.py` for a more complete demonstration of linking
330  capabilities and limitations.
331
332- Linkers (`projectal.linkers`) can now be given a list of Entities (of one
333 type) to link/unlink/relink in bulk. E.g:
334    ```
335    staff.unlink_skill(skill1)  # Before
336    staff.unlink_skill([skill1, skill2, skill3])  # This works now too
337    ```
338
339- Linkers now strip the payload to only the required fields instead of passing
340  on the entire Entity object. This cuts down on network traffic significantly.
341
342- Linkers now also work in reverse. The Projectal server currently only supports
343  linking entities in one direction (e.g., Company to Staff), which often means
344  writing something like:
345    ```
346    staff.link_location(location)
347    company.link_staff(staff)
348    ```
349  The change in direction is not very intuitive and would require you to constantly
350  verify which direction is the one available to you in the documentation.
351
352  Reverse linkers hide this from you and figure out the direction of the relationship
353  for you behind the scenes. So now this is possible, even though the API doesn't
354  strictly support it:
355    ```
356    staff.link_location(location)
357    staff.link_company(company)
358    ```
359    Caveat: the documentation for Staff will not list Company links. You will still
360    have to look up the Company documentation for the link description.
361
362- Requesting entity links with the `links=` parameter will now always ensure the
363  link field (e.g., `taskList`) exists in the result, even if there are no links.
364  The server may not always return a value, but we can use a default value ([] for
365  lists, None for dicts).
366
367- Added a `Permission` entity to correctly type Permissions in responses.
368
369- Added a `Tag` entity, new in Projectal 3.0.
370
371- Added `links` parameter to `Company.get_primary_company()`
372
373- `Department.tree()`: now consumes a `holder` Entity object instead
374  of a uuId.
375
376- `Department.tree()`: added `generic_staff` parameter, new in
377  Projectal 3.0.
378
379- Don't break on trailing slash in Projectal URL
380
381- When creating tasks, populate the `projectRef` and `parent` fields in the
382  returned Task object.
383
384- Added convenience functions for matching on fields where you only want
385  one result (e.g match_one()) which return the first match found.
386
387- Update the entity `history()` method for Projectal 3.0. Some new parameters
388  allow you to restrict the history to a particular range or to get only the
389  changes for a webhook timestamp.
390
391- Entity objects can call `.history()` on themselves.
392
393- The library now keeps a reference to the User account that is currently logged
394  in and using the API: `projectal.api_auth_details`.
395
396**Known issues**:
397- You cannot save changes to Notes or Calendars via their holding entity. You
398  must save the changes on the Note or Calendar directly. To illustrate:
399  ```
400  staff = projectal.Staff.get(<uuid>, links=['calendar'])
401  calendar = staff['calendarList'][0]
402  calendar['name'] = 'Calendar 2'
403
404  # Cannot do this - will not pick up the changes
405  staff.save()
406
407  # You must do this for now
408  calendar.save()
409  ```
410  This will be resolved in a future release.
411
412- When creating Notes, the `created` and `modified` values may differ by
413  1ms in the object you have a reference to compared to what is actually
414  stored in the database.
415
416- Duration calculation is not precise yet (mentioned in 2.1.0)
417
418### 2.1.0
419**Breaking changes**:
420- Getting location calendar is now done on an instance instead of class. So
421  `projectal.Location.calendar(uuid)` is now simply `location.calendar()`
422- The `CompanyType.Master` enum has been replaced with `CompanyType.Primary`.
423  This was a leftover reference to the Master Company which was renamed in
424  Projectal several versions ago.
425
426**Other changes**:
427- Date conversion functions return None when given None or empty string
428- Added `Task.reset_duration()` as a basic duration calculator for tasks.
429  This is a work-in-progress and will be gradually improved. The duration
430  calculator takes into consideration the location to remove non-work
431  days from the estimate of working duration. It currently does not work
432  for the time component or `isWorking=True` exceptions.
433- Change detection in `Entity.changes()` now excludes cases where the
434  server has no value and the new value is None. Saving this change has
435  no effect and would always detect a change until a non-None value is
436  set, which is noisy and generates more network activity.
437
438### 2.0.3
439- Better support for calendars.
440  - Distinguish between calendar containers ("Calendar") and the
441    calendar items within them ("CalendarItem").
442  - Allow CalendarItems to be saved directly. E.G item.save()
443- Fix 'holder' parameter in contact/staff/location/task_template not
444  permitting object type. Now consumes uuId or object to match rest of
445  the library.
446- `Entity.changes()` has been extended with an `old=True` flag. When
447  this flag is true, the set of changes will now return both the original
448  and the new values. E.g.
449```
450task.changes()
451# {'name': 'current'}
452task.changes(old=True)
453# {'name': {'old': 'original', 'new': 'current'}}
454```
455- Fixed entity link cache causing errors when deleting a link from an entity
456  which has not been fetched with links (deleting from empty list).
457
458### 2.0.2
459- Fixed updating Webhook entities
460
461### 2.0.1
462- Fixed application ID not being used correctly.
463
464### 2.0.0
465- Version 2.0 accompanies the release of Projectal 2.0. There are no major changes
466  since the previous release.
467- Expose `Entity.changes()` function. It returns a list of fields on an entity that
468  have changed since fetching it. These are the changes that will be sent over to the
469  server when an update request is made.
470- Added missing 'packaging' dependency to requirements.
471
472### 1.2.0
473
474**Breaking changes**:
475
476- Renamed `request_timestamp` to `response_timestamp` to better reflect its purpose.
477- Automatic timestamp conversion into dates (introduced in `1.1.0`) has been reverted.
478  All date fields returned from the server remain as UTC timestamps.
479
480  The reason is that date fields on tasks contain a time component and converting them
481  into date strings was erasing the time, resulting in a value that does not match
482  the database.
483
484  Note: the server supports setting date fields using a date string like `2022-04-05`.
485  You may use this if you prefer but the server will always return a timestamp.
486
487  Note: we provide utility functions for easily converting dates from/to
488  timestamps expected by the Projectal server. See:
489  `projectal.date_from_timestamp()`,`projectal.timestamp_from_date()`, and
490  `projectal.timestamp_from_datetime()`.
491
492**Other changes**:
493- Implement request chunking - for methods that consume a list of entities, we now
494  automatically batch them up into multiple requests to prevent timeouts on really
495  large request. Values are configurable through
496  `projectal.chunk_size_read` and `projectal.chunk_size_write`.
497  Default values: Read: 1000 items. Write: 200 items.
498- Added profile get/set functions on entities for easier use. Now you only need to supply
499  the key and the data. E.g:
500
501```
502key = 'hr_connector'
503data = {'staff_source': 'company_z'}
504task.profile_set(key, data)
505```
506
507- Entity link methods now automatically update the entity's cached list of links. E.g:
508  a task fetched with staff links will have `task['staffList'] = [Staff1,Staff2]`.
509  Before, doing a `task.link_staff(staff)` did not modify the list to reflect the
510  addition. Now, it will turn into `[Staff1,Staff2,Staff3]`. The same applies for update
511  and delete.
512
513  This allows you to modify links and continue working with that object without having
514  to fetch it again to obtain the most recent link data. Be aware that if you acquire
515  the object without requesting the link data as well
516  (e.g: `projectal.Task.get(id, links='STAFF')`),
517  these lists will not accurately reflect what's in the database, only the changes made
518  while the object is held.
519
520- Support new `applicationId` property on login. Set with: `projectal.api_application_id`.
521  The application ID is sent back to you in webhooks so you know which application was
522  the source of the event (and you can choose to filter them accordingly).
523- Added `Entity.set_readonly()` to allow setting values on entities that will not
524  be sent over to the server when updating/saving the entity.
525
526  The main use case for this is to populate cached entities which you have just created
527  with values you already know about. This is mainly a workaround for the limitation of
528  the server not sending the full object back after creating it, resulting in the client
529  needing to fetch the object in full again if it needs some of the fields set by the
530  server after creation.
531
532  Additionally, some read-only fields will generate an error on the server if
533  included in the update request. This method lets you set these values on newly
534  created objects without triggering this error.
535
536  A common example is setting the `projectRef` of a task you just created.
537
538
539### 1.1.1
540- Add support for 'profiles' API. Profiles are a type of key-value storage that target
541  any entity. Not currently documented.
542- Fix handling error message parsing in ProjectalException for batch create operation
543- Add `Task.update_order()` to set task order
544- Return empty list when GETing empty list instead of failing (no request to server)
545- Expose the timestamp returned by requests that modify the database. Use
546  `projectal.request_timestamp` to get the value of the most recent request (None
547  if no timestamp in response)
548
549### 1.1.0
550- Minimum Projectal version is now 1.9.4.
551
552**Breaking changes**:
553- Entity `list()` now returns a list of UUIDs instead of full objects. You may provide
554  an `expand` parameter to restore the previous behavior: `Entity.list(expand=True)`.
555  This change is made for performance reasons where you may have thousands of tasks
556  and getting them all may time out. For those cases, we suggest writing a query to filter
557  down to only the tasks and fields you need.
558- `Company.get_master_company()` has been renamed to `Company.get_primary_company()`
559  to match the server.
560- The following date fields are converted into date strings upon fetch:
561  `startTime`, `closeTime`, `scheduleStart`, `scheduleFinish`.
562  These fields are added or updated using date strings (like `2022-03-02`), but the
563  server returns timestamps (e.g: 1646006400000) upon fetch, which is confusing. This
564  change ensures they are always date strings for consistency.
565
566**Other changes**:
567- When updating an entity, only the fields that have changed are sent to the server. When
568  updating a list of entities, unmodified entities are not sent to the server at all. This
569  dramatically reduces the payload size and should speed things up.
570- When fetching entities, entity links are now typed as well. E.g. `project['rebateList']`
571  contains a list of `Rebate` instead of `dict`.
572- Added `date_from_timestamp()` and `timestamp_from_date()` functions to help with
573  converting to/from dates and Projectal timestamps.
574- Entity history now uses `desc` by default (index 0 is newest)
575- Added `Project.tasks()` to list all task UUIDs within a project.
576
577### 1.0.3
578- Fix another case of automatic JWT refresh not working
579
580### 1.0.2
581- Entity instances can `save()` or `delete()` on themselves
582- Fix broken `dict` methods (`get()` and `update()`) when called from Entity instances
583- Fix automatic JWT refresh only working in some cases
584
585### 1.0.1
586- Added `list()` function for all entities
587- Added search functions for all entities (match-, search, query)
588- Added `Company.get_master_company()`
589- Fixed adding template tasks
590
591"""
592
593import logging
594import os
595
596from projectal.entities import *
597from projectal.dynamic_enums import *
598from .api import *
599from . import profile
600
601api_base = os.getenv("PROJECTAL_URL")
602api_username = os.getenv("PROJECTAL_USERNAME")
603api_password = os.getenv("PROJECTAL_PASSWORD")
604api_application_id = None
605api_auth_details = None
606api_alias = None
607cookies = None
608chunk_size_read = 1000
609chunk_size_write = 200
610
611# Records the timestamp generated by the last request (database
612# event time). These are reported on add or updates; if there is
613# no timestamp in the response, this is set to None.
614response_timestamp = None
615
616
617# The minimum version number of the Projectal instance that this
618# API client targets. Lower versions are not supported and will
619# raise an exception.
620MIN_PROJECTAL_VERSION = "5.3.0"
621
622__verify = True
623
624logging.getLogger("projectal-api-client").addHandler(logging.NullHandler())