kodi_client 0.5.7 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dd073d0e999df44e921b07f3aab1c148ee3647a584e2de13a2c070a151f7a2b
-  data.tar.gz: 00ac80c0f82b4bfcb0031e8cc2abf6e4c894ccff58515fcdfd08fbe1c3b7fb63
+  metadata.gz: 23953ca4422d697b3b13a223f63b339acc5d4d4fdb8c7accccdc5f0b7f85f9cb
+  data.tar.gz: 92e3d514686cdddddcc16a1be9046ba56a8d31e039316fb98ab98dca45a864db
 SHA512:
-  metadata.gz: b1a718355773fd1a1e12127f334f74a9bc1d9382ec47e9143a2dc776e1bb056157f4ac5ca0ec1232b14c27c8cc55bacacae1b37e0b831213af7472c2aeef16ec
-  data.tar.gz: e6dccd2f74a7c2f7a4790635b21f01730c88a69bfe47c6b8905b500dade3b650689506640a2428c00824ca03097658906563a7f88806aad094a3dc64d7edcf0c
+  metadata.gz: 734b5574d16a2deac4a88f81f6d3b94f4a5cd9c769fbda34034a6f3b614c4a03b5c44f40060ad100d24e1a2e032de8ceb35107f6922a51fdc396d19db4207204
+  data.tar.gz: 1cbb33466f364232765025183bb4336c03913ff1f1ff9887a18cd7f221b4cd5fac2640671a3213e2049533888044b551b5a4738ce7c2f0219b1fe21b6c15d3b6

data/README.md

@@ -6,10 +6,11 @@ Currently implemented are the following Methods:
 * Addons
 * Application
 * Favourites
+* Files
 * GUI
 * Input
 * Player
-* Profile
+* Profiles
 * System
 
 ## Installation

data/kodi_client.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'kodi_client'
-  spec.version       = '0.5.7'
+  spec.version       = '0.6.3'
   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, player, profile and system (more will be added with the time). '\
+  spec.description   = 'A client for the Kodi JSON API v12, currently implemented methods are 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'
   spec.homepage      = 'https://github.com/cfe86/RubyKodiClient'

data/lib/kodi_client/Chainable.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'kodi_client/options'
-
 module KodiClient
   # Offers methods like connect, auth and tls to be chained together
   module Chainable
@@ -9,6 +7,7 @@ module KodiClient
     attr_accessor :options, :client
 
     def connect(ip, port)
+      @client = KodiClient::Client.new
       merge_options(->(options) { options.with_connection(ip, port) })
     end
 

data/lib/kodi_client/kodi_module.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'http'
-require 'kodi_client/util/comparable'
-
 module KodiClient
 
   # the client that stores
@@ -79,9 +76,5 @@ module KodiClient
     def error?
       !@error.nil?
     end
-
-    def ==(other)
-      compare(self, other)
-    end
   end
 end

data/lib/kodi_client/method/addons.rb

@@ -1,11 +1,7 @@
 # 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 Method
     # contains all Kodi Application methods
     class Addons < KodiModule
 
@@ -34,11 +30,8 @@ module KodiClient
       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'])
@@ -47,22 +40,14 @@ module KodiClient
       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

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require 'kodi_client/kodi_module'
-require 'kodi_client/global_types/application_types'
-
 module KodiClient
-  module Modules
+  module Method
     # contains all Kodi Application methods
     class Application < KodiModule
 

data/lib/kodi_client/method/audio_library.rb

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

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require 'kodi_client/kodi_module'
-require 'kodi_client/global_types/favourites_types'
-
 module KodiClient
-  module Modules
+  module Method
     # contains all Kodi Application methods
     class Favourites < KodiModule
 

data/lib/kodi_client/method/files.rb

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

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require 'kodi_client/global_types/gui_types'
-require 'kodi_client/kodi_module'
-
 module KodiClient
-  module Modules
+  module Method
     # contains all Kodi GUI methods
     class GUI < KodiModule
 

data/lib/kodi_client/method/input.rb

@@ -1,11 +1,7 @@
 # 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 Method
     # contains all Kodi Input methods
     class Input < KodiModule
 

data/lib/kodi_client/method/player.rb

@@ -1,12 +1,7 @@
 # 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 Method
     # contains all Kodi Application methods
     class Player < KodiModule
 

data/lib/kodi_client/method/profiles.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
-require 'kodi_client/kodi_module'
-require 'kodi_client/global_types/profiles_types'
-
 module KodiClient
-  module Modules
+  module Method
     # contains all Kodi Application methods
     class Profiles < KodiModule
 

data/lib/kodi_client/method/system.rb

@@ -1,11 +1,7 @@
 # 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 Method
     # contains all Kodi System methods
     class System < KodiModule
 

data/lib/kodi_client/{global_types → types}/addon_types.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require 'kodi_client/global_types/item_types'
-require 'kodi_client/util/comparable'
-require 'kodi_client/util/iterable'
-require 'kodi_client/util/creatable'
+require 'kodi_client/types/item_types'
+require 'kodi_client/types/list_types'
 
 module KodiClient
   module Types
@@ -118,17 +116,10 @@ module KodiClient
         attr_reader :addon_id, :author, :broken, :dependencies, :description, :disclaimer, :enabled, :extra_info,
                     :fan_art, :installed, :name, :path, :rating, :summary, :thumbnail, :type, :version
 
-        def self.create(hash)
-          return nil if hash.nil?
+        fields_to_map %w[addon_id author broken dependencies description disclaimer enabled extra_info fan_art
+                         installed name path rating summary thumbnail type version label]
 
-          dependencies = AddonDependency.create_list(hash['dependencies'])
-          extra_info = AddonExtraInfo.create_list(hash['extrainfo'])
-
-          new(hash['addonid'], hash['author'], hash['broken'], dependencies, hash['description'], hash['disclaimer'],
-              hash['enabled'], extra_info, hash['fanart'], hash['installed'], hash['name'], hash['path'],
-              hash['rating'], hash['summary'], hash['thumbnail'], hash['type'], hash['version'],
-              *hash_to_arr(hash, ['label']))
-        end
+        type_mapping ['dependencies', AddonDependency, true], ['extrainfo', AddonExtraInfo, true]
 
         def initialize(addon_id, author, broken, dependencies, description, disclaimer, enabled, extra_info,
                        fan_art, installed, name, path, rating, summary, thumbnail, type, version, label)
@@ -156,16 +147,11 @@ module KodiClient
       # getAddons return
       class Addons
         include Comparable
+        extend Creatable
 
         attr_reader :addons, :limits
 
-        def self.create(hash)
-          return nil if hash.nil?
-
-          addons = AddonDetails.create_list(hash['addons'])
-          limits = List::ListLimitsReturned.create(hash['limits'])
-          new(addons, limits)
-        end
+        type_mapping ['addons', AddonDetails, true], ['limits', List::ListLimitsReturned]
 
         def initialize(addons, limits)
           @addons = addons
@@ -176,14 +162,11 @@ module KodiClient
       # getAddon return
       class Addon
         include Comparable
+        extend Creatable
 
         attr_reader :addon
 
-        def self.create(hash)
-          return nil if hash.nil?
-
-          new(AddonDetails.create(hash['addon']))
-        end
+        type_mapping ['addon', AddonDetails]
 
         def initialize(addon)
           @addon = addon

data/lib/kodi_client/{global_types → types}/application_types.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require 'kodi_client/util/comparable'
-require 'kodi_client/util/iterable'
-require 'kodi_client/util/creatable'
-
 module KodiClient
   module Types
     module Application
@@ -20,6 +16,21 @@ module KodiClient
         LANGUAGE = 'language'
       end
 
+      # represent application properties version
+      class Version
+        include Comparable
+        extend Creatable
+
+        attr_reader :major, :minor, :revision, :tag
+
+        def initialize(major, minor, revision, tag)
+          @major = major
+          @minor = minor
+          @revision = revision
+          @tag = tag
+        end
+      end
+
       # Application.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#Application.Property.Value
       class PropertyValue
         include Comparable
@@ -27,12 +38,7 @@ module KodiClient
 
         attr_reader :name, :version, :muted, :volume
 
-        def self.create(hash)
-          return null if hash.nil?
-
-          version = Version.create(hash['version'])
-          new(hash['name'], version, hash['muted'], hash['volume'])
-        end
+        type_mapping ['version', Version]
 
         def initialize(name, version, muted, volume)
           @name = name
@@ -41,21 +47,6 @@ module KodiClient
           @volume = volume
         end
       end
-
-      # represent application properties version
-      class Version
-        include Comparable
-        extend Creatable
-
-        attr_reader :major, :minor, :revision, :tag
-
-        def initialize(major, minor, revision, tag)
-          @major = major
-          @minor = minor
-          @revision = revision
-          @tag = tag
-        end
-      end
     end
   end
 end