kodi_client 0.5.6 → 0.6.2

data/lib/kodi_client/method/addons.rb

@@ -28,42 +28,30 @@ module KodiClient
                                     'installed' => installed.nil? || !installed ? 'all' : 'installed'
                                   })
         json = invoke_api(request)
-
-        result = json['result'].nil? ? nil : Types::Addons::Addons.new(json['result'])
+        result = Types::Addons::Addons.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 = json['result'].nil? ? nil : Types::Addons::Addon.new(json['result'])
+        result = Types::Addons::Addon.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/application.rb

@@ -28,7 +28,7 @@ module KodiClient
       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'])
+        result = Types::Application::PropertyValue.create(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end

data/lib/kodi_client/method/audio_library.rb

@@ -0,0 +1,49 @@
+# 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 AudioLibrary < KodiModule
+
+      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/favourites.rb

@@ -28,7 +28,7 @@ module KodiClient
         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'])
+        result = Types::Favourites::GetFavouriteReturned.create(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end

data/lib/kodi_client/method/files.rb

@@ -0,0 +1,89 @@
+# 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
+    # contains all Kodi Application methods
+    class Files < KodiModule
+
+      GET_DIRECTORY = 'Files.GetDirectory'
+      GET_FILE_DETAILS = 'Files.GetFileDetails'
+      GET_SOURCES = 'Files.GetSources'
+      PREPARE_DOWNLOAD = 'Files.PrepareDownload'
+      SET_FILE_DETAILS = 'Files.SetFileDetails'
+
+      def get_directory(directory, media = Types::Files::Media::FILES,
+                        properties = Types::List::ListFieldFiles.all_properties,
+                        sort = Types::List::ListSort.new,
+                        limits = Types::List::ListLimits.new(0, 50), kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_DIRECTORY,
+                                  {
+                                    'directory' => directory,
+                                    'media' => media,
+                                    'properties' => properties,
+                                    'sort' => { 'ignorearticle' => sort.ignore_article, 'method' => sort.method,
+                                                'order' => sort.order,
+                                                'useartistsortname' => sort.use_artist_sort_name },
+                                    'limits' => { 'start' => limits.list_start, 'end' => limits.list_end }
+                                  })
+        json = invoke_api(request)
+        result = KodiClient::Types::Files::GetDirectoryReturned.create(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_file_details(file, media = Types::Files::Media::FILES,
+                           properties = Types::List::ListFieldFiles.all_properties, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_FILE_DETAILS,
+                                  {
+                                    'file' => file,
+                                    'media' => media,
+                                    'properties' => properties
+                                  })
+        json = invoke_api(request)
+        result = KodiClient::Types::List::ListItemFile.create(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_sources(media = Types::Files::Media::FILES,
+                      sort = Types::List::ListSort.new,
+                      limits = Types::List::ListLimits.new(0, 50), kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_SOURCES,
+                                  {
+                                    'media' => media,
+                                    'sort' => { 'ignorearticle' => sort.ignore_article, 'method' => sort.method,
+                                                'order' => sort.order,
+                                                'useartistsortname' => sort.use_artist_sort_name },
+                                    'limits' => { 'start' => limits.list_start, 'end' => limits.list_end }
+                                  })
+        json = invoke_api(request)
+        result = KodiClient::Types::Files::GetSourcesReturned.create(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def prepare_download(path, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, PREPARE_DOWNLOAD, { 'path' => path })
+        json = invoke_api(request)
+        result = KodiClient::Types::Files::PrepareDownloadReturned.create(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def set_file_details(file, media = Types::Files::Media::VIDEO, play_count = nil, last_played = nil,
+                           resume = nil, kodi_id = 1)
+        params = { 'file' => file, 'media' => media}
+        params['playcount'] = play_count unless play_count.nil?
+        params['lastplayed'] = last_played unless last_played.nil?
+        params['resume'] = resume unless resume.nil?
+        request = KodiRequest.new(kodi_id, SET_FILE_DETAILS, params)
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client/method/gui.rb

@@ -24,7 +24,7 @@ module KodiClient
       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'])
+        result = KodiClient::Types::GUI::PropertyValue.create(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end
@@ -32,7 +32,7 @@ module KodiClient
       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) }
+        result = Types::GUI::StereoscopyMode.create_list(json['result']['stereoscopicmodes'])
         json['result'] = result
         KodiResponse.new(json)
       end

data/lib/kodi_client/method/player.rb

@@ -41,7 +41,7 @@ module KodiClient
       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) }
+        result = Types::Player::Player.create_list(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end
@@ -57,7 +57,7 @@ module KodiClient
         request = KodiRequest.new(kodi_id, GET_ITEM, { 'playerid' => player_id,
                                                        'properties' => properties })
         json = invoke_api(request)
-        result = Types::List::ListItemAll.new(json['result']['item'])
+        result = Types::List::ListItemAll.create(json['result']['item'])
         json['result'] = result
         KodiResponse.new(json)
       end
@@ -65,7 +65,7 @@ module KodiClient
       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) }
+        result = Types::Player::Player.create_list(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end
@@ -74,7 +74,7 @@ module KodiClient
         request = KodiRequest.new(kodi_id, GET_PROPERTIES, { 'playerid' => player_id,
                                                              'properties' => properties })
         json = invoke_api(request)
-        result = Types::Player::PropertyValue.new(json['result'])
+        result = Types::Player::PropertyValue.create(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end
@@ -82,7 +82,7 @@ module KodiClient
       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'])
+        result = Types::Player::PlayerViewMode.create(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end
@@ -130,7 +130,7 @@ module KodiClient
       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'])
+        result = Types::Player::SeekReturned.create(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end

data/lib/kodi_client/method/profiles.rb

@@ -15,7 +15,7 @@ module KodiClient
       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'])
+        result = Types::Profiles::DetailsProfile.create(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end
@@ -30,7 +30,7 @@ module KodiClient
                                                 'order' => sort.order,
                                                 'useartistsortname' => sort.use_artist_sort_name } })
         json = invoke_api(request)
-        result = json['result'].nil? ? nil : Types::Profiles::GetProfilesReturned.new(json['result'])
+        result = Types::Profiles::GetProfilesReturned.create(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end

data/lib/kodi_client/method/system.rb

@@ -25,7 +25,7 @@ module KodiClient
       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'])
+        result = Types::System::PropertyValue.create(json['result'])
         json['result'] = result
         KodiResponse.new(json)
       end

data/lib/kodi_client/util/comparable.rb

@@ -4,7 +4,6 @@ module KodiClient
 
   # offers compare methods
   module Comparable
-
     def compare(obj1, obj2)
       is_same = true
       obj1.instance_variables.each do |it|
@@ -13,5 +12,9 @@ module KodiClient
 
       is_same
     end
+
+    def ==(other)
+      compare(self, other)
+    end
   end
 end

data/lib/kodi_client/util/creatable.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module KodiClient
+
+  # creates a create and create_list method by hash
+  module Creatable
+
+    def fields_to_map(fields)
+      @fields_to_map = fields
+    end
+
+    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
+
+    def lazy_type_mapping
+      {}
+    end
+
+    def create_list(hash)
+      hash.nil? ? [] : hash.map { |it| create(it) }.reject(&:nil?)
+    end
+
+    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
+
+    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
+
+    def hash_to_arr(hash, fields)
+      Creatable.hash_to_arr(hash, fields, @type_mapping.nil? ? {} : @type_mapping)
+    end
+
+    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

data/lib/kodi_client.rb

@@ -5,8 +5,10 @@ require 'json'
 
 require 'kodi_client/Chainable'
 require 'kodi_client/method/addons'
+require 'kodi_client/method/audio_library'
 require 'kodi_client/method/application'
 require 'kodi_client/method/favourites'
+require 'kodi_client/method/files'
 require 'kodi_client/method/gui'
 require 'kodi_client/method/input'
 require 'kodi_client/method/player'
@@ -22,12 +24,14 @@ module KodiClient
   class Client
     include Chainable
 
-    attr_reader :addons, :application, :gui, :player, :input, :favourites, :system, :profiles
+    attr_reader :audio_library, :addons, :application, :favourites, :files, :gui, :input, :player, :profiles, :system
 
     def initialize
       @addons = KodiClient::Modules::Addons.new
+      @audio_library = KodiClient::Modules::AudioLibrary.new
       @application = KodiClient::Modules::Application.new
       @favourites = KodiClient::Modules::Favourites.new
+      @files = KodiClient::Modules::Files.new
       @gui = KodiClient::Modules::GUI.new
       @input = KodiClient::Modules::Input.new
       @player = KodiClient::Modules::Player.new
@@ -35,15 +39,11 @@ module KodiClient
       @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)
+    def apply_options_to_methods(options)
+      instance_variables.each do |it|
+        mod = instance_variable_get(it)
+        mod.apply_options(options) if mod.is_a?(KodiClient::KodiModule)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kodi_client
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.2
 platform: ruby
 authors:
 - Christian Feier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-11-18 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, 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
+  Addons, Application, Favourites, Files, GUI, Input, Player, Profiles 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: []
@@ -47,6 +47,7 @@ files:
 - 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/files_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
@@ -61,7 +62,9 @@ files:
 - lib/kodi_client/kodi_module.rb
 - lib/kodi_client/method/addons.rb
 - lib/kodi_client/method/application.rb
+- lib/kodi_client/method/audio_library.rb
 - lib/kodi_client/method/favourites.rb
+- lib/kodi_client/method/files.rb
 - lib/kodi_client/method/gui.rb
 - lib/kodi_client/method/input.rb
 - lib/kodi_client/method/player.rb
@@ -69,6 +72,7 @@ files:
 - lib/kodi_client/method/system.rb
 - lib/kodi_client/options.rb
 - lib/kodi_client/util/comparable.rb
+- lib/kodi_client/util/creatable.rb
 - lib/kodi_client/util/iterable.rb
 homepage: https://github.com/cfe86/RubyKodiClient
 licenses: