kodi_client 0.5.7 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dd073d0e999df44e921b07f3aab1c148ee3647a584e2de13a2c070a151f7a2b
-  data.tar.gz: 00ac80c0f82b4bfcb0031e8cc2abf6e4c894ccff58515fcdfd08fbe1c3b7fb63
+  metadata.gz: 5686743b785e5b591798992689064cec6c1e0d48a54721b97d9d28ae5a97ded3
+  data.tar.gz: fc7516af1d65c10ef63897253979bdb67b8d74f6f11bb74c959ccc942f8c026e
 SHA512:
-  metadata.gz: b1a718355773fd1a1e12127f334f74a9bc1d9382ec47e9143a2dc776e1bb056157f4ac5ca0ec1232b14c27c8cc55bacacae1b37e0b831213af7472c2aeef16ec
-  data.tar.gz: e6dccd2f74a7c2f7a4790635b21f01730c88a69bfe47c6b8905b500dade3b650689506640a2428c00824ca03097658906563a7f88806aad094a3dc64d7edcf0c
+  metadata.gz: ed6fbc05813a0f0a606c08c2e18606603af576e06f4af5941912097b477ad0a622a5ea7f47c7ce52062188b38522d60522337a06261d23f6894f5e1fbb6480c6
+  data.tar.gz: fb200b6342ff5a29d291d60e8c8e61d53de6012bcc5b29058e16ae2eee8d3df9583ed7e8f6f78a72a2da02481d74e9e48d6dbc945dbad73ed85526e711220532

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.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, 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/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/list_types.rb

@@ -153,6 +153,95 @@ module KodiClient
         YEAR = 'year'
       end
 
+      # List.Fields.Files https://kodi.wiki/view/JSON-RPC_API/v12#List.Fields.Files
+      module ListFieldFiles
+        extend Iterable
+
+        ALBUM = 'album'
+        ALBUMARTIST = 'albumartist'
+        ALBUMARTISTID = 'albumartistid'
+        ALBUMID = 'albumid'
+        ALBUMLABEL = 'albumlabel'
+        ART = 'art'
+        ARTIST = 'artist'
+        ARTISTID = 'artistid'
+        CAST = 'cast'
+        COMMENT = 'comment'
+        COUNTRY = 'country'
+        DATEADDED = 'dateadded'
+        DESCRIPTION = 'description'
+        DIRECTOR = 'director'
+        DISC = 'disc'
+        DISPLAYARTIST = 'displayartist'
+        DURATION = 'duration'
+        EPISODE = 'episode'
+        EPISODEGUIDE = 'episodeguide'
+        FANART = 'fanart'
+        FILE = 'file'
+        FIRSTAIRED = 'firstaired'
+        GENRE = 'genre'
+        GENREID = 'genreid'
+        IMDBNUMBER = 'imdbnumber'
+        LASTMODIFIED = 'lastmodified'
+        LASTPLAYED = 'lastplayed'
+        LYRICS = 'lyrics'
+        MIMETYPE = 'mimetype'
+        MOOD = 'mood'
+        MPAA = 'mpaa'
+        MUSICBRAINZALBUMARTISTID = 'musicbrainzalbumartistid'
+        MUSICBRAINZALBUMID = 'musicbrainzalbumid'
+        MUSICBRAINZARTISTID = 'musicbrainzartistid'
+        MUSICBRAINZTRACKID = 'musicbrainztrackid'
+        ORIGINALTITLE = 'originaltitle'
+        PLAYCOUNT = 'playcount'
+        PLOT = 'plot'
+        PLOTOUTLINE = 'plotoutline'
+        PREMIERED = 'premiered'
+        PRODUCTIONCODE = 'productioncode'
+        RATING = 'rating'
+        RESUME = 'resume'
+        RUNTIME = 'runtime'
+        SEASON = 'season'
+        SET = 'set'
+        SETID = 'setid'
+        SHOWLINK = 'showlink'
+        SHOWTITLE = 'showtitle'
+        SIZE = 'size'
+        SORTTITLE = 'sorttitle'
+        SPECIALSORTEPISODE = 'specialsortepisode'
+        SPECIALSORTSEASON = 'specialsortseason'
+        STREAMDETAILS = 'streamdetails'
+        STUDIO = 'studio'
+        STYLE = 'style'
+        TAG = 'tag'
+        TAGLINE = 'tagline'
+        THEME = 'theme'
+        THUMBNAIL = 'thumbnail'
+        TITLE = 'title'
+        TOP250 = 'top250'
+        TRACK = 'track'
+        TRAILER = 'trailer'
+        TVSHOWID = 'tvshowid'
+        UNIQUEID = 'uniqueid'
+        VOTES = 'votes'
+        WATCHEDEPISODES = 'watchedepisodes'
+        WRITER = 'writer'
+        YEAR = 'year'
+      end
+
+      # File/Label tuple
+      class FileLabel
+        include Comparable
+        extend Creatable
+
+        attr_reader :file, :label
+
+        def initialize(file, label)
+          @file = file
+          @label = label
+        end
+      end
+
       # List.Item.Base https://kodi.wiki/view/JSON-RPC_API/v12#List.Item.Base
       module ListItemBase
         include Video::VideoDetailsFile
@@ -299,7 +388,7 @@ module KodiClient
           stream_details = Types::Video::Streams.create(hash['streamdetails'])
           art = Types::Media::MediaArtwork.create(hash['art'])
           hash['type'] = 'unknown' if hash['type'].nil?
-          new(*Creatable.hash_to_arr(hash, %w[channel channel_number channel_type end_time hidden locked start_time 
+          new(*Creatable.hash_to_arr(hash, %w[channel channel_number channel_type end_time hidden locked start_time
                                               sub_channel_number album album_artist album_artist_id album_id
                                               album_release_type album_status bit_rate bpm]), cast,
               hash['channels'], hash['comment'], hash['compilation'], contributors,
@@ -356,9 +445,76 @@ module KodiClient
                          fan_art, thumbnail, label, artist, artist_id, display_artist, musicbrainz_album_artist_id,
                          rating, sort_artist, user_rating, year, genre)
         end
+      end
+
+      # List.Item.File https://kodi.wiki/view/JSON-RPC_API/v12#List.Item.File
+      class ListItemFile
+        include ListItemBase
+        include Comparable
+        extend Creatable
+
+        attr_reader :file, :file_type, :last_modified, :mime_type, :size
+
+        def self.create(hash)
+          return nil if hash.nil?
+
+          cast = Types::Video::VideoCast.create_list(hash['cast'])
+          contributors = Types::Audio::AudioContributor.create_list(hash['contributors'])
+          resume = Types::Video::VideoResume.create(hash['resume'])
+          stream_details = Types::Video::Streams.create(hash['streamdetails'])
+          art = Types::Media::MediaArtwork.create(hash['art'])
+          hash['type'] = 'unknown' if hash['type'].nil?
+          new(*Creatable.hash_to_arr(hash, %w[file_type last_modified mime_type size]),
+              *Creatable.hash_to_arr(hash, %w[album album_artist album_artist_id album_id
+                                              album_release_type album_status bit_rate bpm]), cast,
+              hash['channels'], hash['comment'], hash['compilation'], contributors,
+              *Creatable.hash_to_arr(hash, %w[country description disc disc_title display_composer
+                                              display_conductor display_lyricist display_orchestra duration
+                                              dyn_path episode episode_guide first_aired id imdb_number
+                                              is_box_set lyrics media_path mood mpaa musicbrainz_artist_id
+                                              musicbrainz_track_id original_date original_title plot_outline
+                                              premiered production_code release_date release_type sample_rate
+                                              season set set_id show_link show_title sort_title
+                                              special_sort_episode special_sort_season studio style tag
+                                              tag_line theme top250 total_discs track trailer tv_show_id
+                                              type unique_id votes watched_episodes writer director]),
+              resume, hash['runtime'], stream_details,
+              *Creatable.hash_to_arr(hash, %w[date_added file last_played plot title]), art,
+              *Creatable.hash_to_arr(hash, %w[play_count fan_art thumbnail label artist artist_id
+                                              display_artist musicbrainz_album_artist_id rating sort_artist
+                                              user_rating year genre]))
+        end
 
-        def ==(other)
-          compare(self, other)
+        def initialize(file_type, last_modified, mime_type, size,
+                       album, album_artist, album_artist_id, album_id, album_release_type, album_status, bit_rate,
+                       bpm, cast, channels, comment, compilation, contributors, country, description, disc,
+                       disc_title, display_composer, display_conductor, display_lyricist, display_orchestra,
+                       duration, dyn_path, episode, episode_guide, first_aired, id, imdb_number, is_box_set,
+                       lyrics, media_path, mood, mpaa, musicbrainz_artist_id, musicbrainz_track_id, original_date,
+                       original_title, plot_outline, premiered, production_code, release_date, release_type,
+                       sample_rate, season, set, set_id, show_link, show_title, sort_title, special_sort_episode,
+                       special_sort_season, studio, style, tag, tag_line, theme, top250, total_discs, track,
+                       trailer, tv_show_id, type, unique_id, votes, watched_episodes, writer, director, resume,
+                       runtime, stream_details, date_added, file, last_played, plot, title, art, play_count,
+                       fan_art, thumbnail, label, artist, artist_id, display_artist, musicbrainz_album_artist_id,
+                       rating, sort_artist, user_rating, year, genre)
+          @file = file
+          @file_type = file_type
+          @last_modified = last_modified
+          @mime_type = mime_type
+          @size = size
+          list_item_base(album, album_artist, album_artist_id, album_id, album_release_type, album_status, bit_rate,
+                         bpm, cast, channels, comment, compilation, contributors, country, description, disc,
+                         disc_title, display_composer, display_conductor, display_lyricist, display_orchestra,
+                         duration, dyn_path, episode, episode_guide, first_aired, id, imdb_number, is_box_set,
+                         lyrics, media_path, mood, mpaa, musicbrainz_artist_id, musicbrainz_track_id, original_date,
+                         original_title, plot_outline, premiered, production_code, release_date, release_type,
+                         sample_rate, season, set, set_id, show_link, show_title, sort_title, special_sort_episode,
+                         special_sort_season, studio, style, tag, tag_line, theme, top250, total_discs, track,
+                         trailer, tv_show_id, type, unique_id, votes, watched_episodes, writer, director, resume,
+                         runtime, stream_details, date_added, file, last_played, plot, title, art, play_count,
+                         fan_art, thumbnail, label, artist, artist_id, display_artist, musicbrainz_album_artist_id,
+                         rating, sort_artist, user_rating, year, genre)
         end
       end
 

data/lib/kodi_client/global_types/video_types.rb

@@ -126,6 +126,8 @@ module KodiClient
         attr_reader :audio, :subtitle, :video
 
         def self.create(hash)
+          return nil if hash.nil?
+
           audio = Types::Player::AudioStream.create_list(hash['audio'])
           subtitle = Types::Player::Subtitle.create_list(hash['subtitle'])
           video = Types::Player::VideoStream.create_list(hash['video'])

data/lib/kodi_client/method/files.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/files_types'
+require 'kodi_client/global_types/list_types'
+
+module KodiClient
+  module Modules
+    # 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.rb

@@ -7,6 +7,7 @@ require 'kodi_client/Chainable'
 require 'kodi_client/method/addons'
 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'
@@ -22,12 +23,13 @@ module KodiClient
   class Client
     include Chainable
 
-    attr_reader :addons, :application, :gui, :player, :input, :favourites, :system, :profiles
+    attr_reader :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
+      @files = KodiClient::Modules::Files.new
       @gui = KodiClient::Modules::GUI.new
       @input = KodiClient::Modules::Input.new
       @player = KodiClient::Modules::Player.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kodi_client
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.6.0
 platform: ruby
 authors:
 - Christian Feier
@@ -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: []
@@ -47,6 +47,7 @@ files:
 - 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/files_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
@@ -62,6 +63,7 @@ files:
 - lib/kodi_client/method/addons.rb
 - lib/kodi_client/method/application.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