kodi_client 0.4.0

data/lib/kodi_client/global_types/player_type.rb

@@ -0,0 +1,300 @@
+# frozen_string_literal: true
+
+require 'kodi_client/global_types/item_types'
+require 'kodi_client/global_types/global_types'
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/iterable'
+
+module KodiClient
+  module Types
+    module Player
+
+      # enum for in/out zoom
+      module Zoom
+        extend Iterable
+
+        IN = 'in'
+        OUT = 'out'
+      end
+
+      # Player.ViewMode https://kodi.wiki/view/JSON-RPC_API/v12#Player.ViewMode
+      module ViewMode
+        extend Iterable
+        NORMAL = 'normal'
+        ZOOM = 'zoom'
+        STRETCH_4x3 = 'strech4x3'
+        WIDE_ZOOM = 'widezoom'
+        STRETCH_16x9 = 'stretch16x9'
+        ORIGINAL = 'original'
+        STRETCH_16x9_NONLIN = 'stretch16x9nonline'
+        ZOOM_120_WIDTH = 'zoom120width'
+        ZOOM_110_WIDTH = 'zoom110width'
+      end
+
+      # player types
+      module PlayerVisibilityType
+        extend Iterable
+        INTERNAL = 'internal'
+        EXTERNAL = 'external'
+        REMOTE = 'remote'
+      end
+
+      # Player.Type https://kodi.wiki/view/JSON-RPC_API/v12#Player.Type
+      module PlayerType
+        extend Iterable
+
+        VIDEO = 'video'
+        AUDIO = 'audio'
+        PICTURE = 'picture'
+      end
+
+      # Player.Repeat https://kodi.wiki/view/JSON-RPC_API/v12#Player.Repeat
+      module PlayerRepeat
+        extend Iterable
+
+        OFF = 'off'
+        ONE = 'one'
+        ALL = 'all'
+        CYCLE = 'cycle'
+      end
+
+      # player speed enum, -32 to 32
+      module PlayerSpeed
+        extend Iterable
+
+        MINUS_32 = -32
+        MINUS_16 = -16
+        MINUS_8 = -8
+        MINUS_4 = -4
+        MINUS_2 = -2
+        MINUS_1 = -1
+        NEUTRAL = 0
+        PLUS_1 = 1
+        PLUS_2 = 2
+        PLUS_4 = 4
+        PLUS_8 = 8
+        PLUS_16 = 16
+        PLUS_32 = 32
+      end
+
+      # player id and type
+      class Player
+        include Comparable
+
+        attr_reader :player_id, :player_type, :type, :name, :plays_audio, :plays_video
+
+        def initialize(hash)
+          @player_id = hash['playerid']
+          @player_type = hash['playertype']
+          @type = hash['type']
+          @name = hash['name']
+          @plays_audio = hash['playsaudio']
+          @plays_video = hash['playsvideo']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Player Subtitle https://kodi.wiki/view/JSON-RPC_API/v12#Player.Subtitle
+      class Subtitle
+        include Comparable
+
+        attr_reader :index, :is_default, :is_forced, :is_impaired, :language, :name
+
+        def initialize(hash)
+          @index = hash['index']
+          @is_default = hash['isdefault']
+          @is_forced = hash['isforced']
+          @is_impaired = hash['isimpaired']
+          @language = hash['language']
+          @name = hash['name']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Player.Audio.Stream https://kodi.wiki/view/JSON-RPC_API/v12#Player.Audio.Stream
+      class AudioStream
+        include Comparable
+
+        attr_reader :bitrate, :channels, :codec, :index, :is_default, :is_forced, :is_original, :language,
+                    :name, :sample_rate
+
+        def initialize(hash)
+          @bitrate = hash['bitrate']
+          @channels = hash['channels']
+          @codec = hash['codec']
+          @index = hash['index']
+          @is_default = hash['isdefault']
+          @is_forced = hash['isforced']
+          @is_original = hash['isoriginal']
+          @language = hash['language']
+          @name = hash['name']
+          @sample_rate = hash['samplerate']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Player.Video.Stream https://kodi.wiki/view/JSON-RPC_API/v12#Player.Video.Stream
+      class VideoStream
+        include Comparable
+
+        attr_reader :codec, :height, :index, :language, :name, :width, :duration, :aspect
+
+        def initialize(hash)
+          @codec = hash['codec']
+          @height = hash['height']
+          @index = hash['index']
+          @language = hash['language']
+          @name = hash['name']
+          @width = hash['width']
+          @duration = hash['duration']
+          @aspect = hash['aspect']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Player.Property.Name https://kodi.wiki/view/JSON-RPC_API/v12#Player.Property.Name
+      module PropertyName
+        extend Iterable
+
+        AUDIOSTREAMS = 'audiostreams'
+        CANCHANGESPEED = 'canchangespeed'
+        CANMOVE = 'canmove'
+        CANREPEAT = 'canrepeat'
+        CANROTATE = 'canrotate'
+        CANSEEK = 'canseek'
+        CANSHUFFLE = 'canshuffle'
+        CANZOOM = 'canzoom'
+        CURRENTAUDIOSTREAM = 'currentaudiostream'
+        CURRENTSUBTITLE = 'currentsubtitle'
+        CURRENTVIDEOSTREAM = 'currentvideostream'
+        LIVE = 'live'
+        PARTYMODE = 'partymode'
+        PERCENTAGE = 'percentage'
+        PLAYLISTID = 'playlistid'
+        POSITION = 'position'
+        REPEAT = 'repeat'
+        SHUFFLED = 'shuffled'
+        SPEED = 'speed'
+        SUBTITLEENABLED = 'subtitleenabled'
+        SUBTITLES = 'subtitles'
+        TIME = 'time'
+        TOTALTIME = 'totaltime'
+        TYPE = 'type'
+        VIDEOSTREAMS = 'videostreams'
+      end
+
+      # Player.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#Player.Property.Name
+      class PropertyValue
+        include Comparable
+
+        def initialize(hash)
+          @audio_streams = hash['audiostreams'].map { |it| AudioStream.new(it) }
+          @cache_percentage = hash['cachepercentage']
+          @can_change_speed = hash['canchangespeed']
+          @can_move = hash['canmove']
+          @can_repeat = hash['canrepeat']
+          @can_rotate = hash['canrotate']
+          @can_seek = hash['canseek']
+          @can_shuffle = hash['canshuffle']
+          @can_zoom = hash['canzoom']
+          @current_audio_stream = AudioStream.new(hash['currentaudiostream'])
+          @current_subtitle = Subtitle.new(hash['currentsubtitle'])
+          @current_video_stream = VideoStream.new(hash['currentvideostream'])
+          @live = hash['live']
+          @party_mode = hash['partymode']
+          @percentage = hash['percentage']
+          @playlist_id = hash['playlistid'].nil? ? -1 : hash['playlistid']
+          @position = hash['position'].nil? ? -1 : hash['position']
+          @position = hash['position'].nil? ? -1 : hash['position']
+          @repeat = hash['repeat'].nil? ? PlayerRepeat::OFF : hash['repeat']
+          @shuffled = hash['shuffled']
+          @speed = hash['speed']
+          @subtitle_enabled = hash['subtitleenabled']
+          @subtitles = hash['subtitles'].map { |it| Subtitle.new(it) }
+          @time = Types::Global::GlobalTime.new(hash['time'])
+          @total_time = Types::Global::GlobalTime.new(hash['totaltime'])
+          @type = hash['type'].nil? ? PlayerType::VIDEO : hash['type']
+          @video_streams = hash['videostreams'].map { |it| VideoStream.new(it) }
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # return value for Player.GetViewMode
+      class PlayerViewMode
+        include Comparable
+
+        attr_reader :nonlinear_stretch, :pixel_ratio, :vertical_shift, :view_mode, :zoom
+
+        def initialize(hash)
+          @nonlinear_stretch = hash['nonlinearstretch']
+          @pixel_ratio = hash['pixelratio']
+          @vertical_shift = hash['verticalshift']
+          @view_mode = hash['viewed']
+          @zoom = hash['zoom']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Player.Position.Time https://kodi.wiki/view/JSON-RPC_API/v12#Player.Position.Time
+      class PlayerPositionTime
+        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
+
+      # defines  the jump size for seek
+      module SeekJump
+        include Iterable
+
+        SMALL_FORWARD = 'smallforward'
+        SMALL_BACKWARD = 'smallbackward'
+        BIG_FORWARD = 'bigforward'
+        BIG_BACKWARD = 'bigbackward'
+      end
+
+      # return value of Player.Seek
+      class SeekReturnValue
+        include Comparable
+
+        def initialize(hash)
+          @percentage = hash['percentage']
+          @time = Types::Global::GlobalTime.new(hash['time'])
+          @total_time = Types::Global::GlobalTime.new(hash['totaltime'])
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/pvr_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/iterable'
+
+module KodiClient
+  module Types
+    module PVR
+
+      # PVR.Channel.Type https://kodi.wiki/view/JSON-RPC_API/v12#PVR.Channel.Type
+      module ChannelType
+        TV = 'TV'
+        RADIO = 'Radio'
+      end
+    end
+  end
+end
+

data/lib/kodi_client/global_types/video_types.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'kodi_client/global_types/media_types'
+require 'kodi_client/global_types/player_type'
+require 'kodi_client/util/comparable'
+
+module KodiClient
+  module Types
+    module Video
+
+      # Video.Details.Base https://kodi.wiki/view/JSON-RPC_API/v12#Video.Details.Base
+      module VideoDetailsBase
+        include Media::MediaDetailsBase
+
+        attr_reader :art, :play_count
+
+        def video_details_base(hash)
+          @art = Types::Media::MediaArtwork.new(hash['art'])
+          @play_count = ['playcount']
+          media_details_base(hash)
+        end
+      end
+
+      # Video.Cast https://kodi.wiki/view/JSON-RPC_API/v12#Video.Cast
+      class VideoCast
+        include Comparable
+
+        attr_reader :name, :order, :role, :thumbnail
+
+        def initialize(hash)
+          @name = hash['name']
+          @order = hash['order']
+          @role = hash['role']
+          @thumbnail = hash['thumbnail']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Video.Details.Media https://kodi.wiki/view/JSON-RPC_API/v12#Video.Details.Media
+      module VideoDetailsMedia
+        include VideoDetailsBase
+
+        attr_reader :title
+
+        def video_details_media(hash)
+          @title = hash['title']
+          video_details_base(hash)
+        end
+      end
+
+      # Video.Details.Item https://kodi.wiki/view/JSON-RPC_API/v12#Video.Details.Item
+      module VideoDetailsItem
+        include VideoDetailsMedia
+
+        attr_reader :date_added, :file, :last_played, :plot
+
+        def video_details_item(hash)
+          @date_added = hash['dateadded']
+          @file = hash['file']
+          @last_played = hash['lastplayed']
+          @plot = hash['plot']
+          video_details_media(hash)
+        end
+      end
+
+      # Video.Details.File https://kodi.wiki/view/JSON-RPC_API/v12#Video.Details.File
+      module VideoDetailsFile
+        include VideoDetailsItem
+
+        attr_reader :director, :resume, :runtime, :stream_details
+
+        def video_details_file(hash)
+          @director = hash['director']
+          @resume = VideoResume.new(hash['resume'])
+          @runtime = hash['runtime']
+          @stream_details = Streams.new(hash['streamdetails'])
+          video_details_item(hash)
+        end
+      end
+
+      # Video.Resume https://kodi.wiki/view/JSON-RPC_API/v12#Video.Resume
+      class VideoResume
+        include Comparable
+
+        attr_reader :position, :total
+
+        def initialize(hash)
+          @position = hash['position']
+          @total = hash['total']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Video.Streams https://kodi.wiki/view/JSON-RPC_API/v12#Video.Streams
+      class Streams
+        include Comparable
+
+        attr_reader :audio, :subtitle, :video
+
+        def initialize(hash)
+          @audio = hash['audio'].nil? ? [] : hash['audio'].map { |it| Types::Player::AudioStream.new(it) }
+          @subtitle = hash['subtitle'].nil? ? [] : hash['subtitle'].map { |it| Types::Player::Subtitle.new(it) }
+          @video = hash['video'].nil? ? [] : hash['video'].map { |it| Types::Player::VideoStream.new(it) }
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/kodi_module.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'kodi_client/util/comparable'
+
+module KodiClient
+
+  # the client that stores
+  class KodiModule
+
+    def apply_options(options)
+      @endpoint_url = "#{options.tls ? 'https://' : 'http://'}#{options.ip}:#{options.port}/jsonrpc"
+      @options = options
+    end
+
+    def invoke_api(request)
+      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)
+    end
+
+    def build_client
+      client = HTTP.headers(Content_Type: 'application/json')
+      if !@options.username.nil? && !@options.password.nil?
+        client = client.basic_auth({ user: @options.username, pass: @options.password })
+      end
+
+      client
+    end
+
+    private :build_client
+  end
+
+  # represents an error response
+  class KodiError
+
+    attr_reader :code, :message
+
+    def initialize(hash)
+      @code = hash['code']
+      @message = hash['message']
+    end
+
+    def ==(other)
+      @code == other.code && @message == other.message
+    end
+  end
+
+  # represents a kodi requests
+  class KodiRequest
+
+    attr_accessor :id, :jsonrpc, :method, :params
+
+    def initialize(kodi_id, method, params = {}, jsonrpc = '2.0')
+      @id = kodi_id
+      @jsonrpc = jsonrpc
+      @method = method
+      @params = params
+    end
+  end
+
+  # represents a kodi response
+  class KodiResponse
+    include Comparable
+
+    attr_reader :id, :jsonrpc, :result, :error
+
+    def initialize(hash)
+      @id = hash['id']
+      @jsonrpc = hash['jsonrpc']
+      @result = hash['result']
+      @error = KodiError.new(hash['error']) unless hash['error'].nil?
+    end
+
+    def error?
+      !@error.nil?
+    end
+
+    def ==(other)
+      compare(self, other)
+    end
+  end
+end

data/lib/kodi_client/method/addons.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/addon_types'
+require 'kodi_client/global_types/list_types'
+
+module KodiClient
+  module Modules
+    # contains all Kodi Application methods
+    class Addons < KodiModule
+
+      EXECUTE_ADDON = 'Addons.ExecuteAddon'
+      GET_ADDON_DETAILS = 'Addons.GetAddonDetails'
+      GET_ADDONS = 'Addons.GetAddons'
+      SET_ADDON_ENABLED = 'Addons.SetAddonEnabled'
+
+      def get_addons(type = Types::Addons::AddonTypes::UNKNOWN,
+                     content = Types::Addons::AddonContent::UNKNOWN,
+                     enabled = nil, properties = [],
+                     limit = Types::List::ListLimits.new(0, 50), installed = nil, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_ADDONS,
+                                  {
+                                    'type' => type,
+                                    'content' => content,
+                                    'enabled' => enabled.nil? || !enabled ? 'all' : 'enabled',
+                                    'properties' => properties,
+                                    'limits' => { 'start' => limit.list_start, 'end' => limit.list_end },
+                                    'installed' => installed.nil? || !installed ? 'all' : 'installed'
+                                  })
+        json = invoke_api(request)
+
+        result = json['result'].nil? ? nil : Types::Addons::Addons.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_addon_details(addon_id = nil, properties = [], kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_ADDON_DETAILS,
+                                  {
+                                    'addonid' => addon_id,
+                                    'properties' => properties
+                                  })
+        json = invoke_api(request)
+
+        result = json['result'].nil? ? nil : Types::Addons::Addon.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def execute_addon(addon_id = nil, params = '', wait = false, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, EXECUTE_ADDON,
+                                  {
+                                    'addonid' => addon_id,
+                                    'params' => params,
+                                    'wait' => wait
+                                  })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def set_addon_enabled(addon_id = nil, enabled = Types::Global::Toggle::TOGGLE, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SET_ADDON_ENABLED,
+                                  {
+                                    'addonid' => addon_id,
+                                    'enabled' => enabled
+                                  })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client/method/application.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/application_types'
+
+module KodiClient
+  module Modules
+    # contains all Kodi Application methods
+    class Application < KodiModule
+
+      QUIT = 'Application.Quit'
+      SET_MUTE = 'Application.SetMute'
+      SET_VOLUME = 'Application.SetVolume'
+      GET_PROPERTIES = 'Application.GetProperties'
+
+      def quit(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, QUIT)
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def mute(kodi_id = 1, mute_state: Types::Global::Toggle::TOGGLE)
+        request = KodiRequest.new(kodi_id, SET_MUTE, { 'mute' => mute_state })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def get_properties(properties = Types::Application::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::Application::PropertyValue.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def set_volume(volume, kodi_id = 1)
+        set_volume_incr_decr_vol(volume, kodi_id)
+      end
+
+      def increment_volume(kodi_id = 1)
+        set_volume_incr_decr_vol(Types::Global::IncrementDecrement::INCREMENT, kodi_id)
+      end
+
+      def decrement_volume(kodi_id = 1)
+        set_volume_incr_decr_vol(Types::Global::IncrementDecrement::INCREMENT, kodi_id)
+      end
+
+      def set_volume_incr_decr_vol(volume, kodi_id = 1)
+        if volume.is_a?(Integer) && (volume > 100 || volume.negative?)
+          throw ArgumentError.new('Volume must be between 0 and 100.')
+        end
+        request = KodiRequest.new(kodi_id, SET_VOLUME, { 'volume' => volume })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      private :set_volume_incr_decr_vol
+    end
+  end
+end