kodi_client 0.6.3 → 0.7.2

data/lib/kodi_client/types/addons/addon_types_type.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Addons
+      # Addon Types https://kodi.wiki/view/JSON-RPC_API/v12#Addon.Types
+      module AddonTypes
+        extend Extensions::Iterable
+
+        UNKNOWN = 'unknown'
+        KODI_ADSP = 'kodi.adsp'
+        KODI_AUDIO_DECODER = 'kodi.audiodecoder'
+        KODI_CONTEXT_ITEM = 'kodi.context.item'
+        KODI_GAME_CONTROLLER = 'kodi.game.controller'
+        KODI_INPUT_STREAM = 'kodi.inputstream'
+        KODI_PERIPHERAL = 'kodi.peripheral'
+        KODI_RESOURCE_IMAGES = 'kodi.resource.images'
+        KODI_RESOURCE_LANGUAGE = 'kodi.resource.language'
+        KODI_RESOURCE_UI_SOUNDS = 'kodi.resource.uisounds'
+        XBMC_ADDON_AUDIO = 'xbmc.addon.audio'
+        XBMC_ADDON_EXECUTABLE = 'xbmc.addon.executable'
+        XBMC_ADDON_IMAGE = 'xbmc.addon.image'
+        XBMC_ADDON_REPOSITORY = 'xbmc.addon.repository'
+        XBMC_ADDON_VIDEO = 'xbmc.addon.video'
+        XBMC_AUDIO_ENCODER = 'xbmc.audioencoder'
+        XBMC_GUI_SKIN = 'xbmc.gui.skin'
+        XBMC_METADATA_SCRAPER_ALBUMS = 'xbmc.metadata.scraper.albums'
+        XBMC_METADATA_SCRAPER_ARTISTS = 'xbmc.metadata.scraper.artists'
+        XBMC_METADATA_SCRAPER_LIBRARY = 'xbmc.metadata.scraper.library'
+        XBMC_METADATA_SCRAPER_MOVIES = 'xbmc.metadata.scraper.movies'
+        XBMC_METADATA_SCRAPER_MUSIC_VIDEOS = 'xbmc.metadata.scraper.musicvideos'
+        XBMC_METADATA_SCRAPER_TV_SHOWS = 'xbmc.metadata.scraper.episodes'
+        XBMC_PLAYER_MUSIC_VIZ = 'xbmc.player.musicviz'
+        XBMC_PVR_CLIENT = 'xbmc.pvrclient'
+        XBMC_PYTHON_LIBRARY = 'xbmc.python.library'
+        XBMC_PYTHON_LYRICS = 'xbmc.python.lyrics'
+        XBMC_PYTHON_MODULE = 'xbmc.python.module'
+        XBMC_PYTHON_PLUGIN_SOURCE = 'xbmc.python.pluginsource'
+        XBMC_PYTHON_SCRIPT = 'xbmc.python.script'
+        XBMC_PYTHON_WEATHER = 'xbmc.python.weather'
+        XBMC_SERVICE = 'xbmc.service'
+        XBMC_SUBTITLE_MODULE = 'xbmc.subtitle.module'
+        XBMC_UI_SCREENSAVER = 'xbmc.ui.screensaver'
+        XBMC_WEBINTERFACE = 'xbmc.webinterface'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/addons/get_addon_returned_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Addons
+      # getAddon return
+      class GetAddonReturned
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :addon
+
+        type_mapping ['addon', AddonDetails]
+
+        def initialize(addon)
+          @addon = addon
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/addons/get_addons_returned_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Addons
+      # getAddons return
+      class GetAddonsReturned
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :addons, :limits
+
+        type_mapping ['addons', AddonDetails, true], ['limits', List::ListLimitsReturned]
+
+        def initialize(addons, limits)
+          @addons = addons
+          @limits = limits
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/application/property_name_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Application
+      # Application.Property.Name https://kodi.wiki/view/JSON-RPC_API/v12#Application.Property.Name
+      module PropertyName
+        extend Extensions::Iterable
+
+        VOLUME = 'volume'
+        MUTED = 'muted'
+        NAME = 'name'
+        VERSION = 'version'
+        SORT_TOKENS = 'sorttokens'
+        LANGUAGE = 'language'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/application/property_value_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Application
+      # Application.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#Application.Property.Value
+      class PropertyValue
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :name, :version, :muted, :volume
+
+        type_mapping ['version', Version]
+
+        def initialize(name, version, muted, volume)
+          @name = name
+          @version = version
+          @muted = muted
+          @volume = volume
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/application/version_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Application
+      # represent application properties version
+      class Version
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :major, :minor, :revision, :tag
+
+        def initialize(major, minor, revision, tag)
+          @major = major
+          @minor = minor
+          @revision = revision
+          @tag = tag
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_album_release_type_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Album.ReleaseType https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Album.ReleaseType
+      module AudioAlbumReleaseType
+        extend Extensions::Iterable
+
+        ALBUM = 'album'
+        SINGLE = 'single'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_artist_role_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+
+      # Audio.Artist.Roles https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Artist.Roles
+      class AudioArtistRole
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :role, :role_id
+
+        def initialize(role, role_id)
+          @role = role
+          @role_id = role_id
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_contributor_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Contributor https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Contributors
+      class AudioContributor
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :artist_id, :name, :role, :role_id
+
+        def initialize(artist_id, name, role, role_id)
+          @artist_id = artist_id
+          @name = name
+          @role = role
+          @role_id = role_id
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_details_album_type.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Details.Album https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Album
+      class AudioDetailsAlbum
+        include AudioDetailsMedia
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :album_duration, :album_id, :album_label, :album_status, :compilation, :date_modified, :date_new,
+                    :description, :is_box_set, :last_played, :mood, :musicbrainz_album_id, :musicbrainz_release_group_id,
+                    :play_count, :release_type, :song_genres, :source_id, :style, :theme, :total_discs, :type
+
+        fields_to_map %w[album_duration album_id album_label album_status art artist artist_id compilation date_added
+                         date_modified date_new description display_artist fan_art genre is_box_set label last_played
+                         mood musicbrainz_album_artist_id musicbrainz_album_id musicbrainz_release_group_id
+                         original_date play_count rating release_date release_type song_genres sort_artist source_id
+                         style theme thumbnail title total_discs type user_rating votes year]
+
+        type_mapping ['songgenres', Genre, true], ['art', Types::Media::MediaArtwork]
+
+        def initialize(album_duration, album_id, album_label, album_status, art, artist, artist_id, compilation,
+                       date_added, date_modified, date_new, description, display_artist, fan_art, genre, is_box_set,
+                       label, last_played, mood, musicbrainz_album_artist_id, musicbrainz_album_id,
+                       musicbrainz_release_group_id, original_date, play_count, rating, release_date, release_type,
+                       song_genres, sort_artist, source_id, style, theme, thumbnail, title, total_discs, type,
+                       user_rating, votes, year)
+          @album_duration = album_duration
+          @album_id = album_id
+          @album_label = album_label
+          @album_status = album_status
+          @compilation = compilation
+          @date_modified = date_modified
+          @date_new = date_new
+          @description = description
+          @is_box_set = is_box_set
+          @last_played = last_played
+          @mood = mood
+          @musicbrainz_album_id = musicbrainz_album_id
+          @musicbrainz_release_group_id = musicbrainz_release_group_id
+          @play_count = play_count
+          @release_type = release_type
+          @song_genres = song_genres
+          @source_id = source_id
+          @style = style
+          @theme = theme
+          @total_discs = total_discs
+          @type = type
+          audio_details_media(artist, artist_id, display_artist, musicbrainz_album_artist_id, original_date,
+                              rating, release_date, sort_artist, title, user_rating, votes, year,
+                              art, date_added, genre, fan_art, thumbnail, label)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_details_artist_type.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Details.Artist https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Artist
+      class AudioDetailsArtist
+        include AudioDetailsBase
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :artist, :artist_id, :born, :compilation_artist, :description, :died, :disambiguation, :disbanded,
+                    :formed, :gender, :instrument, :is_album_artist, :mood, :musicbrainz_artist_id, :roles, :song_genres,
+                    :sort_name, :source_id, :style, :type, :years_active
+
+        fields_to_map %w[artist artist_id born compilation_artist description died disambiguation disbanded
+                         formed gender instrument is_album_artist mood musicbrainz_artist_id roles song_genres
+                         sort_name source_id style type years_active art date_added genre fan_art thumbnail
+                         label]
+
+        type_mapping ['songgenres', Genre, true], ['art', Types::Media::MediaArtwork], ['roles', AudioArtistRole, true]
+
+        def initialize(artist, artist_id, born, compilation_artist, description, died, disambiguation, disbanded,
+                       formed, gender, instrument, is_album_artist, mood, musicbrainz_artist_id, roles, song_genres,
+                       sort_name, source_id, style, type, years_active, art, date_added, genre, fan_art, thumbnail,
+                       label)
+          @artist = artist
+          @artist_id = artist_id
+          @born = born
+          @compilation_artist = compilation_artist
+          @description = description
+          @died = died
+          @disambiguation = disambiguation
+          @disbanded = disbanded
+          @formed = formed
+          @gender = gender
+          @instrument = instrument
+          @is_album_artist = is_album_artist
+          @mood = mood
+          @musicbrainz_artist_id = musicbrainz_artist_id
+          @roles = roles
+          @song_genres = song_genres
+          @sort_name = sort_name
+          @source_id = source_id
+          @style = style
+          @type = type
+          @years_active = years_active
+          audio_details_base(art, date_added, genre, fan_art, thumbnail, label)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_details_base_type.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Details.Base https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Base
+      module AudioDetailsBase
+        include Media::MediaDetailsBase
+
+        attr_reader :art, :date_added, :genre
+
+        def audio_details_base_mappings
+          [['art', Types::Media::MediaArtwork]] + media_details_base_mappings
+        end
+
+        def audio_details_base_by_hash(hash)
+          audio_details_base(*Extensions::Creatable.hash_to_arr(hash, %w[art date_added genre fan_art thumbnail label]),
+                             audio_details_base_mappings)
+        end
+
+        def audio_details_base(art, date_added, genre, fan_art, thumbnail, label)
+          @art = art
+          @date_added = date_added
+          @genre = genre
+          media_details_base(fan_art, thumbnail, label)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_details_media_type.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Details.Media https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Media
+      module AudioDetailsMedia
+        include AudioDetailsBase
+
+        def self.included(base)
+          base.extend(self)
+        end
+
+        attr_reader :artist, :artist_id, :display_artist, :musicbrainz_album_artist_id, :original_date, :rating,
+                    :release_date, :sort_artist, :title, :user_rating, :votes, :year
+
+        def audio_details_media_mappings
+          audio_details_base_mappings
+        end
+
+        def audio_details_media_by_hash(hash)
+          audio_details_media(*Extensions::Creatable.hash_to_arr(hash, %w[artist artist_id display_artist
+                                                                          musicbrainz_album_artist_id original_date
+                                                                          rating release_date sort_artist title
+                                                                          user_rating votes year art date_added
+                                                                          genre fan_art thumbnail label],
+                                                                 audio_details_base_mappings))
+        end
+
+        def audio_details_media(artist, artist_id, display_artist, musicbrainz_album_artist_id, original_date,
+                                rating, release_date, sort_artist, title, user_rating, votes, year,
+                                art, date_added, genre, fan_art, thumbnail, label)
+          @artist = artist
+          @artist_id = artist_id
+          @display_artist = display_artist
+          @musicbrainz_album_artist_id = musicbrainz_album_artist_id
+          @original_date = original_date
+          @rating = rating
+          @release_date = release_date
+          @sort_artist = sort_artist
+          @title = title
+          @user_rating = user_rating
+          @votes = votes
+          @year = year
+          audio_details_base(art, date_added, genre, fan_art, thumbnail, label)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_details_role_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Details.Role https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Role
+      class AudioDetailsRole
+        include Items::ItemDetailsBase
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :role_id, :title
+
+        fields_to_map %w[role_id title label]
+
+        def initialize(role_id, title, label)
+          @role_id = role_id
+          @title = title
+          item_details_base(label)
+        end
+      end
+    end
+  end
+end
+

data/lib/kodi_client/types/audio/audio_details_song_type.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Details.Song https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Song
+      class AudioDetailsSong
+        include AudioDetailsMedia
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :album, :album_artist, :album_artist_id, :album_id, :album_release_type, :bitrate, :bpm, :channels,
+                    :comment, :contributors, :disc, :disc_title, :display_composer, :display_conductor,
+                    :display_lyricist, :display_orchestra, :duration, :file, :genre_id, :last_played, :lyrics, :mood,
+                    :musicbrainz_artist_id, :musicbrainz_track_id, :play_count, :sample_rate, :song_id, :source_id,
+                    :track
+
+        type_mapping ['contributors', Types::Audio::AudioContributor, true], *audio_details_media_mappings
+
+        fields_to_map %w[album album_artist album_artist_id album_id album_release_type bitrate bpm channels
+                         comment contributors disc disc_title display_composer display_conductor display_lyricist
+                         display_orchestra duration file genre_id last_played lyrics mood musicbrainz_artist_id
+                         musicbrainz_track_id play_count sample_rate song_id source_id track
+                         artist artist_id display_artist musicbrainz_album_artist_id original_date
+                         rating release_date sort_artist title user_rating votes year
+                         art date_added genre fan_art thumbnail label]
+
+        def initialize(album, album_artist, album_artist_id, album_id, album_release_type, bitrate, bpm, channels,
+                       comment, contributors, disc, disc_title, display_composer, display_conductor, display_lyricist,
+                       display_orchestra, duration, file, genre_id, last_played, lyrics, mood, musicbrainz_artist_id,
+                       musicbrainz_track_id, play_count, sample_rate, song_id, source_id, track,
+                       artist, artist_id, display_artist, musicbrainz_album_artist_id, original_date,
+                       rating, release_date, sort_artist, title, user_rating, votes, year,
+                       art, date_added, genre, fan_art, thumbnail, label)
+          @album = album
+          @album_artist = album_artist
+          @album_artist_id = album_artist_id
+          @album_id = album_id
+          @album_release_type = album_release_type
+          @bitrate = bitrate
+          @bpm = bpm
+          @channels = channels
+          @comment = comment
+          @contributors = contributors
+          @disc = disc
+          @disc_title = disc_title
+          @display_composer = display_composer
+          @display_conductor = display_conductor
+          @display_lyricist = display_lyricist
+          @display_orchestra = display_orchestra
+          @duration = duration
+          @file = file
+          @genre_id = genre_id
+          @last_played = last_played
+          @lyrics = lyrics
+          @mood = mood
+          @musicbrainz_artist_id = musicbrainz_artist_id
+          @musicbrainz_track_id = musicbrainz_track_id
+          @play_count = play_count
+          @sample_rate = sample_rate
+          @song_id = song_id
+          @source_id = source_id
+          @track = track
+          audio_details_media(artist, artist_id, display_artist, musicbrainz_album_artist_id, original_date,
+                              rating, release_date, sort_artist, title, user_rating, votes, year,
+                              art, date_added, genre, fan_art, thumbnail, label)
+        end
+      end
+    end
+  end
+end
+

data/lib/kodi_client/types/audio/audio_fields_album_type.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Fields.Album https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Fields.Album
+      module AudioFieldsAlbum
+        extend Extensions::Iterable
+
+        ALBUM_DURATION = 'albumduration'
+        ALBUM_LABEL = 'albumlabel'
+        ALBUM_STATUS = 'albumstatus'
+        ART = 'art'
+        ARTIST = 'artist'
+        ARTIST_ID = 'artistid'
+        COMPILATION = 'compilation'
+        DATE_ADDED = 'dateadded'
+        DATE_MODIFIED = 'datemodified'
+        DATE_NEW = 'datenew'
+        DESCRIPTION = 'description'
+        DISPLAY_ARTIST = 'displayartist'
+        FAN_ART = 'fanart'
+        GENRE = 'genre'
+        IS_BOX_SET = 'isboxset'
+        LAST_PLAYED = 'lastplayed'
+        MOOD = 'mood'
+        MUSICBRAINZ_ALBUM_ARTIST_ID = 'musicbrainzalbumartistid'
+        MUSICBRAINZ_ALBUM_ID = 'musicbrainzalbumid'
+        MUSICBRAINZ_RELEASE_GROUP_ID = 'musicbrainzreleasegroupid'
+        ORIGINAL_DATE = 'originaldate'
+        PLAY_COUNT = 'playcount'
+        RATING = 'rating'
+        RELEASE_DATE = 'releasedate'
+        RELEASE_TYPE = 'releasetype'
+        SONG_GENRES = 'songgenres'
+        SORT_ARTIST = 'sortartist'
+        SOURCE_ID = 'sourceid'
+        STYLE = 'style'
+        THEME = 'theme'
+        THUMBNAIL = 'thumbnail'
+        TITLE = 'title'
+        TOTAL_DISCS = 'totaldiscs'
+        TYPE = 'type'
+        USER_RATING = 'userrating'
+        VOTES = 'votes'
+        YEAR = 'year'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_fields_artist_type.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Fields.Artist https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Fields.Artist
+      module AudioFieldsArtist
+        extend Extensions::Iterable
+
+        INSTRUMENT = 'instrument'
+        STYLE = 'style'
+        MOOD = 'mood'
+        BORN = 'born'
+        FORMED = 'formed'
+        DESCRIPTION = 'description'
+        GENRE = 'genre'
+        DIED = 'died'
+        DISBANDED = 'disbanded'
+        YEARS_ACTIVE = 'yearsactive'
+        MUSICBRAINZ_ARTIST_ID = 'musicbrainzartistid'
+        FAN_ART = 'fanart'
+        THUMBNAIL = 'thumbnail'
+        COMPILATION_ARTIST = 'compilationartist'
+        DATE_ADDED = 'dateadded'
+        ROLES = 'roles'
+        SONG_GENRES = 'songgenres'
+        IS_ALBUM_ARTIST = 'isalbumartist'
+        SORT_NAME = 'sortname'
+        TYPE = 'type'
+        GENDER = 'gender'
+        DISAMBIGUATION = 'disambiguation'
+        ART = 'art'
+        SOURCE_ID = 'sourceid'
+        DATE_MODIFIED = 'datemodified'
+        DATE_NEW = 'datenew'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/audio/audio_fields_role_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Fields.Role https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Fields.Role
+      module AudioFieldsRole
+        extend Extensions::Iterable
+
+        TITLE = 'title'
+      end
+    end
+  end
+end
+