xbmc-client 0.1.0

data/.document

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

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gemspec
+
+group :development do
+
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    xbmc-client (0.1.0)
+      activesupport (>= 3.0.0)
+      httparty (>= 0.6.0)
+      i18n
+      json (>= 1.4.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    crack (0.1.8)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    i18n (0.4.2)
+    json (1.4.6)
+    shoulda (2.10.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.0)
+  httparty (>= 0.6.0)
+  i18n
+  json (>= 1.4.5)
+  shoulda (= 2.10.3)
+  xbmc-client!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Christoph Olszowka
+
+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,79 @@
+= XBMC-Client
+
+This is a simple Ruby client for the XBMC (XBox Media Center) JSON-RPC API.
+
+It does not define all the API methods explicitly, but rather loads and defines them
+on the fly by pulling the available namespaces and methods from the JSONRPC.Introspect
+call baked into the XBMC Api and thus has all methods described there available via
+Xbmc::NAMESPACE.method_name_in_underscore_writing, so for example the JSON RPC call 
+`AudioPlayer.PlayPause` becomes `Xbmc::AudioPlayer.play_pause`.
+
+Parameters can be passed in to all methods via the optional first argument to each
+method call, which is expected to be a hash: `Xbmc::AudioLibrary.get_songs(:albumid => 1)`
+
+Note that this is a very early release and is considered experimental. There will
+be bugs.
+
+The client is being developed against Ruby 1.9.2, but should work with Ruby 1.8 as well.
+
+== Install
+
+  gem install xbmc-client
+  
+== Usage
+
+  require 'pp'
+  require 'xbmc-client'
+  
+  # Set up the url and auth credentials
+  Xbmc.base_uri "http://localhost:8435"
+  Xbmc.basic_auth "xbmc", "xbmc"
+  Xbmc.load_api! # This will call JSONRPC.Introspect and create all subclasses and methods dynamically
+  
+  pp Xbmc::AudioLibrary.get_artists
+  # > [{"artistid"=>1,
+  #    "fanart"=>"special://masterprofile/Thumbnails/Music/Fanart/c03803be.tbn",
+  #    "label"=>"The Weakerthans"}, ... ]
+  
+  pp Xbmc::AudioLibrary.get_songs(:albumid => 1)
+  # [{"fanart"=>"special://masterprofile/Thumbnails/Music/Fanart/c03803be.tbn",
+  #   "file"=>
+  #   "/some/path/to/a/file.mp3",
+  #   "label"=>"Elegy for Elsabet",
+  #   "songid"=>20}, ...]
+  
+  # You can interact with the raw api with:
+  Xbmc.invoke_method('JSONRPC.Introspect', :getdescriptions => 'true') # Will return the raw response
+  Xbmc.invoke_and_process('JSONRPC.Introspect, :getdescriptions => 'true') # Will return the JSON-parsed response body's result subcollection
+  
+
+As you'll notice, it tries to automatically pull the correct collection for `get_xyz`
+calls, which means that you don't have to go to the subcollection [:result][:artists] in the
+above example like you would if the response would be returned unprocessed.
+
+See the examples directory in the repository for further usage examples!
+
+Also, be sure to check out the API docs at the XBMC wiki: 
+http://wiki.xbmc.org/index.php?title=JSON_RPC
+
+== Issues
+
+* No unit tests
+* No parameter validation
+* Fields (i.e. album details etc.) should be automatically requested by the api, but this would
+  currently require the JSONRPC.Introspect Api method to return a collection of available fields
+  for each method.
+
+== 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 Christoph Olszowka. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "xbmc-client"
+    gem.summary = %Q{A simple API client for the XBMC JSON-RPC API}
+    gem.description = %Q{A simple API client for the XBMC JSON-RPC API}
+    gem.email = "christoph at olszowka de"
+    gem.homepage = "http://github.com/colszowka/xbmc-client"
+    
+    gem.add_dependency 'httparty', ">= 0.6.0"
+    gem.add_dependency 'json', ">= 1.4.5"
+    gem.add_dependency 'activesupport', ">= 3.0.0"
+    gem.add_dependency 'i18n'
+    
+    gem.authors = ["Christoph Olszowka"]
+    gem.add_development_dependency "shoulda", "2.10.3"
+    # 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-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/audio_library.rb

@@ -0,0 +1,15 @@
+require 'pp'
+require './' + File.join(File.dirname(__FILE__), '../lib', 'xbmc-client')
+
+Xbmc.base_uri "http://localhost:8435"
+Xbmc.basic_auth "xbmc", "xbmc"
+
+Xbmc.load_api!
+
+pp Xbmc::AudioLibrary.get_artists
+puts "="*60
+pp Xbmc::AudioLibrary.get_albums(:artistid => Xbmc::AudioLibrary.get_artists.first[:artistid])
+puts "="*60
+pp Xbmc::AudioLibrary.get_songs(:albumid => 1)
+
+pp Xbmc::AudioPlayer.play_pause

data/lib/ruby_ext.rb

@@ -0,0 +1,7 @@
+class Object
+  def metaclass
+    class << self
+      self
+    end
+  end
+end

data/lib/xbmc-client.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default)
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ruby_ext'
+require 'active_support/core_ext'
+
+# A simple XBMC JSON RPC API Client. See README for details.
+class Xbmc
+  # Error class for indicating trouble with authentication against the XBMC Api
+  class UnauthorizedError < StandardError; end;
+  
+  include HTTParty
+
+  class << self
+    # API interaction: Invokes the given method with given params, parses the JSON response body, maps it to
+    # a HashWithIndifferentAccess and returns the :result subcollection
+    def invoke_and_process(method, params={})
+      JSON.parse(invoke_method(method, params).body).with_indifferent_access[:result]
+    end
+    
+    # Raw API interaction: Invoke the given JSON RPC Api call and return the raw response (which is an instance of
+    # HTTParty::Response)
+    def invoke_method(method, params={})
+      response = post('/jsonrpc', :body => {"jsonrpc" => "2.0", "params" => params, "id" => "1", "method" => method}.to_json)
+      raise Xbmc::UnauthorizedError, "Could not authorize with XBMC. Did you set up your credentials for basic_auth using Xbmc.basic_auth 'user', 'pass'?" if response.response.class == Net::HTTPUnauthorized
+      response
+      
+    # Capture connection errors and send them out with a custom message
+    rescue Errno::ECONNREFUSED, SocketError, HTTParty::UnsupportedURIScheme => err
+      raise err.class, err.message + ". Did you configure the url and port for XBMC properly using Xbmc.base_uri 'http://localhost:1234'?"
+    end
+
+    # Returns an array of available api commands instantiated as Xbmc::Command objects
+    def commands
+      @commands ||= invoke_and_process("JSONRPC.Introspect", :getdescriptions => true)[:commands].map {|c| Xbmc::Command.new(c[:command])}
+    end
+
+    # Loads the available commands via JSONRPC.Introspect and defines the namespace classes and corresponding methods
+    # in the ruby namespace
+    def load_api!
+      return false if @api_loaded
+      commands.each do |command|
+        command.send :define_method!
+      end
+      @api_loaded = true
+    end
+  end
+end
+
+require 'xbmc/command'

data/lib/xbmc/command.rb

@@ -0,0 +1,49 @@
+# Representation of a XBMC JSON RPC method
+class Xbmc::Command
+  attr_reader :command, :namespace, :method_name, :original_method
+
+  def initialize(command)
+    @command = command
+    parse_command!
+  end
+
+  # Invokes this command and processes the result
+  def invoke(params={})
+    process_result(Xbmc.invoke_and_process(command, params))
+  end
+
+  private
+
+  # Extract the namespace and method names from the given JSON RPC raw command name
+  def parse_command!
+    @namespace, @original_method = command.split('.')
+    @method_name = original_method.underscore
+  end
+
+  # Will create the corresponding class for namespace if not defined yet
+  # and also define the given method
+  def define_method!
+    klass_name = "Xbmc::#{namespace}"
+    begin
+      klass = klass_name.constantize
+    rescue NameError => err
+      eval("#{klass_name} = Class.new")
+      klass = klass_name.constantize
+    end
+  
+    command_object = self
+    klass.metaclass.send(:define_method, method_name.to_sym) do |*args|
+      command_object.invoke(*args)
+    end
+  end
+
+  # Will return the subcollection "xyz" from the response for "get_xyz" commands when
+  # the collection is present, or just the result collection otherwise.
+  def process_result(result)
+    if method_name =~ /^get_(.+)/ and (collection = result[$1.gsub('_', '')]).present?
+      return collection
+    else
+      return result
+    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-client'
+
+class Test::Unit::TestCase
+end

data/test/test_xbmc-client.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestXbmcClient < 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-client.gemspec

@@ -0,0 +1,73 @@
+# 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-client}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Olszowka"]
+  s.date = %q{2010-11-25}
+  s.description = %q{A simple API client for the XBMC JSON-RPC API}
+  s.email = %q{christoph at olszowka de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rvmrc",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/audio_library.rb",
+     "lib/ruby_ext.rb",
+     "lib/xbmc-client.rb",
+     "lib/xbmc/command.rb",
+     "test/helper.rb",
+     "test/test_xbmc-client.rb",
+     "xbmc-client.gemspec"
+  ]
+  s.homepage = %q{http://github.com/colszowka/xbmc-client}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple API client for the XBMC JSON-RPC API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_xbmc-client.rb",
+     "examples/audio_library.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_runtime_dependency(%q<httparty>, [">= 0.6.0"])
+      s.add_runtime_dependency(%q<json>, [">= 1.4.5"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, ["= 2.10.3"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.6.0"])
+      s.add_dependency(%q<json>, [">= 1.4.5"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<shoulda>, ["= 2.10.3"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.6.0"])
+    s.add_dependency(%q<json>, [">= 1.4.5"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<shoulda>, ["= 2.10.3"])
+  end
+end
+

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: xbmc-client
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christoph Olszowka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-25 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 5
+        version: 1.4.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 3
+        version: 2.10.3
+  type: :development
+  version_requirements: *id005
+description: A simple API client for the XBMC JSON-RPC API
+email: christoph at olszowka de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/audio_library.rb
+- lib/ruby_ext.rb
+- lib/xbmc-client.rb
+- lib/xbmc/command.rb
+- test/helper.rb
+- test/test_xbmc-client.rb
+- xbmc-client.gemspec
+has_rdoc: true
+homepage: http://github.com/colszowka/xbmc-client
+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 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple API client for the XBMC JSON-RPC API
+test_files: 
+- test/helper.rb
+- test/test_xbmc-client.rb
+- examples/audio_library.rb