kodi_client 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 860eb2c3848cb508f5faaad0bf3716e330d1cb1113ebdfd6d847ccd33302d360
-  data.tar.gz: d51f977964b4a89698985c7cfb5f78f83b83a1c00502d436eee6b84550177f28
+  metadata.gz: 1d7046ba7c1c40c4302d7563b33a8805b83b3275069697af432b2880a59daf05
+  data.tar.gz: 340843f609031566aee613714f5a0e52b65add52bee208141e6ef3eee8fe929c
 SHA512:
-  metadata.gz: 55f60b1ad247d88fcb77ae527a3b47a43521853d8f3d06f6fbe29db07ec465fb91c29a6146ec20414dadb0c00191172e974fae29291d63d1cbabd50e2105666d
-  data.tar.gz: dad48a6e2c40302af39190e88a531d268f7b20f08cdac4322f73406c78d5b1a02df351faa260afab5094edb1aa1f301cce4be6c2c2c2c707c32e7c59c15cbf5a
+  metadata.gz: 3af04fc11780d040693c50348d3ce5aded43cb67ae8ae8487498d4a9d66f6d3286b684716798d57e70bc6f58128ba4022d9fae35af635ce6ce016a7663e53c74
+  data.tar.gz: de5b32cc6ad5c54b3efd5bc0e75544c66444a2c566d097fd13244122019da1dc3435df15a649d0a4ebda1e8171e5f4afd6865fc2d092fcfddbe351587a67d5c3

data/README.md

@@ -9,6 +9,7 @@ Currently implemented are the following Methods:
 * GUI
 * Input
 * Player
+* System
 
 ## Installation
 from [rubygems](https://rubygems.org/gems/kodi_client) using

data/kodi_client.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'kodi_client'
-  spec.version       = '0.4.5'
+  spec.version       = '0.5.0'
   spec.authors       = ['Christian Feier']
   spec.email         = ['christian.feier@gmail.com']
 
   spec.summary       = 'A work-in-progress client for Kodi JSON API v2.'
-  spec.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'
+  spec.description   = 'A client for the Kodi JSON API v12, currently implemented methods are addons, application, favourites, gui, input, player 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'
   spec.homepage      = 'https://github.com/cfe86/RubyKodiClient'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.5.0'

data/lib/kodi_client/global_types/system_types.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/iterable'
+require 'kodi_client/util/comparable'
+
+module KodiClient
+  module Types
+    module System
+
+      # System.Property.Name https://kodi.wiki/view/JSON-RPC_API/v12#System.Property.Name
+      module PropertyName
+        extend Iterable
+
+        CAN_SHUTDOWN = 'canshutdown'
+        CAN_SUSPEND = 'cansuspend'
+        CAN_HIBERNATE = 'canhibernate'
+        CAN_REBOOT = 'canreboot'
+      end
+
+      # System.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#System.Property.Value
+      class PropertyValue
+        include Comparable
+
+        attr_reader :can_hibernate, :can_reboot, :can_shutdown, :can_suspend
+
+        def initialize(hash)
+          @can_hibernate = hash['canhibernate']
+          @can_reboot = hash['canreboot']
+          @can_shutdown = hash['canshutdown']
+          @can_suspend = hash['cansuspend']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      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 = json['result'].nil? ? nil : Types::System::PropertyValue.new(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.rb

@@ -10,6 +10,7 @@ require 'kodi_client/method/favourites'
 require 'kodi_client/method/gui'
 require 'kodi_client/method/input'
 require 'kodi_client/method/player'
+require 'kodi_client/method/system'
 
 
 # client for Kodi rest api https://kodi.wiki/view/JSON-RPC_API/v12
@@ -20,7 +21,7 @@ module KodiClient
   class Client
     include Chainable
 
-    attr_reader :addons, :application, :gui, :player, :input, :favourites
+    attr_reader :addons, :application, :gui, :player, :input, :favourites, :system
 
     def initialize
       @addons = KodiClient::Modules::Addons.new
@@ -29,6 +30,7 @@ module KodiClient
       @gui = KodiClient::Modules::GUI.new
       @input = KodiClient::Modules::Input.new
       @player = KodiClient::Modules::Player.new
+      @system = KodiClient::Modules::System.new
     end
 
     def apply_options(options)
@@ -38,6 +40,7 @@ module KodiClient
       @input.apply_options(options)
       @player.apply_options(options)
       @favourites.apply_options(options)
+      @system.apply_options(options)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kodi_client
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Christian Feier
@@ -25,8 +25,8 @@ 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
+  addons, application, favourites, gui, input, player 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
@@ -55,6 +55,7 @@ files:
 - 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/system_types.rb
 - lib/kodi_client/global_types/video_types.rb
 - lib/kodi_client/kodi_module.rb
 - lib/kodi_client/method/addons.rb
@@ -63,6 +64,7 @@ files:
 - lib/kodi_client/method/gui.rb
 - lib/kodi_client/method/input.rb
 - lib/kodi_client/method/player.rb
+- lib/kodi_client/method/system.rb
 - lib/kodi_client/options.rb
 - lib/kodi_client/util/comparable.rb
 - lib/kodi_client/util/iterable.rb