rype 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+.belly
+.redcar
+*.gem
+pkg
+tags
+pkg
+.bundle
+Gemfile.lock
+vendor/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rype.gemspec
+gemspec

data/History.txt

@@ -0,0 +1,9 @@
+2010/08/12
+  - Added some very basic instructions.
+
+2010/04/12
+  - Simple class structure for sending chat messages
+
+2010/04/11
+  - Started development, with a simple file that uses various chat-related aspects of the raw dbus-transported API.
+  - Added dependency: dbus => http://github.com/mvidner/ruby-dbus/downloads

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Niko Felger
+
+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.
+
+This product uses the Skype API but is not endorsed, certified or otherwise
+approved in any way by Skype.

data/Rakefile

@@ -0,0 +1,78 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+require "spec"
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = %w(--format specdoc --colour)
+  t.libs = ["spec"]
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new('features') do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+
+task :default => ["spec", "features"]
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "rype"
+  s.version           = "0.1.0"
+  s.summary           = "Skype Api wrapper"
+  s.author            = "Niko Felger"
+  s.email             = "niko.felger@gmail.com"
+  s.homepage          = "http://github.com/nfelger/rype"
+
+  s.has_rdoc          = false
+  # You should probably have a README of some kind. Change the filename
+  # as appropriate
+  # s.extra_rdoc_files  = %w(README)
+  # s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem (like your README)
+  s.files             = %w(History.txt) + Dir.glob("{bin,spec,lib/**/*}")
+  s.executables       = FileList["bin/**"].map { |f| File.basename(f) }
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("cucumber")
+end
+
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+task :package => :gemspec
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/examples/chats/echo_server.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..', 'lib')
+
+require 'rype'
+require 'pp'
+
+Rype.on(:chatmessage_received) do |chatmessage|
+  chatmessage.chat do |chat|
+    chatmessage.body do |body|
+      chat.send_message(body)
+    end
+  end
+end
+
+Rype.attach.join

data/examples/chats/list_chats.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..', 'lib')
+
+require 'rype'
+require 'pp'
+
+Rype.attach
+
+Rype.chats do |chats|
+  chats.each do |chat|
+    p chat
+  end
+end

data/examples/chats/send_chat.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..', 'lib')
+require 'rype'
+
+Rype.attach
+
+chat_id, message_body = ARGV[0..1]
+
+Rype.chat(chat_id).send_message(message_body)

data/examples/start_skype

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+export DISPLAY=:2
+
+if [[ ! -e /tmp/.X2-lock ]]
+then Xvfb :2 &
+fi
+
+skype &

data/features/receive_chatmessage.feature

@@ -0,0 +1,9 @@
+Feature: Receiving chat messages
+  Background:
+    Given I am using the Skype Api testing fake
+
+  Scenario: Receiving a message
+    Given a client has registered a callback for notifications about "CHATMESSAGE"
+    When Skype issues a notification "CHATMESSAGE 123 STATUS RECEIVED"
+    Then the callback should be called
+    

data/features/send_chatmessage.feature

@@ -0,0 +1,13 @@
+Feature: Send a chat message
+
+  Background:
+    Given I am using the Skype Api testing fake
+
+  Scenario: Send message
+    Given there is a chat with id "#test/$echo123;2010fc482c5ce233"
+    When I send a chatmessage "Howdy pal!" to "#test/$echo123;2010fc482c5ce233"
+    Then the Skype Api should receive the message 
+      """
+      CHATMESSAGE #test/$echo123;2010fc482c5ce233 Howdy pal!
+      """
+    

data/features/step_definitions/skype_steps.rb

@@ -0,0 +1,39 @@
+Given /^I am using the Skype Api testing fake$/ do
+  # Silence constant re-assignment warning.
+  original_verbosity = $VERBOSE
+  $VERBOSE = nil
+  Rype::Api = Rype::FakeApi
+  $VERBOSE = original_verbosity
+end
+
+Given /^there is a chat with id "([^\"]*)"$/ do |chat_id|
+  # Let's assume it exists.
+end
+
+Given /^a client has registered a callback for notifications about "([^\"]*)"$/ do |scope|
+  @callback = lambda do
+    if @called
+      @called
+    else
+      @called = true
+      false
+    end
+  end
+  Rype::Api.on_notification(scope, @callback)
+end
+
+When /^I send a chatmessage "([^\"]*)" to "([^\"]*)"$/ do |message_body, chat_id|
+  Rype::Chat.new(chat_id).send_message(message_body)
+end
+
+When /^Skype issues a notification "([^\"]*)"$/ do |notification|
+  Rype::Api.notify(notification)
+end
+
+Then /^the Skype Api should receive the message$/ do |string|
+  Rype::Api.recorded_messages.should include(string)
+end
+
+Then /^the callback should be called$/ do
+  @callback.call.should be_true
+end

data/features/support/env.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..', 'lib')
+
+require 'rype'

data/features/support/lib/fake_api.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+
+module Rype
+  class FakeApi < Api
+    class << self
+      extend Forwardable
+
+      def_delegator :instance, :recorded_messages
+    end
+
+    def attach
+    end
+
+    def invoke(message)
+      recorded_messages << message
+    end
+
+    def recorded_messages
+      @recorded_messages ||= []
+    end
+  end
+end

data/lib/rype.rb

@@ -0,0 +1,23 @@
+require 'forwardable'
+
+require 'rype/api'
+require 'rype/chat'
+require 'rype/chatmessage'
+require 'rype/events'
+
+module Rype
+  Offline = Class.new StandardError
+  Denied  = Class.new StandardError
+
+  class << self
+    extend Forwardable
+
+    def_delegators Rype::Api,    :instance, :attach, :thread
+    def_delegator  Rype::Chat,   :new, :chat
+    def_delegator  Rype::Chat,   :all, :chats
+    def_delegator  Rype::Events, :on
+
+    Rype::Events.initialize_listeners
+  end
+end
+

data/lib/rype/api.rb

@@ -0,0 +1,121 @@
+require 'dbus'
+require 'forwardable'
+
+module Rype
+  class Notify < DBus::Object
+    dbus_interface "com.Skype.API.Client" do
+      dbus_method :Notify, "in data:s" do |message|
+        Api.notify(message)
+      end
+    end
+  end
+
+  class Api
+    class << self
+      extend Forwardable
+      def_delegators :instance, :attach, :invoke, :on_notification, :notify, :thread
+
+      def instance
+        @instance ||= new
+      end
+    end
+
+    attr_reader :thread
+
+    def attach(application_name="rype")
+      raise "Already attached." if attached?
+
+      # Say hi to Skype.
+      status, = api.Invoke "NAME #{application_name}"
+
+      if status == 'CONNSTATUS OFFLINE'
+        raise Rype::Offline
+      elsif status != 'OK'
+        raise Rype::Denied
+      end
+
+      api.Invoke "PROTOCOL 7"
+
+      run_notification_thread
+    end
+
+    def invoke(message, &block)
+      raise "Not attached to Skype. Call Rype::Api.attach first." unless attached?
+
+      log_outgoing message
+      if block_given?
+        api.Invoke(message) do |headers, answer|
+          log_incoming answer
+          block.call(answer)
+        end
+      else
+        answer = api.Invoke(message) do |_, _|
+          # Huh? Without passing in a block, sometimes it hangs...??
+        end
+        log_incoming answer
+        answer
+      end
+    end
+
+    def on_notification(scope, proc=nil, &block)
+      raise "Need to register callbacks before attaching to Skype." if attached?
+
+      callbacks[scope] ||= []
+      callbacks[scope] << (proc ? proc : block)
+    end
+
+    def notify(message)
+      log_incoming message
+
+      callbacks.keys.each do |key|
+        next unless match = Regexp.new("^#{key}").match(message)
+        callbacks[key].each{ |callback| callback.call(*match.captures) }
+      end
+    end
+
+  private
+
+    def initialize
+      # 'pu'a says no.
+    end
+
+    def attached?
+      thread and thread.alive?
+    end
+
+    def api
+      @api ||= begin
+        skype_service = bus.service("com.Skype.API")
+        skype_object  = skype_service.object('/com/Skype')
+        skype_object.introspect
+        skype_object["com.Skype.API"]
+      end
+    end
+
+    def run_notification_thread
+      @thread ||= Thread.new do
+        receiving_service = bus.request_service("com.nikofelger.ruby-skype")
+        receiving_service.export(Notify.new("/com/Skype/Client"))
+        dbus_event_loop = DBus::Main.new
+        dbus_event_loop << bus
+        dbus_event_loop.run
+      end
+    end
+
+    def bus
+      DBus::SessionBus.instance
+    end
+
+    def callbacks
+      @callback ||= {}
+    end
+    
+    def log_incoming(message)
+      STDERR.puts "<- #{message}"
+    end
+ 
+    def log_outgoing(message)
+      STDERR.puts "-> #{message}"
+    end
+  end
+end

data/lib/rype/chat.rb

@@ -0,0 +1,28 @@
+require 'rype/events'
+
+module Rype
+  class Chat
+    class << self
+      attr_accessor :chats
+
+      def all
+        chats if chats
+
+        Api.invoke("SEARCH CHATS")
+        sleep 0.01 while chats.nil?
+        
+        yield chats
+      end
+    end
+
+    attr_reader :chatname
+
+    def initialize(chatname)
+      @chatname = chatname
+    end
+
+    def send_message(message)
+      Api.invoke("CHATMESSAGE #{@chatname} #{message}")
+    end
+  end
+end

data/lib/rype/chatmessage.rb

@@ -0,0 +1,37 @@
+module Rype
+  class Chatmessage
+    def initialize(id)
+      @chatmessage_id = id
+    end
+    
+    def chat(&block)
+      return unless block_given?
+      get_property("CHATNAME") do |chatname|
+        block.call(Chat.new(chatname))
+      end
+    end
+    
+    def body(&block)
+      return unless block_given?
+      get_property("BODY", &block)
+    end
+
+    def from(&block)
+      return unless block_given?
+      get_property("FROM_HANDLE", &block)
+    end
+
+    def from_name(&block)
+      return unless block_given?
+      get_property("FROM_DISPNAME", &block)
+    end
+
+  private
+    def get_property(property, &block)
+      return unless block_given?
+      Api.invoke("GET CHATMESSAGE #{@chatmessage_id} #{property}") do |message|
+        yield message.split[3..-1].join(' ')
+      end
+    end
+  end
+end

data/lib/rype/events.rb

@@ -0,0 +1,29 @@
+require 'thread'
+
+module Rype
+  class Events
+    class << self
+      def on(event)
+        case event
+
+        when :chatmessage_received
+          Rype::Api.instance.on_notification("CHATMESSAGE (.*) STATUS RECEIVED") do |chatmessage_id|
+            yield Chatmessage.new(chatmessage_id)
+          end
+
+        when :chats_received
+          Rype::Api.instance.on_notification("CHATS (.*)") do |chatlist|
+            yield chatlist.split(', ').map { |chatname| Chat.new(chatname) }
+          end
+        end
+      end
+      
+      def initialize_listeners
+        mutex = Mutex.new
+        Rype::Events.on(:chats_received) do |chats|          
+          mutex.synchronize { Rype::Chat.chats = chats }
+        end
+      end
+    end
+  end
+end

data/readme.md

@@ -0,0 +1,70 @@
+# rype – Ruby library to talk to the Skype API
+
+## Description
+
+This library is a simple wrapper for Skype's dbus-based Linux API.
+
+Currently, it has the following capabilities:
+
+* Get a list of your chats,
+* send chat messages,
+* receive chat messages,
+* use the raw Skype protocol via Rype::Api#invoke and Rype::Api#on_notification. More information about the protocol at [developer.skype.com](http://developer.skype.com)
+
+
+## Installation
+
+In order to work with the rype gem, there are a few requirements:
+
+- You need to be on Linux
+- You need to have Skype running
+- You need dbus installed (e.g., via apt on Ubuntu)
+- You need the ruby-dbus gem:
+  - wget http://github.com/downloads/mvidner/ruby-dbus/ruby-dbus-0.3.1.tgz
+  - tar xzf ruby-dbus-0.3.1.tgz
+  - cd ruby-dbus-0.3.1
+  - follow the instructions in README
+- You may want Xvfb (if you want to run Skype head-less)
+
+
+## Verify your installation
+
+To confirm it's working, start skype and sign in. Then, open an irb session and:
+
+    require 'dbus'
+    bus = DBus::SessionBus.instance
+    skype_service = bus.service("com.Skype.API")
+    client_to_skype = skype_service.object('/com/Skype')
+    client_to_skype.introspect
+    api = client_to_skype["com.Skype.API"]
+    api.Invoke("NAME rype")
+
+If everything is set up correctly, Skype will now ask whether "rype" should be allowed to connect.
+
+
+## Usage
+
+There are a few examples in `examples/` that should give you an idea of how
+to use the gem.
+
+
+## Head-less Skype
+
+Say you want to be running an app that connects to Skype on a box that won't have a display attached. For this use case, Xvfb is quite handy:
+
+> "Xvfb or X virtual framebuffer is an X11 server that performs all graphical operations in memory, not showing any screen output." (wikipedia)"
+
+In `examples/start_skype`, there's a shell script that shows how to start Skype and Xvfb.
+
+You can safely ignore warnings about missing fonts, but if they bother you, try:
+
+     sudo aptitude install xfonts-100dpi xfonts-75dpi xfonts-scalable xfonts-cyrillic
+
+If Xvfb won't start at all, more drastic measures may be required:
+
+     sudo apt-get install xserver-xorg-core
+
+## small print
+
+This product uses the Skype API but is not endorsed, certified or otherwise
+approved in any way by Skype.

data/rype.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.version     = "0.0.1"
+  s.name        = "rype"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Niko Felger"]
+  s.email       = ["niko.felger@gmail.com"]
+  s.homepage    = "https://github.com/nfelger/rype"
+  s.summary     = %q{Unofficial Skype Api wrapper}
+  s.description = %q{Unofficial Skype Api wrapper}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.has_rdoc      = false
+  s.rubygems_version = %q{1.3.7}
+  s.add_dependency("ruby-dbus", [">= 0.6"])
+  s.add_development_dependency("rspec")
+end

data/spec/lib/rype/chat_spec.rb

@@ -0,0 +1,39 @@
+require 'rype/chat'
+
+# describe Rype::Chat, '.all' do
+#   subject { Rype::Chat }
+# 
+#   it "should get the list of chats from the api" do
+#     Rype.instance.should_receive(:invoke).with("SEARCH CHATS") do
+#       Rype.instance.notify("CHATS")
+#     end
+# 
+#     subject.all
+#   end
+# 
+#   context "when the response contains chats" do
+#     before(:each) do
+#       Rype.instance.stub!(:invoke).with("SEARCH CHATS") do
+#         Rype.instance.notify("CHATS #bitman/$jessy;eb06e65612353279, #bitman/$jdenton;9244e98f82d7d391")
+#       end
+#     end
+# 
+#     it "should return a new Chat object for each chat id in the response" do
+#       subject.all do |chats|
+#         chats.all?{|chat| chat.should be_a(Rype::Chat)}
+#         chats.map{|chat| chat.chatname}.should == ["#bitman/$jessy;eb06e65612353279", "#bitman/$jdenton;9244e98f82d7d391"]
+#       end
+#     end
+#   end
+# end
+
+describe Rype::Chat, '#send_message' do
+  subject { Rype::Chat.new('#test/$echo123;2010fc482c5ce233') }
+
+  it "should tell the api to send the message" do
+    Rype.instance.should_receive(:invoke).
+      with("CHATMESSAGE #test/$echo123;2010fc482c5ce233 ohai Zkaip")
+
+    subject.send_message("ohai Zkaip")
+  end
+end

data/spec/lib/rype_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'rype'
+
+describe Rype do
+  describe '.instance' do
+    subject { Rype.instance }
+    it { should be_a(Rype::Api) }
+  end
+
+  describe '.attach' do
+    it "should delegate to Rype::Api" do
+      Rype::Api.should_receive(:attach).with("chat id")
+      Rype.attach("chat id")
+    end
+  end
+
+  describe '.chat' do
+    subject { Rype.chat('chat id') }
+    it { should be_a(Rype::Chat) }
+  end
+
+  describe '.chats' do
+    it "should delegate to Rype::Chat" do
+      Rype::Chat.should_receive(:all)
+      Rype.chats
+    end
+  end
+
+  describe '.on' do
+    it "should delegate to Rype::Events" do
+      Rype::Events.should_receive(:on)
+      Rype.on
+    end
+  end
+
+  describe '.thread' do
+    it 'should delegate to Rype::Api' do
+      Rype::Api.should_receive(:thread)
+      Rype.thread
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rype'
+require File.join(File.dirname(__FILE__), '..', 'features', 'support', 'lib', 'fake_api')
+require 'pp'
+
+Rype::Api.instance_variable_set(:"@instance", Rype::FakeApi.instance)

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rype
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Niko Felger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-dbus
+  requirement: &7610360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7610360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &7609960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7609960
+description: Unofficial Skype Api wrapper
+email:
+- niko.felger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- History.txt
+- LICENSE
+- Rakefile
+- examples/chats/echo_server.rb
+- examples/chats/list_chats.rb
+- examples/chats/send_chat.rb
+- examples/start_skype
+- features/receive_chatmessage.feature
+- features/send_chatmessage.feature
+- features/step_definitions/skype_steps.rb
+- features/support/env.rb
+- features/support/lib/fake_api.rb
+- lib/rype.rb
+- lib/rype/api.rb
+- lib/rype/chat.rb
+- lib/rype/chatmessage.rb
+- lib/rype/events.rb
+- readme.md
+- rype.gemspec
+- spec/lib/rype/chat_spec.rb
+- spec/lib/rype_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nfelger/rype
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Unofficial Skype Api wrapper
+test_files: []