kodi_client 0.6.3 → 0.6.4

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_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_base_type.rb

@@ -0,0 +1,31 @@
+# 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
+          mappings = { 'art' => Extensions::Creatable::CreateMap.new(Types::Media::MediaArtwork) }
+          mappings.merge(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,45 @@
+# 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
+
+        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_fields_album_type.rb

@@ -0,0 +1,51 @@
+# 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 id
+        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/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 DetailsAlbum
+        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/genre_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # Audio.Details.Genres https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Genres
+      class Genre
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :genre_id, :title
+
+        def initialize(genre_id, title)
+          @genre_id = genre_id
+          @title = title
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Audio
+      # return type for AudioLibrary.GetAlbums
+      class GetAlbumsReturned
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :albums, :limits
+
+        type_mapping ['albums', DetailsAlbum, true], ['limits', List::ListLimitsReturned]
+
+        def initialize(albums, limits)
+          @albums = albums
+          @limits = limits
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/favourites/details_favourite_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Favourites
+      # Favourite.Details.Favourite https://kodi.wiki/view/JSON-RPC_API/v12#Favourite.Details.Favourite
+      class DetailsFavourite
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :path, :thumbnail, :title, :type, :window, :window_parameter
+
+        def initialize(path, thumbnail, title, type, window, window_parameter)
+          @path = path
+          @thumbnail = thumbnail
+          @title = title
+          @type = type
+          @window = window
+          @window_parameter = window_parameter
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/favourites/fields_favourite_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Favourites
+      # Favourite.Fields.Favourite https://kodi.wiki/view/JSON-RPC_API/v12#Favourite.Fields.Favourite
+      module FieldsFavourite
+        extend Extensions::Iterable
+
+        WINDOW = 'window'
+        WINDOW_PARAMETER = 'windowparameter'
+        THUMBNAIL = 'thumbnail'
+        PATH = 'path'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/favourites/get_favourite_returned_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Favourites
+      # return type for Favourites.GetFavourites
+      class GetFavouriteReturned
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :favourites, :limits
+
+        type_mapping ['favourites', DetailsFavourite, true], ['limits', Types::List::ListLimitsReturned]
+
+        def initialize(favourites, limits)
+          @favourites = favourites
+          @limits = limits
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/favourites/type_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Favourites
+      # Favourite.Type https://kodi.wiki/view/JSON-RPC_API/v12#Favourite.Type
+      module Type
+        extend Extensions::Iterable
+
+        MEDIA = 'media'
+        WINDOW = 'window'
+        SCRIPT = 'script'
+        ANDROID_APP = 'androidapp'
+        UNKNOWN = 'unknown'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/files/file_label_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Files
+      # File/Label tuple
+      class FileLabel
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :file, :label
+
+        def initialize(file, label)
+          @file = file
+          @label = label
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/files/get_directory_returned_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Files
+      # return value for GetDirectory
+      class GetDirectoryReturned
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :files, :limits
+
+        type_mapping ['files', List::ListItemFile, true], ['limits', List::ListLimitsReturned]
+
+        def initialize(files, limits)
+          @files = files
+          @limits = limits
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/files/get_sources_returned_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Files
+      # return value for GetSources
+      class GetSourcesReturned
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :sources, :limits
+
+        type_mapping ['sources', Files::FileLabel, true], ['limits', List::ListLimitsReturned]
+
+        def initialize(sources, limits)
+          @sources = sources
+          @limits = limits
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/files/media_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Files
+      # Files.Media https://kodi.wiki/view/JSON-RPC_API/v12#Files.Media
+      module Media
+        extend Extensions::Iterable
+
+        VIDEO = 'video'
+        MUSIC = 'music'
+        PICTURES = 'pictures'
+        FILES = 'files'
+        PROGRAMS = 'programs'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/files/prepare_download_returned_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Files
+      # return value for GetPrepareDownload
+      class PrepareDownloadReturned
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :details, :mode, :protocol
+
+        def initialize(details, mode, protocol)
+          @details = details
+          @mode = mode
+          @protocol = protocol
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/types/global/direction_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Global
+      # direction for left, right, up, down
+      module Direction
+        extend Extensions::Iterable
+
+        LEFT = 'left'
+        RIGHT = 'right'
+        UP = 'up'
+        DOWN = 'down'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/global/global_time_type.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Global
+      # Global.Time https://kodi.wiki/view/JSON-RPC_API/v12#Global.Time
+      class GlobalTime
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :hours, :minutes, :seconds, :milliseconds
+
+        def initialize(hours, minutes, seconds, milliseconds)
+          @hours = hours
+          @minutes = minutes
+          @seconds = seconds
+          @milliseconds = milliseconds
+        end
+      end
+    end
+  end
+end