xbmc-jsonrpc 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 atom smith
+
+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.rdoc

@@ -0,0 +1,91 @@
+= xbmc-jsonrpc
+
+XBMC_JSONRPC is a module created for simple interaction with the XBMC JSONRPC API introduced in XBMC dharma 2.
+
+Create a new connection:
+       irb(main):001:0> x = XBMC_JSONRPC.new
+       => XBMC_JSONRPC
+
+List all commands (including the details):
+
+     irb(main):002:0> x.commands
+     => {"System.GetInfoLabels"=>{"executable"=>true, "permission"=>"ReadData", "description"=>"Retrieve info labels about the system"}, "Files.Download"=>{"executable"=>true, "permission"=>"ReadData", "description"=>"Specify a file to download to get info about how to download it, i.e a proper URL"}, "PicturePlayer.PlayPause"=>{"executable"=>true, "permission"=>"ControlPlayback", "description"=>"Pauses or unpause slideshow"}.....
+
+Find suitable commands based on name / description:
+
+     irb(main):003:0> x.apropos :slideshow
+
+     	PicturePlayer.PlayPause
+        		Pauses or unpause slideshow
+
+
+        XBMC.StartSlideshow
+           		Starts slideshow. Parameter example {"directory": "/foo/", "random": true, "recursive": true} or just string to recursively and random run directory
+
+
+        PicturePlayer.Stop
+           		Stops slideshow
+
+
+        PicturePlayer.SkipNext
+           		Skips to next picture in the slideshow
+
+
+       	PicturePlayer.SkipPrevious
+           		Skips to previous picture in the slideshow
+
+     => nil
+
+
+Get the commands for a namespace:
+
+    irb(main):007:0> x::XBMC.commands
+
+    	XBMC.Play
+        		Starts playback
+
+
+        XBMC.GetVolume
+           		Retrieve the current volume
+
+
+        XBMC.StartSlideshow
+          		Starts slideshow. Parameter example {"directory": "/foo/", "random": true, "recursive": true} or just string to recursively and random run directory
+
+
+        XBMC.SetVolume
+           		Set volume. Parameter integer between 0 amd 100
+
+
+       	XBMC.Quit
+           		Quit xbmc
+
+
+       	XBMC.Log
+           		Logs a line in the xbmc.log. Parameter example {"message": "foo", "level": "info"} or just a string to log message with level debug
+
+
+     	XBMC.ToggleMute
+           		Toggle mute
+
+=> [nil, nil, nil, nil, nil, nil, nil]
+
+
+Commands are run like so:
+
+         irb(main):008:0> x::VideoPlayer.PlayPause
+         => {"result"=>{"playing"=>true, "paused"=>false}, "id"=>1, "jsonrpc"=>"2.0"}
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 atom smith. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "xbmc-jsonrpc"
+    gem.summary = %Q{A module for interacting with xbmc's json-rpc server}
+    gem.description = %Q{A module for interacting with xbmc's json-rpc server}
+    gem.email = "re5etsmyth@gmail.com"
+    gem.homepage = "http://github.com/re5et/xbmc-jsonrpc"
+    gem.authors = ["atom smith"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "xbmc-jsonrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/xbmc-jsonrpc.rb

@@ -0,0 +1,457 @@
+# This program allows easy interaction with XBMC's json-rpc API.
+# Connection information is provided, and connection is created
+# and stored for repeated use.  The list of classes and methods
+# available are retrieved from the XBMC json-rpc API, and can be
+# accessed or referenced using instance.commands or
+# instance.print_commands.  An command can be searched for using
+# instance.apropos
+#
+# Author:: atom smith (http://twitter.com/re5et)
+# Copyright:: Copyright (c) 2010 atom smith
+# License:: Distributes under the same terms as Ruby
+
+require 'rubygems'
+require 'net/http'
+require 'json'
+
+# The XBMC_JSONRPC module is a namespace / wrapper
+
+module XBMC_JSONRPC
+
+  # Attempt to create connection with xbmc server, and retrieve available
+  # commands.  Accepts connection information arguments and if successful
+  # returns a new connection
+  def self.new(options = {})
+    @connection = XBMC_JSONRPC::Connection.new(options)
+    if @connection.command('JSONRPC.Ping')
+      commands = @connection.command('JSONRPC.Introspect')['result']['commands']
+      @commands = {}
+
+      commands.each do |command|
+        command_name = command.shift[1]
+        @commands[command_name] = command
+      end
+      return self
+    end
+    return false
+  end
+
+  # Make an API call to the instance XBMC server
+  def self.command(method,args = {})
+    @connection.command(method, args)
+  end
+
+  # returns all available commands returned by JSON.Introspect
+  def self.commands
+    @commands
+  end
+
+  # nicely print out all available commands.
+  # useful at command line / irb / etc
+  def self.get_commands
+    @commands.each {|k,v| self.pp_command k  }
+    return nil
+  end
+
+  # finds and prettily prints appropriate commands based on provided keyword
+  def self.apropos(find)
+    regexp = /#{find}/im
+    matches = []
+    @commands.each do |k,v|
+      matches.push(k) if k =~ regexp || v['description'] =~ regexp
+    end
+    if matches.empty?
+      puts "\n\nNo commands found, try being less specific\n\n"
+    else
+      matches.each {|command| self.pp_command command }
+    end
+    return nil
+  end
+
+  # prettily print out requested command
+  def self.pp_command(command)
+    description = @commands[command]['description']
+    description = "<no description exists for #{command}>" unless !description.empty?
+
+    puts "\n\t#{command}"
+    puts "\t\t#{description}\n\n"
+  end
+
+  # Class to create and store connection information for xbmc server
+  # also handles actual json back and forth.
+  class Connection
+
+    def initialize(options)
+
+      connection_info = {
+        :server => '127.0.0.1',
+        :port => '8080',
+        :user => 'xbmc',
+        :pass => ''
+      }
+
+      @connection_info = connection_info.merge(options)
+
+      @url = URI.parse("http://#{@connection_info[:server]}:#{@connection_info[:port]}/jsonrpc")
+    end
+
+    def command(method, params = {})
+      req = Net::HTTP::Post.new(@url.path)
+      req.basic_auth @connection_info[:user], @connection_info[:pass]
+      req.add_field 'Content-Type', 'application/json'
+      req.body = {
+        "id" => 1,
+        "jsonrpc" => "2.0",
+        "method" => method,
+        "params" => params
+      }.to_json
+
+      res = Net::HTTP.new(@url.host, @url.port).start {|http| http.request(req) }
+
+      if res.kind_of? Net::HTTPSuccess
+        return JSON.parse(res.body)
+      else
+        return res.error!
+      end
+    rescue StandardError
+      print "Unable to connect to server specified\n", $!
+      return false
+    end
+
+  end
+
+  # utility class for others to inherit from.  For now uses method missing
+  # to make all calls to the send_command because there is no meaningful
+  # difference between namespaces / methods at the moment.
+  class APIBase
+
+    # get the correct api namespace to use
+    def self.namespace
+      @namespace = @namespace || self.name.to_s.split('::')[1]
+    end
+
+    # pass on namespace + method and arguments
+    def self.method_missing(method, args = {})
+      XBMC_JSONRPC.command("#{self.namespace}.#{method}", args)
+    end
+
+    # show commands for namespace
+    def self.commands
+      XBMC_JSONRPC.commands.keys.grep(/#{self.namespace}\./) {|command| XBMC_JSONRPC.pp_command(command) }
+    end
+
+  end
+
+  class JSONRPC < APIBase
+
+    # def self.Introspect
+    # end
+
+    # def self.Version
+    # end
+
+    # def self.Permission
+    # end
+
+    # def self.Ping
+    # end
+
+    # def self.Announce
+    # end
+
+  end
+
+  class Player < APIBase
+
+    # def self.GetActivePlayers
+    # end
+
+  end
+
+  class AudioPlayer < APIBase
+
+    # same methods as VideoPlayer
+
+  end
+
+  class VideoPlayer < APIBase
+
+    # def self.PlayPause
+    # end
+
+    # def self.Stop
+    # end
+
+    # def self.SkipPrevious
+    # end
+
+    # def self.SkipNext
+    # end
+
+    # def self.BigSkipBackward
+    # end
+
+    # def self.BigSkipForward
+    # end
+
+    # def self.SmallSkipBackward
+    # end
+
+    # def self.SmallSkipForward
+    # end
+
+    # def self.Rewind
+    # end
+
+    # def self.Forward
+    # end
+
+    # def self.GetTime
+    # end
+
+    # def self.GetTimeMS
+    # end
+
+    # def self.GetPercentage
+    # end
+
+    # def self.SeekTime
+    # end
+
+    # def self.SeekPercentage
+    # end
+
+  end
+
+  class PicturePlayer < APIBase
+
+    # def self.PlayPause
+    # end
+
+    # def self.Stop
+    # end
+
+    # def self.SkipPrevious
+    # end
+
+    # def self.SkipNext
+    # end
+
+    # def self.MoveLeft
+    # end
+
+    # def self.MoveRight
+    # end
+
+    # def self.MoveDown
+    # end
+
+    # def self.MoveUp
+    # end
+
+    # def self.ZoomOut
+    # end
+
+    # def self.ZoomIn
+    # end
+
+    # def self.Zoom
+    # end
+
+    # def self.Rotate
+    # end
+
+  end
+
+  class VideoPlaylist < APIBase
+
+    # def self.Play
+    # end
+
+    # def self.SkipPrevious
+    # end
+
+    # def self.SkipNext
+    # end
+
+    # def self.GetItems
+    # end
+
+    # def self.Add
+    # end
+
+    # def self.Clear
+    # end
+
+    # def self.Shuffle
+    # end
+
+    # def self.UnShuffle
+    # end
+
+  end
+
+  class AudioPlaylist < APIBase
+
+    # def self.Play
+    # end
+
+    # def self.SkipPrevious
+    # end
+
+    # def self.SkipNext
+    # end
+
+    # def self.GetItems
+    # end
+
+    # def self.Add
+    # end
+
+    # def self.Clear
+    # end
+
+    # def self.Shuffle
+    # end
+
+    # def self.UnShuffle
+    # end
+
+  end
+
+  class Playlist < APIBase
+
+    # def self.Create
+    # end
+
+    # def self.Destroy
+    # end
+
+    # def self.GetItems
+    # end
+
+    # def self.Add
+    # end
+
+    # def self.Remove
+    # end
+
+    # def self.Swap
+    # end
+
+    # def self.Shuffle
+    # end
+
+  end
+
+  class Files < APIBase
+
+    # def self.GetSources
+    # end
+
+    # def self.Download
+    # end
+
+    # def self.GetDirectory
+    # end
+
+  end
+
+  class AudioLibrary < APIBase
+
+    # def self.GetArtists
+    # end
+
+    # def self.GetAlbums
+    # end
+
+    # def self.GetSongs
+    # end
+
+    # def self.ScanForContent
+    # end
+
+  end
+
+  class VideoLibrary < APIBase
+
+    # def self.GetMovies
+    # end
+
+    # def self.GetTVShows
+    # end
+
+    # def self.GetSeasons
+    # end
+
+    # def self.GetEpisodes
+    # end
+
+    # def self.GetMusicVideoAlbums
+    # end
+
+    # def self.GetMusicVideos
+    # end
+
+    # def self.GetRecentlyAddedMovies
+    # end
+
+    # def self.GetRecentlyAddedEpisodes
+    # end
+
+    # def self.GetRecentlyAddedMusicVideos
+    # end
+
+    # def self.ScanForContent
+    # end
+
+  end
+
+  class System < APIBase
+
+    # def self.Shutdown
+    # end
+
+    # def self.Suspend
+    # end
+
+    # def self.Hibernate
+    # end
+
+    # def self.Reboot
+    # end
+
+    # def self.GetInfoLabels
+    # end
+
+    # def self.GetInfoBooleans
+    # end
+
+  end
+
+  class XBMC < APIBase
+
+    # def self.GetVolume
+    # end
+
+    # def self.SetVolume
+    # end
+
+    # def self.ToggleMute
+    # end
+
+    # def self.Play
+    # end
+
+    # def self.StartSlideShow
+    # end
+
+    # def self.Log
+    # end
+
+    # def self.Quit
+    # end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'xbmc-jsonrpc'
+
+class Test::Unit::TestCase
+end

data/test/test_xbmc-jsonrpc.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestXbmcJsonrpc < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/xbmc-jsonrpc.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{xbmc-jsonrpc}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["atom smith"]
+  s.date = %q{2010-10-14}
+  s.description = %q{A module for interacting with xbmc's json-rpc server}
+  s.email = %q{re5etsmyth@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/xbmc-jsonrpc.rb",
+     "test/helper.rb",
+     "test/test_xbmc-jsonrpc.rb",
+     "xbmc-jsonrpc.gemspec"
+  ]
+  s.homepage = %q{http://github.com/re5et/xbmc-jsonrpc}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A module for interacting with xbmc's json-rpc server}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_xbmc-jsonrpc.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: xbmc-jsonrpc
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- atom smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A module for interacting with xbmc's json-rpc server
+email: re5etsmyth@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/xbmc-jsonrpc.rb
+- test/helper.rb
+- test/test_xbmc-jsonrpc.rb
+- xbmc-jsonrpc.gemspec
+has_rdoc: true
+homepage: http://github.com/re5et/xbmc-jsonrpc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A module for interacting with xbmc's json-rpc server
+test_files: 
+- test/helper.rb
+- test/test_xbmc-jsonrpc.rb