skypekit 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+lib/*.so
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec', '~> 2.9.0'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Railsware (www.railsware.com)
+
+MIT License
+
+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,51 @@
+# Skypekit
+
+Ruby FFI interface to libskypekit C library
+
+## Dependencies
+
+* libskypekit C library
+* ffi gem
+
+## Installation
+
+Install [libskypekit](https://github.com/railsware/libskypekit).
+
+Add this line to your application's Gemfile:
+
+    gem 'skypekit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install skypekit
+
+## Usage
+
+Check examples directory.
+
+Run ping_pong example:
+
+    SK_KEY=bla.pem SK_USER=user SK_PASS=secret be ruby examples/ping_pong.rb
+
+## Author
+
+* Andriy Yanko
+
+## Contributors
+
+* Volodymyr Bezobiuk
+* Alexey Vasiliev
+
+## License
+
+* Copyright (c) 2012 Railsware (www.railsware.com)
+* [MIT](www.opensource.org/licenses/MIT)
+
+## References
+
+* [libskypekit](https://github.com/railsware/libskypekit)
+* [SkypeKit C++ Wrapper Reference](http://developer.skype.com/skypekit/reference/cpp/index.html)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/examples/ping_pong.rb

@@ -0,0 +1,49 @@
+require "skypekit"
+$skype = Skypekit::Skype.new(:keyfile => ENV['SK_KEY'])
+
+$skype.start
+$skype.login(ENV['SK_USER'], ENV['SK_PASS'])
+
+def terminate
+  puts "Terminating"
+  $skype.stop
+  exit
+end
+
+trap('INT') do
+  terminate
+end
+
+loop do
+  event = $skype.get_event
+
+  unless event
+    sleep 5
+    next
+  end
+
+  case event.type 
+  when :account_status
+
+    if event.data.logged_in?
+      puts "Congrats! We are Logged in!"
+    end
+
+    if event.data.logged_out?
+      puts "Authentication failed: #{event.data.reason}"
+      terminate
+    end
+
+  when :chat_message
+    message = event.data
+
+    puts "@" * 80
+    p message
+    puts "@" * 80
+
+    if message.body == "ping"
+      $skype.send_chat_message(message.convo_id, "pong")
+    end
+
+  end
+end

data/lib/skypekit.rb

@@ -0,0 +1,11 @@
+#
+# Copyright (c) 2012 Railsware (www.railsware.com)
+#
+require "ffi"
+
+require "skypekit/ffi"
+require "skypekit/ffi/event"
+require "skypekit/ffi/account_status_data"
+require "skypekit/ffi/chat_message_data"
+
+require "skypekit/skype"

data/lib/skypekit/ffi.rb

@@ -0,0 +1,92 @@
+#
+# Copyright (c) 2012 Railsware (www.railsware.com)
+#
+module Skypekit
+  module FFI
+    extend ::FFI::Library
+
+    #
+    # @see https://github.com/railsware/libskypekit/blob/master/include/skypekit.h
+    #
+
+    #ffi_lib File.expand_path("../../../../libskypekit/lib/libskypekit.so", __FILE__)
+    ffi_lib "skypekit.so.1"
+
+    ErrorType = enum(
+      :already_running, 1,
+      :already_initialized,
+      :not_initialized,
+      :not_running,
+      :keyfile_access,
+      :skypename_required,
+      :password_required,
+      :account_not_found,
+      :conversation_not_found,
+      :login_failure,
+      :send_message_failure
+    )
+
+    EventType = enum(
+      :account_status, 1,
+      :chat_message
+    )
+
+    AccountStatusType = enum(
+     :logged_out, 1,
+     :logged_out_and_pwd_saved,  # the account is logged out, but password is not needed for re-login
+     :connecting_to_p2p,         # connecting to P2P network
+     :connecting_to_server,      # connecting to login server
+     :logging_in,                # waiting for response from server
+     :initializing,              # response OK. initialising account-specific lib structures
+     :logged_in,                 # alright, we're good to go!
+     :logging_out                # Logout() has been called but not processed yet
+    )
+
+    AccountLogoutReasonType = enum(
+      :logout_called, 1,           # manual logout (or unknown reason from previous session)
+      :https_proxy_auth_failed,    # sync errors at login/registration
+      :socks_proxy_auth_failed,    # sync errors at login/registration
+      :p2p_connect_failed,         # sync errors at login/registration
+      :server_connect_failed,      # sync errors at login/registration
+      :server_overloaded,          # sync errors at login/registration
+      :db_in_use,                  # sync errors at login/registration
+      :invalid_skypename,          # sync errors at registration
+      :invalid_email,              # sync errors at registration
+      :unacceptable_password,      # sync errors at registration
+      :skypename_taken,            # sync errors at registration
+      :rejected_as_underage,       # sync errors at registration
+      :no_such_identity,           # sync errors at login
+      :incorrect_password,         # sync errors at login
+      :too_many_login_attempts,    # sync errors at login
+      :password_has_changed,       # async errors (can happen anytime while logged in)
+      :periodic_uic_update_failed, # async errors (can happen anytime while logged in)
+      :db_disk_full,               # async errors (can happen anytime while logged in)
+      :db_io_error,                # async errors (can happen anytime while logged in)
+      :db_corrupt,                 # async errors (can happen anytime while logged in)
+      :db_failure,                 # deprecated (superceded by more detailed DB_* errors)
+      :invalid_app_id,             # platform sdk
+      :app_id_failure,             # platform sdk
+      :unsupported_version         # forced upgrade/discontinuation
+    )
+
+    attach_function :skypekit_skype_new, [], :pointer
+
+    attach_function :skypekit_skype_free, [:pointer], :void
+
+    attach_function :skypekit_skype_init, [:pointer, :string, :string, :int, :string], ErrorType
+
+    attach_function :skypekit_skype_start, [:pointer], ErrorType
+
+    attach_function :skypekit_skype_login, [:pointer, :string, :string], ErrorType
+
+    attach_function :skypekit_count_events, [:pointer], ErrorType
+
+    attach_function :skypekit_get_event, [:pointer], :pointer
+
+    attach_function :skypekit_event_free, [:pointer], :void
+
+    attach_function :skypekit_chat_send_message, [:pointer, :string, :string, :int], ErrorType
+
+    attach_function :skypekit_skype_stop, [:pointer], ErrorType
+  end
+end

data/lib/skypekit/ffi/account_status_data.rb

@@ -0,0 +1,38 @@
+#
+# Copyright (c) 2012 Railsware (www.railsware.com)
+#
+module Skypekit
+  module FFI
+    class AccountStatusData < ::FFI::Struct
+      layout \
+        :status, FFI::AccountStatusType,
+        :reason, FFI::AccountLogoutReasonType,
+        :skypename, :string,
+        :payload, :pointer
+
+      def status
+        self[:status]
+      end
+
+      def skypename
+        self[:skypename]
+      end
+
+      def reason
+        self[:reason]
+      end
+
+      def logged_in?
+        status == :logged_in
+      end
+
+      def logged_out?
+        status == :logged_out && reason != 0
+      end
+
+      def inspect
+        "#{super} status=#{status} skypename=#{skypename} reason=#{reason}"
+      end
+    end
+  end
+end

data/lib/skypekit/ffi/chat_message_data.rb

@@ -0,0 +1,46 @@
+#
+# Copyright (c) 2012 Railsware (www.railsware.com)
+#
+module Skypekit
+  module FFI
+    class ChatMessageData < ::FFI::Struct
+      layout \
+        :convo_id, :string,
+        :convo_guid, :string,
+        :author, :string,
+        :author_displayname, :string,
+        :body_xml, :string,
+        :timestamp, :time_t,
+        :payload, :pointer
+        
+      def convo_id
+        self[:convo_id]
+      end
+
+      def convo_guid
+        self[:convo_guid]
+      end
+
+      def author
+        self[:author]
+      end
+
+      def author_displayname
+        self[:author_displayname]
+      end
+
+      def sent_at
+        Time.at(self[:timestamp])
+      end
+
+      def body
+        self[:body_xml]
+      end
+
+
+      def inspect
+        "#{super} convo_id=#{convo_id} convo_guid=#{convo_guid} author=#{author} author_displayname=#{author_displayname} sent_at=#{sent_at} body=#{body}"
+      end
+    end
+  end
+end

data/lib/skypekit/ffi/event.rb

@@ -0,0 +1,46 @@
+#
+# Copyright (c) 2012 Railsware (www.railsware.com)
+#
+module Skypekit
+  module FFI
+    class Event < ::FFI::ManagedStruct
+      def self.release(pointer)
+        FFI.skypekit_event_free(pointer)
+      end
+
+      layout \
+        :type,  FFI::EventType,
+        :timestamp, :time_t,
+        :data, :pointer,
+        :next, :pointer
+      
+      def type
+        self[:type]
+      end
+
+      def timestamp
+        self[:timestamp]
+      end
+
+      def created_at
+        @created_at ||= Time.at(self[:timestamp])
+      end
+
+      def data
+        @data ||= 
+          case self.type
+          when :account_status
+            AccountStatusData.new(self[:data])
+          when :chat_message
+            ChatMessageData.new(self[:data])
+          else
+            raise NotImplementedError, "event type #{type.inspect} is not implemeted"
+          end
+      end
+
+      def inspect
+        "#{super} type=#{type} created_at=#{created_at}"
+      end
+    end
+  end
+end

data/lib/skypekit/skype.rb

@@ -0,0 +1,47 @@
+#
+# Copyright (c) 2012 Railsware (www.railsware.com)
+#
+module Skypekit
+  class Skype
+    def self.release(pointer)
+      Skypekit::FFI.skypekit_skype_free(pointer)
+    end
+
+    def initialize(options = {})
+      @keyfile = options[:keyfile] || "skypekit.pem"
+      @host    = options[:host] || "127.0.0.1"
+      @port    = options[:port] || 8963
+      @logfile = options[:logfile] || nil
+
+      @pointer = ::FFI::AutoPointer.new(Skypekit::FFI.skypekit_skype_new, self.class.method(:release))
+    end
+
+    def start
+      File.exists?(@keyfile) or raise ArgumentError, "Can't find certificate file #{@keyfile.inspect}"
+      Skypekit::FFI.skypekit_skype_init(pointer, @keyfile, @host, @port, @logfile)
+      Skypekit::FFI.skypekit_skype_start(pointer)
+    end
+
+    def login(username, password)
+      Skypekit::FFI.skypekit_skype_login(pointer, username, password)
+    end
+
+    def get_event
+      event_pointer = Skypekit::FFI.skypekit_get_event(pointer)
+      Skypekit::FFI::Event.new(event_pointer) unless event_pointer.address.zero?
+    end
+
+    def stop
+      Skypekit::FFI.skypekit_skype_stop(pointer)
+    end
+
+    def send_chat_message(chat_id, message)
+      Skypekit::FFI.skypekit_chat_send_message(pointer, chat_id, message, 0)
+    end
+
+    private
+
+    attr_reader :pointer
+
+  end
+end

data/skypekit.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andriy Yanko"]
+  gem.email         = ["andriy.yanko@gmail.com"]
+  gem.description   = %q{Ruby FFI interface to libskypekit C library}
+  gem.summary       = %q{Ruby FFI interface to libskypekit C library}
+  gem.homepage      = "https://github.com/railsware/skypekit"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "skypekit"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+
+  gem.add_runtime_dependency "ffi", ">=1.0.0"
+end

data/spec/skypekit/ffi_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Skypekit::FFI do
+  describe "as class" do
+    subject { described_class }
+
+    specify { should respond_to(:skypekit_skype_new) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+Bundler.setup
+
+require 'skypekit'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: skypekit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andriy Yanko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: &13134860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *13134860
+description: Ruby FFI interface to libskypekit C library
+email:
+- andriy.yanko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/ping_pong.rb
+- lib/skypekit.rb
+- lib/skypekit/ffi.rb
+- lib/skypekit/ffi/account_status_data.rb
+- lib/skypekit/ffi/chat_message_data.rb
+- lib/skypekit/ffi/event.rb
+- lib/skypekit/skype.rb
+- skypekit.gemspec
+- spec/skypekit/ffi_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/railsware/skypekit
+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.15
+signing_key: 
+specification_version: 3
+summary: Ruby FFI interface to libskypekit C library
+test_files:
+- spec/skypekit/ffi_spec.rb
+- spec/spec_helper.rb