kodi_client 0.4.0

data/lib/kodi_client/method/gui.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'kodi_client/global_types/gui_types'
+require 'kodi_client/kodi_module'
+
+module KodiClient
+  module Modules
+    # contains all Kodi GUI methods
+    class GUI < KodiModule
+
+      ACTIVATE_WINDOW = 'GUI.ActivateWindow'
+      GET_PROPERTIES = 'GUI.GetProperties'
+      GET_STEREOSCOPIC_MODES = 'GUI.GetStereoscopicModes'
+      SET_STEREOSCOPIC_MODES = 'GUI.SetStereoscopicMode'
+      SET_FULLSCREEN = 'GUI.SetFullscreen'
+      SHOW_NOTIFICATION = 'GUI.ShowNotification'
+
+      def activate_window(window = Types::GUI::GUIWindow::HOME, parameters = [], kodi_id = 1)
+        request = KodiRequest.new(kodi_id, ACTIVATE_WINDOW, { 'window' => window, 'parameters' => parameters })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def get_properties(properties = Types::GUI::PropertyName.all_properties, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_PROPERTIES, { 'properties' => properties })
+        json = invoke_api(request)
+        result = json['result'].nil? ? nil : KodiClient::Types::GUI::PropertyValue.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_stereoscopic_modes(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_STEREOSCOPIC_MODES, {})
+        json = invoke_api(request)
+        result = json['result'].nil? ? nil : json['result']['stereoscopicmodes'].map { |it| Types::GUI::StereoscopyMode.new(it) }
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def set_fullscreen(fullscreen = Types::Global::Toggle, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_FULLSCREEN, { 'fullscreen' => fullscreen })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def set_stereoscopic_mode(mode = Types::GUI::StereoscopyMode::OFF, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_STEREOSCOPIC_MODES, { 'mode' => mode })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def show_notification(title, message, image = '', display_time_in_ms = 5000, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SHOW_NOTIFICATION, { 'title' => title,
+                                                                'message' => message,
+                                                                'image' => image,
+                                                                'displaytime' => display_time_in_ms })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client/method/player.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/addon_types'
+require 'kodi_client/global_types/list_types'
+require 'kodi_client/global_types/player_type'
+
+module KodiClient
+  module Modules
+    # contains all Kodi Application methods
+    class Player < KodiModule
+
+      ADD_SUBTITLE = 'Player.AddSubtitle'
+      OPEN = 'Player.Open'
+      GET_ACTIVE_PLAYER = 'Player.GetActivePlayers'
+      GET_ITEM = 'Player.GetItem'
+      GET_PLAYERS = 'Player.GetPlayers'
+      GET_PROPERTIES = 'Player.GetProperties'
+      GET_VIEW_MODE = 'Player.GetViewMode'
+      GO_TO = 'Player.GoTo'
+      MOVE = 'Player.Move'
+      ROTATE = 'Player.Rotate'
+      PLAY_PAUSE = 'Player.PlayPause'
+      SEEK = 'Player.Seek'
+      SET_AUDIO_STREAM = 'Player.SetAudioStream'
+      SET_PARTY_MODE = 'Player.SetPartymode'
+      SET_REPEAT = 'Player.SetRepeat'
+      SET_SPEED = 'Player.SetSpeed'
+      SET_SUBTITLE = 'Player.SetSubtitle'
+      SET_VIDEO_STREAM = 'Player.SetVideoStream'
+      SET_VIEW_MODE = 'Player.SetViewMode'
+      STOP = 'Player.Stop'
+      ZOOM = 'Player.Zoom'
+
+      def add_subtitle(player_id, subtitle, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, ADD_SUBTITLE, { 'playerid' => player_id, 'subtitle' => subtitle })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def get_active_players(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_ACTIVE_PLAYER, {})
+        json = invoke_api(request)
+        result = json['result'].nil? ? nil : json['result'].map { |it| Types::Player::Player.new(it) }
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      # local file or stream url
+      def player_open(file, options = {}, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, OPEN, { 'item' => { 'file' => file }, 'options' => options })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def get_item(player_id, properties = Types::List::ListFieldsAll.all_properties, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_ITEM, { 'playerid' => player_id,
+                                                       'properties' => properties })
+        json = invoke_api(request)
+        result = Types::List::ListItemAll.new(json['result']['item'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_players(media = Types::Media::MediaType::ALL, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_PLAYERS, { 'media' => media })
+        json = invoke_api(request)
+        result = json['result'].map { |it| Types::Player::Player.new(it) }
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_properties(player_id, properties = Types::Player::PropertyName.all_properties, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_PROPERTIES, { 'playerid' => player_id,
+                                                             'properties' => properties })
+        json = invoke_api(request)
+        result = Types::Player::PropertyValue.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_view_mode(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_VIEW_MODE, {})
+        json = invoke_api(request)
+        result = Types::Player::PlayerViewMode.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      # goes to the next/prev item or to a specific item in the playlist
+      #
+      # @param [String] player_id - the player id
+      # @param [Integer/Types::Global::NextPrev] to - playlist position, or prev/next
+      # @param [Integer] kodi_id - the kodi id
+      #
+      # @return [KodiResponse] - OK or Error
+      def go_to(player_id, to = Types::Global::NextPrev::NEXT, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GO_TO, { 'playerid' => player_id, 'to' => to })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def move(player_id, direction = Types::Global::Direction::UP, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, MOVE, { 'playerid' => player_id, 'direction' => direction })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def rotate(player_id, rotate = Types::Global::Rotate::CLOCKWISE, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, ROTATE, { 'playerid' => player_id, 'value' => rotate })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def play_pause(player_id, play = Types::Global::Toggle::TOGGLE, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, PLAY_PAUSE, { 'playerid' => player_id, 'play' => play })
+        json = invoke_api(request)
+        result = json['result']['speed']
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      # seeks to the given position
+      #
+      # @param [Integer] player_id - the player id
+      # @param [Float/PlayerPositionTime/PlayerSeekJump/Integer] value - the seek value in either Percentage,
+      #                                                                  PositionTime, Jump or seek by seconds
+      #
+      # return [KodiResponse] - return percentage, time and total time
+      def seek(player_id, value, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SEEK, { 'playerid' => player_id, 'value' => value })
+        json = invoke_api(request)
+        result = Types::Player::SeekReturnValue.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      # sets the given audio stream
+      #
+      # @param [Integer, Next/Prev] stream - the stream to set, can either be the index or next/prev
+      #
+      # return [KodiResponse] 'OK' or error
+      def set_audio_stream(player_id, stream, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_AUDIO_STREAM, { 'playerid' => player_id, 'stream' => stream })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def set_party_mode(player_id, mode = Types::Global::Toggle::TOGGLE, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_PARTY_MODE, { 'playerid' => player_id, 'partymode' => mode })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def set_repeat(player_id, repeat = Types::Player::PlayerRepeat::ALL, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_REPEAT, { 'playerid' => player_id, 'repeat' => repeat })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def set_speed(player_id, speed = Types::Global::IncrementDecrement::INCREMENT, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_SPEED, { 'playerid' => player_id, 'speed' => speed })
+        json = invoke_api(request)
+        result = json['result']['speed']
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      # sets the subtitle
+      #
+      # @param [Integer] player_id - the player id
+      # @param [Next|Prev/Integer] subtitle - the subtitle to set. Can either be an index or next/prev
+      # @param [Boolean] enabled - true if the set subtitle should be enabled, else false
+      #
+      # @return [KodiResponse] - 'OK' else error
+      def set_subtitle(player_id, subtitle = Types::Global::NextPrev::NEXT, enabled = false, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_SUBTITLE, { 'playerid' => player_id, 'subtitle' => subtitle,
+                                                           'enabled' => enabled })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      # Sets the video stream
+      #
+      # @param [Integer] player_id - the player id
+      # @param [Next|Prev/Integer] stream - the stream to set. Can either be an index or next/prev
+      #
+      # @return [KodiResponse] - 'OK' else error
+      def set_video_stream(player_id, stream = Types::Global::NextPrev::NEXT, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_VIDEO_STREAM, { 'playerid' => player_id, 'stream' => stream })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def set_view_mode(player_id, mode = Types::Player::ViewMode::NORMAL, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_VIEW_MODE, { 'playerid' => player_id, 'viewmode' => mode })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def stop(player_id, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, STOP, { 'playerid' => player_id })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      # Sets the zoom
+      #
+      # @param [Integer] player_id - the player id
+      # @param [Zoom/Integer] zoom - Can either be 1-10 or step In/Out
+      #
+      # @return [KodiResponse] - 'OK' else error
+      def zoom(player_id, zoom, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, ZOOM, { 'playerid' => player_id, 'zoom' => zoom })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client/options.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module KodiClient
+  # holds all options like ip, port, credentials
+  class Options
+
+    attr_accessor :ip, :port, :username, :password, :tls
+
+    def initialize
+      @tls = false
+    end
+
+    def with_connection(ip, port)
+      @ip = ip
+      @port = port
+    end
+
+    def with_auth(username, password)
+      @username = username
+      @password = password
+    end
+
+    def with_tls(enabled: true)
+      @tls = enabled
+    end
+  end
+end

data/lib/kodi_client/util/comparable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module KodiClient
+
+  # offers compare methods
+  module Comparable
+
+    def compare(obj1, obj2)
+      is_same = true
+      obj1.instance_variables.each do |it|
+        is_same = false if obj1.instance_variable_get(it) != obj2.instance_variable_get(it)
+      end
+
+      is_same
+    end
+  end
+end

data/lib/kodi_client/util/iterable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module KodiClient
+
+  # offers iterable methods
+  module Iterable
+    def all_properties
+      constants.map { |it| const_get(it) }.sort!
+    end
+  end
+end

data/lib/kodi_client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'json'
+
+require 'kodi_client/Chainable'
+require 'kodi_client/method/addons'
+require 'kodi_client/method/application'
+require 'kodi_client/method/gui'
+require 'kodi_client/method/player'
+
+
+# client for Kodi rest api https://kodi.wiki/view/JSON-RPC_API/v12
+module KodiClient
+  extend Chainable
+
+  # client that holds all methods such as application, gui etc.
+  class Client
+    include Chainable
+
+    attr_reader :addons, :application, :gui, :player
+
+    def initialize
+      @addons = KodiClient::Modules::Addons.new
+      @application = KodiClient::Modules::Application.new
+      @gui = KodiClient::Modules::GUI.new
+      @player = KodiClient::Modules::Player.new
+    end
+
+    def apply_options(options)
+      @addons.apply_options(options)
+      @application.apply_options(options)
+      @gui.apply_options(options)
+      @player.apply_options(options)
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: kodi_client
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Christian Feier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-15 00:00:00.000000000 Z
+dependencies: []
+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
+email:
+- christian.feier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kodi_client.gemspec
+- lib/kodi_client.rb
+- lib/kodi_client/Chainable.rb
+- 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/global_types.rb
+- lib/kodi_client/global_types/gui_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/pvr_type.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/gui.rb
+- lib/kodi_client/method/player.rb
+- lib/kodi_client/options.rb
+- lib/kodi_client/util/comparable.rb
+- lib/kodi_client/util/iterable.rb
+homepage: https://github.com/cfe86/RubyKodiClient
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cfe86/RubyKodiClient
+  source_code_uri: https://github.com/cfe86/RubyKodiClient
+  changelog_uri: https://github.com/cfe86/RubyKodiClient
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A work-in-progress client for Kodi JSON API v2.
+test_files: []