kodi_client 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80cc6b2d42829c10df356d2b3e8c2bf46dae2303db1596c7a8b8e1b6d7962379
+  data.tar.gz: 26d8be4a79379e65da672294cb612ff89600964828dad4f612a23a1a0d0c2e68
+SHA512:
+  metadata.gz: 39697217776c9224ee079b989a046a34cbde9310e8444109edcd550e19020dc0610c74cc1e3f750dde4eb95ccc3f946da302bd14dda5d6a1782935c0dc704dd2
+  data.tar.gz: f9eb383b7b973d6f1f9d55d6fad5aff9b704f79ff95b2882814cb85a8834d70872c8f7e805f015eb0a999c7cce4cc49a7c4206ba480039c71700111258052d9f

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/ParameterLists:
+  Enabled: false
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kodi_client.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
+
+gem 'http'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Chris
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# RubyKodiClient
+
+RubyKodiClient is a work-in-progress client for [Kodi JSON API v12](https://kodi.wiki/view/JSON-RPC_API/v12) written in ruby.
+
+Currently implemented are the following Methods:
+* Addons
+* Application
+* GUI
+* Player
+
+## Installation
+from [rubygems](https://rubygems.org/gems/kodi_client) using
+```shell
+gem install kodi-client
+```
+or from the sources using
+```shell
+gem build kodi-client.gemspec
+```
+and then execute
+```shell
+gem build kodi-client-0.4.0.gemspec
+```
+
+## Enable Kodi Remote Control
+In order to use JKodi Wrapper, Kodi remote control must be enabled. To do so perform the following steps:
+
+1.) Go to Settings
+![Settings](https://github.com/cf86/JKodiWrapper/blob/master/screenshots/Settings.png)
+
+2.) Open the Services Menu
+![Service](https://github.com/cf86/JKodiWrapper/blob/master/screenshots/Service.png)
+
+3.) Select the Control Tab
+![Control](https://github.com/cf86/JKodiWrapper/blob/master/screenshots/Control.png)
+
+4.) Enable Remote control
+![Remote Access](https://github.com/cf86/JKodiWrapper/blob/master/screenshots/RemoteAccess.png)
+
+## Usage
+
+To create a client you need at least the ip and port of the kodi server
+```ruby
+client = KodiClient.connect('127.0.0.1', 8080)
+```
+optional you can also provide authentication and if required, TLS 
+```ruby
+client = KodiClient.connect('127.0.0.1', 8080).auth('kodi', 'password').use_tls
+```
+once a client is created, all methods are available, e.g.
+```ruby
+client = KodiClient.connect('127.0.0.1', 8080).auth('kodi', 'password').use_tls
+application = client.application
+gui = client.gui
+```
+with the method aquired, all calls can be executed, for example to quit kodi
+```ruby
+client = KodiClient.connect('127.0.0.1', 8080).auth('kodi', 'password').use_tls
+application = client.application
+application.quit
+```
+or to play a movie
+```ruby
+client = KodiClient.connect('127.0.0.1', 8080).auth('kodi', 'password').use_tls
+player = client.player
+# the file can be a local path on the server, or e.g. an upnp file url
+player.player_open('path/to/file')
+```
+some calls just return a simple `OK` result, some also return some data, the full response is always returned
+in a `KodiResponse`, which contains any `error` and any `result` as specified in the documentation.
+```ruby
+client = KodiClient.connect('127.0.0.1', 8080).auth('kodi', 'password').use_tls
+player = client.player
+# the file can be a local path on the server, or e.g. an upnp file url
+player.player_open('path/to/file')
+# movie started, now we can seek (assuming it is player 1) to 50% of the movie
+response = player.seek(1, 50.0)
+# seek returns percentage, time and total time
+response.result.percentage # => 50.0
+response.result.time # => { 'hours' => 1, 'minutes' => 30, 'seconds' => 0}, 'milliseconds' => 0 }
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/kodi_client.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kodi_client'
+  spec.version       = '0.4.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, gui and player (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'
+
+  spec.metadata['homepage_uri'] = 'https://github.com/cfe86/RubyKodiClient'
+  spec.metadata['source_code_uri'] = 'https://github.com/cfe86/RubyKodiClient'
+  spec.metadata['changelog_uri'] = 'https://github.com/cfe86/RubyKodiClient'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/kodi_client/Chainable.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'kodi_client/options'
+
+module KodiClient
+  # Offers methods like connect, auth and tls to be chained together
+  module Chainable
+
+    attr_accessor :options, :client
+
+    def connect(ip, port)
+      merge_options(->(options) { options.with_connection(ip, port) })
+    end
+
+    def auth(username, password)
+      merge_options(->(options) { options.with_auth(username, password) })
+    end
+
+    def use_tls(enabled: true)
+      merge_options(->(options) { options.with_tls(enabled) })
+    end
+
+    def merge_options(set_command)
+      client = def_client
+      options = def_options
+      set_command.call(options)
+      client.apply_options(options)
+      client
+    end
+
+    def def_client
+      if @client.nil?
+        @client = KodiClient::Client.new
+        @client.client = @client
+      end
+      @client
+    end
+
+    def def_options
+      if @options.nil?
+        @options ||= KodiClient::Options.new
+        @client.options = @options
+      end
+      @options
+    end
+  end
+end

data/lib/kodi_client/global_types/addon_types.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+require 'kodi_client/global_types/item_types'
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/iterable'
+
+module KodiClient
+  module Types
+    module Addons
+
+      # Addon Types https://kodi.wiki/view/JSON-RPC_API/v12#Addon.Types
+      module AddonTypes
+        include Iterable
+
+        UNKNOWN = 'unknown'
+        KODI_ADSP = 'kodi.adsp'
+        KODI_AUDIODECODER = 'kodi.audiodecoder'
+        KODI_CONTEXT_ITEM = 'kodi.context.item'
+        KODI_GAME_CONTROLLER = 'kodi.game.controller'
+        KODI_INPUTSTREAM = 'kodi.inputstream'
+        KODI_PERIPHERAL = 'kodi.peripheral'
+        KODI_RESOURCE_IMAGES = 'kodi.resource.images'
+        KODI_RESOURCE_LANGUAGE = 'kodi.resource.language'
+        KODI_RESOURCE_UISOUNDS = 'kodi.resource.uisounds'
+        XBMC_ADDON_AUDIO = 'xbmc.addon.audio'
+        XBMC_ADDON_EXECUTABLE = 'xbmc.addon.executable'
+        XBMC_ADDON_IMAGE = 'xbmc.addon.image'
+        XBMC_ADDON_REPOSITORY = 'xbmc.addon.repository'
+        XBMC_ADDON_VIDEO = 'xbmc.addon.video'
+        XBMC_AUDIOENCODER = 'xbmc.audioencoder'
+        XBMC_GUI_SKIN = 'xbmc.gui.skin'
+        XBMC_METADATA_SCRAPER_ALBUMS = 'xbmc.metadata.scraper.albums'
+        XBMC_METADATA_SCRAPER_ARTISTS = 'xbmc.metadata.scraper.artists'
+        XBMC_METADATA_SCRAPER_LIBRARY = 'xbmc.metadata.scraper.library'
+        XBMC_METADATA_SCRAPER_MOVIES = 'xbmc.metadata.scraper.movies'
+        XBMC_METADATA_SCRAPER_MUSICVIDEOS = 'xbmc.metadata.scraper.musicvideos'
+        XBMC_METADATA_SCRAPER_TVSHOWS = 'xbmc.metadata.scraper.episodes'
+        XBMC_PLAYER_MUSICVIZ = 'xbmc.player.musicviz'
+        XBMC_PVRCLIENT = 'xbmc.pvrclient'
+        XBMC_PYTHON_LIBRARY = 'xbmc.python.library'
+        XBMC_PYTHON_LYRICS = 'xbmc.python.lyrics'
+        XBMC_PYTHON_MODULE = 'xbmc.python.module'
+        XBMC_PYTHON_PLUGINSOURCE = 'xbmc.python.pluginsource'
+        XBMC_PYTHON_SCRIPT = 'xbmc.python.script'
+        XBMC_PYTHON_WEATHER = 'xbmc.python.weather'
+        XBMC_SERVICE = 'xbmc.service'
+        XBMC_SUBTITLE_MODULE = 'xbmc.subtitle.module'
+        XBMC_UI_SCREENSAVER = 'xbmc.ui.screensaver'
+        XBMC_WEBINTERFACE = 'xbmc.webinterface'
+      end
+
+      # Addon.Content https://kodi.wiki/view/JSON-RPC_API/v12#Addon.Content
+      module AddonContent
+        include Iterable
+        UNKNOWN = 'unknown'
+        AUDIO = 'audio'
+        EXECUTABLE = 'executable'
+        IMAGE = 'image'
+        VIDEO = 'video'
+      end
+
+      # Addon.Fields https://kodi.wiki/view/JSON-RPC_API/v12#Addon.Content
+      module AddonFields
+        extend Iterable
+
+        AUTHOR = 'author'
+        BROKEN = 'broken'
+        DEPENDENCIES = 'dependencies'
+        DESCRIPTION = 'description'
+        DISCLAIMER = 'disclaimer'
+        ENABLED = 'enabled'
+        EXTRAINFO = 'extrainfo'
+        FANART = 'fanart'
+        INSTALLED = 'installed'
+        NAME = 'name'
+        PATH = 'path'
+        RATING = 'rating'
+        SUMMARY = 'summary'
+        THUMBNAIL = 'thumbnail'
+        VERSION = 'version'
+      end
+
+      # represents addon dependency
+      class AddonDependency
+        include Comparable
+
+        attr_reader :addonid, :optional, :version
+
+        def initialize(hash)
+          @addonid = hash['addonid']
+          @optional = hash['optional']
+          @version = hash['version']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # represents addon extra info
+      class AddonExtraInfo
+        include Comparable
+
+        attr_reader :key, :value
+
+        def initialize(hash)
+          @key = hash['key']
+          @value = hash['value']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # represents addon details
+      class AddonDetails
+        include Comparable
+        include Items::ItemDetailsBase
+
+        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)
+        end
+      end
+
+      # getAddons return
+      class Addons
+        include Comparable
+
+        attr_reader :addons, :limits
+
+        def initialize(hash)
+          @addons = hash['addons'].map { |it| AddonDetails.new(it) }
+          @limits = List::ListLimitsReturned.new(hash['limits'])
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # getAddon return
+      class Addon
+        include Comparable
+
+        attr_reader :addon
+
+        def initialize(hash)
+          @addon = AddonDetails.new(hash['addon'])
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/application_types.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'kodi_client/util/comparable'
+require 'kodi_client/util/iterable'
+
+module KodiClient
+  module Types
+    module Application
+
+      # Application.Property.Name https://kodi.wiki/view/JSON-RPC_API/v12#Application.Property.Name
+      module PropertyName
+        extend Iterable
+
+        VOLUME = 'volume'
+        MUTED = 'muted'
+        NAME = 'name'
+        VERSION = 'version'
+        SORT_TOKENS = 'sorttokens'
+        LANGUAGE = 'language'
+      end
+
+      # Application.Property.Value https://kodi.wiki/view/JSON-RPC_API/v12#Application.Property.Value
+      class PropertyValue
+        include Comparable
+
+        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
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+
+      # represent application properties version
+      class Version
+        include Comparable
+        attr_reader :major, :minor, :revision, :tag
+
+        def initialize(hash)
+          @major = hash['major']
+          @minor = hash['minor']
+          @revision = hash['revision']
+          @tag = hash['tag']
+        end
+
+        def ==(other)
+          compare(self, other)
+        end
+      end
+    end
+  end
+end

data/lib/kodi_client/global_types/audio_types.rb

@@ -0,0 +1,77 @@
+# 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'
+
+module KodiClient
+  module Types
+    module Audio
+
+      # Audio.Contributor https://kodi.wiki/view/JSON-RPC_API/v12#Audio.Contributors
+      class AudioContributor
+        include Comparable
+
+        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)
+        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(hash)
+          @art = Types::Media::MediaArtwork.new(hash['art'])
+          @date_added = hash['date_added']
+          @genre = hash['genre']
+          media_details_base(hash)
+        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_albumartist_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)
+        end
+      end
+    end
+  end
+end