lws 6.2.1 → 6.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02ddf61260b1288e6e201f1c80aa065963e9beec247b133b6a4fb78a2b78cdca
-  data.tar.gz: 6526aa14baee05dd3e6e1618a87e21c2ca274afba7d360bf5585420f8c8221ce
+  metadata.gz: 7b91a46e1cd07d2abdbe4d45e4d634725177bd993926e617a0eb0bf79b78a038
+  data.tar.gz: a5a570895842b2d7d7bfe6f40326a34b84c2d3a484668832588091d84ffb7b0c
 SHA512:
-  metadata.gz: f9e1a3341fd4b28dea74abfe121b8352b8fa22d0aea35b239f48f9d7ba45bd91382c636385f83a08c3f3b9f4efadf72dccca35119e62d423cd12b1d877c032ed
-  data.tar.gz: dbfd3e1334c6790712e60e931eed86c94f98d478b9ea54e5c2fca855cfe5f57967d394b32d2777a8f4e480d9a1b419f8eede43f7b9b9df57d4e922ace9f972b3
+  metadata.gz: 214b724cd2c734cdb95e50be7b74d0cfbd5f8766a6cb3d665e17f21fa0202f80abddbe968d9f150583fd82e00c9a31ead72e5ff62e6aeb40539868d8b3ed0b38
+  data.tar.gz: 491e70649040f36afdb496accf6c0e41ed640649606d313a375d5b7cfc2cd8b967673d0752037e21bde5e92d7a411d6a367f692cea0ee76a7b1496ddfb353f0e

data/CHANGELOG.md

@@ -4,6 +4,15 @@ Up until v6.1.0, we used the standard Gem version numbering starting at v0.0.1.
 From v6.1.0 on the version will follow the API version of LWS in the major/minor
 part of te version.
 
+## v6.2.2
+
+* Add some more attributes to the Presence app
+* Use persistent HTTP connections from now on (#12101)
+  * Add a configuration option for enabling/disabling persistent HTTP
+    connections
+* Add support for dirtiness checking for all models (#12100)
+  * Only save models using the HTTP if dirty
+
 ## v6.2.1
 
 * Add new models and attributes to the Presence app (#12098, #12099)

data/lib/lws.rb

@@ -126,7 +126,11 @@ module LWS
       c.use HTTPLogger, config.logger, config.http_debug_headers if config.http_debug
 
       # Adapter
-      c.adapter Faraday.default_adapter
+      if config.http_persistent
+        c.adapter :net_http_persistent
+      else
+        c.adapter Faraday.default_adapter
+      end
     end
 
     return api

data/lib/lws/apps/generic.rb

@@ -18,6 +18,8 @@ module LWS::Generic
   #
   # This model forms the base for all LWS models.
   class Model < Spyke::Base
+    include ActiveModel::Dirty
+
     include_root_in_json true
 
     # @private
@@ -50,7 +52,12 @@ module LWS::Generic
     # @param [Symbol] name the name of the attribute to add
     # @return [void]
     def self.attribute(name)
+      define_attribute_methods(name)
       attributes(name)
+      define_method(:"#{name}=") do |value|
+        send(:"#{name}_will_change!") unless value == attribute(name)
+        super(value)
+      end
     end
 
     # @private
@@ -79,6 +86,50 @@ module LWS::Generic
       self.include_root_in_json self.name.split("::").last.underscore.to_sym
       api
     end
+
+    # @private
+    # @!visibility private
+    #
+    # Sets up the object/model and then clears any changes information as
+    # a result of loading and processing the JSON from LWS.
+    #
+    # return [Model] a new instance of the generic model
+    def initialize(*args)
+      super
+      clear_changes_information if persisted?
+    end
+
+    # Reloads the attributes of this model by retrieving it from LWS
+    # via HTTP.
+    #
+    # This also clears information about tracked changes to attribute
+    # values!
+    #
+    # @return [Hash] a mapping of retrieved attribute names to values
+    def reload
+      result = super
+      clear_changes_information if result
+      result
+    end
+
+    # Restore the attributes of this model to the previous (original) values.
+    #
+    # @return [Array<String>] list of attribute names that were rolled back
+    def rollback
+      restore_attributes
+    end
+
+    # Saves the model to LWS via HTTP if there are any changes.
+    #
+    # @return [Hash, Trueclass] a mapping of attributes names to values,
+    #   or +true+ if no save action was necessary.
+    def save
+      return true unless changed?
+      result = super
+      changes_applied if result
+      result
+    end
+
   end
 
   # = The configuration class

data/lib/lws/apps/presence.rb

@@ -113,8 +113,8 @@ module LWS::Presence
     attribute :long
 
     # @!attribute map_positions
-    #   @return [Array<Location::Map::Position>] the positions
-    #     that are associated with the location
+    #   @return [Array<Location::Map::Position>] the location map positions
+    #     that track this location
     has_many :map_positions, class_name: "LWS::Presence::Location::Map::Position"
 
     # @attribute maps
@@ -295,6 +295,10 @@ module LWS::Presence
     #   @return [String, nil] the customer specific reference for the person
     attribute :customer_reference
 
+    # @!attribute email
+    #   @return [String, nil] the email address of the person
+    attribute :email
+
     # @!attribute ero
     #   @return [Boolean] whether the person is emergency response
     #     ceritified
@@ -304,6 +308,10 @@ module LWS::Presence
     #   @return [String, nil] some extra info for the person
     attribute :extra_info
 
+    # @!attribute import_ref
+    #   @return [String, nil] reference for storing the uid of the remote database
+    attribute :import_ref
+
     # @!attribute last_sync
     #   @return [String, nil] the last date/time the status was updated via a
     #      device or RFID tag
@@ -334,10 +342,28 @@ module LWS::Presence
     #   @return [String] the name of the person
     attribute :name
 
+    # @!attribute phone_fixed
+    #   @return [String] the fixed phonenumber of the person
+    attribute :phone_fixed
+
+    # @!attribute phone_mobile
+    #   @return [String] the mobile phonenumber of the person
+    attribute :phone_moblie
+
+    # @!attribute phone_extension
+    #   @return [String] the fixed phonenumber extension of the person
+    attribute :phone_extension
+
     # @!attribute picture_url
     #   @return [String, nil] the URL of the picture of the person
     attribute :picture_url
 
+    # @!attribute present
+    #   @return [Boolean] if a person is present at a location. It looks
+    #     at the state of a person so that local state checking is not
+    #     needed.
+    attribute :present
+
     # @!attribute rfid
     #   @return [String, nil] the RFID tag ID linked to the person
     attribute :rfid
@@ -352,6 +378,10 @@ module LWS::Presence
     #      linked to the person
     attribute :udid
 
+    # @!attribute vehicle_registration_plate
+    #   @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
     attribute :visibility

data/lib/lws/config.rb

@@ -54,6 +54,10 @@ module LWS
     #    (default: +false+)
     property :http_debug_headers, default: false
 
+    #@!attribute http_persistent
+    #  @return [Boolean] whether persistent HTTP connections are used
+    property :http_persistent, default: true
+
     #@!attribute json_debug
     #  @return [Boolean] whether to show JSON debug messages (default: +false+)
     property :json_debug, default: false

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.2.1'.freeze
+  VERSION = '6.2.2'.freeze
 
 end

data/test/generic_test.rb

@@ -11,21 +11,15 @@
 
 require "test_helper"
 
-class TestGenericConfiguration < MiniTest::Test
+class TestGenericModel < MiniTest::Test
 
-  # Generic class needs to be accessed under some kind of app
+  # Generic models needs to be accessed as under some kind of app
   include LWS::Auth
 
   def setup
     @configuration = Configuration.all.first
   end
 
-  def test_valid
-    refute_nil(@configuration)
-    assert_instance_of(Configuration, @configuration)
-    refute_nil(@configuration.id)
-  end
-
   def test_her_compatibility
     @configuration.assign_attributes("value" => "other_value")
     assert_equal("other_value", @configuration.value)
@@ -58,4 +52,51 @@ class TestGenericConfiguration < MiniTest::Test
     end
   end
 
+  def test_dirty
+    # No changes for a just found instance
+    configuration = Configuration.find(@configuration.id)
+    refute(configuration.changed?)
+    assert_equal({}, configuration.changes)
+
+    # Changes when an attribute is changed
+    configuration.value = "other_value"
+    assert(configuration.changed?)
+    assert_equal({ "value" => ["test_value", "other_value"] },
+                 configuration.changes)
+
+    # Changes reverted when rolled back
+    configuration.rollback
+    refute(configuration.changed?)
+    assert_equal({}, configuration.changes)
+
+    # Changes overwritten when reloaded
+    configuration.value = "other_value"
+    assert(configuration.changed?)
+    configuration.reload
+    refute(configuration.changed?)
+    assert_equal({}, configuration.changes)
+
+    # Not committed to the API if not changed
+    refute(configuration.changed?)
+    result = configuration.save
+    assert_equal(true, result)
+  end
+
+end
+
+class TestGenericConfiguration < MiniTest::Test
+
+  # Generic class needs to be accessed under some kind of app
+  include LWS::Auth
+
+  def setup
+    @configuration = Configuration.all.first
+  end
+
+  def test_valid
+    refute_nil(@configuration)
+    assert_instance_of(Configuration, @configuration)
+    refute_nil(@configuration.id)
+  end
+
 end

data/test/json_parser_test.rb

@@ -16,6 +16,8 @@ class TestJSONParser < MiniTest::Test
   include WebMock::API
 
   def setup
+    # Redo LWS setup with persistent HTTP connections disabled.
+    reconfigure(http_persistent: false)
     WebMock.enable!
     company = { id: "correct",
                 country: "NL",
@@ -31,7 +33,7 @@ class TestJSONParser < MiniTest::Test
     stub_request(:get, full_uri.to_s)
       .to_return(body: MultiJson.dump(company))
     stub_request(:put, full_uri.to_s)
-      .to_return(body: MultiJson.dump(company.merge(errors: { ticket: ["is an invalid field"] })))
+      .to_return(body: MultiJson.dump(company.merge(errors: { contact_person_id: ["can't be blank"] })))
     full_uri.path = "/companies"
     stub_request(:post, full_uri.to_s)
       .to_return(body: "", status: 204)
@@ -39,6 +41,7 @@ class TestJSONParser < MiniTest::Test
 
   def teardown
     WebMock.disable!
+    reconfigure
   end
 
   def test_broken_json
@@ -59,9 +62,9 @@ class TestJSONParser < MiniTest::Test
 
   def test_correct_json_with_errors
     company = LWS::Auth::Company.find("correct")
-    company.ticket = "unknown attribute"
+    company.contact_person_id = ""
     company.save
-    assert_equal ["Ticket is an invalid field"], company.errors.to_a
+    assert_equal ["Contact person can't be blank"], company.errors.to_a
   end
 
 end

data/test/stubbing_test.rb

@@ -14,8 +14,10 @@ require "test_helper"
 class TestStubbing < MiniTest::Test
 
   def setup
-    # Redo the LWS setup with cache
-    reconfigure(stubbing: File.expand_path("../fixtures", __FILE__))
+    # Redo LWS setup with stubbing enabled and persistent HTTP connections
+    # disabled.
+    reconfigure(http_persistent: false,
+                stubbing: File.expand_path("../fixtures", __FILE__))
   end
 
   def teardown

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 6.2.1
+  version: 6.2.2
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware