kodi_client 0.4.1 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d626f5d559146d9c8d24b29cbcc1a87b05c0653d0b092d593bef0da9390cfded
-  data.tar.gz: '0841f786338f19c0c8341ebc7cc71aec0131a308af374bdd7a5347ab7acd41ad'
+  metadata.gz: 988e821c68bbe4f1ffc3579c64aa02647814f9aea0fb5af409d619a10e82ab71
+  data.tar.gz: 1df5a3cea4ac46a7fb1fc7420f3f8a66244ceaed0a79a06673a6f9b9e3e6fcd0
 SHA512:
-  metadata.gz: 357427f184bb3c50c6fb30ae226e014800cd3264726d6cad187efad951a7f724e7d37f5f728cce8c0cfaad7efdcd719be01e6097263da33f69975b4829490e15
-  data.tar.gz: 0e6e1d0fa1b67859cfc19489bf1694c95ee432f30f8afc3c78358823c4e777c928dd3a3eb679b00d3825201363a69514f060001f11b49b9f8d793693cf73bd2b
+  metadata.gz: 4cbaa96ef989fc5c9708007f623f7c272ad465670099ac3d5251b5b2621e2f02411b23ad3aa3b5864b62b91bd4a530276cb884205b8e2f180491fce3a5c74204
+  data.tar.gz: a7aca817104f7be2f5919713cf07d40a4901f3fc6c0dc57ab248be2be0a34194b7c96f751277aaf3466561e19d83bf16ec1401c0a5765a1c0cdc51f51ec04bef

data/.rubocop.yml

@@ -11,4 +11,6 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Enabled: false
 Metrics/PerceivedComplexity:
+  Enabled: false
+Style/OptionalBooleanParameter:
   Enabled: false

data/README.md

@@ -5,8 +5,12 @@ RubyKodiClient is a work-in-progress client for [Kodi JSON API v12](https://kodi
 Currently implemented are the following Methods:
 * Addons
 * Application
+* Favourites
 * GUI
+* Input
 * Player
+* Profile
+* System
 
 ## Installation
 from [rubygems](https://rubygems.org/gems/kodi_client) using
@@ -19,7 +23,7 @@ gem build kodi-client.gemspec
 ```
 and then execute
 ```shell
-gem build kodi-client-0.4.0.gemspec
+gem build kodi-client-x.x.x.gemspec
 ```
 
 ## Enable Kodi Remote Control

data/kodi_client.gemspec

@@ -2,12 +2,15 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'kodi_client'
-  spec.version       = '0.4.1'
+  spec.version       = '0.5.6'
   spec.authors       = ['Christian Feier']
   spec.email         = ['christian.feier@gmail.com']
 
   spec.summary       = 'A work-in-progress client for Kodi JSON API v2.'
-  spec.description   = 'A client for the Kodi JSON API v12, currently implemented methods are addons, application, gui and player (more will be added with the time). For more information how to use it and how to activate Remote Control in Kodi, please check the github page https://github.com/cfe86/RubyKodiClient'
+  spec.description   = 'A client for the Kodi JSON API v12, currently implemented methods are addons, application, '\
+                       'favourites, gui, input, player, profile and system (more will be added with the time). '\
+                       'For more information how to use it and how to activate Remote Control in Kodi, '\
+                       'please check the github page https://github.com/cfe86/RubyKodiClient'
   spec.homepage      = 'https://github.com/cfe86/RubyKodiClient'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.5.0'

data/lib/kodi_client/global_types/audio_types.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'kodi_client/global_types/media_types'
-require 'kodi_client/global_types/player_type'
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
 

data/lib/kodi_client/global_types/favourites_types.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/iterable'
+require 'kodi_client/global_types/list_types'
+
+module KodiClient
+  module Types
+    module Favourites
+
+      # Favourite.Type https://kodi.wiki/view/JSON-RPC_API/v12#Favourite.Type
+      module Type
+        extend Iterable
+
+        MEDIA = 'media'
+        WINDOW = 'window'
+        SCRIPT = 'script'
+        ANDROID_APP = 'androidapp'
+        UNKNOWN = 'unknown'
+      end
+
+      # Favourite.Fields.Favourite https://kodi.wiki/view/JSON-RPC_API/v12#Favourite.Fields.Favourite
+      module FieldsFavourite
+        extend Iterable
+
+        WINDOW = 'window'
+        WINDOW_PARAMETER = 'windowparameter'
+        THUMBNAIL = 'thumbnail'
+        PATH = 'path'
+      end
+
+      # Favourite.Details.Favourite https://kodi.wiki/view/JSON-RPC_API/v12#Favourite.Details.Favourite
+      class DetailsFavourite
+        include Comparable
+
+        attr_reader :path, :thumbnail, :title, :type, :window, :window_parameter
+
+        def initialize(hash)
+          @path = hash['path']
+          @thumbnail = hash['thumbnail']
+          @title = hash['title']
+          @type = hash['type']
+          @window = hash['window']
+          @window_parameter = hash['windowparameter']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # return type for Favourites.GetFavourites
+      class GetFavouriteReturned
+        include Comparable
+
+        attr_reader :favourites, :limits
+
+        def initialize(hash)
+          @favourites = hash['favourites'].map { |it| DetailsFavourite.new(it) }
+          @limits = Types::List::ListLimitsReturned.new(hash['limits'])
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/global_types.rb

@@ -18,7 +18,7 @@ module KodiClient
 
       # rotate for clockwise and counter clockwise
       module Rotate
-        include Iterable
+        extend Iterable
 
         CLOCKWISE = 'clockwise'
         COUNTER_CLOCKWISE = 'counterclockwise'
@@ -26,7 +26,7 @@ module KodiClient
 
       # direction for left, right, up, down
       module Direction
-        include Iterable
+        extend Iterable
 
         LEFT = 'left'
         RIGHT = 'right'
@@ -36,7 +36,7 @@ module KodiClient
 
       # enum for prev/next
       module NextPrev
-        include Iterable
+        extend Iterable
 
         NEXT = 'next'
         PREV = 'previous'
@@ -46,7 +46,7 @@ module KodiClient
 
       # Global.IncrementDecrement https://kodi.wiki/view/JSON-RPC_API/v12#Global.IncrementDecrement
       module IncrementDecrement
-        include Iterable
+        extend Iterable
 
         INCREMENT = 'increment'
         DECREMENT = 'decrement'
@@ -99,6 +99,14 @@ module KodiClient
           compare(self, other)
         end
       end
+
+      # available Password Encryptions
+      module PasswordEncryption
+        extend Iterable
+
+        NONE = 'none'
+        MD5 = 'md5'
+      end
     end
   end
 end

data/lib/kodi_client/global_types/input_types.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/iterable'
+
+module KodiClient
+  module Types
+    module Input
+
+      # Input.Action https://kodi.wiki/view/JSON-RPC_API/v12#Input.Action
+      module InputAction
+        extend Iterable
+
+        ANALOGFASTFORWARD = 'analogfastforward'
+        ANALOGMOVE = 'analogmove'
+        ANALOGMOVEX = 'analogmovex'
+        ANALOGMOVEY = 'analogmovey'
+        ANALOGREWIND = 'analogrewind'
+        ANALOGSEEKBACK = 'analogseekback'
+        ANALOGSEEKFORWARD = 'analogseekforward'
+        ASPECTRATIO = 'aspectratio'
+        AUDIODELAY = 'audiodelay'
+        AUDIODELAYMINUS = 'audiodelayminus'
+        AUDIODELAYPLUS = 'audiodelayplus'
+        AUDIONEXTLANGUAGE = 'audionextlanguage'
+        AUDIOTOGGLEDIGITAL = 'audiotoggledigital'
+        BACK = 'back'
+        BACKSPACE = 'backspace'
+        BIGSTEPBACK = 'bigstepback'
+        BIGSTEPFORWARD = 'bigstepforward'
+        BLUE = 'blue'
+        CHANNELDOWN = 'channeldown'
+        CHANNELUP = 'channelup'
+        CHAPTERORBIGSTEPBACK = 'chapterorbigstepback'
+        CHAPTERORBIGSTEPFORWARD = 'chapterorbigstepforward'
+        CLOSE = 'close'
+        CODECINFO = 'codecinfo'
+        CONTEXTMENU = 'contextmenu'
+        COPY = 'copy'
+        CREATEBOOKMARK = 'createbookmark'
+        CREATEEPISODEBOOKMARK = 'createepisodebookmark'
+        CURSORLEFT = 'cursorleft'
+        CURSORRIGHT = 'cursorright'
+        CYCLESUBTITLE = 'cyclesubtitle'
+        DECREASEPAR = 'decreasepar'
+        DECREASERATING = 'decreaserating'
+        DECREASEVISRATING = 'decreasevisrating'
+        DELETE = 'delete'
+        DOUBLECLICK = 'doubleclick'
+        DOWN = 'down'
+        ENTER = 'enter'
+        ERROR = 'error'
+        FASTFORWARD = 'fastforward'
+        FILTER = 'filter'
+        FILTERCLEAR = 'filterclear'
+        FILTERSMS2 = 'filtersms2'
+        FILTERSMS3 = 'filtersms3'
+        FILTERSMS4 = 'filtersms4'
+        FILTERSMS5 = 'filtersms5'
+        FILTERSMS6 = 'filtersms6'
+        FILTERSMS7 = 'filtersms7'
+        FILTERSMS8 = 'filtersms8'
+        FILTERSMS9 = 'filtersms9'
+        FIRSTPAGE = 'firstpage'
+        FULLSCREEN = 'fullscreen'
+        GREEN = 'green'
+        GUIPROFILE = 'guiprofile'
+        HIGHLIGHT = 'highlight'
+        INCREASEPAR = 'increasepar'
+        INCREASERATING = 'increaserating'
+        INCREASEVISRATING = 'increasevisrating'
+        INFO = 'info'
+        JUMPSMS2 = 'jumpsms2'
+        JUMPSMS3 = 'jumpsms3'
+        JUMPSMS4 = 'jumpsms4'
+        JUMPSMS5 = 'jumpsms5'
+        JUMPSMS6 = 'jumpsms6'
+        JUMPSMS7 = 'jumpsms7'
+        JUMPSMS8 = 'jumpsms8'
+        JUMPSMS9 = 'jumpsms9'
+        LASTPAGE = 'lastpage'
+        LEFT = 'left'
+        LEFTCLICK = 'leftclick'
+        LOCKPRESET = 'lockpreset'
+        LONGCLICK = 'longclick'
+        LONGPRESS = 'longpress'
+        MENU = 'menu'
+        MIDDLECLICK = 'middleclick'
+        MOUSEDRAG = 'mousedrag'
+        MOUSEMOVE = 'mousemove'
+        MOVE = 'move'
+        MOVEITEMDOWN = 'moveitemdown'
+        MOVEITEMUP = 'moveitemup'
+        MUTE = 'mute'
+        NEXTCALIBRATION = 'nextcalibration'
+        NEXTCHANNELGROUP = 'nextchannelgroup'
+        NEXTLETTER = 'nextletter'
+        NEXTPICTURE = 'nextpicture'
+        NEXTPRESET = 'nextpreset'
+        NEXTRESOLUTION = 'nextresolution'
+        NEXTSCENE = 'nextscene'
+        NEXTSTEREOMODE = 'nextstereomode'
+        NEXTSUBTITLE = 'nextsubtitle'
+        NOOP = 'noop'
+        NUMBER0 = 'number0'
+        NUMBER1 = 'number1'
+        NUMBER2 = 'number2'
+        NUMBER3 = 'number3'
+        NUMBER4 = 'number4'
+        NUMBER5 = 'number5'
+        NUMBER6 = 'number6'
+        NUMBER7 = 'number7'
+        NUMBER8 = 'number8'
+        NUMBER9 = 'number9'
+        OSD = 'osd'
+        PAGEDOWN = 'pagedown'
+        PAGEUP = 'pageup'
+        PANGESTURE = 'pangesture'
+        PARENTDIR = 'parentdir'
+        PARENTFOLDER = 'parentfolder'
+        PAUSE = 'pause'
+        PLAY = 'play'
+        PLAYERDEBUG = 'playerdebug'
+        PLAYERPROCESSINFO = 'playerprocessinfo'
+        PLAYLIST = 'playlist'
+        PLAYPAUSE = 'playpause'
+        PLAYPVR = 'playpvr'
+        PLAYPVRRADIO = 'playpvrradio'
+        PLAYPVRTV = 'playpvrtv'
+        PREVIOUSCHANNELGROUP = 'previouschannelgroup'
+        PREVIOUSMENU = 'previousmenu'
+        PREVIOUSPICTURE = 'previouspicture'
+        PREVIOUSPRESET = 'previouspreset'
+        PREVIOUSSCENE = 'previousscene'
+        PREVIOUSSTEREOMODE = 'previousstereomode'
+        PREVLETTER = 'prevletter'
+        QUEUE = 'queue'
+        RANDOMPRESET = 'randompreset'
+        RECORD = 'record'
+        RED = 'red'
+        RELOADKEYMAPS = 'reloadkeymaps'
+        RENAME = 'rename'
+        RESETCALIBRATION = 'resetcalibration'
+        REWIND = 'rewind'
+        RIGHT = 'right'
+        RIGHTCLICK = 'rightclick'
+        ROTATE = 'rotate'
+        ROTATECCW = 'rotateccw'
+        ROTATEGESTURE = 'rotategesture'
+        SCANITEM = 'scanitem'
+        SCREENSHOT = 'screenshot'
+        SCROLLDOWN = 'scrolldown'
+        SCROLLUP = 'scrollup'
+        SELECT = 'select'
+        SETRATING = 'setrating'
+        SETTINGSLEVELCHANGE = 'settingslevelchange'
+        SETTINGSRESET = 'settingsreset'
+        SHIFT = 'shift'
+        SHOWPRESET = 'showpreset'
+        SHOWSUBTITLES = 'showsubtitles'
+        SHOWTIME = 'showtime'
+        SHOWTIMERRULE = 'showtimerrule'
+        SHOWVIDEOMENU = 'showvideomenu'
+        SKIPNEXT = 'skipnext'
+        SKIPPREVIOUS = 'skipprevious'
+        SMALLSTEPBACK = 'smallstepback'
+        STEPBACK = 'stepback'
+        STEPFORWARD = 'stepforward'
+        STEREOMODE = 'stereomode'
+        STEREOMODETOMONO = 'stereomodetomono'
+        STOP = 'stop'
+        SUBTITLEALIGN = 'subtitlealign'
+        SUBTITLEDELAY = 'subtitledelay'
+        SUBTITLEDELAYMINUS = 'subtitledelayminus'
+        SUBTITLEDELAYPLUS = 'subtitledelayplus'
+        SUBTITLESHIFTDOWN = 'subtitleshiftdown'
+        SUBTITLESHIFTUP = 'subtitleshiftup'
+        SWIPEDOWN = 'swipedown'
+        SWIPELEFT = 'swipeleft'
+        SWIPERIGHT = 'swiperight'
+        SWIPEUP = 'swipeup'
+        SWITCHPLAYER = 'switchplayer'
+        SYMBOLS = 'symbols'
+        TAP = 'tap'
+        TOGGLECOMMSKIP = 'togglecommskip'
+        TOGGLEFULLSCREEN = 'togglefullscreen'
+        TOGGLESTEREOMODE = 'togglestereomode'
+        TOGGLEWATCHED = 'togglewatched'
+        UP = 'up'
+        VERTICALSHIFTDOWN = 'verticalshiftdown'
+        VERTICALSHIFTUP = 'verticalshiftup'
+        VOLAMPDOWN = 'volampdown'
+        VOLAMPUP = 'volampup'
+        VOLUMEAMPLIFICATION = 'volumeamplification'
+        VOLUMEDOWN = 'volumedown'
+        VOLUMEUP = 'volumeup'
+        WHEELDOWN = 'wheeldown'
+        WHEELUP = 'wheelup'
+        YELLOW = 'yellow'
+        ZOOMGESTURE = 'zoomgesture'
+        ZOOMIN = 'zoomin'
+        ZOOMLEVEL1 = 'zoomlevel1'
+        ZOOMLEVEL2 = 'zoomlevel2'
+        ZOOMLEVEL3 = 'zoomlevel3'
+        ZOOMLEVEL4 = 'zoomlevel4'
+        ZOOMLEVEL5 = 'zoomlevel5'
+        ZOOMLEVEL6 = 'zoomlevel6'
+        ZOOMLEVEL7 = 'zoomlevel7'
+        ZOOMLEVEL8 = 'zoomlevel8'
+        ZOOMLEVEL9 = 'zoomlevel9'
+        ZOOMNORMAL = 'zoomnormal'
+        ZOOMOUT = 'zoomout'
+      end
+    end
+  end
+end
+

data/lib/kodi_client/global_types/list_types.rb

@@ -41,6 +41,33 @@ module KodiClient
         end
       end
 
+      # ascending/descending for sorting
+      module SortOrder
+        extend Iterable
+
+        ASCENDING = 'ascending'
+        DESCENDING = 'descending'
+      end
+
+      # List.Sort https://kodi.wiki/view/JSON-RPC_API/v12#List.Sort
+      class ListSort
+        include Comparable
+
+        attr_reader :ignore_article, :method, :order, :use_artist_sort_name
+
+        def initialize(ignore_article = false, method = ListSortMethod::NONE,
+                       sortOrder = SortOrder::ASCENDING, use_artist_sort_name = false)
+          @ignore_article = ignore_article
+          @method = method
+          @order = SortOrder::ASCENDING
+          @use_artist_sort_name = use_artist_sort_name
+        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
@@ -241,6 +268,53 @@ module KodiClient
           compare(self, other)
         end
       end
+
+      # methods for list sorting
+      module ListSortMethod
+        extend Iterable
+
+        NONE = 'none'
+        LABEL = 'label'
+        DATE = 'date'
+        SIZE = 'size'
+        FILE = 'file'
+        PATH = 'path'
+        DRIVE_TYPE = 'drivetype'
+        TITLE = 'title'
+        TRACK = 'track'
+        TIME = 'time'
+        ARTIST = 'artist'
+        ALBUM = 'album'
+        ALBUM_TYPE = 'albumtype'
+        GENRE = 'genre'
+        COUNTRY = 'country'
+        YEAR = 'year'
+        RATING = 'rating'
+        USER_RATING = 'userrating'
+        VOTES = 'votes'
+        TOP_250 = 'top250'
+        PROGRAM_COUNT = 'programcount'
+        PLAYLIST = 'playlist'
+        EPISODE = 'episode'
+        SEASON = 'season'
+        TOTAL_EPISODES = 'totalepisodes'
+        WATCHED_EPISODES = 'watchedepisodes'
+        TV_SHOW_STATUS = 'tvshowstatus'
+        TV_SHOW_TITLE = 'tvshowtitle'
+        SORT_TITLE = 'sorttitle'
+        PRODUCTION_CODE = 'productioncode'
+        MPAA = 'mpaa'
+        STUDIO = 'studio'
+        DATE_ADDED = 'dateadded'
+        LAST_PLAYED = 'lastplayed'
+        PLAY_COUNT = 'playcount'
+        LISTENERS = 'listeners'
+        BITRATE = 'bitrate'
+        RANDOM = 'random'
+        TOTAL_DISCS = 'totaldiscs'
+        ORIGINAL_DATE = 'originaldate'
+        BPM = 'bpm'
+      end
     end
   end
 end

data/lib/kodi_client/global_types/profiles_types.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/iterable'
+require 'kodi_client/global_types/item_types'
+
+module KodiClient
+  module Types
+    module Profiles
+
+      # Profiles.Fields.Profile https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Fields.Profile
+      module FieldsProfile
+        extend Iterable
+
+        LOCK_MODE = 'lockmode'
+        THUMBNAIL = 'thumbnail'
+      end
+
+      # Profiles.Details.Profile https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Details.Profile
+      class DetailsProfile
+        include Comparable
+        include Items::ItemDetailsBase
+
+        attr_reader :lock_mode, :thumbnail
+
+        def initialize(hash)
+          @lock_mode = hash['lockmode']
+          @thumbnail = hash['thumbnail']
+          item_details_base(hash)
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # return type for Profiles.GetProfiles
+      class GetProfilesReturned
+        include Comparable
+
+        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
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Profiles.Password https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Password
+      class ProfilePassword
+        include Comparable
+
+        attr_reader :value, :encryption
+
+        def initialize(value, encryption = Types::Global::PasswordEncryption::MD5)
+          @value = value
+          @encryption = encryption
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/pvr_type.rb

@@ -8,6 +8,8 @@ module KodiClient
 
       # PVR.Channel.Type https://kodi.wiki/view/JSON-RPC_API/v12#PVR.Channel.Type
       module ChannelType
+        extend Iterable
+        
         TV = 'TV'
         RADIO = 'Radio'
       end

data/lib/kodi_client/global_types/system_types.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/iterable'
+require 'kodi_client/util/comparable'
+
+module KodiClient
+  module Types
+    module System
+
+      # System.Property.Name https://kodi.wiki/view/JSON-RPC_API/v12#System.Property.Name
+      module PropertyName
+        extend Iterable
+
+        CAN_SHUTDOWN = 'canshutdown'
+        CAN_SUSPEND = 'cansuspend'
+        CAN_HIBERNATE = 'canhibernate'
+        CAN_REBOOT = 'canreboot'
+      end
+
+      # System.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#System.Property.Value
+      class PropertyValue
+        include Comparable
+
+        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)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/kodi_module.rb

@@ -17,6 +17,7 @@ module KodiClient
       h = request.instance_variables.each_with_object({}) do |var, hash|
         hash[var.to_s.delete('@')] = request.instance_variable_get(var)
       end
+
       @http_client ||= build_client
       response = @http_client.post(@endpoint_url, json: h).to_s
       JSON.parse(response)

data/lib/kodi_client/method/favourites.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/favourites_types'
+
+module KodiClient
+  module Modules
+    # contains all Kodi Application methods
+    class Favourites < KodiModule
+
+      ADD_FAVOURITE = 'Favourites.AddFavourite'
+      GET_FAVOURITES = 'Favourites.GetFavourites'
+
+      def add_favourite(title, type = Types::Favourites::Type::UNKNOWN, path = nil, window = nil,
+                        window_parameter = nil, thumbnail = nil, kodi_id = 1)
+        params = { 'title' => title, 'type' => type }
+        params['path'] = path unless path.nil?
+        params['window'] = window unless window.nil?
+        params['windowparameter'] = window_parameter unless window_parameter.nil?
+        params['thumbnail'] = thumbnail unless thumbnail.nil?
+        request = KodiRequest.new(kodi_id, ADD_FAVOURITE, params)
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def get_favourites(properties = Types::Favourites::FieldsFavourite.all_properties, type = nil, kodi_id = 1)
+        params = { 'properties' => properties }
+        params['type'] = type unless type.nil?
+        request = KodiRequest.new(kodi_id, GET_FAVOURITES, params)
+        json = invoke_api(request)
+        result = json['result'].nil? ? nil : Types::Favourites::GetFavouriteReturned.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+    end
+  end
+end
+
+# 'path' => path,
+#   'window' => window, 'windowparameter' => windowparameter,
+#   'thumbnail' => thumbnail

data/lib/kodi_client/method/input.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'kodi_client/global_types/gui_types'
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/input_types'
+
+module KodiClient
+  module Modules
+    # contains all Kodi Input methods
+    class Input < KodiModule
+
+      BACK = 'Input.Back'
+      CONTEXT_MENU = 'Input.ContextMenu'
+      DOWN = 'Input.Down'
+      EXECUTE_ACTION = 'Input.ExecuteAction'
+      HOME = 'Input.Home'
+      INFO = 'Input.Info'
+      LEFT = 'Input.Left'
+      RIGHT = 'Input.Right'
+      SELECT = 'Input.Select'
+      SEND_TEXT = 'Input.SendText'
+      SHOW_CODEC = 'Input.ShowCodec'
+      SHOW_OSD = 'Input.ShowOSD'
+      SHOW_PLAYER_PROCESS_INFO = 'Input.ShowPlayerProcessInfo'
+      UP = 'Input.Up'
+
+      def back(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, BACK, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def context_menu(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, CONTEXT_MENU, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def down(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, DOWN, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def execute_action(action = Types::Input::InputAction::BACK, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, EXECUTE_ACTION, { 'action' => action })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def home(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, HOME, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def info(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, INFO, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def left(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, LEFT, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def right(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, RIGHT, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def select(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SELECT, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def send_text(text, done = true, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SEND_TEXT, { 'text' => text, 'done' => done})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def show_codec(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SHOW_CODEC, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def show_osd(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SHOW_OSD, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def show_player_process_info(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SHOW_PLAYER_PROCESS_INFO, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def up(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, UP, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client/method/profiles.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/profiles_types'
+
+module KodiClient
+  module Modules
+    # contains all Kodi Application methods
+    class Profiles < KodiModule
+
+      GET_CURRENT_PROFILE = 'Profiles.GetCurrentProfile'
+      GET_PROFILES = 'Profiles.GetProfiles'
+      LOAD_PROFILE = 'Profiles.LoadProfile'
+
+      def get_current_profile(properties = Types::Profiles::FieldsProfile.all_properties, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_CURRENT_PROFILE, { 'properties' => properties })
+        json = invoke_api(request)
+        result = json['result'].nil? ? nil : Types::Profiles::DetailsProfile.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_profiles(properties = Types::Profiles::FieldsProfile.all_properties,
+                       limit = Types::List::ListLimits.new(0, 50),
+                       sort = Types::List::ListSort.new, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_PROFILES,
+                                  { 'properties' => properties,
+                                    'limits' => { 'start' => limit.list_start, 'end' => limit.list_end },
+                                    'sort' => { 'ignorearticle' => sort.ignore_article, 'method' => sort.method,
+                                                'order' => sort.order,
+                                                'useartistsortname' => sort.use_artist_sort_name } })
+        json = invoke_api(request)
+        result = json['result'].nil? ? nil : Types::Profiles::GetProfilesReturned.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def load_profile(profile_name, password, prompt = false, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, LOAD_PROFILE,
+                                  { 'profile' => profile_name,
+                                    'password' => { 'value' => password.value, 'encryption' => password.encryption },
+                                    'prompt' => prompt })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client/method/system.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'kodi_client/global_types/gui_types'
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/system_types'
+
+module KodiClient
+  module Modules
+    # contains all Kodi System methods
+    class System < KodiModule
+
+      EJECT_OPTICAL_DRIVE = 'System.EjectOpticalDrive'
+      GET_PROPERTIES = 'System.GetProperties'
+      HIBERNATE = 'System.Hibernate'
+      REBOOT = 'System.Reboot'
+      SHUTDOWN = 'System.Shutdown'
+      SUSPEND = 'System.Suspend'
+
+      def eject_optical_drive(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, EJECT_OPTICAL_DRIVE, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def get_properties(properties = Types::System::PropertyName.all_properties, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_PROPERTIES, { 'properties' => properties })
+        json = invoke_api(request)
+        result = json['result'].nil? ? nil : Types::System::PropertyValue.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def hibernate(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, HIBERNATE, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def reboot(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, REBOOT, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def shutdown(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SHUTDOWN, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def suspend(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SUSPEND, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client.rb

@@ -6,8 +6,12 @@ require 'json'
 require 'kodi_client/Chainable'
 require 'kodi_client/method/addons'
 require 'kodi_client/method/application'
+require 'kodi_client/method/favourites'
 require 'kodi_client/method/gui'
+require 'kodi_client/method/input'
 require 'kodi_client/method/player'
+require 'kodi_client/method/profiles'
+require 'kodi_client/method/system'
 
 
 # client for Kodi rest api https://kodi.wiki/view/JSON-RPC_API/v12
@@ -18,20 +22,28 @@ module KodiClient
   class Client
     include Chainable
 
-    attr_reader :addons, :application, :gui, :player
+    attr_reader :addons, :application, :gui, :player, :input, :favourites, :system, :profiles
 
     def initialize
       @addons = KodiClient::Modules::Addons.new
       @application = KodiClient::Modules::Application.new
+      @favourites = KodiClient::Modules::Favourites.new
       @gui = KodiClient::Modules::GUI.new
+      @input = KodiClient::Modules::Input.new
       @player = KodiClient::Modules::Player.new
+      @profiles = KodiClient::Modules::Profiles.new
+      @system = KodiClient::Modules::System.new
     end
 
     def apply_options(options)
       @addons.apply_options(options)
       @application.apply_options(options)
       @gui.apply_options(options)
+      @input.apply_options(options)
       @player.apply_options(options)
+      @favourites.apply_options(options)
+      @profiles.apply_options(options)
+      @system.apply_options(options)
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kodi_client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.6
 platform: ruby
 authors:
 - Christian Feier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-15 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -25,9 +25,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.4
 description: A client for the Kodi JSON API v12, currently implemented methods are
-  addons, application, gui and player (more will be added with the time). For more
-  information how to use it and how to activate Remote Control in Kodi, please check
-  the github page https://github.com/cfe86/RubyKodiClient
+  addons, application, favourites, gui, input, player, profile and system (more will
+  be added with the time). For more information how to use it and how to activate
+  Remote Control in Kodi, please check the github page https://github.com/cfe86/RubyKodiClient
 email:
 - christian.feier@gmail.com
 executables: []
@@ -46,19 +46,27 @@ files:
 - lib/kodi_client/global_types/addon_types.rb
 - lib/kodi_client/global_types/application_types.rb
 - lib/kodi_client/global_types/audio_types.rb
+- lib/kodi_client/global_types/favourites_types.rb
 - lib/kodi_client/global_types/global_types.rb
 - lib/kodi_client/global_types/gui_types.rb
+- lib/kodi_client/global_types/input_types.rb
 - lib/kodi_client/global_types/item_types.rb
 - lib/kodi_client/global_types/list_types.rb
 - lib/kodi_client/global_types/media_types.rb
 - lib/kodi_client/global_types/player_type.rb
+- lib/kodi_client/global_types/profiles_types.rb
 - lib/kodi_client/global_types/pvr_type.rb
+- lib/kodi_client/global_types/system_types.rb
 - lib/kodi_client/global_types/video_types.rb
 - lib/kodi_client/kodi_module.rb
 - lib/kodi_client/method/addons.rb
 - lib/kodi_client/method/application.rb
+- lib/kodi_client/method/favourites.rb
 - lib/kodi_client/method/gui.rb
+- lib/kodi_client/method/input.rb
 - lib/kodi_client/method/player.rb
+- lib/kodi_client/method/profiles.rb
+- lib/kodi_client/method/system.rb
 - lib/kodi_client/options.rb
 - lib/kodi_client/util/comparable.rb
 - lib/kodi_client/util/iterable.rb