lws 6.3.1 → 6.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ef5cd27ac33754477433676be254a830b11ae048deeaddc8c847b19468ffe64
-  data.tar.gz: 15fa827aed23e1a58d7843783f9f712aaf62e6db743acf43cdf64ac95fc11276
+  metadata.gz: 6735eba2229b17c2690bddf74524980752e5deea2e893d65e2789be1138df2a3
+  data.tar.gz: b5e0914b8295744c2e5ee2670d44835962faf000ccc307c75b0ff8de6b80e141
 SHA512:
-  metadata.gz: e49fae53085988517741dba01bd314152a21230c1338ff023ad0ad844f4c66343ec79adaa1a9703337eca4f8c4bbf76fd0c8152fadf3be5dd0de5cb5e4d70f19
-  data.tar.gz: a322643e07f01d0c97215d59523991385fe6b166843f10c2d64cc001749718053037bdaaadc1486f0eed8653d9338a4ff178374e9fc5f84c10868f346497a45d
+  metadata.gz: b82822f7f43fb6752b3f137fdad30be4e0a0f90e9084c22e5c3db6b6cbad70e49acf15772b2b3ae5f73e16037e134db3afa3bcd13956835089168219f76d4e9f
+  data.tar.gz: a3bbf82f1eb2c003bea92750544e4447b76949ca5cdff28730d7502e9826cb4d5cacb52299cbf4c2a88dae336fd48c6ccb769f1524fce7a9217cd8c5116b85df

data/CHANGELOG.md

@@ -6,6 +6,14 @@ of LWS in the major/minor part of te version.
 
 The changelog follows the [Keep a Changelog] format from version 6.3.0 on.
 
+## [6.3.2] - 2019-09-26
+### Added
+* Expanded the models and attributes in the presence app (#12108)
+* Added a `#dig` method for the generic/all models
+
+### Fixed
+* Fixed the reduced/dropped test coverage (#12107)
+
 ## [6.3.1] - 2019-09-05
 ### Changed
 * Reworked the JSON parser to handle metadata better
@@ -151,3 +159,4 @@ Initial release
 [Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
 [6.3.0]: https://gitlab.leftclick.eu/platform/ruby-lws/compare/v6.2.3...v6.3.0
 [6.3.1]: https://gitlab.leftclick.eu/platform/ruby-lws/compare/v6.3.0...v6.3.1
+[6.3.1]: https://gitlab.leftclick.eu/platform/ruby-lws/compare/v6.3.1...v6.3.2

data/lib/lws/apps/generic.rb

@@ -150,6 +150,17 @@ module LWS::Generic
       result
     end
 
+    # Extracts a nested attribute vlaue specified by the sequence of attribute names
+    # by calling dig at each step, returning +nil+ if any intermediate step is +nil+.
+    def dig(*attrs)
+      attr = attrs.shift
+      value = send(attr)
+      return nil if value.nil?
+      return value if attrs.empty?
+      raise TypeError, "#{value.class} does not have #dig method" unless value.respond_to? :dig
+      value.dig(*attrs)
+    end
+
   end
 
   # = The configuration class

data/lib/lws/apps/presence.rb

@@ -35,6 +35,59 @@ module LWS::Presence
 
   ### App specific classes
 
+  # = The appointment class
+  #
+  # @note
+  #   This class is only used within the context of either the {Location} or
+  #   the {Person} class.
+  class Appointment < LWS::Generic::Model
+    use_api LWS::Presence.api
+
+    # @!attribute title
+    #   @return [String] the title of the appointment
+    attribute :title
+
+    # @!attribute datetime_end
+    #   @return [String] the timestamp of the end of the appointment
+    attribute :datetime_end
+
+    # @!attribute datetime_start
+    #   @return [String] the timestamp of the start of the appointment
+    attribute :datetime_start
+
+    # @!attribute description
+    #   @return [String] the description of the appointment
+    attribute :description
+
+    # @!attribute invite
+    #   @return [String] the original invite body of the appointment
+    attribute :invite
+
+    # @!attribute location
+    #   @return [Location] the location of the appointment
+    belongs_to :location, uri: "locations/:id"
+
+    # @!attribute location
+    #   @return [Integer] the ID of the location of the appointment
+    attribute :location_id
+
+    # @!attribute organiser
+    #   @return [Person] the origaniser of the appointment
+    belongs_to :organiser, class_name: "LWS::Presence::Person"
+
+    # @!attribute organiser_id
+    #   @return [Fixnum] the ID of the origaniser of the appointment
+    attribute :organiser_id
+
+    # @!attribute people
+    #   @return [Array<Person>] the people associated with the appointment
+    has_many :people
+
+    # @!attribute uuid
+    #   @return [String] the UUID of the location
+    attribute :uuid
+  end
+
   # = The location class
   class Location < LWS::Generic::Model
     use_api LWS::Presence.api
@@ -44,6 +97,10 @@ module LWS::Presence
     #     including the location itself
     attribute :ancestor_ids
 
+    # @!attribute appointments
+    #   @return [Array<Appointment>] the appointments taking place at the location
+    has_many :appointments
+
     # @!attribute capacity
     #   @return [Integer] the capacity (maximum number of people) of the location
     attribute :capacity
@@ -121,6 +178,16 @@ module LWS::Presence
     #   @return [String] the name of the location
     attribute :name
 
+    # @!attribute owner
+    #   @return [Person, nil] the owner of the location
+    belongs_to :owner, class_name: "LWS::Presence::Person",
+                       foreign_key: "owner_id",
+                       uri: "people/:id"
+
+    # @!attribute owner_id
+    #   @return [Fixnum, nil] the ID of the owner of the location
+    attribute :owner_id
+
     # @!attribute parent
     #   @return [Location] the parent of the location
     belongs_to :parent, class_name: "LWS::Presence::Location",
@@ -147,6 +214,10 @@ module LWS::Presence
     # @!attribute readers
     #   @return [Array<Reader>] the (RFID/code/ID/...) readers linked to this location
     has_many :readers
+
+    # @!attribute uuid
+    #   @return [String] the UUID of the location
+    attribute :uuid
   end
 
   # = The location map class
@@ -239,10 +310,45 @@ module LWS::Presence
     attribute :y_pos
   end
 
+  # = The notification class
+  #
+  # @note This model can only be created via LWS, never retrieved, deleted or updated.
+  class Notification < LWS::Generic::Model
+    use_api LWS::Presence.api
+
+    # @attribute location
+    #   @return [Location] the location the notification is for
+    belongs_to :location, uri: "locations/:id"
+
+    # @attribute location_id
+    #   @return [Fixnum] the ID of the location the notification is for
+    attribute :location_id
+
+    # @attribute receiver
+    #   @return [Person] the receiver of the notification
+    belongs_to :receiver
+
+    # @attribute receiver_id
+    #   @return [Integer] the ID of the receiver of the notification
+    belongs_to :receiver_id
+
+    # @attribute sender
+    #   @return [Person] the sender of the notification
+    belongs_to :sender
+
+    # @attribute sender_id
+    #   @return [Integer] the ID of the receiver of the nofication
+    belongs_to :sender_id
+  end
+
   # = The person class
   class Person < LWS::Generic::Model
     use_api LWS::Presence.api
 
+    # @!attribute appointments
+    #   @return [Array<Appointment>] the appointments involving the person
+    has_many :appointments
+
     # @!attribute company
     #   @return [LWS::Auth::Company] the company the person belongs to
     belongs_to :company, class_name: "LWS::Auth::Company"
@@ -269,9 +375,14 @@ module LWS::Presence
     attribute :extra_info
 
     # @!attribute import_ref
-    #   @return [String, nil] reference for storing the uid of the remote database
+    #   @return [String, nil] reference for storing the uid of the remote
+    #     database
     attribute :import_ref
 
+    # @!attribute kind
+    #   @return ["employee", "guest"] the person kind
+    attribute :kind
+
     # @!attribute last_sync
     #   @return [String, nil] the last date/time the status was updated via a
     #      device or RFID tag
@@ -339,11 +450,13 @@ module LWS::Presence
     attribute :udid
 
     # @!attribute vehicle_registration_plate
-    #   @return [String, nil] The vehicle registration plate of the persons transport
+    #   @return [String, nil] The vehicle registration plate of the persons
+    #     transport
     attribute :vehicle_registration_plate
 
     # @!attribute visibility
-    #   @return ["public", "private"] if a person should be protected by not showing critical information
+    #   @return ["public", "private"] if a person should be protected by not
+    #     showing critical information
     attribute :visibility
   end
 

data/lib/lws/version.rb

@@ -13,6 +13,6 @@ module LWS
 
   # The LWS library version.
   # @note The major and minor version parts match the LWS API version!
-  VERSION = '6.3.1'.freeze
+  VERSION = '6.3.2'.freeze
 
 end

data/test/generic_test.rb

@@ -25,6 +25,12 @@ class TestGenericModel < MiniTest::Test
     assert_equal("other_value", @configuration.value)
   end
 
+  def test_not_found
+    assert_raises LWS::Errors::ResourceNotFound do
+      Configuration.find("NOTEXIST")
+    end
+  end
+
   def test_lifecycle
     # Create
     new_configuration = Configuration.create(key: "test", value: "some_value")
@@ -88,6 +94,18 @@ class TestGenericModel < MiniTest::Test
     assert_equal(true, result)
   end
 
+  def test_dig
+    company = LWS::Auth::Company.find(1)
+    assert_equal(company.id, company.dig(:id))
+
+    assert_equal(company.contact_person.name, company.dig(:contact_person, :name))
+    assert_nil(company.dig(:parent, :name))
+
+    assert_raises(TypeError) do
+      company.dig(:id, :foo)
+    end
+  end
+
 end
 
 class TestGenericConfiguration < MiniTest::Test
@@ -115,5 +133,10 @@ class TestGenericStorage < MiniTest::Test
   def test_upload
     data = StringIO.new("some file contents\n")
     refute_nil(Storage.create(data, "test.txt", "text/plain"))
+
+    # Also test using the default HTTP adapter.
+    reconfigure(http_persistent: false)
+    data = StringIO.new("some more file contents\n")
+    refute_nil(Storage.create(data, "test2.txt", "text/plain"))
   end
 end

data/test/json_parser_test.rb

@@ -24,10 +24,16 @@ class TestJSONParser < MiniTest::Test
                     country: "NL",
                     # ...
                   } }
+    companies = [ { id: "correct",
+                     country: "NL",
+                     # ...
+                  } ]
 
     full_uri = LWS::Auth.api.url_prefix.dup
     full_uri.path = "/companies/broken"
     stub_request(:get, full_uri.to_s).to_return(body: "{}invalid json")
+    full_uri.path = "/companies/noobj"
+    stub_request(:get, full_uri.to_s).to_return(body: "\"str\"")
     full_uri.path = "/companies/empty"
     stub_request(:get, full_uri.to_s).to_return(body: "")
     full_uri.path = "/companies/correct"
@@ -36,6 +42,8 @@ class TestJSONParser < MiniTest::Test
     stub_request(:put, full_uri.to_s)
       .to_return(body: MultiJson.dump(company.merge(errors: { contact_person_id: ["can't be blank"] })))
     full_uri.path = "/companies"
+    stub_request(:get, full_uri.to_s)
+      .to_return(body: MultiJson.dump(companies))
     stub_request(:post, full_uri.to_s)
       .to_return(body: "", status: 204)
   end
@@ -49,12 +57,24 @@ class TestJSONParser < MiniTest::Test
     assert_raises LWS::Errors::InvalidResponse do
       company = LWS::Auth::Company.find("broken")
     end
+
+    assert_raises LWS::Errors::InvalidResponse do
+      company = LWS::Auth::Company.find("noobj")
+    end
+
+    assert_raises LWS::Errors::InvalidResponse do
+      company = LWS::Auth::Company.find("empty")
+    end
   end
 
   def test_correct_json
     company = LWS::Auth::Company.find("correct")
     assert_equal "correct", company.id
   end
+  def test_correct_json_ary
+    companies = LWS::Auth::Company.all.to_a
+    assert_equal "correct", companies.first.id
+  end
 
   def test_no_content_json
     company = LWS::Auth::Company.create

data/test/presence_test.rb

@@ -11,12 +11,36 @@
 
 require "test_helper"
 
+class TestPresenceAppointment < MiniTest::Test
+
+  include LWS::Presence
+
+  def setup
+    @location = Location.where(includes: "appointments.*").find(1)
+    @appointment = @location.appointments.first
+  end
+
+  def test_valid
+    refute_nil(@appointment)
+    assert_instance_of(Appointment, @appointment)
+    refute_nil(@appointment.id)
+  end
+
+  def test_valid_associations
+    assert_instance_of(Location, @appointment.location)
+    assert_equal(@location, @appointment.location)
+    assert_instance_of(Person, @appointment.organiser)
+    assert_instance_of(Person, @appointment.people.first)
+  end
+
+end
+
 class TestPresenceLocation < MiniTest::Test
 
   include LWS::Presence
 
   def setup
-    @location = Location.find(1)
+    @location = Location.where(includes: "appointments.*").find(1)
   end
 
   def test_valid
@@ -26,9 +50,11 @@ class TestPresenceLocation < MiniTest::Test
   end
 
   def test_valid_associations
+    assert_instance_of(Appointment, @location.appointments.first)
     assert_instance_of(LWS::Auth::Company, @location.company)
     assert_instance_of(Location::Map::Position, @location.map_positions.first)
     assert_instance_of(Location::Map, @location.maps.first)
+    assert_instance_of(Person, @location.owner)
     assert_instance_of(Person, @location.people.first)
     assert_instance_of(Reader, @location.readers.first)
     loc = Location.where(includes: "people_tree").find(1)
@@ -92,12 +118,29 @@ class TestPresenceLocationMapPosition < MiniTest::Test
   end
 
 end
+
+class TestPresenceNotification < MiniTest::Test
+
+  include LWS::Presence
+
+  def setup
+    @notification = Notification.create(location_id: 1,
+                                        receiver_id: 1,
+                                        sender_id: 1)
+  end
+
+  def test_valid
+    refute_nil(@notification)
+  end
+
+end
+
 class TestPresencePerson < MiniTest::Test
 
   include LWS::Presence
 
   def setup
-    @person = Person.find(1)
+    @person = Person.where(includes: "appointments.*").find(1)
   end
 
   def test_valid
@@ -107,6 +150,7 @@ class TestPresencePerson < MiniTest::Test
   end
 
   def test_valid_associations
+    assert_instance_of(Appointment, @person.appointments.first)
     assert_instance_of(LWS::Auth::Company, @person.company)
     assert_instance_of(Location, @person.location)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 6.3.1
+  version: 6.3.2
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2019-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware