kodi_client 0.5.5 → 0.6.1

data/lib/kodi_client/global_types/media_types.rb

@@ -2,6 +2,8 @@
 
 require 'kodi_client/global_types/item_types'
 require 'kodi_client/util/comparable'
+require 'kodi_client/util/creatable'
+require 'kodi_client/util/iterable'
 
 module KodiClient
   module Types
@@ -10,6 +12,7 @@ module KodiClient
       # media types
       module MediaType
         extend Iterable
+
         VIDEO = 'video'
         AUDIO = 'audio'
         ALL = 'all'
@@ -21,28 +24,33 @@ module KodiClient
 
         attr_reader :fan_art, :thumbnail
 
-        def media_details_base(hash)
-          @fan_art = hash['fanart']
-          @thumbnail = hash['thumbnail']
-          item_details_base(hash)
+        def media_details_base_mappings
+          item_details_base_mappings
+        end
+
+        def media_details_base_by_hash(hash)
+          media_details_base(*Creatable.hash_to_arr(hash, %w[fan_art thumbnail label]), media_details_base_mappings)
+        end
+
+        def media_details_base(fan_art, thumbnail, label)
+          @fan_art = fan_art
+          @thumbnail = thumbnail
+          item_details_base(label)
         end
       end
 
       # Media.Artwork https://kodi.wiki/view/JSON-RPC_API/v12#Media.Artwork
       class MediaArtwork
         include Comparable
+        extend Creatable
 
         attr_reader :banner, :fan_art, :poster, :thumb
 
-        def initialize(hash)
-          @banner = hash['banner']
-          @fan_art = hash['fanart']
-          @poster = hash['poster']
-          @thumb = hash['thumb']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(banner, fan_art, poster, thumb)
+          @banner = banner
+          @fan_art = fan_art
+          @poster = poster
+          @thumb = thumb
         end
       end
     end

data/lib/kodi_client/global_types/player_type.rb

@@ -4,6 +4,7 @@ require 'kodi_client/global_types/item_types'
 require 'kodi_client/global_types/global_types'
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
 
 module KodiClient
   module Types
@@ -20,6 +21,7 @@ module KodiClient
       # Player.ViewMode https://kodi.wiki/view/JSON-RPC_API/v12#Player.ViewMode
       module ViewMode
         extend Iterable
+
         NORMAL = 'normal'
         ZOOM = 'zoom'
         STRETCH_4x3 = 'strech4x3'
@@ -34,6 +36,7 @@ module KodiClient
       # player types
       module PlayerVisibilityType
         extend Iterable
+
         INTERNAL = 'internal'
         EXTERNAL = 'external'
         REMOTE = 'remote'
@@ -80,87 +83,75 @@ module KodiClient
       # player id and type
       class Player
         include Comparable
+        extend Creatable
 
         attr_reader :player_id, :player_type, :type, :name, :plays_audio, :plays_video
 
-        def initialize(hash)
-          @player_id = hash['playerid']
-          @player_type = hash['playertype']
-          @type = hash['type']
-          @name = hash['name']
-          @plays_audio = hash['playsaudio']
-          @plays_video = hash['playsvideo']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(player_id, player_type, type, name, plays_audio, plays_video)
+          @player_id = player_id
+          @player_type = player_type
+          @type = type
+          @name = name
+          @plays_audio = plays_audio
+          @plays_video = plays_video
         end
       end
 
       # Player Subtitle https://kodi.wiki/view/JSON-RPC_API/v12#Player.Subtitle
       class Subtitle
         include Comparable
+        extend Creatable
 
         attr_reader :index, :is_default, :is_forced, :is_impaired, :language, :name
 
-        def initialize(hash)
-          @index = hash['index']
-          @is_default = hash['isdefault']
-          @is_forced = hash['isforced']
-          @is_impaired = hash['isimpaired']
-          @language = hash['language']
-          @name = hash['name']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(index, is_default, is_forced, is_impaired, language, name)
+          @index = index
+          @is_default = is_default
+          @is_forced = is_forced
+          @is_impaired = is_impaired
+          @language = language
+          @name = name
         end
       end
 
       # Player.Audio.Stream https://kodi.wiki/view/JSON-RPC_API/v12#Player.Audio.Stream
       class AudioStream
         include Comparable
+        extend Creatable
 
         attr_reader :bitrate, :channels, :codec, :index, :is_default, :is_forced, :is_original, :language,
                     :name, :sample_rate
 
-        def initialize(hash)
-          @bitrate = hash['bitrate']
-          @channels = hash['channels']
-          @codec = hash['codec']
-          @index = hash['index']
-          @is_default = hash['isdefault']
-          @is_forced = hash['isforced']
-          @is_original = hash['isoriginal']
-          @language = hash['language']
-          @name = hash['name']
-          @sample_rate = hash['samplerate']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(bitrate, channels, codec, index, is_default, is_forced, is_original, language, name, sample_rate)
+          @bitrate = bitrate
+          @channels = channels
+          @codec = codec
+          @index = index
+          @is_default = is_default
+          @is_forced = is_forced
+          @is_original = is_original
+          @language = language
+          @name = name
+          @sample_rate = sample_rate
         end
       end
 
       # Player.Video.Stream https://kodi.wiki/view/JSON-RPC_API/v12#Player.Video.Stream
       class VideoStream
         include Comparable
+        extend Creatable
 
         attr_reader :codec, :height, :index, :language, :name, :width, :duration, :aspect
 
-        def initialize(hash)
-          @codec = hash['codec']
-          @height = hash['height']
-          @index = hash['index']
-          @language = hash['language']
-          @name = hash['name']
-          @width = hash['width']
-          @duration = hash['duration']
-          @aspect = hash['aspect']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(codec, height, index, language, name, width, duration, aspect)
+          @codec = codec
+          @height = height
+          @index = index
+          @language = language
+          @name = name
+          @width = width
+          @duration = duration
+          @aspect = aspect
         end
       end
 
@@ -198,76 +189,84 @@ module KodiClient
       # Player.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#Player.Property.Name
       class PropertyValue
         include Comparable
-
-        def initialize(hash)
-          @audio_streams = hash['audiostreams'].map { |it| AudioStream.new(it) }
-          @cache_percentage = hash['cachepercentage']
-          @can_change_speed = hash['canchangespeed']
-          @can_move = hash['canmove']
-          @can_repeat = hash['canrepeat']
-          @can_rotate = hash['canrotate']
-          @can_seek = hash['canseek']
-          @can_shuffle = hash['canshuffle']
-          @can_zoom = hash['canzoom']
-          @current_audio_stream = AudioStream.new(hash['currentaudiostream'])
-          @current_subtitle = Subtitle.new(hash['currentsubtitle'])
-          @current_video_stream = VideoStream.new(hash['currentvideostream'])
-          @live = hash['live']
-          @party_mode = hash['partymode']
-          @percentage = hash['percentage']
-          @playlist_id = hash['playlistid'].nil? ? -1 : hash['playlistid']
-          @position = hash['position'].nil? ? -1 : hash['position']
-          @position = hash['position'].nil? ? -1 : hash['position']
-          @repeat = hash['repeat'].nil? ? PlayerRepeat::OFF : hash['repeat']
-          @shuffled = hash['shuffled']
-          @speed = hash['speed']
-          @subtitle_enabled = hash['subtitleenabled']
-          @subtitles = hash['subtitles'].map { |it| Subtitle.new(it) }
-          @time = Types::Global::GlobalTime.new(hash['time'])
-          @total_time = Types::Global::GlobalTime.new(hash['totaltime'])
-          @type = hash['type'].nil? ? PlayerType::VIDEO : hash['type']
-          @video_streams = hash['videostreams'].map { |it| VideoStream.new(it) }
-        end
-
-        def ==(other)
-          compare(self, other)
+        extend Creatable
+
+        attr_reader :audio_streams, :cache_percentage, :can_change_speed, :can_move, :can_repeat, :can_rotate,
+                    :can_seek, :can_shuffle, :can_zoom, :current_audio_stream, :current_subtitle, :current_video_stream,
+                    :live, :party_mode, :percentage, :playlist_id, :position, :repeat, :shuffled, :speed,
+                    :subtitle_enabled, :subtitles, :time, :total_time, :type, :video_streams
+
+        type_mapping ['audiostreams', AudioStream, true], ['currentaudiostream', AudioStream],
+                     ['currentsubtitle', Subtitle], ['currentvideostream', VideoStream],
+                     ['subtitles', Subtitle, true], ['time', Global::GlobalTime],
+                     ['totaltime', Global::GlobalTime], ['videostreams', VideoStream, true]
+
+        def initialize(audio_streams, cache_percentage, can_change_speed, can_move, can_repeat, can_rotate, can_seek,
+                       can_shuffle, can_zoom, current_audio_stream, current_subtitle, current_video_stream, live,
+                       party_mode, percentage, playlist_id, position, repeat, shuffled, speed,
+                       subtitle_enabled, subtitles, time, total_time, type, video_streams)
+          type = type.nil? ? PlayerType::VIDEO : type
+          playlist_id = playlist_id.nil? ? -1 : playlist_id
+          position = position.nil? ? -1 : position
+          repeat = repeat.nil? ? PlayerRepeat::OFF : repeat
+
+          @audio_streams = audio_streams
+          @cache_percentage = cache_percentage
+          @can_change_speed = can_change_speed
+          @can_move = can_move
+          @can_repeat = can_repeat
+          @can_rotate = can_rotate
+          @can_seek = can_seek
+          @can_shuffle = can_shuffle
+          @can_zoom = can_zoom
+          @current_audio_stream = current_audio_stream
+          @current_subtitle = current_subtitle
+          @current_video_stream = current_video_stream
+          @live = live
+          @party_mode = party_mode
+          @percentage = percentage
+          @playlist_id = playlist_id
+          @position = position
+          @repeat = repeat
+          @shuffled = shuffled
+          @speed = speed
+          @subtitle_enabled = subtitle_enabled
+          @subtitles = subtitles
+          @time = time
+          @total_time = total_time
+          @type = type
+          @video_streams = video_streams
         end
       end
 
       # return value for Player.GetViewMode
       class PlayerViewMode
         include Comparable
+        extend Creatable
 
         attr_reader :nonlinear_stretch, :pixel_ratio, :vertical_shift, :view_mode, :zoom
 
-        def initialize(hash)
-          @nonlinear_stretch = hash['nonlinearstretch']
-          @pixel_ratio = hash['pixelratio']
-          @vertical_shift = hash['verticalshift']
-          @view_mode = hash['viewed']
-          @zoom = hash['zoom']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(nonlinear_stretch, pixel_ratio, vertical_shift, view_mode, zoom)
+          @nonlinear_stretch = nonlinear_stretch
+          @pixel_ratio = pixel_ratio
+          @vertical_shift = vertical_shift
+          @view_mode = view_mode
+          @zoom = zoom
         end
       end
 
       # Player.Position.Time https://kodi.wiki/view/JSON-RPC_API/v12#Player.Position.Time
       class PlayerPositionTime
         include Comparable
+        extend Creatable
 
         attr_reader :hours, :minutes, :seconds, :milliseconds
 
-        def initialize(hash)
-          @hours = hash['hours']
-          @minutes = hash['minutes']
-          @seconds = hash['seconds']
-          @milliseconds = hash['milliseconds']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(hours, minutes, seconds, milliseconds)
+          @hours = hours
+          @minutes = minutes
+          @seconds = seconds
+          @milliseconds = milliseconds
         end
       end
 
@@ -282,17 +281,18 @@ module KodiClient
       end
 
       # return value of Player.Seek
-      class SeekReturnValue
+      class SeekReturned
         include Comparable
+        extend Creatable
 
-        def initialize(hash)
-          @percentage = hash['percentage']
-          @time = Types::Global::GlobalTime.new(hash['time'])
-          @total_time = Types::Global::GlobalTime.new(hash['totaltime'])
-        end
+        attr_reader :percentage, :time, :total_time
+
+        type_mapping ['time', Global::GlobalTime], ['totaltime', Global::GlobalTime]
 
-        def ==(other)
-          compare(self, other)
+        def initialize(percentage, time, total_time)
+          @percentage = percentage
+          @time = time
+          @total_time = total_time
         end
       end
     end

data/lib/kodi_client/global_types/profiles_types.rb

@@ -2,6 +2,7 @@
 
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
 require 'kodi_client/global_types/item_types'
 
 module KodiClient
@@ -20,13 +21,16 @@ module KodiClient
       class DetailsProfile
         include Comparable
         include Items::ItemDetailsBase
+        extend Creatable
 
         attr_reader :lock_mode, :thumbnail
 
-        def initialize(hash)
-          @lock_mode = hash['lockmode']
-          @thumbnail = hash['thumbnail']
-          item_details_base(hash)
+        fields_to_map %w[lock_mode thumbnail label]
+
+        def initialize(lock_mode, thumbnail, label)
+          @lock_mode = lock_mode
+          @thumbnail = thumbnail
+          item_details_base(label)
         end
 
         def ==(other)
@@ -37,22 +41,22 @@ module KodiClient
       # return type for Profiles.GetProfiles
       class GetProfilesReturned
         include Comparable
+        extend Creatable
 
         attr_reader :limits, :profiles
 
-        def initialize(hash)
-          @limits = Types::List::ListLimitsReturned.new(hash['limits'])
-          @profiles = hash['profiles'].nil? ? [] : hash['profiles'].map { |it| Types::Profiles::DetailsProfile.new(it) }
-        end
+        type_mapping ['limits', List::ListLimitsReturned], ['profiles', DetailsProfile, true]
 
-        def ==(other)
-          compare(self, other)
+        def initialize(limits, profiles)
+          @limits = limits
+          @profiles = profiles
         end
       end
 
       # Profiles.Password https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Password
       class ProfilePassword
         include Comparable
+        extend Creatable
 
         attr_reader :value, :encryption
 
@@ -60,10 +64,6 @@ module KodiClient
           @value = value
           @encryption = encryption
         end
-
-        def ==(other)
-          compare(self, other)
-        end
       end
     end
   end

data/lib/kodi_client/global_types/system_types.rb

@@ -2,6 +2,7 @@
 
 require 'kodi_client/util/iterable'
 require 'kodi_client/util/comparable'
+require 'kodi_client/util/creatable'
 
 module KodiClient
   module Types
@@ -20,18 +21,15 @@ module KodiClient
       # System.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#System.Property.Value
       class PropertyValue
         include Comparable
+        extend Creatable
 
         attr_reader :can_hibernate, :can_reboot, :can_shutdown, :can_suspend
 
-        def initialize(hash)
-          @can_hibernate = hash['canhibernate']
-          @can_reboot = hash['canreboot']
-          @can_shutdown = hash['canshutdown']
-          @can_suspend = hash['cansuspend']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(can_hibernate, can_reboot, can_shutdown, can_suspend)
+          @can_hibernate = can_hibernate
+          @can_reboot = can_reboot
+          @can_shutdown = can_shutdown
+          @can_suspend = can_suspend
         end
       end
     end

data/lib/kodi_client/global_types/video_types.rb

@@ -3,39 +3,45 @@
 require 'kodi_client/global_types/media_types'
 require 'kodi_client/global_types/player_type'
 require 'kodi_client/util/comparable'
+require 'kodi_client/util/creatable'
 
 module KodiClient
   module Types
     module Video
-
       # Video.Details.Base https://kodi.wiki/view/JSON-RPC_API/v12#Video.Details.Base
       module VideoDetailsBase
         include Media::MediaDetailsBase
 
         attr_reader :art, :play_count
 
-        def video_details_base(hash)
-          @art = Types::Media::MediaArtwork.new(hash['art'])
-          @play_count = ['playcount']
-          media_details_base(hash)
+        def video_details_base_mappings
+          media_details_base_mappings
+        end
+
+        def video_details_base_by_hash(hash)
+          video_details_base(*Creatable.hash_to_arr(hash, %w[art play_count fan_art thumbnail label],
+                                                    video_details_base_mappings))
+        end
+
+        def video_details_base(art, play_count, fan_art, thumbnail, label)
+          @art = art
+          @play_count = play_count
+          media_details_base(fan_art, thumbnail, label)
         end
       end
 
       # Video.Cast https://kodi.wiki/view/JSON-RPC_API/v12#Video.Cast
       class VideoCast
         include Comparable
+        extend Creatable
 
         attr_reader :name, :order, :role, :thumbnail
 
-        def initialize(hash)
-          @name = hash['name']
-          @order = hash['order']
-          @role = hash['role']
-          @thumbnail = hash['thumbnail']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(name, order, role, thumbnail)
+          @name = name
+          @order = order
+          @role = role
+          @thumbnail = thumbnail
         end
       end
 
@@ -45,9 +51,18 @@ module KodiClient
 
         attr_reader :title
 
-        def video_details_media(hash)
-          @title = hash['title']
-          video_details_base(hash)
+        def video_details_media_mappings
+          video_details_base_mappings
+        end
+
+        def video_details_media_by_hash(hash)
+          video_details_media(*Creatable.hash_to_arr(hash, %w[title art play_count fan_art thumbnail label]),
+                              video_details_base_mappings)
+        end
+
+        def video_details_media(title, art, play_count, fan_art, thumbnail, label)
+          @title = title
+          video_details_base(art, play_count, fan_art, thumbnail, label)
         end
       end
 
@@ -57,12 +72,22 @@ module KodiClient
 
         attr_reader :date_added, :file, :last_played, :plot
 
-        def video_details_item(hash)
-          @date_added = hash['dateadded']
-          @file = hash['file']
-          @last_played = hash['lastplayed']
-          @plot = hash['plot']
-          video_details_media(hash)
+        def video_details_item_mappings
+          video_details_media_mappings
+        end
+
+        def video_details_item_by_hash(hash)
+          video_details_item(*Creatable.hash_to_arr(hash, %w[date_added file last_played plot title art
+                                                             play_count fan_art thumbnail label],
+                                                    video_details_item_mappings))
+        end
+
+        def video_details_item(date_added, file, last_played, plot, title, art, play_count, fan_art, thumbnail, label)
+          @date_added = date_added
+          @file = file
+          @last_played = last_played
+          @plot = plot
+          video_details_media(title, art, play_count, fan_art, thumbnail, label)
         end
       end
 
@@ -72,45 +97,57 @@ module KodiClient
 
         attr_reader :director, :resume, :runtime, :stream_details
 
-        def video_details_file(hash)
-          @director = hash['director']
-          @resume = VideoResume.new(hash['resume'])
-          @runtime = hash['runtime']
-          @stream_details = Streams.new(hash['streamdetails'])
-          video_details_item(hash)
+        def video_details_file_mappings
+          mappings = {
+            'resume' => Creatable::CreateMap.new(VideoResume),
+            'streamdetails' => Creatable::CreateMap.new(Streams)
+          }
+          mappings.merge(video_details_item_mappings)
+        end
+
+        def video_details_file_by_hash(hash)
+          video_details_file(*Creatable.hash_to_arr(hash, %w[director resume runtime stream_details date_added
+                                                             file last_played plot title art play_count fan_art
+                                                             thumbnail label], video_details_file_mappings))
+        end
+
+        def video_details_file(director, resume, runtime, stream_details, date_added, file, last_played, plot, title,
+                               art, play_count, fan_art, thumbnail, label)
+          @director = director
+          @resume = resume
+          @runtime = runtime
+          @stream_details = stream_details
+          video_details_item(date_added, file, last_played, plot, title, art, play_count, fan_art, thumbnail, label)
         end
       end
 
       # Video.Resume https://kodi.wiki/view/JSON-RPC_API/v12#Video.Resume
       class VideoResume
         include Comparable
+        extend Creatable
 
         attr_reader :position, :total
 
-        def initialize(hash)
-          @position = hash['position']
-          @total = hash['total']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(position, total)
+          @position = position
+          @total = total
         end
       end
 
       # Video.Streams https://kodi.wiki/view/JSON-RPC_API/v12#Video.Streams
       class Streams
         include Comparable
+        extend Creatable
 
         attr_reader :audio, :subtitle, :video
 
-        def initialize(hash)
-          @audio = hash['audio'].nil? ? [] : hash['audio'].map { |it| Types::Player::AudioStream.new(it) }
-          @subtitle = hash['subtitle'].nil? ? [] : hash['subtitle'].map { |it| Types::Player::Subtitle.new(it) }
-          @video = hash['video'].nil? ? [] : hash['video'].map { |it| Types::Player::VideoStream.new(it) }
-        end
+        type_mapping ['audio', Player::AudioStream, true], ['subtitle', Player::Subtitle, true],
+                     ['video', Player::VideoStream, true]
 
-        def ==(other)
-          compare(self, other)
+        def initialize(audio, subtitle, video)
+          @audio = audio
+          @subtitle = subtitle
+          @video = video
         end
       end
     end