kodi_client 0.4.1 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d626f5d559146d9c8d24b29cbcc1a87b05c0653d0b092d593bef0da9390cfded
-  data.tar.gz: '0841f786338f19c0c8341ebc7cc71aec0131a308af374bdd7a5347ab7acd41ad'
+  metadata.gz: 860eb2c3848cb508f5faaad0bf3716e330d1cb1113ebdfd6d847ccd33302d360
+  data.tar.gz: d51f977964b4a89698985c7cfb5f78f83b83a1c00502d436eee6b84550177f28
 SHA512:
-  metadata.gz: 357427f184bb3c50c6fb30ae226e014800cd3264726d6cad187efad951a7f724e7d37f5f728cce8c0cfaad7efdcd719be01e6097263da33f69975b4829490e15
-  data.tar.gz: 0e6e1d0fa1b67859cfc19489bf1694c95ee432f30f8afc3c78358823c4e777c928dd3a3eb679b00d3825201363a69514f060001f11b49b9f8d793693cf73bd2b
+  metadata.gz: 55f60b1ad247d88fcb77ae527a3b47a43521853d8f3d06f6fbe29db07ec465fb91c29a6146ec20414dadb0c00191172e974fae29291d63d1cbabd50e2105666d
+  data.tar.gz: dad48a6e2c40302af39190e88a531d268f7b20f08cdac4322f73406c78d5b1a02df351faa260afab5094edb1aa1f301cce4be6c2c2c2c707c32e7c59c15cbf5a

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,7 +5,9 @@ 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
 
 ## Installation
@@ -19,7 +21,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,12 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'kodi_client'
-  spec.version       = '0.4.1'
+  spec.version       = '0.4.5'
   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 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.homepage      = 'https://github.com/cfe86/RubyKodiClient'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.5.0'

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 Favourite
+        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| Favourite.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/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
+        include 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/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.rb

@@ -6,7 +6,9 @@ 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'
 
 
@@ -18,12 +20,14 @@ module KodiClient
   class Client
     include Chainable
 
-    attr_reader :addons, :application, :gui, :player
+    attr_reader :addons, :application, :gui, :player, :input, :favourites
 
     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
     end
 
@@ -31,7 +35,9 @@ module KodiClient
       @addons.apply_options(options)
       @application.apply_options(options)
       @gui.apply_options(options)
+      @input.apply_options(options)
       @player.apply_options(options)
+      @favourites.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.4.5
 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 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
 email:
 - christian.feier@gmail.com
 executables: []
@@ -46,8 +46,10 @@ 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
@@ -57,7 +59,9 @@ files:
 - 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/options.rb
 - lib/kodi_client/util/comparable.rb