lws 6.2.0 → 6.2.1

data/lib/lws/apps/generic.rb

@@ -26,7 +26,7 @@ module LWS::Generic
     # This method wraps Spyke's .find method so that we can raise
     # an LWS-specific exception.
     #
-    # @param [Fixnum, String] id the ID of the resource to find and
+    # @param [Integer, String] id the ID of the resource to find and
     #   retrieve
     # @raise [LWS::Errors::ResourceNotFound] if not all of the resources
     #   could be found
@@ -84,7 +84,7 @@ module LWS::Generic
   # = The configuration class
   class Configuration < Model
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the configuration
+    #   @return [Integer] the (unique) ID of the configuration
     attribute :id
 
     # @!attribute key

data/lib/lws/apps/maps.rb

@@ -40,7 +40,7 @@ module LWS::Maps
     use_api LWS::Maps.api
 
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the map
+    #   @return [Integer] the (unique) ID of the map
     attribute :id
 
     # @!attribute company
@@ -48,7 +48,7 @@ module LWS::Maps
     belongs_to :company, class_name: "LWS::Auth::Company"
 
     # @!attribute company_id
-    #   @return [Fixnum] the ID of the company that maintains/owns the map
+    #   @return [Integer] the ID of the company that maintains/owns the map
     attribute :company_id
 
     # @!attribute markers
@@ -64,7 +64,7 @@ module LWS::Maps
     belongs_to :source
 
     # @!attribute source_id
-    #   @return [Fixnum] the ID of the map source used for tiling the map
+    #   @return [Integer] the ID of the map source used for tiling the map
     attribute :source_id
 
     # @!attribute created_at [r]
@@ -81,7 +81,7 @@ module LWS::Maps
     use_api LWS::Maps.api
 
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the map marker
+    #   @return [Integer] the (unique) ID of the map marker
     attribute :id
 
     # @attribute lat
@@ -97,7 +97,7 @@ module LWS::Maps
     belongs_to :map
 
     # @!attribute map_id
-    #   @return [Fixnum] the ID of the map that the marker is placed on
+    #   @return [Integer] the ID of the map that the marker is placed on
     attribute :map_id
 
     # @!attribute name
@@ -122,7 +122,7 @@ module LWS::Maps
     use_api LWS::Maps.api
 
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the map source
+    #   @return [Integer] the (unique) ID of the map source
     attribute :id
 
     # @!attribute key

data/lib/lws/apps/presence.rb

@@ -40,32 +40,65 @@ module LWS::Presence
     use_api LWS::Presence.api
 
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the location
+    #   @return [Integer] the (unique) ID of the location
     attribute :id
 
+    # @!attribute ancestor_ids
+    #   @return [Array<Integer>] the ID of the locations that containt the location,
+    #     including the location itself
+    attribute :ancestor_ids
+
     # @!attribute capacity
-    #   @return [Fixnum] the capacity (maximum number of people) of the location
-    #      (including descendant locations)
+    #   @return [Integer] the capacity (maximum number of people) of the location
     attribute :capacity
 
+    # @!attribute capacity_tree
+    #   @return [Integer] the capacity (maximum number of people) of the location
+    #      including descendant locations
+    attribute :capacity_tree
+
     # @!attribute capacity_used
-    #   @return [Fixnum] the used capacity (present number of people) of the location
-    #      (including descendant locations)
+    #   @return [Integer] the used capacity (present number of people) of the location
     attribute :capacity_used
 
+    # @!attribute capacity_used_tree
+    #   @return [Integer] the used capacity (present number of people) of the location
+    #      including descendant locations
+    attribute :capacity_used_tree
+
     # @!attribute capacity_used_percentage
     #   @return [Float] the used capacity percentage of the location
-    #     (including descendant locations)
     attribute :capacity_used_precentage
 
+    # @!attribute capacity_used_percentage_tree
+    #   @return [Float] the used capacity percentage of the location
+    #     including descendant locations
+    attribute :capacity_used_precentage_tree
+
+    # @!attribute checkout_location
+    #   @return [Location, nil] the location to move people to when they
+    #     are checked out
+    belongs_to :checkout_location, class_name: "LWS::Presence::Location",
+                                   foreign_key: "checkout_location_id",
+                                   uri: "locations/:id"
+
+    # @!attribute checkout_location_id
+    #   @return [Integer, nil] the ID of the location to move people to when they
+    #     are checked out
+    attribute :checkout_location_id
+
     # @!attribute company
     #   @return [LWS::Auth::Company] the company the location belongs to
     belongs_to :company, class_name: "LWS::Auth::Company"
 
     # @!attribute company_id
-    #   @return [Fixnum] the ID of the company the location belongs to
+    #   @return [Integer] the ID of the company the location belongs to
     attribute :company_id
 
+    # @!attribute descendant_ids
+    #   @return [Array<Integer>] the IDs of the underlying locations of the location
+    attribute :descendant_ids
+
     # @!attribute lat
     #   @return [Float] the latitude of the location
     attribute :lat
@@ -79,28 +112,38 @@ module LWS::Presence
     #   @return [Float] the longitude of the location
     attribute :long
 
-    # @!attribute map_location_id
-    #   @note
-    #     There is not a relation for this at the moment!
-    #   @return [Fixnum] the ID of the map location associated with the location
-    attribute :map_location_id
+    # @!attribute map_positions
+    #   @return [Array<Location::Map::Position>] the positions
+    #     that are associated with the location
+    has_many :map_positions, class_name: "LWS::Presence::Location::Map::Position"
+
+    # @attribute maps
+    #   @return [Array<Location::Map>] the maps for this location
+    has_many :maps, class_name: "LWS::Presence::Location::Map"
 
     # @!attribute name
     #   @return [String] the name of the location
     attribute :name
 
     # @!attribute parent
-    #  @return [Location] the parent of the location
-    belongs_to :parent, class_name: "LWS::Presence::Location"
+    #   @return [Location] the parent of the location
+    belongs_to :parent, class_name: "LWS::Presence::Location",
+                        foreign_key: "parent_id",
+                        uri: "locations/:id"
 
     # @!attribute parent_id
-    #  @return [Fixnum] the ID of the parent of the location
+    #   @return [Integer] the ID of the parent of the location
     attribute :parent_id
 
     # @!attribute people
-    #  @return [Array<Person>] the people associated with the location
+    #   @return [Array<Person>] the people associated with the location
     has_many :people
 
+    # @!attribute people_tree
+    #   @return [Array<Person>] the people associated with the location
+    #     including descendant locations
+    has_many :people_tree, class_name: "LWS::Presence::Person"
+
     # @!attribute range
     #   @return [Integer] the range around the location in meters
     attribute :range
@@ -118,12 +161,126 @@ module LWS::Presence
     attribute :updated_at
   end
 
+  # = The location map class
+  #
+  # @note
+  #   This class is only used within the context of the {Location} class.
+  class Location::Map < LWS::Generic::Model
+    use_api LWS::Presence.api
+    uri "locations/:location_id/maps(/:id)"
+
+    # @!attribute id [r]
+    #   @return [Integer] the (unique) ID of the location
+    attribute :id
+
+    # @!attribute location
+    #   @return [Location] the location the map belongs to
+    belongs_to :location
+
+    # @!attribute location_id
+    #   @return [Integer] the ID of the location the map belongs to
+    attribute :location_id
+
+    # @!attribute name
+    #   @return [String, nil] the name of the map
+    attribute :name
+
+    # @!attribute picture_url
+    #   @return [String, nil] the URL of the picture of the map
+    attribute :picture_url
+
+    # @!attribute position
+    #   @return [Integer] the position (index) of the map, if multiple are
+    #     present
+    attribute :position
+
+    # @!attribute positions
+    #   @return [Array<Location::Map::Position>] the positions linked to this
+    #     map
+    has_many :positions
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the location was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the location was last updated
+    attribute :updated_at
+  end
+
+  # = The map position class
+  #
+  # @note
+  #   This class is only used within the context of the {Location::Map} class.
+  class Location::Map::Position < LWS::Generic::Model
+    use_api LWS::Presence.api
+    uri "locations/:location_id/maps/:location_map_id/positions(/:id)"
+
+    # @!attribute id [r]
+    #   @return [Integer] the (unique) ID of the location
+    attribute :id
+
+    # @!attribute height
+    #   @return [Integer] the height of the position on the map in percentage
+    attribute :height
+
+    # @!attribute location
+    #   @return [Location] the location of the map this position is
+    #     associated with
+    belongs_to :location
+
+    # @!attribute location_id
+    #   @return [Location] the ID of the location of the location map this
+    #     position is associated with
+    attribute :location_id
+
+    # @!attribute location_map
+    #   @return [Location::Map] the location map the position belongs to
+    belongs_to :location_map, class_name: "LWS::Presence::Location::Map",
+                              foreign_key: "location_map_id",
+                              uri: "locations/:location_id/maps/:id"
+
+    # @!attribute location_map_id
+    #   @return [Integer] the ID of the location map the position belongs to
+    attribute :location_map_id
+
+    # @!attribute tracking_location
+    #   @return [Location] the location the position tracks on the map
+    belongs_to :tracking_location, class_name: "LWS::Presence::Location",
+                                   foreign_key: "tracking_location_id",
+                                   uri: "locations/:id"
+
+    # @!attribute tracking_location_id
+    #   @return [Integer] the ID of the location the position tracks on the map
+    attribute :tracking_location_id
+
+    # @!attribute width
+    #   @return [Integer] the width of the position on the map in percentage
+    attribute :width
+
+    # @!attribute x_pos
+    #   @return [Integer] the x_pos of the position on the map in percentage
+    attribute :x_pos
+
+    # @!attribute y_pos
+    #   @return [Integer] the y_pos of the position on the map in percentage
+    attribute :y_pos
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the location was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the location was last updated
+    attribute :updated_at
+  end
+
   # = The person class
   class Person < LWS::Generic::Model
     use_api LWS::Presence.api
 
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the person
+    #   @return [Integer] the (unique) ID of the person
     attribute :id
 
     # @!attribute company
@@ -131,7 +288,7 @@ module LWS::Presence
     belongs_to :company, class_name: "LWS::Auth::Company"
 
     # @!attribute company_id
-    #   @return [Fixnum] the ID of the company the person belongs to
+    #   @return [Integer] the ID of the company the person belongs to
     attribute :company_id
 
     # @!attribute customer_reference
@@ -139,8 +296,8 @@ module LWS::Presence
     attribute :customer_reference
 
     # @!attribute ero
-    #  @return [Boolean] whether the person is emergency response
-    #    certified
+    #   @return [Boolean] whether the person is emergency response
+    #     ceritified
     attribute :ero
 
     # @!attribute extra_info
@@ -164,8 +321,13 @@ module LWS::Presence
     #   @return [Location] the location the person is located at
     belongs_to :location
 
+    # @!attribute location_ancestors_ids
+    #   @return [Array<Integer>] the IDs of the (nesting) locations
+    #     the person is located at
+    attribute :location_ancestor_ids
+
     # @!attribute location_id
-    #   @return [Fixnum] the ID of the location the person is located at
+    #   @return [Integer] the ID of the location the person is located at
     attribute :location_id
 
     # @!attribute name
@@ -190,6 +352,10 @@ module LWS::Presence
     #      linked to the person
     attribute :udid
 
+    # @!attribute visibility
+    #   @return ["public", "private"] if a person should be protected by not showing critical information
+    attribute :visibility
+
     # @!attribute created_at [r]
     #   @return [String] the timestamp of when the person was created
     attribute :created_at
@@ -204,11 +370,11 @@ module LWS::Presence
     use_api LWS::Presence.api
 
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the reader
+    #   @return [Integer] the (unique) ID of the reader
     attribute :id
 
     # @!attribute gateway
-    #   @return [Fixnum] the (32-bit) LCIO gateway ID of the reader
+    #   @return [Integer] the (32-bit) LCIO gateway ID of the reader
     attribute :gateway
 
     # @!attribute location
@@ -216,11 +382,11 @@ module LWS::Presence
     belongs_to :location
 
     # @!attribute location_id
-    #   @return [Fixnum] the ID of the location of the reader
+    #   @return [Integer] the ID of the location of the reader
     attribute :location_id
 
     # @!attribute node
-    #   @return [Fixnum] the (8-bit) LCIO gateway node number of the reader
+    #   @return [Integer] the (8-bit) LCIO gateway node number of the reader
     attribute :node
 
     # @!attribute created_at [r]

data/lib/lws/apps/resource.rb

@@ -46,7 +46,7 @@ module LWS::Resource
     use_api LWS::Resource.api
 
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the collection
+    #   @return [Integer] the (unique) ID of the collection
     attribute :id
 
     # @!attribute account
@@ -55,7 +55,7 @@ module LWS::Resource
     belongs_to :account, class_name: "LWS::Auth::Account"
 
     # @!attribute account_id
-    #   @return [Fixnum] the ID of the account of the user that created the
+    #   @return [Integer] the ID of the account of the user that created the
     #     collection
     attribute :account_id
 
@@ -64,7 +64,7 @@ module LWS::Resource
     belongs_to :company, class_name: "LWS::Auth::Company"
 
     # @!attribute company_id
-    #   @return [Fixnum] the ID of the company the collection belongs to
+    #   @return [Integer] the ID of the company the collection belongs to
     attribute :company_id
 
     # @!attribute folder
@@ -72,7 +72,7 @@ module LWS::Resource
     belongs_to :folder
 
     # @!attribute folder_id
-    #   @return [Fixnum] the ID of the folder that the collection is
+    #   @return [Integer] the ID of the folder that the collection is
     #     filed in
     attribute :folder_id
 
@@ -155,7 +155,7 @@ module LWS::Resource
     uri "collections/:collection_id/items(/:id)"
 
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the collection item
+    #   @return [Integer] the (unique) ID of the collection item
     attribute :id
 
     # @!attribute collection
@@ -164,7 +164,7 @@ module LWS::Resource
     belongs_to :collection
 
     # @!attribute collection_id
-    #  @return [Fixnum] the ID of the collection that the collection item is a
+    #  @return [Integer] the ID of the collection that the collection item is a
     #    part of
     attribute :collection_id
 
@@ -226,7 +226,7 @@ module LWS::Resource
     attribute :modification_date
     
     # @!attribute order_priority
-    #   @return [Fixnum] the order priority of the of the post (ascending;
+    #   @return [Integer] the order priority of the of the post (ascending;
     #     0 is lowers)
     attribute :order_priority
     
@@ -263,7 +263,7 @@ module LWS::Resource
              uri: "collections/:collection_id/feeds/:feed_id/posts(/:id)"
 
     # @!attribute refresh_interval
-    #   @return [Fixnum] the interval used to refresh the feed (in seconds)
+    #   @return [Integer] the interval used to refresh the feed (in seconds)
     attribute :refresh_interval
   end
 
@@ -279,7 +279,7 @@ module LWS::Resource
                uri: "collections/:collection_id/feeds(/:id)"
 
     # @!attribute feed_id
-    #   @return [Fixnum] the ID of the collection feed that the collection
+    #   @return [Integer] the ID of the collection feed that the collection
     #     feed is a post is part of
     attribute :feed_id
   end
@@ -360,7 +360,7 @@ module LWS::Resource
     attribute :long
 
     # @!attribute refresh_intervla
-    #   @return [Fixnum] the interval used to refresh the weather location
+    #   @return [Integer] the interval used to refresh the weather location
     #     (in seconds)
     attribute :refresh_interval
 
@@ -379,15 +379,15 @@ module LWS::Resource
     uri "collections/:collection_id/weather_locations/:weather_location_id/forecasts(/:id)"
 
     # @!attribute code
-    #   @return [Fixnum] the code for the weather location forecast
+    #   @return [Integer] the code for the weather location forecast
     attribute :code
 
     # @!attribute date
-    #   @return [Fixnum] the timestamp of the date of the weather location forecast
+    #   @return [Integer] the timestamp of the date of the weather location forecast
     attribute :date
 
     # @!attribute description
-    #   @return [Fixnum] the description of the weather location forecast
+    #   @return [Integer] the description of the weather location forecast
     attribute :description
 
     # @!attribute observation
@@ -411,7 +411,7 @@ module LWS::Resource
                uri: "collections/:collection_id/weather_location(/:id)"
 
     # @!attribute weather_location_id
-    #   @return [Fixnum] the ID of the collection weather location that the
+    #   @return [Integer] the ID of the collection weather location that the
     #     collection weather location is a post is part of
     attribute :weather_location_id
 
@@ -428,7 +428,7 @@ module LWS::Resource
     use_api LWS::Resource.api
 
     # @!attribute id [r]
-    #   @return [Fixnum] the (unique) ID of the folder
+    #   @return [Integer] the (unique) ID of the folder
     attribute :id
 
     # @!attribute account
@@ -437,7 +437,7 @@ module LWS::Resource
     belongs_to :account, class_name: "LWS::Auth::Account"
 
     # @!attribute account_id
-    #   @return [Fixnum] the ID of the account of the user that created
+    #   @return [Integer] the ID of the account of the user that created
     #     the folder
     attribute :account_id
 
@@ -450,7 +450,7 @@ module LWS::Resource
     belongs_to :company, class_name: "LWS::Auth::Company"
 
     # @!attribute company_id
-    #   @return [Fixnum] the ID of the company the folder belongs to
+    #   @return [Integer] the ID of the company the folder belongs to
     attribute :company_id
 
     # @!attribute folders
@@ -471,7 +471,7 @@ module LWS::Resource
                         foreign_key: "parent_id"
 
     # @!attribute parent_id
-    #   @return [Fixnum, nil] the ID of the parent folder of the folder
+    #   @return [Integer, nil] the ID of the parent folder of the folder
     attribute :parent_id
 
     # @!attribute created_at [r]