kodi_client 0.5.7 → 0.6.3

data/lib/kodi_client/util/creatable.rb

@@ -5,6 +5,68 @@ module KodiClient
   # creates a create and create_list method by hash
   module Creatable
 
+    def fields_to_map(fields)
+      @fields_to_map = fields
+    end
+
+    def type_mapping(*args)
+      return if args.nil?
+
+      @type_mapping = {}
+      args.map { |it| @type_mapping[it[0]] = Creatable::CreateMap.new(it[1], it[2].nil? ? false : it[2]) }
+    end
+
+    def lazy_type_mapping
+      {}
+    end
+
+    def create_list(hash)
+      hash.nil? ? [] : hash.map { |it| create(it) }.reject(&:nil?)
+    end
+
+    def create(hash)
+      return nil if hash.nil?
+
+      if @fields_to_map.nil? || @fields_to_map.empty?
+        fields = @kodi_fields
+        return nil if @kodi_fields.none? { |it| !hash[it.to_s.gsub('_', '')].nil? }
+      else
+        fields = @fields_to_map
+      end
+
+      mapping = @type_mapping.nil? ? lazy_type_mapping : @type_mapping
+      args = fields.map do |it|
+        field = it.to_s.gsub('_', '')
+        Creatable.extract_field_from_hash(field, hash, mapping)
+      end
+
+      new(*args)
+    end
+
+    def self.hash_to_arr(hash, fields, mapping = {})
+      return nil if hash.nil?
+
+      fields.map do |it|
+        field = it.to_s.gsub('_', '')
+        extract_field_from_hash(field, hash, mapping)
+      end
+    end
+
+    def hash_to_arr(hash, fields)
+      Creatable.hash_to_arr(hash, fields, @type_mapping.nil? ? {} : @type_mapping)
+    end
+
+    def self.extract_field_from_hash(field, hash, mapping)
+      map = mapping[field]
+      return nil if hash[field].nil? && map.nil?
+
+      return hash[field] if map.nil?
+
+      return map.type.create_list(hash[field]) if map.is_list
+
+      map.type.create(hash[field])
+    end
+
     def attr_accessor(*args)
       attr_reader(*args)
       attr_writer(*args)
@@ -30,23 +92,15 @@ module KodiClient
       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? }
+    # mapping class with the type and if it is a list field or not
+    class CreateMap
 
-      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
+      attr_reader :type, :is_list
 
-    def hash_to_arr(hash, fields)
-      Creatable.hash_to_arr(hash, fields)
+      def initialize(type, is_list = false)
+        @type = type
+        @is_list = is_list
+      end
     end
   end
 end

data/lib/kodi_client.rb

@@ -4,15 +4,41 @@ require 'http'
 require 'json'
 
 require 'kodi_client/Chainable'
+
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/creatable'
+require 'kodi_client/util/iterable'
+
+require 'kodi_client/kodi_module'
+require 'kodi_client/options'
+
 require 'kodi_client/method/addons'
+require 'kodi_client/method/audio_library'
 require 'kodi_client/method/application'
 require 'kodi_client/method/favourites'
+require 'kodi_client/method/files'
 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'
 
+require 'kodi_client/types/global_types'
+require 'kodi_client/types/item_types'
+require 'kodi_client/types/media_types'
+require 'kodi_client/types/player_type'
+require 'kodi_client/types/pvr_type'
+require 'kodi_client/types/audio_types'
+require 'kodi_client/types/video_types'
+require 'kodi_client/types/system_types'
+require 'kodi_client/types/list_types'
+require 'kodi_client/types/application_types'
+require 'kodi_client/types/addon_types'
+require 'kodi_client/types/gui_types'
+require 'kodi_client/types/favourites_types'
+require 'kodi_client/types/profiles_types'
+require 'kodi_client/types/input_types'
+require 'kodi_client/types/files_types'
 
 # client for Kodi rest api https://kodi.wiki/view/JSON-RPC_API/v12
 module KodiClient
@@ -22,17 +48,19 @@ module KodiClient
   class Client
     include Chainable
 
-    attr_reader :addons, :application, :gui, :player, :input, :favourites, :system, :profiles
+    attr_reader :audio_library, :addons, :application, :favourites, :files, :gui, :input, :player, :profiles, :system
 
     def initialize
-      @addons = KodiClient::Modules::Addons.new
-      @application = KodiClient::Modules::Application.new
-      @favourites = KodiClient::Modules::Favourites.new
-      @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
+      @addons = KodiClient::Method::Addons.new
+      @audio_library = KodiClient::Method::AudioLibrary.new
+      @application = KodiClient::Method::Application.new
+      @favourites = KodiClient::Method::Favourites.new
+      @files = KodiClient::Method::Files.new
+      @gui = KodiClient::Method::GUI.new
+      @input = KodiClient::Method::Input.new
+      @player = KodiClient::Method::Player.new
+      @profiles = KodiClient::Method::Profiles.new
+      @system = KodiClient::Method::System.new
     end
 
     def apply_options_to_methods(options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kodi_client
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.6.3
 platform: ruby
 authors:
 - Christian Feier
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-17 00:00:00.000000000 Z
+date: 2021-11-18 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, 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
+  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
 email:
 - christian.feier@gmail.com
 executables: []
@@ -43,31 +43,34 @@ files:
 - kodi_client.gemspec
 - lib/kodi_client.rb
 - lib/kodi_client/Chainable.rb
-- lib/kodi_client/global_types/addon_types.rb
-- lib/kodi_client/global_types/application_types.rb
-- lib/kodi_client/global_types/audio_types.rb
-- lib/kodi_client/global_types/favourites_types.rb
-- lib/kodi_client/global_types/global_types.rb
-- lib/kodi_client/global_types/gui_types.rb
-- lib/kodi_client/global_types/input_types.rb
-- lib/kodi_client/global_types/item_types.rb
-- 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
 - lib/kodi_client/method/application.rb
+- lib/kodi_client/method/audio_library.rb
 - lib/kodi_client/method/favourites.rb
+- lib/kodi_client/method/files.rb
 - 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/types/addon_types.rb
+- lib/kodi_client/types/application_types.rb
+- lib/kodi_client/types/audio_types.rb
+- lib/kodi_client/types/favourites_types.rb
+- lib/kodi_client/types/files_types.rb
+- lib/kodi_client/types/global_types.rb
+- lib/kodi_client/types/gui_types.rb
+- lib/kodi_client/types/input_types.rb
+- lib/kodi_client/types/item_types.rb
+- lib/kodi_client/types/list_types.rb
+- lib/kodi_client/types/media_types.rb
+- lib/kodi_client/types/player_type.rb
+- lib/kodi_client/types/profiles_types.rb
+- lib/kodi_client/types/pvr_type.rb
+- lib/kodi_client/types/system_types.rb
+- lib/kodi_client/types/video_types.rb
 - lib/kodi_client/util/comparable.rb
 - lib/kodi_client/util/creatable.rb
 - lib/kodi_client/util/iterable.rb

data/lib/kodi_client/global_types/audio_types.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-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
-    module Audio
-
-      # 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(artist_id, name, role, role_id)
-          @artist_id = artist_id
-          @name = name
-          @role = role
-          @role_id = role_id
-        end
-      end
-
-      # Audio.Album.ReleaseType https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Album.ReleaseType
-      module AudioAlbumReleaseType
-        extend Iterable
-
-        ALBUM = 'album'
-        SINGLE = 'single'
-      end
-
-      # Audio.Details.Base https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Base
-      module AudioDetailsBase
-        include Media::MediaDetailsBase
-
-        attr_reader :art, :date_added, :genre
-
-        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
-
-      # Audio.Details.Media https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Details.Media
-      module AudioDetailsMedia
-        include AudioDetailsBase
-
-        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_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
-  end
-end