kodi_client 0.4.5 → 0.5.7

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/profiles_types'
+
+module KodiClient
+  module Modules
+    # contains all Kodi Application methods
+    class Profiles < KodiModule
+
+      GET_CURRENT_PROFILE = 'Profiles.GetCurrentProfile'
+      GET_PROFILES = 'Profiles.GetProfiles'
+      LOAD_PROFILE = 'Profiles.LoadProfile'
+
+      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 = Types::Profiles::DetailsProfile.create(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_profiles(properties = Types::Profiles::FieldsProfile.all_properties,
+                       limit = Types::List::ListLimits.new(0, 50),
+                       sort = Types::List::ListSort.new, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_PROFILES,
+                                  { 'properties' => properties,
+                                    'limits' => { 'start' => limit.list_start, 'end' => limit.list_end },
+                                    'sort' => { 'ignorearticle' => sort.ignore_article, 'method' => sort.method,
+                                                'order' => sort.order,
+                                                'useartistsortname' => sort.use_artist_sort_name } })
+        json = invoke_api(request)
+        result = Types::Profiles::GetProfilesReturned.create(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def load_profile(profile_name, password, prompt = false, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, LOAD_PROFILE,
+                                  { 'profile' => profile_name,
+                                    'password' => { 'value' => password.value, 'encryption' => password.encryption },
+                                    'prompt' => prompt })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client/method/system.rb

@@ -0,0 +1,58 @@
+# 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
+    # contains all Kodi System methods
+    class System < KodiModule
+
+      EJECT_OPTICAL_DRIVE = 'System.EjectOpticalDrive'
+      GET_PROPERTIES = 'System.GetProperties'
+      HIBERNATE = 'System.Hibernate'
+      REBOOT = 'System.Reboot'
+      SHUTDOWN = 'System.Shutdown'
+      SUSPEND = 'System.Suspend'
+
+      def eject_optical_drive(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, EJECT_OPTICAL_DRIVE, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      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 = Types::System::PropertyValue.create(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def hibernate(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, HIBERNATE, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def reboot(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, REBOOT, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def shutdown(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SHUTDOWN, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+
+      def suspend(kodi_id = 1)
+        request = KodiRequest.new(kodi_id, SUSPEND, {})
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+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,52 @@
+# frozen_string_literal: true
+
+module KodiClient
+
+  # creates a create and create_list method by hash
+  module Creatable
+
+    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
+
+    def create_list(hash)
+      hash.nil? ? [] : hash.map { |it| create(it) }
+    end
+
+    def create(hash)
+      return nil if hash.nil?
+      return nil if @kodi_fields.none? { |it| !hash[it].nil? }
+
+      new(*@kodi_fields.map { |it| hash[it] })
+    end
+
+    def self.hash_to_arr(hash, fields)
+      fields.map { |it| hash[it.to_s.gsub('_', '')].nil? ? nil : hash[it.to_s.gsub('_', '')] }
+    end
+
+    def hash_to_arr(hash, fields)
+      Creatable.hash_to_arr(hash, fields)
+    end
+  end
+end

data/lib/kodi_client.rb

@@ -10,6 +10,8 @@ require 'kodi_client/method/favourites'
 require 'kodi_client/method/gui'
 require 'kodi_client/method/input'
 require 'kodi_client/method/player'
+require 'kodi_client/method/profiles'
+require 'kodi_client/method/system'
 
 
 # client for Kodi rest api https://kodi.wiki/view/JSON-RPC_API/v12
@@ -20,7 +22,7 @@ module KodiClient
   class Client
     include Chainable
 
-    attr_reader :addons, :application, :gui, :player, :input, :favourites
+    attr_reader :addons, :application, :gui, :player, :input, :favourites, :system, :profiles
 
     def initialize
       @addons = KodiClient::Modules::Addons.new
@@ -29,15 +31,15 @@ module KodiClient
       @gui = KodiClient::Modules::GUI.new
       @input = KodiClient::Modules::Input.new
       @player = KodiClient::Modules::Player.new
+      @profiles = KodiClient::Modules::Profiles.new
+      @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)
+    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.4.5
+  version: 0.5.7
 platform: ruby
 authors:
 - Christian Feier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-11-17 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 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, 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
 email:
 - christian.feier@gmail.com
 executables: []
@@ -54,7 +54,9 @@ files:
 - 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/profiles_types.rb
 - lib/kodi_client/global_types/pvr_type.rb
+- lib/kodi_client/global_types/system_types.rb
 - lib/kodi_client/global_types/video_types.rb
 - lib/kodi_client/kodi_module.rb
 - lib/kodi_client/method/addons.rb
@@ -63,8 +65,11 @@ files:
 - lib/kodi_client/method/gui.rb
 - lib/kodi_client/method/input.rb
 - lib/kodi_client/method/player.rb
+- lib/kodi_client/method/profiles.rb
+- 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: