lws 6.3.0 → 6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b78881916d363dc9fed830e0be6cecacc6b3928e699b047cb6004eab310f4ec8
-  data.tar.gz: 6de69f0e6437aeaf85cd1bdc1f6527a09cc0e9b33d200b377fb232ea932aa1b0
+  metadata.gz: 7ef5cd27ac33754477433676be254a830b11ae048deeaddc8c847b19468ffe64
+  data.tar.gz: 15fa827aed23e1a58d7843783f9f712aaf62e6db743acf43cdf64ac95fc11276
 SHA512:
-  metadata.gz: 4f18155b4bf72c6572c9d2dac80d1bc2ad00b35bde4a4169806495fdd4deead5971d7da9c6b7954a7ec859d48a7ac067dfad71d1d8d92c79d557be760a90e2ce
-  data.tar.gz: a4935986105ecdf15dd71a6dc33b4b2d40ce5d14363eec241e87cef28904a3db94a542cbe37b9c1cd54955f6c5df60b49d83f11195fb733c414ea3c5ee084251
+  metadata.gz: e49fae53085988517741dba01bd314152a21230c1338ff023ad0ad844f4c66343ec79adaa1a9703337eca4f8c4bbf76fd0c8152fadf3be5dd0de5cb5e4d70f19
+  data.tar.gz: a322643e07f01d0c97215d59523991385fe6b166843f10c2d64cc001749718053037bdaaadc1486f0eed8653d9338a4ff178374e9fc5f84c10868f346497a45d

data/CHANGELOG.md

@@ -6,6 +6,16 @@ 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.1] - 2019-09-05
+### Changed
+* Reworked the JSON parser to handle metadata better
+* Updated/reworked the Resource app models: added/removed/updated attributes
+  where necessary (#12106)
+
+### Removed
+* Removed some attributes that are already part of the generic model from
+  DigitalSignage app models
+
 ## [6.3.0] - 2019-09-05
 ### Added
 * Added slide, layout and related models to the DigitalSignage app (#12103)
@@ -140,3 +150,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

data/lib/lws/apps/digital_signage.rb

@@ -558,14 +558,6 @@ module LWS::DigitalSignage
     #   @return [Array<Version>] the versions of the layout
     has_many :versions, class_name: "LWS::DigitalSignage::Layout::Version",
                         uri: "layouts/:layout_id/versions(/:id)"
-
-    # @!attribute created_at [r]
-    #   @return [String] the timestamp of when the layout was created
-    attribute :created_at
-
-    # @!attribute updated_at [r]
-    #   @return [String] the timestamp of when the layout was last updated
-    attribute :updated_at
   end
 
   # = The layout category class
@@ -591,14 +583,6 @@ module LWS::DigitalSignage
     # @!attribute name
     #   @return [String] the name of the layout category
     attribute :name
-
-    # @!attribute created_at [r]
-    #   @return [String] the timestamp of when the layout category was created
-    attribute :created_at
-
-    # @!attribute updated_at [r]
-    #   @return [String] the timestamp of when the layout category was last updated
-    attribute :updated_at
   end
 
   # = The layout element class
@@ -657,15 +641,6 @@ module LWS::DigitalSignage
     # FIXME: Missing endpoint in LWS
     belongs_to :version, class_name: "LWS::DigitalSignage::Layout::Version",
                          foreign_key: :layout_version_id
-
-    # @!attribute created_at [r]
-    #   @return [String] the timestamp of when the layout element was created
-    attribute :created_at
-
-    # @!attribute updated_at [r]
-    #   @return [String] the timestamp of when the layout element was last
-    #     updated
-    attribute :updated_at
   end
 
   # = The layout element customizable class
@@ -698,22 +673,15 @@ module LWS::DigitalSignage
     attribute :hint_message
 
     # @!attribute presets
-    #   @return [Array<Hash>] the presets for attribute values (label to value)
+    #   This is a list of mappings of the preset label (key +"label"+) to the
+    #   preset value (key +"value"+).
+    #
+    #   @return [Array<Hash{String => String}>] the presets for attribute values
     attribute :presets
 
     # @!attribute uuid
     #   @return [String] the UUID of the customizable attribute/property
     attribute :uuid
-
-    # @!attribute created_at [r]
-    #   @return [String] the timestamp of when the layout element customizable
-    #     was created
-    attribute :created_at
-
-    # @!attribute updated_at [r]
-    #   @return [String] the timestamp of when the layout element customizable
-    #     was last updated
-    attribute :updated_at
   end
 
   # = The layout element property class
@@ -747,15 +715,6 @@ module LWS::DigitalSignage
     # @!attribute value
     #   @return [String] the attribute/property value
     attribute :value
-
-    # @!attribute created_at [r]
-    #   @return [String] the timestamp of when the layout element was created
-    attribute :created_at
-
-    # @!attribute updated_at [r]
-    #   @return [String] the timestamp of when the layout element was last
-    #     updated
-    attribute :updated_at
   end
 
   # = The layout version class
@@ -782,14 +741,6 @@ module LWS::DigitalSignage
     # @!attribute layout_id
     #   @return [Integer] the ID of the layout the layout version is for
     attribute :layout_id
-
-    # @!attribute created_at [r]
-    #   @return [String] the timestamp of when the layout version was created
-    attribute :created_at
-
-    # @!attribute updated_at [r]
-    #   @return [String] the timestamp of when the layout version was last updated
-    attribute :updated_at
   end
 
   # = The player class
@@ -1745,14 +1696,6 @@ module LWS::DigitalSignage
     # @!attribute value
     #   @return [String, nil] the value of the player tag
     attribute :value
-
-    # @!attribute created_at [r]
-    #   @return [String] the timestamp of when the player tag was created
-    attribute :created_at
-
-    # @!attribute updated_at [r]
-    #   @return [String] the timestamp of when the player tag was last updated
-    attribute :updated_at
   end
 
   # = The slide class
@@ -1799,14 +1742,6 @@ module LWS::DigitalSignage
     #   @return [Array<Schedule>] the slide schedules that apply for the slide
     # FIXME: Missing endpoint in LWS
     has_many :schedules, class_name: "LWS::DigitalSignage::Slide::Schedule"
-
-    # @!attribute created_at [r]
-    #   @return [string] the timestamp of when the slide was created
-    attribute :created_at
-
-    # @!attribute updated_at [r]
-    #   @return [string] the timestamp of when the slide was last updated
-    attribute :updated_at
   end
 
   # = The slide schedule class
@@ -1859,14 +1794,6 @@ module LWS::DigitalSignage
     # @!attribute visible
     #   @return [Boolean] whether the slide is visible within the slide schedule
     attribute :visible
-
-    # @!attribute created_at [r]
-    #   @return [string] the timestamp of when the slide schedule was created
-    attribute :created_at
-
-    # @!attribute updated_at [r]
-    #   @return [string] the timestamp of when the slide schedule was last updated
-    attribute :updated_at
   end
 
 end

data/lib/lws/apps/resource.rb

@@ -43,10 +43,9 @@ module LWS::Resource
   # = The collection class
   #
   # There are two ways to view collections.  Either it is viewed as a set
-  # of items with metadata (use {#metadata} and {#items}), or it is viewed
-  # as something that is associated with one or more meta collections that
-  # each have specific item objects (see for example {#feed}, {#image},
-  # {#images}, etc.).
+  # of items (see {#items}), or it is viewed as something that is associated
+  # with one or more meta collections that each have specific item objects (see
+  # for example {#feed}, {#image}, {#images}, etc.).
   class Collection < LWS::Generic::Model
     use_api LWS::Resource.api
 
@@ -68,6 +67,14 @@ module LWS::Resource
     #   @return [Integer] the ID of the company the collection belongs to
     attribute :company_id
 
+    # @!attribute deleted_at
+    #   @return [String, nil] the timestamp of when the collection was deleted
+    attribute :deleted_at
+
+    # @!attribute description
+    #   @return [String] the description of the collection
+    attribute :description
+
     # @!attribute email
     #   @return [String, nil] the email address used for email imports
     attribute :email
@@ -93,10 +100,6 @@ module LWS::Resource
     #     the name of the class/kind of the collection
     attribute :kind
 
-    # @!attribute metadata
-    #   @return [Hash] the metadata of the collection
-    attribute :metadata
-
     # @!attribute name
     #   @return [String] the name of the collection
     attribute :name
@@ -112,6 +115,11 @@ module LWS::Resource
 
     # @!group Collection Items Attribute Summary
 
+    # @!attribute config
+    #   @return [Collection::Config] the configuration that is part of the
+    #     collection (if kind is +:config+)
+    has_one :config
+
     # @!attribute feed
     #   @return [Collection::Feed] the feed that is part of the collection
     #     (if kind is +:feed+)
@@ -132,6 +140,21 @@ module LWS::Resource
     #     collection (if kind is +:images+)
     has_many :images
 
+    # @!attribute powerpoint
+    #   @return [Collection::PowerPoint] the PowerPoint presentation that is
+    #     part of the collection (if kind is +:powerpoint+)
+    has_one :powerpoint
+
+    # @!attribute youtube
+    #   @return [Collection::YouTube] the YouTube video that is part of the collection
+    #     (if kind is +:youtube+)
+    has_one :youtube
+
+    # @!attribute youtubes
+    #   @return [Array<Collection::YouTube>] the YouTube videos that are part
+    #     of the collection (if kind is +:youtubes+)
+    has_many :youtubes
+
     # @!attribute video
     #   @return [Collection::Video] the video that is part of the collection
     #     (if kind is +:video+)
@@ -142,6 +165,16 @@ module LWS::Resource
     #     collection (if kind is +:videos+)
     has_many :videos
 
+    # @!attribute vimeo
+    #   @return [Collection::Vimeo] the Vimeo video that is part of the collection
+    #     (if kind is +:vimeo+)
+    has_one :vimeo
+
+    # @!attribute vimeos
+    #   @return [Array<Collection::Vimeo>] the Vimeo videos that are part of
+    #     the collection (if kind is +:vimeos+)
+    has_many :vimeos
+
     # @!attribute weather_location
     #   @return [Collection::WeatherLocation] the weather collection that is
     #     part of the collection (if kind is +:weather_location+)
@@ -165,9 +198,23 @@ module LWS::Resource
     #    part of
     attribute :collection_id
 
+    # @!attribute metadata
+    #   @return [Hash] the metadata of the collection item
+    attribute :metadata
+
     # @!attribute name
     #   @return [String] the name of the collection item
     attribute :name
+
+    # @!attribute position
+    #   @return [Integer] the position of the item within the collection
+    attribute :position
+  end
+
+  # = The collection config class
+  class Collection::Config < Collection::Item
+    use_api LWS::Resource.api
+    uri "collections/:collection_id/configs(/:id)"
   end
 
   # = The collection post class
@@ -282,9 +329,9 @@ module LWS::Resource
     #   @return [String] the URL of the image
     attribute :data_url
 
-    # @!attribute metadata
-    #   @return [Hash] the metadata of the image
-    attribute :metadata
+    # @!attribute thumbnail_url
+    #   @return [String] the URL of the thumbnail of the image
+    attribute :thumbnail_url
   end
 
   # = The collection video class
@@ -296,12 +343,36 @@ module LWS::Resource
     #   @return [String] the URL of the video
     attribute :data_url
 
-    # @!attribute metadata
-    #   @return [Hash] the metadata of the video
-    attribute :metadata
+    # @!attribute thumbnail_url
+    #   @return [String] the URL of the thumbnail of the video
+    attribute :thumbnail_url
+  end
+
+  # = The collection Vimeo class
+  class Collection::Vimeo < Collection::Item
+    use_api LWS::Resource.api
+    uri "collections/:collection_id/vimeos(/:id)"
 
     # @!attribute data_url
-    #   @return [String] the URL of the thumbnail of the video
+    #   @return [String] the URL of the vimeo
+    attribute :data_url
+
+    # @!attribute thumbnail_url
+    #   @return [String] the URL of the thumbnail of the vimeo
+    attribute :thumbnail_url
+  end
+
+  # = The collection YouTube class
+  class Collection::YouTube < Collection::Item
+    use_api LWS::Resource.api
+    uri "collections/:collection_id/youtubes(/:id)"
+
+    # @!attribute data_url
+    #   @return [String] the URL of the youtube
+    attribute :data_url
+
+    # @!attribute thumbnail_url
+    #   @return [String] the URL of the thumbnail of the youtube
     attribute :thumbnail_url
   end
 
@@ -348,7 +419,7 @@ module LWS::Resource
     #   @return [Float, nil] the longitude of the weather location
     attribute :long
 
-    # @!attribute refresh_intervla
+    # @!attribute refresh_interval
     #   @return [Integer] the interval used to refresh the weather location
     #     (in seconds)
     attribute :refresh_interval
@@ -438,6 +509,14 @@ module LWS::Resource
     #   @return [Integer] the ID of the company the folder belongs to
     attribute :company_id
 
+    # @!attribute deleted_at
+    #   @return [String, nil] the timestamp of when the folder was deleted
+    attribute :deleted_at
+
+    # @!attribute description
+    #    @return [String] the description of the folder
+    attribute :description
+
     # @!attribute folders
     #   @return [Array<Folder>] the folders contained in the folder
     has_many :folders

data/lib/lws/middleware/json_parser.rb

@@ -18,12 +18,27 @@ module LWS
     class JSONParser < Faraday::Response::Middleware
 
       def parse(body)
-        data = MultiJson.load(body, symbolize_keys: true) || {}
-        metadata = data.delete(:metadata)
-        errors = data.delete(:errors)
-
-        # If there are errors, discard the data.
-        data = nil if errors.present?
+        json = MultiJson.load(body, symbolize_keys: true)
+        data = nil
+        metadata = nil
+        errors = nil
+
+        if json.is_a? Array
+          data = json
+        elsif json.is_a? Hash
+          if json[:errors].present?
+            metadata = json[:metadata]
+            errors = json[:errors]
+          elsif json[:data].present?
+            data = json[:data]
+            metadata = json[:metadata]
+            errors = json[:errors]
+          else
+            data = json
+          end
+        else
+          raise "cannot interpret parsed JSON: #{json.inspect}"
+        end
 
         { data: data,
           metadata: metadata,

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.0'.freeze
+  VERSION = '6.3.1'.freeze
 
 end

data/test/json_parser_test.rb

@@ -19,10 +19,11 @@ class TestJSONParser < MiniTest::Test
     # Redo LWS setup with persistent HTTP connections disabled.
     reconfigure(http_persistent: false)
     WebMock.enable!
-    company = { id: "correct",
-                country: "NL",
-                # ...
-              }
+    company = { data:
+                  { id: "correct",
+                    country: "NL",
+                    # ...
+                  } }
 
     full_uri = LWS::Auth.api.url_prefix.dup
     full_uri.path = "/companies/broken"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.3.1
 platform: ruby
 authors:
 - LeftClick B.V.