kodi_client 0.5.5 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3f04d9b1f829af8765bb790f49accaa47bebd71b1d4e1755b1776782d089fdb
-  data.tar.gz: 29d45652a206f4d32c05103a520eb984c5925a775dfe9479535b57d6d5d3a477
+  metadata.gz: 5fea7dad06fe723225e4d8bf268db09490af87c98a74f653e5966f170d1156fd
+  data.tar.gz: a4d8a3dfcac1a85abbf1c073b0c2f6016de9de9d07249eabc5067fe47c829727
 SHA512:
-  metadata.gz: 17431c4ec21d3b0f315847aacca3efd821afb1d4d0dcee1deae25196b4ad0a74effb6b08e53a6a97c727dd5302eef409560e55b39ee02f002e55bd73e01eefda
-  data.tar.gz: 3461b3f8babd1636c722a4d2fab9ac8391446c4f0144f8c744a87555fe155b1b7197ccd1f559951fef133ba9324934a89a9ea75682388efaf68d45e71b70f42a
+  metadata.gz: 031fcbe6dc03750fa90d3b8d395f903082d6b2b8586f3fe49ff3d9d5ca3375501e2b8e34305808399026de10bd62a5cfc00bf3ad5fc505cb5043e47ba2cdc85f
+  data.tar.gz: 6e9622971b0e8737130feddefca5ac49a8efd4073dd4ec9719b524c2cb7ba3781e915322a03bd1ffac63fe4ab48b3ed1428a83135a69223add9a041b8ff1288d

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.5'
+  spec.version       = '0.6.1'
   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

@@ -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

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'kodi_client/global_types/item_types'
+require 'kodi_client/global_types/list_types'
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
 
 module KodiClient
   module Types
@@ -10,7 +12,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 +53,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 +86,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,64 +114,65 @@ 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)
-        end
-
-        def ==(other)
-          compare(self, other)
+        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]
+
+        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)
+          @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
 
       # getAddons return
       class Addons
         include Comparable
+        extend Creatable
 
         attr_reader :addons, :limits
 
-        def initialize(hash)
-          @addons = hash['addons'].map { |it| AddonDetails.new(it) }
-          @limits = List::ListLimitsReturned.new(hash['limits'])
-        end
+        type_mapping ['addons', AddonDetails, true], ['limits', List::ListLimitsReturned]
 
-        def ==(other)
-          compare(self, other)
+        def initialize(addons, limits)
+          @addons = addons
+          @limits = limits
         end
       end
 
       # getAddon return
       class Addon
         include Comparable
+        extend Creatable
 
         attr_reader :addon
 
-        def initialize(hash)
-          @addon = AddonDetails.new(hash['addon'])
-        end
+        type_mapping ['addon', AddonDetails]
 
-        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
@@ -19,38 +20,35 @@ module KodiClient
         LANGUAGE = 'language'
       end
 
-      # Application.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#Application.Property.Value
-      class PropertyValue
+      # represent application properties version
+      class Version
         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']
-        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
 
-      # represent application properties version
-      class Version
+      # Application.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#Application.Property.Value
+      class PropertyValue
         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 :name, :version, :muted, :volume
+
+        type_mapping ['version', Version]
 
-        def ==(other)
-          compare(self, other)
+        def initialize(name, version, muted, volume)
+          @name = name
+          @version = version
+          @muted = muted
+          @volume = volume
         end
       end
     end

data/lib/kodi_client/global_types/audio_types.rb

@@ -3,6 +3,7 @@
 require 'kodi_client/global_types/media_types'
 require 'kodi_client/util/comparable'
 require 'kodi_client/util/iterable'
+require 'kodi_client/util/creatable'
 
 module KodiClient
   module Types
@@ -11,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
 
@@ -40,11 +38,21 @@ 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_mappings
+          mappings = { 'art' => Creatable::CreateMap.new(Types::Media::MediaArtwork) }
+          mappings.merge(media_details_base_mappings)
+        end
+
+        def audio_details_base_by_hash(hash)
+          audio_details_base(*Creatable.hash_to_arr(hash, %w[art date_added genre fan_art thumbnail label]),
+                             audio_details_base_mappings)
+        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
 
@@ -52,23 +60,165 @@ 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_mappings
+          audio_details_base_mappings
+        end
+
+        def audio_details_media_by_hash(hash)
+          audio_details_media(*Creatable.hash_to_arr(hash, %w[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],
+                                                     audio_details_base_mappings))
+        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
+
+      # Audio.Fields.Album https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Fields.Album
+      module AudioFieldsAlbum
+        extend Iterable
+
+        #album id
+        ALBUM_DURATION = 'albumduration'
+        ALBUM_LABEL = 'albumlabel'
+        ALBUM_STATUS = 'albumstatus'
+        ART = 'art'
+        ARTIST = 'artist'
+        ARTIST_ID = 'artistid'
+        COMPILATION = 'compilation'
+        DATE_ADDED = 'dateadded'
+        DATE_MODIFIED = 'datemodified'
+        DATE_NEW = 'datenew'
+        DESCRIPTION = 'description'
+        DISPLAY_ARTIST = 'displayartist'
+        FAN_ART = 'fanart'
+        GENRE = 'genre'
+        IS_BOX_SET = 'isboxset'
+        LAST_PLAYED = 'lastplayed'
+        MOOD = 'mood'
+        MUSICBRAINZ_ALBUM_ARTIST_ID = 'musicbrainzalbumartistid'
+        MUSICBRAINZ_ALBUM_ID = 'musicbrainzalbumid'
+        MUSICBRAINZ_RELEASE_GROUP_ID = 'musicbrainzreleasegroupid'
+        ORIGINAL_DATE = 'originaldate'
+        PLAY_COUNT = 'playcount'
+        RATING = 'rating'
+        RELEASE_DATE = 'releasedate'
+        RELEASE_TYPE = 'releasetype'
+        SONG_GENRES = 'songgenres'
+        SORT_ARTIST = 'sortartist'
+        SOURCE_ID = 'sourceid'
+        STYLE = 'style'
+        THEME = 'theme'
+        THUMBNAIL = 'thumbnail'
+        TITLE = 'title'
+        TOTAL_DISCS = 'totaldiscs'
+        TYPE = 'type'
+        USER_RATING = 'userrating'
+        VOTES = 'votes'
+        YEAR = 'year'
+      end
+
+      # Audio.Details.Genres https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Genres
+      class Genre
+        include Comparable
+        extend Creatable
+
+        attr_reader :genre_id, :title
+
+        def initialize(genre_id, title)
+          @genre_id = genre_id
+          @title = title
+        end
+      end
+
+      # Audio.Details.Album https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Album
+      class DetailsAlbum
+        include AudioDetailsMedia
+        include Comparable
+        extend Creatable
+
+        attr_reader :album_duration, :album_id, :album_label, :album_status, :compilation, :date_modified, :date_new,
+                    :description, :is_box_set, :last_played, :mood, :musicbrainz_album_id, :musicbrainz_release_group_id,
+                    :play_count, :release_type, :song_genres, :source_id, :style, :theme, :total_discs, :type
+
+        fields_to_map %w[album_duration album_id album_label album_status art artist artist_id compilation date_added
+                         date_modified date_new description display_artist fan_art genre is_box_set label last_played
+                         mood musicbrainz_album_artist_id musicbrainz_album_id musicbrainz_release_group_id
+                         original_date play_count rating release_date release_type song_genres sort_artist source_id
+                         style theme thumbnail title total_discs type user_rating votes year]
+
+        type_mapping ['songgenres', Genre, true], ['art', Types::Media::MediaArtwork]
+
+        def initialize(album_duration, album_id, album_label, album_status, art, artist, artist_id, compilation,
+                       date_added, date_modified, date_new, description, display_artist, fan_art, genre, is_box_set,
+                       label, last_played, mood, musicbrainz_album_artist_id, musicbrainz_album_id,
+                       musicbrainz_release_group_id, original_date, play_count, rating, release_date, release_type,
+                       song_genres, sort_artist, source_id, style, theme, thumbnail, title, total_discs, type,
+                       user_rating, votes, year)
+          @album_duration = album_duration
+          @album_id = album_id
+          @album_label = album_label
+          @album_status = album_status
+          @compilation = compilation
+          @date_modified = date_modified
+          @date_new = date_new
+          @description = description
+          @is_box_set = is_box_set
+          @last_played = last_played
+          @mood = mood
+          @musicbrainz_album_id = musicbrainz_album_id
+          @musicbrainz_release_group_id = musicbrainz_release_group_id
+          @play_count = play_count
+          @release_type = release_type
+          @song_genres = song_genres
+          @source_id = source_id
+          @style = style
+          @theme = theme
+          @total_discs = total_discs
+          @type = type
+          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)
+        end
+      end
+
+      # return type for AudioLibrary.GetAlbums
+      class GetAlbumsReturned
+        include Comparable
+        extend Creatable
+
+        attr_reader :albums, :limits
+
+        def self.lazy_type_mapping
+          {
+            'albums' => Creatable::CreateMap.new(DetailsAlbum, true),
+            'limits' => Creatable::CreateMap.new(List::ListLimitsReturned)
+          }
+        end
+
+        def initialize(albums, limits)
+          @albums = albums
+          @limits = limits
         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
@@ -32,36 +33,32 @@ module KodiClient
       # Favourite.Details.Favourite https://kodi.wiki/view/JSON-RPC_API/v12#Favourite.Details.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| DetailsFavourite.new(it) }
-          @limits = Types::List::ListLimitsReturned.new(hash['limits'])
-        end
+        type_mapping ['favourites', DetailsFavourite, true], ['limits', Types::List::ListLimitsReturned]
 
-        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,68 @@
+# 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
+
+        type_mapping ['files', List::ListItemFile, true], ['limits', List::ListLimitsReturned]
+
+        def initialize(files, limits)
+          @files = files
+          @limits = limits
+        end
+      end
+
+      # return value for GetSources
+      class GetSourcesReturned
+        include Comparable
+        extend Creatable
+
+        attr_reader :sources, :limits
+
+        type_mapping ['sources', List::FileLabel, true], ['limits', List::ListLimitsReturned]
+
+        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