lws 7.0.2 → 7.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2baebac6cb99dc5b7106f8cb9eeff4953f623ed1c7a2465ef165e9bf48c0330a
-  data.tar.gz: 58833b0704e57635dcf70f06391f45276723efadac02ed05106efb23ce82f70d
+  metadata.gz: cd64c620eb066a25ef746caf1dbd624ce627cf476b90d531b910cf5dda7c804f
+  data.tar.gz: 934a7a8a804eb74a7ed954b1db917531cab5dfc03cd5c2daa98846ca7c0aa4f3
 SHA512:
-  metadata.gz: 1430d0b1e0927121be013e60191be69e41b3fcc8a388ac6f707d6c39471fcf540776cf82c674f50104fa200e0c43f28f7c6662b3e1787116205e8b5f04357d51
-  data.tar.gz: 98e60f674fc4b39ab09805accb562f6080c87573930dff4c660f42b8ef0c806c44460fdc191aa6bad86636374cc7619cedbb84ae90fbfdcab2dfeb50f7d6c832
+  metadata.gz: 56945d4070e3f193ed6245371cb054a0f2526e25254d66c27c295f1bb466952fbd1d3d8424257f25d9d463458a4636343bbb972b18c1ac7a95e000b984dc7c9b
+  data.tar.gz: 2a6f40cd0b12ff0ce11f6009e38e162e16deafcf5b8db086e5b1632234ee087225f8d6f6d7c660c1e063e1d605242e404185bc2c538eab59f85d6a2295719bad

data/lib/lws/apps/generic.rb

@@ -180,9 +180,11 @@ module LWS::Generic
   class Storage
     # @!visibility private
     def self.use_api(api)
-      @connection = Faraday.new(url: api.url_prefix) do |c|
-        config = LWS.config
+      config = LWS.config
 
+      # A connection to Active Storage (with JSON request/response, but without
+      # token authentication and caching).
+      @as_connection = Faraday.new(url: api.url_prefix) do |c|
         # Request
         c.request :json
 
@@ -197,6 +199,36 @@ module LWS::Generic
           c.adapter Faraday.default_adapter
         end
       end
+
+      # A plain file connection to LWS (with token autnentication and caching but without
+      # JSON request/response).
+      @lws_connection = Faraday.new(url: api.url_prefix) do |c|
+        # Request
+        if config.caching_object
+          c.use FaradayMiddleware::Caching, config.caching_object
+        end
+        c.use LWS::Middleware::RequestHeaders, config.api_token
+        c.use config.api_token_middleware if config.api_token_middleware.present?
+
+        # Response
+        c.use FaradayMiddleware::FollowRedirects, limit: 3
+        c.use LWS::HTTPLogger, config.logger, config.http_debug_headers if config.http_debug
+
+        # Adapter
+        if config.http_persistent
+          c.adapter :net_http_persistent
+        else
+          c.adapter Faraday.default_adapter
+        end
+      end
+    end
+
+    # (see .upload)
+    # @deprecated
+    #   To have a consistent upload/download naming counterpart, this
+    #   method has been deprecated. Use {.upload} instead.
+    def self.create(file_or_io, filename, content_type = "application/octet-stream")
+      upload(file_or_io, filename, content_type)
     end
 
     # Uploads a file (or IO object) to the storage of the app module.
@@ -208,7 +240,7 @@ module LWS::Generic
     # @param filename [String] the filename to use for the uploaded file/IO object
     # @param content_type [String] the content type of the uploaded file/IO object
     # @return [String, nil] the storage ID (if successful)
-    def self.create(file_or_io, filename, content_type = "application/octet-stream")
+    def self.upload(file_or_io, filename, content_type = "application/octet-stream")
       return nil if file_or_io.closed?
 
       data = file_or_io.read
@@ -217,7 +249,7 @@ module LWS::Generic
                        content_type: content_type,
                        byte_size: data.length,
                        checksum: checksum } }
-      res = @connection.post do |req|
+      res = @as_connection.post do |req|
         req.url "rails/active_storage/direct_uploads"
         req.headers["Accept"] = "application/json"
         req.headers["Content-Type"] = "application/json"
@@ -226,7 +258,7 @@ module LWS::Generic
 
       if res.success?
         result = JSON.parse(res.body)
-        res = @connection.put do |req|
+        res = @as_connection.put do |req|
           req.url result.dig("direct_upload", "url")
           result.dig("direct_upload", "headers").each do |hdr, val|
             req.headers[hdr] = val
@@ -240,6 +272,24 @@ module LWS::Generic
         nil
       end
     end
-  end
 
+    # Downloads a file at the provided URL from the storage using the
+    # appropriate API tokens.
+    #
+    # This method can be used to download images/assets/etc. from LWS using
+    # URLs provided by attributes that end with +_url+.
+    # @param url [String] the URL to download the file from
+    # @return [String] the contents of the file
+    def self.download(url)
+      return nil if url.nil?
+
+      unless url.start_with? @lws_connection.url_prefix.to_s
+        raise ArgumentError,
+          "URL does not belong to this LWS app (endpoint: #{@lws_connection.url_prefix})"
+      end
+
+      res = @lws_connection.get(url)
+      res.body
+    end
+  end
 end

data/lib/lws/apps/presence.rb

@@ -157,13 +157,24 @@ module LWS::Presence
     #   @return [Array<Integer>] the IDs of the underlying locations of the location
     attribute :descendant_ids
 
+    # @!attribute image_storage_id
+    #   @return [String, nil] the storage ID of the image of the location
+    attribute :image_storage_id
+
+    # @!attribute image_url
+    #   @note
+    #     To be able retrieve this, the token needs to be passed via +X-Token+
+    #     in the HTTP request headers!
+    #   @return [String, nil] the URL of the image of the location
+    attribute :image_url
+
     # @!attribute lat
     #   @return [Float] the latitude of the location
     attribute :lat
 
     # @!attribute logoff_time
-    # The format of the time is +HH:MM+ and should be interpreted in the time zone
-    # of the location (see also {#time_zone}).
+    #   The format of the time is +HH:MM+ and should be interpreted in the time zone
+    #   of the location (see also {#time_zone}).
     #   @return [String] the time everybody is automatically logged off
     attribute :logoff_time
 
@@ -238,6 +249,17 @@ module LWS::Presence
     use_api LWS::Presence.api
     uri "locations/:location_id/maps(/:id)"
 
+    # @!attribute image_storage_id
+    #   @return [String, nil] the storage ID of the image of the map
+    attribute :image_storage_id
+
+    # @!attribute image_url
+    #   @note
+    #     To be able retrieve this, the token needs to be passed via +X-Token+
+    #     in the HTTP request headers!
+    #   @return [String, nil] the URL of the image of the map
+    attribute :image_url
+
     # @!attribute location
     #   @return [Location] the location the map belongs to
     belongs_to :location
@@ -251,6 +273,9 @@ module LWS::Presence
     attribute :name
 
     # @!attribute picture_url
+    #   @deprecated
+    #     Unauthenticated retrieval of the picture will not longer be supported
+    #     in upcoming releases of LWS. Use {#image_url} instead!
     #   @return [String, nil] the URL of the picture of the map
     attribute :picture_url
 
@@ -359,6 +384,17 @@ module LWS::Presence
     #   @return [Array<Appointment>] the appointments involving the person
     has_many :appointments
 
+    # @!attribute avatar_storage_id
+    #   @return [String, nil] the storage ID of the avatar of the person
+    attribute :avatar_storage_id
+
+    # @!attribute avatar_url
+    #   @note
+    #     To be able retrieve this, the token needs to be passed via +X-Token+
+    #     in the HTTP request headers!
+    #   @return [String, nil] the URL of the avatar of the person
+    attribute :avatar_url
+
     # @!attribute company
     #   @return [LWS::Auth::Company] the company the person belongs to
     belongs_to :company, class_name: "LWS::Auth::Company"
@@ -457,6 +493,9 @@ module LWS::Presence
     attribute :phone_mobile
 
     # @!attribute picture_url
+    #   @deprecated
+    #     Unauthenticated retrieval of the picture will not longer be supported
+    #     in upcoming releases of LWS. Use {#avatar_url} instead!
     #   @return [String, nil] the URL of the picture of the person
     attribute :picture_url
 
@@ -512,4 +551,9 @@ module LWS::Presence
     attribute :node
   end
 
+  # (see Generic::Storage)
+  class Storage < LWS::Generic::Storage
+    use_api LWS::Presence.api
+  end
+
 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 = "7.0.2".freeze
+  VERSION = "7.0.4".freeze
 
 end

data/test/generic_test.rb

@@ -128,15 +128,37 @@ end
 class TestGenericStorage < MiniTest::Test
 
   # Generic class needs to be accessed under some kind of app
-  include LWS::Resource
+  include LWS::Presence
 
   def test_upload
     data = StringIO.new("some file contents\n")
+    refute_nil(Storage.upload(data, "test.txt", "text/plain"))
+
+    # Test the deprecated method (for now)
     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"))
+    refute_nil(Storage.upload(data, "test2.txt", "text/plain"))
+  end
+
+  def test_download
+    location = Location.find(1)
+    refute_nil(location.image_url)
+
+    data = Storage.download(location.image_url)
+    assert(data.size > 0)
+
+    assert_nil(Storage.download(nil))
+
+    assert_raises(ArgumentError) do
+      Storage.download("https://doesnot.exist.tld/some/file")
+    end
+
+    # Also test using the default HTTP adapter.
+    reconfigure(http_persistent: false)
+    data = Storage.download(location.image_url)
+    assert(data.size > 0)
   end
 end

data/test/test_helper.rb

@@ -23,7 +23,7 @@ SimpleCov.at_exit do
   result.format!
   simplecov_test_suites = ['minitest']
   parallel_offset = ENV['PARALLEL_TEST_GROUPS'] ? ENV['PARALLEL_TEST_GROUPS'].to_i - 1 : 0
-  minimum_coverage = 97
+  minimum_coverage = 95
   # Count the number of commas in the command name to figure out how many result groups were combined into this result
   if result.command_name.scan(/,/).size + 1 >= simplecov_test_suites.size + (parallel_offset * 2) # two parallel suites
     # We only want to enforce minimum coverage after all test suites finish

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 7.0.2
+  version: 7.0.4
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -296,27 +296,27 @@ signing_key:
 specification_version: 4
 summary: LeftClick web services library for Ruby
 test_files:
-- test/fixtures/auth.yml
+- test/presence_test.rb
 - test/fixtures/permissions.yml
-- test/json_parser_test.rb
-- test/test_helper.rb
-- test/setup_test.rb
-- test/auth_test.rb
+- test/fixtures/auth.yml
+- test/corporate_website_test.rb
+- test/logger_test.rb
+- test/support/with_env.rb
 - test/stubbing_test.rb
+- test/ticket_test.rb
 - test/digital_signage_test.rb
-- test/api_token_middleware_test.rb
-- test/config/full.yml
+- test/caching_test.rb
+- test/auth_test.rb
+- test/maps_test.rb
+- test/json_parser_test.rb
+- test/resource_test.rb
+- test/config/endpoints.yml
 - test/config/switch_env.yml
 - test/config/invalid.yml
-- test/config/tokens.yml
 - test/config/empty.yml
-- test/config/endpoints.yml
-- test/maps_test.rb
-- test/logger_test.rb
-- test/ticket_test.rb
-- test/support/with_env.rb
-- test/caching_test.rb
-- test/presence_test.rb
-- test/corporate_website_test.rb
-- test/resource_test.rb
+- test/config/tokens.yml
+- test/config/full.yml
+- test/setup_test.rb
+- test/api_token_middleware_test.rb
 - test/generic_test.rb
+- test/test_helper.rb