kodi_client 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d7046ba7c1c40c4302d7563b33a8805b83b3275069697af432b2880a59daf05
-  data.tar.gz: 340843f609031566aee613714f5a0e52b65add52bee208141e6ef3eee8fe929c
+  metadata.gz: 5686743b785e5b591798992689064cec6c1e0d48a54721b97d9d28ae5a97ded3
+  data.tar.gz: fc7516af1d65c10ef63897253979bdb67b8d74f6f11bb74c959ccc942f8c026e
 SHA512:
-  metadata.gz: 3af04fc11780d040693c50348d3ce5aded43cb67ae8ae8487498d4a9d66f6d3286b684716798d57e70bc6f58128ba4022d9fae35af635ce6ce016a7663e53c74
-  data.tar.gz: de5b32cc6ad5c54b3efd5bc0e75544c66444a2c566d097fd13244122019da1dc3435df15a649d0a4ebda1e8171e5f4afd6865fc2d092fcfddbe351587a67d5c3
+  metadata.gz: ed6fbc05813a0f0a606c08c2e18606603af576e06f4af5941912097b477ad0a622a5ea7f47c7ce52062188b38522d60522337a06261d23f6894f5e1fbb6480c6
+  data.tar.gz: fb200b6342ff5a29d291d60e8c8e61d53de6012bcc5b29058e16ae2eee8d3df9583ed7e8f6f78a72a2da02481d74e9e48d6dbc945dbad73ed85526e711220532

data/README.md

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

data/kodi_client.gemspec

@@ -2,12 +2,15 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'kodi_client'
-  spec.version       = '0.5.0'
+  spec.version       = '0.6.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, 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.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'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.5.0'

data/lib/kodi_client/Chainable.rb

@@ -24,7 +24,7 @@ module KodiClient
       client = def_client
       options = def_options
       set_command.call(options)
-      client.apply_options(options)
+      client.apply_options_to_methods(options)
       client
     end
 
@@ -43,5 +43,7 @@ module KodiClient
       end
       @options
     end
+
+    private :def_client, :def_options, :merge_options
   end
 end

data/lib/kodi_client/global_types/addon_types.rb

@@ -3,6 +3,7 @@
 require 'kodi_client/global_types/item_types'
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
 
 module KodiClient
   module Types
@@ -10,7 +11,7 @@ module KodiClient
 
       # Addon Types https://kodi.wiki/view/JSON-RPC_API/v12#Addon.Types
       module AddonTypes
-        include Iterable
+        extend Iterable
 
         UNKNOWN = 'unknown'
         KODI_ADSP = 'kodi.adsp'
@@ -51,7 +52,8 @@ module KodiClient
 
       # Addon.Content https://kodi.wiki/view/JSON-RPC_API/v12#Addon.Content
       module AddonContent
-        include Iterable
+        extend Iterable
+
         UNKNOWN = 'unknown'
         AUDIO = 'audio'
         EXECUTABLE = 'executable'
@@ -83,33 +85,27 @@ module KodiClient
       # represents addon dependency
       class AddonDependency
         include Comparable
+        extend Creatable
 
-        attr_reader :addonid, :optional, :version
+        attr_reader :addon_id, :optional, :version
 
-        def initialize(hash)
-          @addonid = hash['addonid']
-          @optional = hash['optional']
-          @version = hash['version']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(addon_id, optional, version)
+          @addon_id = addon_id
+          @optional = optional
+          @version = version
         end
       end
 
       # represents addon extra info
       class AddonExtraInfo
         include Comparable
+        extend Creatable
 
         attr_reader :key, :value
 
-        def initialize(hash)
-          @key = hash['key']
-          @value = hash['value']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(key, value)
+          @key = key
+          @value = value
         end
       end
 
@@ -117,33 +113,43 @@ module KodiClient
       class AddonDetails
         include Comparable
         include Items::ItemDetailsBase
+        extend Creatable
 
         attr_reader :addon_id, :author, :broken, :dependencies, :description, :disclaimer, :enabled, :extra_info,
                     :fan_art, :installed, :name, :path, :rating, :summary, :thumbnail, :type, :version
 
-        def initialize(hash)
-          @addon_id = hash['addonid']
-          @author = hash['author']
-          @broken = hash['broken']
-          @dependencies = hash['dependencies'].nil? ? nil : hash['dependencies'].map { |it| AddonDependency.new(it) }
-          @description = hash['description']
-          @disclaimer = hash['disclaimer']
-          @enabled = hash['enabled']
-          @extra_info = hash['extrainfo'].nil? ? nil : hash['extrainfo'].map { |it| AddonExtraInfo.new(it) }
-          @fan_art = hash['fanart']
-          @installed = hash['installed']
-          @name = hash['name']
-          @path = hash['path']
-          @rating = hash['rating']
-          @summary = hash['summary']
-          @thumbnail = hash['thumbnail']
-          @type = hash['type']
-          @version = hash['version']
-          item_details_base(hash)
+        def self.create(hash)
+          return nil if hash.nil?
+
+          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
 
-        def ==(other)
-          compare(self, other)
+        def initialize(addon_id, author, broken, dependencies, description, disclaimer, enabled, extra_info,
+                       fan_art, installed, name, path, rating, summary, thumbnail, type, version, label)
+          @addon_id = addon_id
+          @author = author
+          @broken = broken
+          @dependencies = dependencies
+          @description = description
+          @disclaimer = disclaimer
+          @enabled = enabled
+          @extra_info = extra_info
+          @fan_art = fan_art
+          @installed = installed
+          @name = name
+          @path = path
+          @rating = rating
+          @summary = summary
+          @thumbnail = thumbnail
+          @type = type
+          @version = version
+          item_details_base(label)
         end
       end
 
@@ -153,13 +159,17 @@ module KodiClient
 
         attr_reader :addons, :limits
 
-        def initialize(hash)
-          @addons = hash['addons'].map { |it| AddonDetails.new(it) }
-          @limits = List::ListLimitsReturned.new(hash['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
 
-        def ==(other)
-          compare(self, other)
+        def initialize(addons, limits)
+          @addons = addons
+          @limits = limits
         end
       end
 
@@ -169,12 +179,14 @@ module KodiClient
 
         attr_reader :addon
 
-        def initialize(hash)
-          @addon = AddonDetails.new(hash['addon'])
+        def self.create(hash)
+          return nil if hash.nil?
+
+          new(AddonDetails.create(hash['addon']))
         end
 
-        def ==(other)
-          compare(self, other)
+        def initialize(addon)
+          @addon = addon
         end
       end
     end

data/lib/kodi_client/global_types/application_types.rb

@@ -2,6 +2,7 @@
 
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
 
 module KodiClient
   module Types
@@ -22,35 +23,37 @@ module KodiClient
       # Application.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#Application.Property.Value
       class PropertyValue
         include Comparable
+        extend Creatable
 
         attr_reader :name, :version, :muted, :volume
 
-        def initialize(hash)
-          @name = hash['name']
-          @version = hash['version'].nil? ? nil : Version.new(hash['version'])
-          @muted = hash['muted']
-          @volume = hash['volume']
+        def self.create(hash)
+          return null if hash.nil?
+
+          version = Version.create(hash['version'])
+          new(hash['name'], version, hash['muted'], hash['volume'])
         end
 
-        def ==(other)
-          compare(self, other)
+        def initialize(name, version, muted, volume)
+          @name = name
+          @version = version
+          @muted = muted
+          @volume = volume
         end
       end
 
       # represent application properties version
       class Version
         include Comparable
-        attr_reader :major, :minor, :revision, :tag
+        extend Creatable
 
-        def initialize(hash)
-          @major = hash['major']
-          @minor = hash['minor']
-          @revision = hash['revision']
-          @tag = hash['tag']
-        end
+        attr_reader :major, :minor, :revision, :tag
 
-        def ==(other)
-          compare(self, other)
+        def initialize(major, minor, revision, tag)
+          @major = major
+          @minor = minor
+          @revision = revision
+          @tag = tag
         end
       end
     end

data/lib/kodi_client/global_types/audio_types.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require 'kodi_client/global_types/media_types'
-require 'kodi_client/global_types/player_type'
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
 
 module KodiClient
   module Types
@@ -12,18 +12,15 @@ module KodiClient
       # Audio.Contributor https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Contributors
       class AudioContributor
         include Comparable
+        extend Creatable
 
         attr_reader :artist_id, :name, :role, :role_id
 
-        def initialize(hash)
-          @artist_id = hash['artistid']
-          @name = hash['name']
-          @role = hash['role']
-          @role_id = hash['roleid']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(artist_id, name, role, role_id)
+          @artist_id = artist_id
+          @name = name
+          @role = role
+          @role_id = role_id
         end
       end
 
@@ -41,11 +38,16 @@ module KodiClient
 
         attr_reader :art, :date_added, :genre
 
-        def audio_details_base(hash)
-          @art = Types::Media::MediaArtwork.new(hash['art'])
-          @date_added = hash['date_added']
-          @genre = hash['genre']
-          media_details_base(hash)
+        def audio_details_base_by_hash(hash)
+          audio_details_base(Types::Media::MediaArtwork.create(hash['art']), hash['date_added'], hash['genre'],
+                             *Creatable.hash_to_arr(hash, %w[fan_art thumbnail label]))
+        end
+
+        def audio_details_base(art, date_added, genre, fan_art, thumbnail, label)
+          @art = art
+          @date_added = date_added
+          @genre = genre
+          media_details_base(fan_art, thumbnail, label)
         end
       end
 
@@ -53,23 +55,32 @@ module KodiClient
       module AudioDetailsMedia
         include AudioDetailsBase
 
-        attr_reader :artist, :artist_id, :display_artist, :musicbrainz_albumartist_id, :original_date, :rating,
+        attr_reader :artist, :artist_id, :display_artist, :musicbrainz_album_artist_id, :original_date, :rating,
                     :release_date, :sort_artist, :title, :user_rating, :votes, :year
 
-        def audio_details_media(hash)
-          @artist = hash['artist']
-          @artist_id = hash['artistid']
-          @display_artist = hash['displayartist']
-          @musicbrainz_albumartist_id = hash['musicbrainzalbumartistid']
-          @original_date = hash['originaldate']
-          @rating = hash['rating']
-          @release_date = hash['releasedate']
-          @sort_artist = hash['sortartist']
-          @title = hash['title']
-          @user_rating = hash['userrating']
-          @votes = hash['votes']
-          @year = hash['year']
-          audio_details_base(hash)
+        def audio_details_media_by_hash(hash)
+          audio_details_media(hash['artist'], hash['artistid'], hash['displayartist'], hash['musicbrainzalbumartistid'],
+                              hash['originaldate'], hash['rating'], hash['releasedate'], hash['sortartist'],
+                              hash['title'], hash['userrating'], hash['votes'], hash['year'],
+                              *Creatable.hash_to_arr(hash, %w[art date_added genre fan_art thumbnail label]))
+        end
+
+        def audio_details_media(artist, artist_id, display_artist, musicbrainz_album_artist_id, original_date,
+                                rating, release_date, sort_artist, title, user_rating, votes, year,
+                                art, date_added, genre, fan_art, thumbnail, label)
+          @artist = artist
+          @artist_id = artist_id
+          @display_artist = display_artist
+          @musicbrainz_album_artist_id = musicbrainz_album_artist_id
+          @original_date = original_date
+          @rating = rating
+          @release_date = release_date
+          @sort_artist = sort_artist
+          @title = title
+          @user_rating = user_rating
+          @votes = votes
+          @year = year
+          audio_details_base(art, date_added, genre, fan_art, thumbnail, label)
         end
       end
     end

data/lib/kodi_client/global_types/favourites_types.rb

@@ -2,6 +2,7 @@
 
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
 require 'kodi_client/global_types/list_types'
 
 module KodiClient
@@ -30,38 +31,38 @@ module KodiClient
       end
 
       # Favourite.Details.Favourite https://kodi.wiki/view/JSON-RPC_API/v12#Favourite.Details.Favourite
-      class Favourite
+      class DetailsFavourite
         include Comparable
+        extend Creatable
 
         attr_reader :path, :thumbnail, :title, :type, :window, :window_parameter
 
-        def initialize(hash)
-          @path = hash['path']
-          @thumbnail = hash['thumbnail']
-          @title = hash['title']
-          @type = hash['type']
-          @window = hash['window']
-          @window_parameter = hash['windowparameter']
-        end
-
-        def ==(other)
-          compare(self, other)
+        def initialize(path, thumbnail, title, type, window, window_parameter)
+          @path = path
+          @thumbnail = thumbnail
+          @title = title
+          @type = type
+          @window = window
+          @window_parameter = window_parameter
         end
       end
 
       # return type for Favourites.GetFavourites
       class GetFavouriteReturned
         include Comparable
+        extend Creatable
 
         attr_reader :favourites, :limits
 
-        def initialize(hash)
-          @favourites = hash['favourites'].map { |it| Favourite.new(it) }
-          @limits = Types::List::ListLimitsReturned.new(hash['limits'])
+        def self.create(hash)
+          favourites = DetailsFavourite.create_list(hash['favourites'])
+          limits = Types::List::ListLimitsReturned.create(hash['limits'])
+          new(favourites, limits)
         end
 
-        def ==(other)
-          compare(self, other)
+        def initialize(favourites, limits)
+          @favourites = favourites
+          @limits = limits
         end
       end
     end

data/lib/kodi_client/global_types/files_types.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
+require 'kodi_client/global_types/list_types'
+
+module KodiClient
+  module Types
+    module Files
+
+      # Files.Media https://kodi.wiki/view/JSON-RPC_API/v12#Files.Media
+      module Media
+        extend Iterable
+
+        VIDEO = 'video'
+        MUSIC = 'music'
+        PICTURES = 'pictures'
+        FILES = 'files'
+        PROGRAMS = 'programs'
+      end
+
+      # return value for GetDirectory
+      class GetDirectoryReturned
+        include Comparable
+        extend Creatable
+
+        attr_reader :files, :limits
+
+        def self.create(hash)
+          return nil if hash.nil?
+
+          files = Types::List::ListItemFile.create_list(hash['files'])
+          limits = Types::List::ListLimitsReturned.create(hash['limits'])
+
+          new(files, limits)
+        end
+
+        def initialize(files, limits)
+          @files = files
+          @limits = limits
+        end
+      end
+
+      # return value for GetSources
+      class GetSourcesReturned
+        include Comparable
+        extend Creatable
+
+        attr_reader :sources, :limits
+
+        def self.create(hash)
+          return nil if hash.nil?
+
+          sources = Types::List::FileLabel.create_list(hash['sources'])
+          limits = Types::List::ListLimitsReturned.create(hash['limits'])
+
+          new(sources, limits)
+        end
+
+        def initialize(sources, limits)
+          @sources = sources
+          @limits = limits
+        end
+      end
+
+      # return value for GetPrepareDownload
+      class PrepareDownloadReturned
+        include Comparable
+        extend Creatable
+
+        attr_reader :details, :mode, :protocol
+
+        def initialize(details, mode, protocol)
+          @details = details
+          @mode = mode
+          @protocol = protocol
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/global_types.rb

@@ -2,6 +2,7 @@
 
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
 
 module KodiClient
   module Types
@@ -9,7 +10,7 @@ module KodiClient
 
       # Global.Toggle https://kodi.wiki/view/JSON-RPC_API/v12#Global.Toggle
       module Toggle
-        include Iterable
+        extend Iterable
 
         TOGGLE = 'toggle'
         TRUE = true
@@ -18,7 +19,7 @@ module KodiClient
 
       # rotate for clockwise and counter clockwise
       module Rotate
-        include Iterable
+        extend Iterable
 
         CLOCKWISE = 'clockwise'
         COUNTER_CLOCKWISE = 'counterclockwise'
@@ -26,7 +27,7 @@ module KodiClient
 
       # direction for left, right, up, down
       module Direction
-        include Iterable
+        extend Iterable
 
         LEFT = 'left'
         RIGHT = 'right'
@@ -36,7 +37,7 @@ module KodiClient
 
       # enum for prev/next
       module NextPrev
-        include Iterable
+        extend Iterable
 
         NEXT = 'next'
         PREV = 'previous'
@@ -46,7 +47,7 @@ module KodiClient
 
       # Global.IncrementDecrement https://kodi.wiki/view/JSON-RPC_API/v12#Global.IncrementDecrement
       module IncrementDecrement
-        include Iterable
+        extend Iterable
 
         INCREMENT = 'increment'
         DECREMENT = 'decrement'
@@ -55,49 +56,50 @@ module KodiClient
       # id/label type
       class IdLabel
         include Comparable
-        attr_reader :id, :label
+        extend Creatable
 
-        def initialize(hash)
-          @id = hash['id']
-          @label = hash['label']
-        end
+        attr_reader :id, :label
 
-        def ==(other)
-          compare(self, other)
+        def initialize(id, label)
+          @id = id
+          @label = label
         end
       end
 
       # id/name type
       class IdName
         include Comparable
-        attr_reader :id, :name
+        extend Creatable
 
-        def initialize(hash)
-          @id = hash['id']
-          @name = hash['name']
-        end
+        attr_reader :id, :name
 
-        def ==(other)
-          compare(self, other)
+        def initialize(id, name)
+          @id = id
+          @name = name
         end
       end
 
       # Global.Time https://kodi.wiki/view/JSON-RPC_API/v12#Global.Time
       class GlobalTime
         include Comparable
+        extend Creatable
 
         attr_reader :hours, :minutes, :seconds, :milliseconds
 
-        def initialize(hash)
-          @hours = hash['hours']
-          @minutes = hash['minutes']
-          @seconds = hash['seconds']
-          @milliseconds = hash['milliseconds']
+        def initialize(hours, minutes, seconds, milliseconds)
+          @hours = hours
+          @minutes = minutes
+          @seconds = seconds
+          @milliseconds = milliseconds
         end
+      end
 
-        def ==(other)
-          compare(self, other)
-        end
+      # available Password Encryptions
+      module PasswordEncryption
+        extend Iterable
+
+        NONE = 'none'
+        MD5 = 'md5'
       end
     end
   end