kodi_client 0.4.0

data/lib/kodi_client/global_types/global_types.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/iterable'
+
+module KodiClient
+  module Types
+    module Global
+
+      # Global.Toggle https://kodi.wiki/view/JSON-RPC_API/v12#Global.Toggle
+      module Toggle
+        include Iterable
+
+        TOGGLE = 'toggle'
+        TRUE = true
+        FALSE = false
+      end
+
+      # rotate for clockwise and counter clockwise
+      module Rotate
+        include Iterable
+
+        CLOCKWISE = 'clockwise'
+        COUNTER_CLOCKWISE = 'counterclockwise'
+      end
+
+      # direction for left, right, up, down
+      module Direction
+        include Iterable
+
+        LEFT = 'left'
+        RIGHT = 'right'
+        UP = 'up'
+        DOWN = 'down'
+      end
+
+      # enum for prev/next
+      module NextPrev
+        include Iterable
+
+        NEXT = 'next'
+        PREV = 'previous'
+        ON = 'on'
+        OFF = 'off'
+      end
+
+      # Global.IncrementDecrement https://kodi.wiki/view/JSON-RPC_API/v12#Global.IncrementDecrement
+      module IncrementDecrement
+        include Iterable
+
+        INCREMENT = 'increment'
+        DECREMENT = 'decrement'
+      end
+
+      # id/label type
+      class IdLabel
+        include Comparable
+        attr_reader :id, :label
+
+        def initialize(hash)
+          @id = hash['id']
+          @label = hash['label']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # id/name type
+      class IdName
+        include Comparable
+        attr_reader :id, :name
+
+        def initialize(hash)
+          @id = hash['id']
+          @name = hash['name']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Global.Time https://kodi.wiki/view/JSON-RPC_API/v12#Global.Time
+      class GlobalTime
+        include Comparable
+
+        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)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/gui_types.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require 'kodi_client/global_types/global_types'
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/iterable'
+
+module KodiClient
+  module Types
+    module GUI
+
+      # GUI.Window https://kodi.wiki/view/JSON-RPC_API/v12#GUI.Window
+      module GUIWindow
+
+        ACCESSPOINTS = 'accesspoints'
+        ADDON = 'addon'
+        ADDONBROWSER = 'addonbrowser'
+        ADDONINFORMATION = 'addoninformation'
+        ADDONSETTINGS = 'addonsettings'
+        APPEARANCESETTINGS = 'appearancesettings'
+        AUDIODSPMANAGER = 'audiodspmanager'
+        BUSYDIALOG = 'busydialog'
+        CONTENTSETTINGS = 'contentsettings'
+        CONTEXTMENU = 'contextmenu'
+        EVENTLOG = 'eventlog'
+        EXTENDEDPROGRESSDIALOG = 'extendedprogressdialog'
+        FAVOURITES = 'favourite'
+        FILEBROWSER = 'filebrowser'
+        FILEMANAGER = 'filemanager'
+        FULLSCREENINFO = 'fullscreeninfo'
+        FULLSCREENLIVETV = 'fullscreenlivetv'
+        FULLSCREENRADIO = 'fullscreenradio'
+        FULLSCREENVIDEO = 'fullscreenvideo'
+        GAMECONTROLLERS = 'gamecontrollers'
+        GAMEPADINPUT = 'gamepadinput'
+        HOME = 'home'
+        INTERFACESETTINGS = 'interfacesettings'
+        LOCKSETTINGS = 'locksettings'
+        LOGINSCREEN = 'loginscreen'
+        MEDIAFILTER = 'mediafilter'
+        MEDIASETTINGS = 'mediasettings'
+        MEDIASOURCE = 'mediasource'
+        MOVIEINFORMATION = 'movieinformation'
+        MUSIC = 'music'
+        MUSICINFORMATION = 'musicinformation'
+        MUSICOSD = 'musicosd'
+        MUSICPLAYLIST = 'musicplaylist'
+        MUSICPLAYLISTEDITOR = 'musicplaylisteditor'
+        NETWORKSETUP = 'networksetup'
+        NOTIFICATION = 'notification'
+        NUMERICINPUT = 'numericinput'
+        OKDIALOG = 'okdialog'
+        OSDAUDIODSPSETTINGS = 'osdaudiodspsettings'
+        OSDAUDIOSETTINGS = 'osdaudiosettings'
+        OSDCMSSETTINGS = 'osdcmssettings'
+        OSDVIDEOSETTINGS = 'osdvideosettings'
+        PERIPHERALSETTINGS = 'peripheralsettings'
+        PICTUREINFO = 'pictureinfo'
+        PICTURES = 'pictures'
+        PLAYERCONTROLS = 'playercontrols'
+        PLAYERPROCESSINFO = 'playerprocessinfo'
+        PLAYERSETTINGS = 'playersettings'
+        PROFILES = 'profiles'
+        PROFILESETTINGS = 'profilesettings'
+        PROGRAMS = 'programs'
+        PROGRESSDIALOG = 'progressdialog'
+        PVRCHANNELMANAGER = 'pvrchannelmanager'
+        PVRCHANNELSCAN = 'pvrchannelscan'
+        PVRGROUPMANAGER = 'pvrgroupmanager'
+        PVRGUIDEINFO = 'pvrguideinfo'
+        PVRGUIDESEARCH = 'pvrguidesearch'
+        PVROSDCHANNELS = 'pvrosdchannels'
+        PVROSDGUIDE = 'pvrosdguide'
+        PVROSDTELETEXT = 'pvrosdteletext'
+        PVRRADIORDSINFO = 'pvrradiordsinfo'
+        PVRRECORDINGINFO = 'pvrrecordinginfo'
+        PVRSETTINGS = 'pvrsettings'
+        PVRTIMERSETTING = 'pvrtimersetting'
+        PVRUPDATEPROGRESS = 'pvrupdateprogress'
+        RADIOCHANNELS = 'radiochannels'
+        RADIOGUIDE = 'radioguide'
+        RADIORECORDINGS = 'radiorecordings'
+        RADIOSEARCH = 'radiosearch'
+        RADIOTIMERRULES = 'radiotimerrules'
+        RADIOTIMERS = 'radiotimers'
+        SCREENCALIBRATION = 'screencalibration'
+        SCREENSAVER = 'screensaver'
+        SEEKBAR = 'seekbar'
+        SELECTDIALOG = 'selectdialog'
+        SERVICESETTINGS = 'servicesettings'
+        SETTINGS = 'settings'
+        SHUTDOWNMENU = 'shutdownmenu'
+        SKINSETTINGS = 'skinsettings'
+        SLIDERDIALOG = 'sliderdialog'
+        SLIDESHOW = 'slideshow'
+        SMARTPLAYLISTEDITOR = 'smartplaylisteditor'
+        SMARTPLAYLISTRULE = 'smartplaylistrule'
+        SONGINFORMATION = 'songinformation'
+        STARTUP = 'startup'
+        STARTWINDOW = 'startwindow'
+        SUBMENU = 'submenu'
+        SUBTITLESEARCH = 'subtitlesearch'
+        SYSTEMINFO = 'systeminfo'
+        SYSTEMSETTINGS = 'systemsettings'
+        TELETEXT = 'teletext'
+        TESTPATTERN = 'testpattern'
+        TEXTVIEWER = 'textviewer'
+        TVCHANNELS = 'tvchannels'
+        TVGUIDE = 'tvguide'
+        TVRECORDINGS = 'tvrecordings'
+        TVSEARCH = 'tvsearch'
+        TVTIMERRULES = 'tvtimerrules'
+        TVTIMERS = 'tvtimers'
+        VIDEOBOOKMARKS = 'videobookmarks'
+        VIDEOMENU = 'videomenu'
+        VIDEOOSD = 'videoosd'
+        VIDEOPLAYLIST = 'videoplaylist'
+        VIDEOS = 'videos'
+        VIDEOTIMESEEK = 'videotimeseek'
+        VIRTUALKEYBOARD = 'virtualkeyboard'
+        VISUALISATION = 'visualisation'
+        VISUALISATIONPRESETLIST = 'visualisationpresetlist'
+        VOLUMEBAR = 'volumebar'
+        WEATHER = 'weather'
+        YESNODIALOG = 'yesnodialog'
+      end
+
+      # GUI.Property.Name https://kodi.wiki/view/JSON-RPC_API/v12#GUI.Property.Name
+      module PropertyName
+        extend Iterable
+
+        CURRENTCONTROL = 'currentcontrol'
+        CURRENTWINDOW = 'currentwindow'
+        FULLSCREEN = 'fullscreen'
+        SKIN = 'skin'
+        STEREOSCOPICMODE = 'stereoscopicmode'
+      end
+
+      # GUI.Stereoscopy.Mode https://kodi.wiki/view/JSON-RPC_API/v12#GUI.Stereoscopy.Mode
+      class StereoscopyMode
+        include Comparable
+        include Iterable
+
+        attr_reader :label, :mode
+
+        OFF = 'off'
+        SPLIT_VERTICAL = 'split_vertical'
+        SPLIT_HORIZONTAL = 'split_horizontal'
+        ROW_INTERLEAVED = 'row_interleaved'
+        HARDWARE_BASED = 'hardware_based'
+        ANAGLYPH_CYAN_RED = 'anaglyph_cyan_red'
+        ANAGLYPH_GREEN_MAGENTA = 'anaglyph_green_magenta'
+        ANAGLYPH_YELLOW_BLUE = 'anaglyph_yellow_blue'
+        MONSCOPIC = 'monoscopic'
+
+        def initialize(hash)
+          @label = hash['label']
+          @mode = hash['mode']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # GUI.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#GUI.Property.Value
+      class PropertyValue
+        include Comparable
+
+        attr_reader :current_control, :current_window, :fullscreen, :skin, :stereoscopic_mode
+
+        def initialize(hash)
+          @current_control = Global::IdLabel.new(hash['currentcontrol'])
+          @current_window = Global::IdLabel.new(hash['currentwindow'])
+          @fullscreen = hash['fullscreen']
+          @skin = Global::IdName.new(hash['skin'])
+          @stereoscopic_mode = StereoscopyMode.new(hash['stereoscopicmode'])
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/item_types.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Items
+
+      # Item.Details.Base https://kodi.wiki/view/JSON-RPC_API/v12#Item.Details.Base
+      module ItemDetailsBase
+
+        attr_reader :label
+
+        def item_details_base(hash)
+          @label = hash['label']
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/list_types.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/comparable'
+require 'kodi_client/global_types/video_types'
+require 'kodi_client/global_types/audio_types'
+
+module KodiClient
+  module Types
+    module List
+
+      # List.Limits https://kodi.wiki/view/JSON-RPC_API/v12#List.Limits
+      class ListLimits
+        include Comparable
+
+        attr_reader :list_start, :list_end
+
+        def initialize(list_start, list_end)
+          @list_start = list_start
+          @list_end = list_end
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # List.LimitsReturned https://kodi.wiki/view/JSON-RPC_API/v12#List.LimitsReturned
+      class ListLimitsReturned
+        include Comparable
+
+        attr_reader :list_start, :list_end, :total
+
+        def initialize(hash)
+          @list_start = hash['start']
+          @list_end = hash['end']
+          @total = hash['total']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # List.Fields.All https://kodi.wiki/view/JSON-RPC_API/v12#List.Fields.All
+      module ListFieldsAll
+        extend Iterable
+
+        ALBUM = 'album'
+        ALBUMARTIST = 'albumartist'
+        ALBUMARTISTID = 'albumartistid'
+        ALBUMID = 'albumid'
+        ALBUMLABEL = 'albumlabel'
+        ALBUMRELEASETYPE = 'albumreleasetype'
+        ART = 'art'
+        ARTIST = 'artist'
+        ARTISTID = 'artistid'
+        CAST = 'cast'
+        CHANNEL = 'channel'
+        CHANNELNUMBER = 'channelnumber'
+        CHANNELTYPE = 'channeltype'
+        COMMENT = 'comment'
+        COMPILATION = 'compilation'
+        CONTRIBUTORS = 'contributors'
+        COUNTRY = 'country'
+        DATEADDED = 'dateadded'
+        DESCRIPTION = 'description'
+        DIRECTOR = 'director'
+        DISC = 'disc'
+        DISPLAYARTIST = 'displayartist'
+        DISPLAYCOMPOSER = 'displaycomposer'
+        DISPLAYCONDUCTOR = 'displayconductor'
+        DISPLAYLYRICIST = 'displaylyricist'
+        DISPLAYORCHESTRA = 'displayorchestra'
+        DURATION = 'duration'
+        ENDTIME = 'endtime'
+        EPISODE = 'episode'
+        EPISODEGUIDE = 'episodeguide'
+        FANART = 'fanart'
+        FILE = 'file'
+        FIRSTAIRED = 'firstaired'
+        GENRE = 'genre'
+        GENREID = 'genreid'
+        HIDDEN = 'hidden'
+        IMDBNUMBER = 'imdbnumber'
+        LASTPLAYED = 'lastplayed'
+        LOCKED = 'locked'
+        LYRICS = 'lyrics'
+        MOOD = 'mood'
+        MPAA = 'mpaa'
+        MUSICBRAINZALBUMARTISTID = 'musicbrainzalbumartistid'
+        MUSICBRAINZALBUMID = 'musicbrainzalbumid'
+        MUSICBRAINZARTISTID = 'musicbrainzartistid'
+        MUSICBRAINZTRACKID = 'musicbrainztrackid'
+        ORIGINALTITLE = 'originaltitle'
+        PLAYCOUNT = 'playcount'
+        PLOT = 'plot'
+        PLOTOUTLINE = 'plotoutline'
+        PREMIERED = 'premiered'
+        PRODUCTIONCODE = 'productioncode'
+        RATING = 'rating'
+        RELEASETYPE = 'releasetype'
+        RESUME = 'resume'
+        RUNTIME = 'runtime'
+        SEASON = 'season'
+        SET = 'set'
+        SETID = 'setid'
+        SHOWLINK = 'showlink'
+        SHOWTITLE = 'showtitle'
+        SORTTITLE = 'sorttitle'
+        SPECIALSORTEPISODE = 'specialsortepisode'
+        SPECIALSORTSEASON = 'specialsortseason'
+        STARTTIME = 'starttime'
+        STREAMDETAILS = 'streamdetails'
+        STUDIO = 'studio'
+        STYLE = 'style'
+        TAG = 'tag'
+        TAGLINE = 'tagline'
+        THEME = 'theme'
+        THUMBNAIL = 'thumbnail'
+        TITLE = 'title'
+        TOP250 = 'top250'
+        TRACK = 'track'
+        TRAILER = 'trailer'
+        TVSHOWID = 'tvshowid'
+        UNIQUEID = 'uniqueid'
+        USERRATING = 'userrating'
+        VOTES = 'votes'
+        WATCHEDEPISODES = 'watchedepisodes'
+        WRITER = 'writer'
+        YEAR = 'year'
+      end
+
+      # List.Item.Base https://kodi.wiki/view/JSON-RPC_API/v12#List.Item.Base
+      module ListItemBase
+        include Video::VideoDetailsFile
+        include Audio::AudioDetailsMedia
+
+        attr_reader :album, :album_artist, :album_artist_id, :album_id, :album_release_type, :album_status, :bit_rate,
+                    :bpm, :cast, :channels, :comment, :compilation, :contributors, :country, :description, :disc,
+                    :disc_title, :display_composer, :display_conductor, :display_lyricist, :display_orchestra,
+                    :duration, :dyn_path, :episode, :episode_guide, :first_aired, :id, :imdb_number, :is_box_set,
+                    :lyrics, :media_path, :mood, :mpaa, :musicbrainz_artist_id, :musicbrainz_track_id, :original_date,
+                    :original_title, :plot_outline, :premiered, :production_code, :release_date, :release_type,
+                    :sample_rate, :season, :set, :set_id, :show_link, :show_title, :sort_title, :special_sort_episode,
+                    :special_sort_season, :studio, :style, :tag, :tag_line, :theme, :top250, :total_discs, :track,
+                    :trailer, :tv_show_id, :type, :unique_id, :votes, :watched_episodes, :writer
+
+        def list_item_base(hash)
+          @album = hash['album']
+          @album_artist = hash['albumartist']
+          @album_artist_id = hash['albumartistid']
+          @album_id = hash['albumid']
+          @album_release_type = hash['albumreleasetype']
+          @album_status = hash['albumstatus']
+          @bit_rate = hash['bitrate']
+          @bpm = hash['bpm']
+          @cast = hash['cast'].nil? ? [] : hash['cast'].map { |it| Types::Video::VideoCast.new(it) }
+          @channels = hash['channels']
+          @comment = hash['comment']
+          @compilation = hash['compilation']
+          @contributors = hash['contributors'].nil? ? [] : hash['contributors'].map { |it| Types::Audio::AudioContributor.new(it) }
+          @country = hash['country']
+          @description = hash['description']
+          @disc = hash['disc']
+          @disc_title = hash['disctitle']
+          @display_composer = hash['displaycomposer']
+          @display_conductor = hash['displayconductor']
+          @display_lyricist = hash['displaylyricist']
+          @display_orchestra = hash['displayorchestra']
+          @duration = hash['duration']
+          @dyn_path = hash['dynpath']
+          @episode = hash['episode']
+          @episode_guide = hash['episodeguide']
+          @first_aired = hash['firstaired']
+          @id = hash['id']
+          @imdb_number = hash['imdbnumber']
+          @is_box_set = hash['isboxset']
+          @lyrics = hash['lyrics']
+          @media_path = hash['mediapath']
+          @mood = hash['mood']
+          @mpaa = hash['mpaa']
+          @musicbrainz_artist_id = hash['musicbrainzartistid']
+          @musicbrainz_track_id = hash['musicbrainztrackid']
+          @original_date = hash['originaldate']
+          @original_title = hash['originaltitle']
+          @plot_outline = hash['plotoutline']
+          @premiered = hash['premiered']
+          @production_code = hash['productioncode']
+          @release_date = hash['releasedate']
+          @release_type = hash['releasetype']
+          @sample_rate = hash['samplerate']
+          @season = hash['season']
+          @set = hash['set']
+          @set_id = hash['setid']
+          @show_link = hash['showlink']
+          @show_title = hash['showtitle']
+          @sort_title = hash['sorttitle']
+          @special_sort_episode = hash['specialsortepisode']
+          @special_sort_season = hash['specialsortseason']
+          @studio = hash['studio']
+          @style = hash['style']
+          @tag = hash['tag']
+          @tag_line = hash['tagline']
+          @theme = hash['theme']
+          @top250 = hash['top250']
+          @total_discs = hash['totaldiscs']
+          @track = hash['track']
+          @trailer = hash['trailer']
+          @tv_show_id = hash['tvshowid']
+          @type = hash['type'].nil? ? 'unknown' : hash['type']
+          @unique_id = hash['uniqueid']
+          @votes = hash['votes']
+          @watched_episodes = hash['watchedepisodes']
+          @writer = hash['writer']
+          video_details_file(hash)
+          audio_details_media(hash)
+        end
+      end
+
+      # List.Item.All https://kodi.wiki/view/JSON-RPC_API/v12#List.Item.All
+      class ListItemAll
+        include ListItemBase
+        include Comparable
+
+        attr_reader :channel, :channel_number, :channel_type, :end_time, :hidden, :locked, :start_time,
+                    :sub_channel_number
+
+        def initialize(hash)
+          @channel = hash['channel']
+          @channel_number = hash['channelnumber']
+          @channel_type = hash['channeltype']
+          @end_time = hash['endtime']
+          @hidden = hash['hidden']
+          @locked = hash['locked']
+          @start_time = hash['starttime']
+          @sub_channel_number = hash['subchannelnumber']
+          list_item_base(hash)
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/media_types.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'kodi_client/global_types/item_types'
+require 'kodi_client/util/comparable'
+
+module KodiClient
+  module Types
+    module Media
+
+      # media types
+      module MediaType
+        extend Iterable
+        VIDEO = 'video'
+        AUDIO = 'audio'
+        ALL = 'all'
+      end
+
+      # Media.Details.Base https://kodi.wiki/view/JSON-RPC_API/v12#Media.Details.Base
+      module MediaDetailsBase
+        include Items::ItemDetailsBase
+
+        attr_reader :fan_art, :thumbnail
+
+        def media_details_base(hash)
+          @fan_art = hash['fanart']
+          @thumbnail = hash['thumbnail']
+          item_details_base(hash)
+        end
+      end
+
+      # Media.Artwork https://kodi.wiki/view/JSON-RPC_API/v12#Media.Artwork
+      class MediaArtwork
+        include Comparable
+
+        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)
+        end
+      end
+    end
+  end
+end