kodi_client 0.6.0 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5686743b785e5b591798992689064cec6c1e0d48a54721b97d9d28ae5a97ded3
-  data.tar.gz: fc7516af1d65c10ef63897253979bdb67b8d74f6f11bb74c959ccc942f8c026e
+  metadata.gz: a3459e42458d3c4ec86456bd1e5ab18261a636ca9a61a48b6d2db3dbb0706b72
+  data.tar.gz: a1c20cd980f8c5c63fe69652e737495313110268b184cf2b58cf88ff850908b4
 SHA512:
-  metadata.gz: ed6fbc05813a0f0a606c08c2e18606603af576e06f4af5941912097b477ad0a622a5ea7f47c7ce52062188b38522d60522337a06261d23f6894f5e1fbb6480c6
-  data.tar.gz: fb200b6342ff5a29d291d60e8c8e61d53de6012bcc5b29058e16ae2eee8d3df9583ed7e8f6f78a72a2da02481d74e9e48d6dbc945dbad73ed85526e711220532
+  metadata.gz: 707936b7399a44bb81e2a8efe79700c4267f74ed9f1307503d7f073ac1111b929169cb90bf412cfd615881cd0d92e06e044d4acb09930a059d3b09cfcfd3b215
+  data.tar.gz: 0c5779c4534c5b8a65d571764d0ecfb4cfb1defbc868c499cc977a98783f095fcd96ecf2a829e0fa278565c46e91eb312647b2ab5933f92e4fe19d4a257f7898

data/.rubocop.yml

@@ -12,5 +12,7 @@ Metrics/MethodLength:
   Enabled: false
 Metrics/PerceivedComplexity:
   Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
 Style/OptionalBooleanParameter:
   Enabled: false

data/kodi_client.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'kodi_client'
-  spec.version       = '0.6.0'
+  spec.version       = '0.6.4'
   spec.authors       = ['Christian Feier']
   spec.email         = ['christian.feier@gmail.com']
 

data/lib/kodi_client/extensions/chainable.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Extensions
+    # Offers methods like connect, auth and tls to be chained together
+    module Chainable
+
+      attr_accessor :options, :client
+
+      # Creates a new Client instance and sets the given ip and port to connect to it
+      # @param ip [String] the ip to use
+      # @param port [Integer] the port to connect to
+      # @raise [ArgumentError] thrown if ip or port is nil
+      # @return [Client] the created client
+      def connect(ip, port)
+        throw ArgumentError('ip or port can\'t be nil.') if ip.nil? || port.nil?
+        @client = KodiClient::Client.new
+        merge_options(->(options) { options.with_connection(ip, port) })
+      end
+
+      # sets username and password if required
+      # @param username [String] the username
+      # @param password [String] the password
+      # @return [Client] the existing, or if not existed, a new created client
+      def auth(username, password)
+        throw ArgumentError('username or password can\'t be nil.') if username.nil? || password.nil?
+        merge_options(->(options) { options.with_auth(username, password) })
+      end
+
+      # enables/disables the use of TLS
+      # @param enabled [Boolean] true to enable it, false to disable
+      # @return [Client] the existing, or if not existed, a new created client
+      def use_tls(enabled: true)
+        merge_options(->(options) { options.with_tls(enabled) })
+      end
+
+      # merges the existing options with the new options
+      # @param [Proc] set_command so command to execute on the existing options to merge them
+      # @return [Client] the existing, or if not existed, a new created client
+      def merge_options(set_command)
+        client = def_client
+        options = def_options
+        set_command.call(options)
+        client.apply_options_to_methods(options)
+        client
+      end
+
+      # Creates a new, or if one already exists, returns the existing client
+      # @return [Client] the new or existing client
+      def def_client
+        if @client.nil?
+          @client = KodiClient::Client.new
+          @client.client = @client
+        end
+        @client
+      end
+
+      # Creates a new, or if one already exists, returns the existing Options
+      # @return [KodiOptions] the new or existing Options
+      def def_options
+        if @options.nil?
+          @options ||= KodiClient::KodiOptions.new
+          @client.options = @options
+        end
+        @options
+      end
+
+      private :def_client, :def_options, :merge_options
+    end
+  end
+end

data/lib/kodi_client/extensions/comparable.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Extensions
+    # offers compare methods
+    module Comparable
+
+      # compares the instance variables of 2 objects for equality
+      # @param obj1 object 1
+      # @param obj2 object 2
+      # @return [Boolean] true if both instance variables are the same, else false
+      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
+
+      # compares all Comparables using the defined compare method
+      # @param other [Object] the object to compare with
+      # @return [Boolean] true if equal, else false
+      def ==(other)
+        compare(self, other)
+      end
+    end
+  end
+end

data/lib/kodi_client/extensions/creatable.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Extensions
+    # creates a create and create_list method by hash
+    module Creatable
+
+      # sets the fields to fetch from the given hash for the #create method. This is optional and only to use, if
+      # more fields should be fetched than are provided using attr_reader
+      # @param [Array<String>] fields the fields given as a string array
+      def fields_to_map(fields)
+        @fields_to_map = fields
+      end
+
+      # defines mappings in case an attribute in the hash is not primitive and requires further processing. The argument
+      # is an Array of Arrays. Each array contains ['field_name', [type_to_map_to], [opt if field is a list]]
+      # @param args [Array<Array>] mappings. Example mapping ['art', Media::ArtWork, true], in this case
+      # Media::ArtWork.create_list will be called
+      def type_mapping(*args)
+        return if args.nil?
+
+        @type_mapping = {}
+        args.map { |it| @type_mapping[it[0]] = Creatable::CreateMap.new(it[1], it[2].nil? ? false : it[2]) }
+      end
+
+      # if @type_mapping is nil, it tries to fetch the mapping from here instead
+      # @return [Hash<String, CreateMap>] an hash containing all the mappings
+      def lazy_type_mapping
+        {}
+      end
+
+      # expects the given hash is a list of hashes and calls #create on each element
+      # @param [Array<Hash>] hash given list of hashes
+      # @return [Array] empty if hash is nil, otherwise array containing the elements
+      def create_list(hash)
+        hash.nil? ? [] : hash.map { |it| create(it) }.reject(&:nil?)
+      end
+
+      # creates a Creatable using the provided hash and the attr_reader fields, or if given #fields_to_map instead
+      # The parameters will be passed to initialize the object in the same order as they are passed to attr_reader
+      # or #fields_to_map
+      # @param hash [Hash] the given hash to convert to an object
+      # @return the created object, or nil if the given hash is nil
+      def create(hash)
+        return nil if hash.nil?
+
+        if @fields_to_map.nil? || @fields_to_map.empty?
+          fields = @kodi_fields
+          return nil if @kodi_fields.none? { |it| !hash[it.to_s.gsub('_', '')].nil? }
+        else
+          fields = @fields_to_map
+        end
+
+        mapping = @type_mapping.nil? ? lazy_type_mapping : @type_mapping
+        args = fields.map do |it|
+          field = it.to_s.gsub('_', '')
+          Creatable.extract_field_from_hash(field, hash, mapping)
+        end
+
+        new(*args)
+      end
+
+      # takes a hash and a list of strings and an optional mapping and creates a new array with the created objects
+      # of the hash and fields. If no mapping is provided, the value of this field is returned, otherwise the mapping is
+      # used
+      # @param hash [Hash] the given hash
+      # @param fields [Array<String>] the fields to extract
+      # @param mapping [Hash<String, CreateMap>] optional mapping if a field contains a complex type
+      # @return [Array] an array containing the values of hash[field] in the given field order
+      def self.hash_to_arr(hash, fields, mapping = {})
+        return nil if hash.nil?
+
+        fields.map do |it|
+          field = it.to_s.gsub('_', '')
+          extract_field_from_hash(field, hash, mapping)
+        end
+      end
+
+      # map to self.hash_to_arr. The mapping is taken from #type_mapping
+      def hash_to_arr(hash, fields)
+        Creatable.hash_to_arr(hash, fields, @type_mapping.nil? ? {} : @type_mapping)
+      end
+
+      # extracts the given field from the given hash and optionally applies mapping if given
+      # @param field [String] the field name
+      # @param hash [Hash] the hash where to extract the field from
+      # @param mapping [Hash<String, CreateMap>] optional mapping for complex types
+      # @return the extracted object or nil, if the hash is empty, or [] if the expected value was a list and was nil
+      def self.extract_field_from_hash(field, hash, mapping)
+        map = mapping[field]
+        return nil if hash[field].nil? && map.nil?
+
+        return hash[field] if map.nil?
+
+        return map.type.create_list(hash[field]) if map.is_list
+
+        map.type.create(hash[field])
+      end
+
+      def attr_accessor(*args)
+        attr_reader(*args)
+        attr_writer(*args)
+      end
+
+      def attr_reader(*args)
+        @kodi_fields = args.map { |it| it.to_s.gsub('_', '') }
+
+        args.each do |it|
+          inst_variable_name = "@#{it}".to_sym
+          define_method it do
+            instance_variable_get(inst_variable_name)
+          end
+        end
+      end
+
+      def attr_writer(*args)
+        args.each do |it|
+          inst_variable_name = "@#{it}".to_sym
+          define_method "#{it}=" do |new_value|
+            instance_variable_set(inst_variable_name, new_value)
+          end
+        end
+      end
+
+      # mapping class with the type and if it is a list field or not
+      class CreateMap
+
+        attr_reader :type, :is_list
+
+        def initialize(type, is_list = false)
+          @type = type
+          @is_list = is_list
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/extensions/iterable.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Extensions
+    # offers iterable methods
+    module Iterable
+
+      # @return [Array<String>] returns all constant values if sorted order
+      def all_properties
+        constants.map { |it| const_get(it) }.sort!
+      end
+    end
+  end
+end

data/lib/kodi_client/kodi_error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module KodiClient
+  # represents an error response
+  class KodiError
+    include Extensions::Comparable
+    attr_reader :code, :message
+
+    def initialize(hash)
+      @code = hash['code']
+      @message = hash['message']
+    end
+  end
+end

data/lib/kodi_client/kodi_method.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module KodiClient
+
+  # the client that stores
+  class KodiMethod
+
+    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
+end

data/lib/kodi_client/{options.rb → kodi_options.rb}

@@ -2,7 +2,7 @@
 
 module KodiClient
   # holds all options like ip, port, credentials
-  class Options
+  class KodiOptions
 
     attr_accessor :ip, :port, :username, :password, :tls
 

data/lib/kodi_client/kodi_request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module KodiClient
+  # 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
+end

data/lib/kodi_client/kodi_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KodiClient
+  # represents a kodi response
+  class KodiResponse
+    include Extensions::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
+  end
+end

data/lib/kodi_client/{method → methods}/addons.rb

@@ -1,13 +1,9 @@
 # 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
+  module Methods
     # contains all Kodi Application methods
-    class Addons < KodiModule
+    class Addons < KodiMethod
 
       EXECUTE_ADDON = 'Addons.ExecuteAddon'
       GET_ADDON_DETAILS = 'Addons.GetAddonDetails'
@@ -28,41 +24,30 @@ module KodiClient
                                     'installed' => installed.nil? || !installed ? 'all' : 'installed'
                                   })
         json = invoke_api(request)
-        result = Types::Addons::Addons.create(json['result'])
+        result = Types::Addons::GetAddonsReturned.create(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
-                                  })
+        request = KodiRequest.new(kodi_id, GET_ADDON_DETAILS, { 'addonid' => addon_id,
+                                                                'properties' => properties })
         json = invoke_api(request)
 
-        result = Types::Addons::Addon.create(json['result'])
+        result = Types::Addons::GetAddonReturned.create(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
-                                  })
+        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
-                                  })
+        request = KodiRequest.new(kodi_id, SET_ADDON_ENABLED, { 'addonid' => addon_id, 'enabled' => enabled })
         json = invoke_api(request)
         KodiResponse.new(json)
       end

data/lib/kodi_client/{method → methods}/application.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require 'kodi_client/kodi_module'
-require 'kodi_client/global_types/application_types'
-
 module KodiClient
-  module Modules
+  module Methods
     # contains all Kodi Application methods
-    class Application < KodiModule
+    class Application < KodiMethod
 
       QUIT = 'Application.Quit'
       SET_MUTE = 'Application.SetMute'

data/lib/kodi_client/methods/audio_library.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Methods
+    # contains all Kodi Application methods
+    class AudioLibrary < KodiMethod
+
+      CLEAN = 'AudioLibrary.Clean'
+      EXPORT = 'AudioLibrary.Export'
+      GET_ALBUM_DETAILS = 'AudioLibrary.GetAlbumDetails'
+      GET_ALBUMS = 'AudioLibrary.GetAlbums'
+
+      def clean(show_dialogs = true, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, CLEAN, { 'showdialogs' => show_dialogs })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def export(path, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, EXPORT, { 'options' => { 'path' => path } })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def get_album_details(album_id, properties = Types::Audio::AudioFieldsAlbum.all_properties, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_ALBUM_DETAILS, { 'albumid' => album_id, 'properties' => properties })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def get_albums(properties = Types::Audio::AudioFieldsAlbum.all_properties,
+                     limits = Types::List::ListLimits.new(0, 50),
+                     sort = Types::List::ListSort.new, include_singles = false, all_roles = false, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_ALBUMS,
+                                  { 'properties' => properties,
+                                    'limits' => { 'start' => limits.list_start, 'end' => limits.list_end },
+                                    'sort' => { 'ignorearticle' => sort.ignore_article, 'method' => sort.method,
+                                                'order' => sort.order,
+                                                'useartistsortname' => sort.use_artist_sort_name },
+                                    'includesingles' => include_singles, 'allroles' => all_roles })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client/{method → methods}/favourites.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require 'kodi_client/kodi_module'
-require 'kodi_client/global_types/favourites_types'
-
 module KodiClient
-  module Modules
+  module Methods
     # contains all Kodi Application methods
-    class Favourites < KodiModule
+    class Favourites < KodiMethod
 
       ADD_FAVOURITE = 'Favourites.AddFavourite'
       GET_FAVOURITES = 'Favourites.GetFavourites'

data/lib/kodi_client/{method → methods}/files.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require 'kodi_client/kodi_module'
-require 'kodi_client/global_types/files_types'
-require 'kodi_client/global_types/list_types'
-
 module KodiClient
-  module Modules
+  module Methods
     # contains all Kodi Application methods
-    class Files < KodiModule
+    class Files < KodiMethod
 
       GET_DIRECTORY = 'Files.GetDirectory'
       GET_FILE_DETAILS = 'Files.GetFileDetails'

data/lib/kodi_client/{method → methods}/gui.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require 'kodi_client/global_types/gui_types'
-require 'kodi_client/kodi_module'
-
 module KodiClient
-  module Modules
+  module Methods
     # contains all Kodi GUI methods
-    class GUI < KodiModule
+    class GUI < KodiMethod
 
       ACTIVATE_WINDOW = 'GUI.ActivateWindow'
       GET_PROPERTIES = 'GUI.GetProperties'

data/lib/kodi_client/{method → methods}/input.rb

@@ -1,13 +1,9 @@
 # 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
+  module Methods
     # contains all Kodi Input methods
-    class Input < KodiModule
+    class Input < KodiMethod
 
       BACK = 'Input.Back'
       CONTEXT_MENU = 'Input.ContextMenu'

data/lib/kodi_client/{method → methods}/player.rb

@@ -1,14 +1,9 @@
 # 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
+  module Methods
     # contains all Kodi Application methods
-    class Player < KodiModule
+    class Player < KodiMethod
 
       ADD_SUBTITLE = 'Player.AddSubtitle'
       OPEN = 'Player.Open'

data/lib/kodi_client/{method → methods}/profiles.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require 'kodi_client/kodi_module'
-require 'kodi_client/global_types/profiles_types'
-
 module KodiClient
-  module Modules
+  module Methods
     # contains all Kodi Application methods
-    class Profiles < KodiModule
+    class Profiles < KodiMethod
 
       GET_CURRENT_PROFILE = 'Profiles.GetCurrentProfile'
       GET_PROFILES = 'Profiles.GetProfiles'

data/lib/kodi_client/{method → methods}/system.rb

@@ -1,13 +1,9 @@
 # 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
+  module Methods
     # contains all Kodi System methods
-    class System < KodiModule
+    class System < KodiMethod
 
       EJECT_OPTICAL_DRIVE = 'System.EjectOpticalDrive'
       GET_PROPERTIES = 'System.GetProperties'

data/lib/kodi_client/types/addons/addon_content_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Addons
+      # Addon.Content https://kodi.wiki/view/JSON-RPC_API/v12#Addon.Content
+      module AddonContent
+        extend Extensions::Iterable
+
+        UNKNOWN = 'unknown'
+        AUDIO = 'audio'
+        EXECUTABLE = 'executable'
+        IMAGE = 'image'
+        VIDEO = 'video'
+      end
+    end
+  end
+end

data/lib/kodi_client/types/addons/addon_dependency_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KodiClient
+  module Types
+    module Addons
+      # Addon.Details.dependencies https://kodi.wiki/view/JSON-RPC_API/v12#Addon.Details
+      class AddonDependency
+        include Extensions::Comparable
+        extend Extensions::Creatable
+
+        attr_reader :addon_id, :optional, :version
+
+        def initialize(addon_id, optional, version)
+          @addon_id = addon_id
+          @optional = optional
+          @version = version
+        end
+      end
+    end
+  end
+end