kodi_client 0.5.0 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d7046ba7c1c40c4302d7563b33a8805b83b3275069697af432b2880a59daf05
-  data.tar.gz: 340843f609031566aee613714f5a0e52b65add52bee208141e6ef3eee8fe929c
+  metadata.gz: a3f04d9b1f829af8765bb790f49accaa47bebd71b1d4e1755b1776782d089fdb
+  data.tar.gz: 29d45652a206f4d32c05103a520eb984c5925a775dfe9479535b57d6d5d3a477
 SHA512:
-  metadata.gz: 3af04fc11780d040693c50348d3ce5aded43cb67ae8ae8487498d4a9d66f6d3286b684716798d57e70bc6f58128ba4022d9fae35af635ce6ce016a7663e53c74
-  data.tar.gz: de5b32cc6ad5c54b3efd5bc0e75544c66444a2c566d097fd13244122019da1dc3435df15a649d0a4ebda1e8171e5f4afd6865fc2d092fcfddbe351587a67d5c3
+  metadata.gz: 17431c4ec21d3b0f315847aacca3efd821afb1d4d0dcee1deae25196b4ad0a74effb6b08e53a6a97c727dd5302eef409560e55b39ee02f002e55bd73e01eefda
+  data.tar.gz: 3461b3f8babd1636c722a4d2fab9ac8391446c4f0144f8c744a87555fe155b1b7197ccd1f559951fef133ba9324934a89a9ea75682388efaf68d45e71b70f42a

data/README.md

@@ -9,6 +9,7 @@ Currently implemented are the following Methods:
 * GUI
 * Input
 * Player
+* Profile
 * 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.5.5'
   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, 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'
   spec.homepage      = 'https://github.com/cfe86/RubyKodiClient'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.5.0'

data/lib/kodi_client/global_types/audio_types.rb

@@ -1,7 +1,6 @@
 # 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'
 

data/lib/kodi_client/global_types/favourites_types.rb

@@ -30,7 +30,7 @@ module KodiClient
       end
 
       # Favourite.Details.Favourite https://kodi.wiki/view/JSON-RPC_API/v12#Favourite.Details.Favourite
-      class Favourite
+      class DetailsFavourite
         include Comparable
 
         attr_reader :path, :thumbnail, :title, :type, :window, :window_parameter
@@ -56,7 +56,7 @@ module KodiClient
         attr_reader :favourites, :limits
 
         def initialize(hash)
-          @favourites = hash['favourites'].map { |it| Favourite.new(it) }
+          @favourites = hash['favourites'].map { |it| DetailsFavourite.new(it) }
           @limits = Types::List::ListLimitsReturned.new(hash['limits'])
         end
 

data/lib/kodi_client/global_types/global_types.rb

@@ -18,7 +18,7 @@ module KodiClient
 
       # rotate for clockwise and counter clockwise
       module Rotate
-        include Iterable
+        extend Iterable
 
         CLOCKWISE = 'clockwise'
         COUNTER_CLOCKWISE = 'counterclockwise'
@@ -26,7 +26,7 @@ module KodiClient
 
       # direction for left, right, up, down
       module Direction
-        include Iterable
+        extend Iterable
 
         LEFT = 'left'
         RIGHT = 'right'
@@ -36,7 +36,7 @@ module KodiClient
 
       # enum for prev/next
       module NextPrev
-        include Iterable
+        extend Iterable
 
         NEXT = 'next'
         PREV = 'previous'
@@ -46,7 +46,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'
@@ -99,6 +99,14 @@ module KodiClient
           compare(self, other)
         end
       end
+
+      # available Password Encryptions
+      module PasswordEncryption
+        extend Iterable
+
+        NONE = 'none'
+        MD5 = 'md5'
+      end
     end
   end
 end

data/lib/kodi_client/global_types/input_types.rb

@@ -8,7 +8,7 @@ module KodiClient
 
       # Input.Action https://kodi.wiki/view/JSON-RPC_API/v12#Input.Action
       module InputAction
-        include Iterable
+        extend Iterable
 
         ANALOGFASTFORWARD = 'analogfastforward'
         ANALOGMOVE = 'analogmove'

data/lib/kodi_client/global_types/list_types.rb

@@ -41,6 +41,33 @@ module KodiClient
         end
       end
 
+      # ascending/descending for sorting
+      module SortOrder
+        extend Iterable
+
+        ASCENDING = 'ascending'
+        DESCENDING = 'descending'
+      end
+
+      # List.Sort https://kodi.wiki/view/JSON-RPC_API/v12#List.Sort
+      class ListSort
+        include Comparable
+
+        attr_reader :ignore_article, :method, :order, :use_artist_sort_name
+
+        def initialize(ignore_article = false, method = ListSortMethod::NONE,
+                       sortOrder = SortOrder::ASCENDING, use_artist_sort_name = false)
+          @ignore_article = ignore_article
+          @method = method
+          @order = SortOrder::ASCENDING
+          @use_artist_sort_name = use_artist_sort_name
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
       # List.Fields.All https://kodi.wiki/view/JSON-RPC_API/v12#List.Fields.All
       module ListFieldsAll
         extend Iterable
@@ -241,6 +268,53 @@ module KodiClient
           compare(self, other)
         end
       end
+
+      # methods for list sorting
+      module ListSortMethod
+        extend Iterable
+
+        NONE = 'none'
+        LABEL = 'label'
+        DATE = 'date'
+        SIZE = 'size'
+        FILE = 'file'
+        PATH = 'path'
+        DRIVE_TYPE = 'drivetype'
+        TITLE = 'title'
+        TRACK = 'track'
+        TIME = 'time'
+        ARTIST = 'artist'
+        ALBUM = 'album'
+        ALBUM_TYPE = 'albumtype'
+        GENRE = 'genre'
+        COUNTRY = 'country'
+        YEAR = 'year'
+        RATING = 'rating'
+        USER_RATING = 'userrating'
+        VOTES = 'votes'
+        TOP_250 = 'top250'
+        PROGRAM_COUNT = 'programcount'
+        PLAYLIST = 'playlist'
+        EPISODE = 'episode'
+        SEASON = 'season'
+        TOTAL_EPISODES = 'totalepisodes'
+        WATCHED_EPISODES = 'watchedepisodes'
+        TV_SHOW_STATUS = 'tvshowstatus'
+        TV_SHOW_TITLE = 'tvshowtitle'
+        SORT_TITLE = 'sorttitle'
+        PRODUCTION_CODE = 'productioncode'
+        MPAA = 'mpaa'
+        STUDIO = 'studio'
+        DATE_ADDED = 'dateadded'
+        LAST_PLAYED = 'lastplayed'
+        PLAY_COUNT = 'playcount'
+        LISTENERS = 'listeners'
+        BITRATE = 'bitrate'
+        RANDOM = 'random'
+        TOTAL_DISCS = 'totaldiscs'
+        ORIGINAL_DATE = 'originaldate'
+        BPM = 'bpm'
+      end
     end
   end
 end

data/lib/kodi_client/global_types/profiles_types.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/iterable'
+require 'kodi_client/global_types/item_types'
+
+module KodiClient
+  module Types
+    module Profiles
+
+      # Profiles.Fields.Profile https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Fields.Profile
+      module FieldsProfile
+        extend Iterable
+
+        LOCK_MODE = 'lockmode'
+        THUMBNAIL = 'thumbnail'
+      end
+
+      # Profiles.Details.Profile https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Details.Profile
+      class DetailsProfile
+        include Comparable
+        include Items::ItemDetailsBase
+
+        attr_reader :lock_mode, :thumbnail
+
+        def initialize(hash)
+          @lock_mode = hash['lockmode']
+          @thumbnail = hash['thumbnail']
+          item_details_base(hash)
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # return type for Profiles.GetProfiles
+      class GetProfilesReturned
+        include Comparable
+
+        attr_reader :limits, :profiles
+
+        def initialize(hash)
+          @limits = Types::List::ListLimitsReturned.new(hash['limits'])
+          @profiles = hash['profiles'].nil? ? [] : hash['profiles'].map { |it| Types::Profiles::DetailsProfile.new(it) }
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # Profiles.Password https://kodi.wiki/view/JSON-RPC_API/v12#Profiles.Password
+      class ProfilePassword
+        include Comparable
+
+        attr_reader :value, :encryption
+
+        def initialize(value, encryption = Types::Global::PasswordEncryption::MD5)
+          @value = value
+          @encryption = encryption
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/pvr_type.rb

@@ -8,6 +8,8 @@ module KodiClient
 
       # PVR.Channel.Type https://kodi.wiki/view/JSON-RPC_API/v12#PVR.Channel.Type
       module ChannelType
+        extend Iterable
+        
         TV = 'TV'
         RADIO = 'Radio'
       end

data/lib/kodi_client/kodi_module.rb

@@ -17,6 +17,7 @@ module KodiClient
       h = request.instance_variables.each_with_object({}) do |var, hash|
         hash[var.to_s.delete('@')] = request.instance_variable_get(var)
       end
+
       @http_client ||= build_client
       response = @http_client.post(@endpoint_url, json: h).to_s
       JSON.parse(response)

data/lib/kodi_client/method/profiles.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'kodi_client/kodi_module'
+require 'kodi_client/global_types/profiles_types'
+
+module KodiClient
+  module Modules
+    # contains all Kodi Application methods
+    class Profiles < KodiModule
+
+      GET_CURRENT_PROFILE = 'Profiles.GetCurrentProfile'
+      GET_PROFILES = 'Profiles.GetProfiles'
+      LOAD_PROFILE = 'Profiles.LoadProfile'
+
+      def get_current_profile(properties = Types::Profiles::FieldsProfile.all_properties, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_CURRENT_PROFILE, { 'properties' => properties })
+        json = invoke_api(request)
+        result = json['result'].nil? ? nil : Types::Profiles::DetailsProfile.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def get_profiles(properties = Types::Profiles::FieldsProfile.all_properties,
+                       limit = Types::List::ListLimits.new(0, 50),
+                       sort = Types::List::ListSort.new, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, GET_PROFILES,
+                                  { 'properties' => properties,
+                                    'limits' => { 'start' => limit.list_start, 'end' => limit.list_end },
+                                    'sort' => { 'ignorearticle' => sort.ignore_article, 'method' => sort.method,
+                                                'order' => sort.order,
+                                                'useartistsortname' => sort.use_artist_sort_name } })
+        json = invoke_api(request)
+        result = json['result'].nil? ? nil : Types::Profiles::GetProfilesReturned.new(json['result'])
+        json['result'] = result
+        KodiResponse.new(json)
+      end
+
+      def load_profile(profile_name, password, prompt = false, kodi_id = 1)
+        request = KodiRequest.new(kodi_id, LOAD_PROFILE,
+                                  { 'profile' => profile_name,
+                                    'password' => { 'value' => password.value, 'encryption' => password.encryption },
+                                    'prompt' => prompt })
+        json = invoke_api(request)
+        KodiResponse.new(json)
+      end
+    end
+  end
+end

data/lib/kodi_client.rb

@@ -10,6 +10,7 @@ require 'kodi_client/method/favourites'
 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'
 
 
@@ -21,7 +22,7 @@ module KodiClient
   class Client
     include Chainable
 
-    attr_reader :addons, :application, :gui, :player, :input, :favourites, :system
+    attr_reader :addons, :application, :gui, :player, :input, :favourites, :system, :profiles
 
     def initialize
       @addons = KodiClient::Modules::Addons.new
@@ -30,6 +31,7 @@ module KodiClient
       @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
     end
 
@@ -40,7 +42,20 @@ module KodiClient
       @input.apply_options(options)
       @player.apply_options(options)
       @favourites.apply_options(options)
+      @profiles.apply_options(options)
       @system.apply_options(options)
     end
   end
 end
+
+client = KodiClient.connect('10.88.111.7', 8080).auth('kodi', 'pw')
+a = client.profiles
+b = a.get_current_profile
+puts b
+# # a.player_open('http://10.88.111.7:1238/%25/2734c6a5037a2c2cafb3b3c184e1ee6f/Breaking%2520Bad%2520-%2520S01E01%2520-%2520Pilot.mkv')
+# a.player_open('C:\Users\Chris\Downloads\bla\Breaking Bad - S01E01 - Pilot.mkv')
+# c = a.get_view_mode
+# puts c
+# a = KodiClient.connect('10.88.111.7', 8080).auth('kodi', 'pw')
+# b = a.application
+# b.quit

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kodi_client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.5
 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 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, 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
 email:
 - christian.feier@gmail.com
 executables: []
@@ -54,6 +54,7 @@ files:
 - 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
@@ -64,6 +65,7 @@ files:
 - 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/util/comparable.rb