xmpp4r-hipchat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 603c26e12cea6bcc5d1f05887d4197ec4ac3f911
+  data.tar.gz: 929efa05d505f2e317fd5975ef67e758e1465311
+SHA512:
+  metadata.gz: 5d5541cfad9e2bfed821bf98f7c7cc74d4fcd109b110c3624fd3f99e1995e534235aca269d96bee2e0fb05f34090b209532d5c71801b6098351aa6d3c1d7645c
+  data.tar.gz: 8221a73c118ec531bc890515df20bd2be0dceab26d5a8a33a22a18a8c4af12afe8a3bde2c87be1920f8e36ed31d84c00b43ea85f7cd92a28bb7a05bf71962d53

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Bartosz Kopiński
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bartosz Kopiński
+
+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,29 @@
+# Xmpp4r::Hipchat
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'xmpp4r-hipchat'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xmpp4r-hipchat
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/xmpp4r/hipchat.rb

@@ -0,0 +1,10 @@
+require 'xmpp4r'
+require 'xmpp4r/muc'
+require 'xmpp4r/muc/x/muc'
+require 'xmpp4r/muc/iq/mucowner'
+require 'xmpp4r/muc/iq/mucadmin'
+require 'xmpp4r/dataforms'
+require 'xmpp4r/roster'
+require 'xmpp4r/vcard'
+require 'xmpp4r/hipchat/version'
+require 'xmpp4r/hipchat/client'

data/lib/xmpp4r/hipchat/client.rb

@@ -0,0 +1,226 @@
+module Jabber
+  module MUC
+    module Hipchat
+      class Client
+        attr_accessor :my_jid, :chat_domain, :conference_domain, :stream
+
+        def initialize(jid)
+          self.my_jid = JID.new(jid)
+          self.stream = Client.new(my_jid.strip) # TODO: Error Handling
+          Jabber::debuglog "Stream initialized"
+          self.chat_domain = my_jid.domain
+
+          @callbacks = Hash.new { |hash, key| hash[key] = CallbackList.new }
+        end
+
+        def join(jid, password = nil, opts = { history: false })
+          room_jid = JID.new(jid)
+          xmuc = XMUC.new
+          xmuc.password = password
+
+          if !opts[:history]
+            history = REXML::Element.new('history').tap{ |h| h.add_attribute('maxstanzas','0') }
+            xmuc.add_element history
+          end
+
+          room_jid.resource = name
+          set_presence(:available, room_jid, nil, xmuc) # TODO: Handle all join responses
+        end
+
+        def exit(jid, reason = nil)
+          room_jid = JID.new(jid)
+          Jabber::debuglog "Exiting #{jid}"
+          set_presence(:unavailable, room_jid, reason)
+        end
+
+        def keep_alive password
+          if stream.is_disconnected?
+            connect(password)
+          end
+        end
+
+        def name
+          my_jid.resource
+        end
+
+        def name= resource
+          my_jid.resource = resource
+        end
+
+        %w(lobby_presence room_presence room_message private_message invite).each do |callback_name|
+          define_method("on_#{callback_name}") do |prio = 0, ref = nil, &block|
+            @callbacks[callback_name.to_sym].add(prio, ref) do |*args|
+              block.call(*args)
+            end
+          end
+        end
+
+        def set_presence(type, to = nil, reason = nil, xmuc = nil, &block)
+          pres      = Presence.new(:chat, reason)
+          pres.type = type
+          pres.to   = to if to
+          pres.from = my_jid
+          pres.add(xmuc) if xmuc
+          stream.send(pres) { |r| block.call(r) }
+        end
+
+        def kick(recipients, room_jid)
+          iq      = Iq.new(:set, room_jid)
+          iq.from = my_jid
+          iq.add(IqQueryMUCAdmin.new)
+          recipients.each do |recipient|
+            item      = IqQueryMUCAdminItem.new
+            item.nick = recipient
+            item.role = :none
+            iq.query.add(item)
+          end
+          stream.send_with_id(iq)
+        end
+
+        def invite(recipients, room_jid)
+          msg      = Message.new
+          msg.from = my_jid
+          msg.to   = room_jid
+          x        = msg.add(XMUCUser.new)
+          recipients.each do |jid|
+            x.add(XMUCUserInvite.new(jid))
+          end
+          stream.send(msg)
+        end
+
+        def send_message(type, jid, text, subject = nil)
+          message = Message.new(JID.new(jid), text.to_s)
+          message.type    = type
+          message.from    = my_jid
+          message.subject = subject
+
+          @send_thread.join if !@send_thread.nil? && @send_thread.alive?
+          @send_thread = Thread.new do
+            stream.send(message)
+            sleep(0.2)
+          end
+        end
+
+        def connect password
+          stream.connect
+          Jabber::debuglog "Connected to stream"
+          stream.auth(password)
+          Jabber::debuglog "Authenticated"
+          @muc_browser = MUCBrowser.new(stream)
+          Jabber::debuglog "MUCBrowser initialized"
+          self.conference_domain = @muc_browser.muc_rooms(chat_domain).keys.first
+          Jabber::debuglog "No conference domain found" if conference_domain.nil?
+          @roster = Roster::Helper.new(stream) # TODO: Error handling
+          @vcard  = Vcard::Helper.new(stream) # TODO: Error handling
+          true
+        end
+
+        def activate_callbacks
+          stream.add_presence_callback(150, self){ |presence| handle_presence(presence) }
+          stream.add_message_callback(150, self){ |message| handle_message(message) }
+          Jabber::debuglog "Callbacks activated"
+        end
+
+        def get_rooms
+          iq = Iq.new(:get, conference_domain)
+          iq.from = stream.jid
+          iq.add(Discovery::IqQueryDiscoItems.new)
+
+          rooms = []
+          stream.send_with_id(iq) do |answer|
+            answer.query.each_element('item') do |item|
+              details = {}
+              item.first.children.each{ |c| details[c.name] = c.text }
+              rooms << {
+                item:    item,
+                details: details
+              }
+            end
+          end
+          rooms
+        end
+
+        def get_users
+          @roster.wait_for_roster
+          @roster.items.map do |jid, item|
+            {
+                  jid: item.jid.to_s,
+                 name: item.iname,
+              mention: item.attributes['mention_name'],
+            }
+          end
+        end
+
+        def get_user_details user_jid
+          vcard = @vcard.get(user_jid)
+          {
+            email: vcard['EMAIL/USERID'],
+            title: vcard['TITLE'],
+            photo: vcard['PHOTO'],
+          }
+        end
+
+        def deactivate_callbacks
+          stream.delete_presence_callback(self)
+          stream.delete_message_callback(self)
+          Jabber::debuglog "Callbacks deactivated"
+        end
+
+        private
+
+        def handle_presence(presence)
+          from_jid      = presence.from.strip.to_s
+          presence_type = presence.type.to_s
+          user_name     = presence.from.resource
+          if user_name.nil?
+            @callbacks[:lobby_presence].process(from_jid, presence_type)
+          else
+            @callbacks[:room_presence].process(from_jid, user_name, presence_type)
+          end
+        end
+
+        def handle_message(message)
+          if is_invite?(message)
+            handle_invite(message)
+          elsif message.type == :chat
+            handle_private_message(message)
+          elsif message.type == :groupchat
+            handle_group_message(message)
+          elsif message.type == :error
+            handle_error(message)
+          end
+        end
+
+        def handle_invite(message)
+          room_name = message.children.last.first_element_text('name')
+          topic     = message.children.last.first_element_text('topic')
+          room_jid  = message.from.strip.to_s
+          user_name = message.from.resource
+          @callbacks[:invite].process(room_jid, user_name, room_name, topic)
+        end
+
+        def handle_private_message(message)
+          user_jid     = message.from.strip.to_s
+          message_body = message.body.to_s
+          @callbacks[:private_message].process(user_jid, message_body)
+        end
+
+        def handle_group_message(message)
+          room_jid     = message.from.strip.to_s
+          user_name    = message.from.resource
+          message_body = message.body.to_s
+          topic        = message.subject.to_s
+          @callbacks[:room_message].process(room_jid, user_name, message_body, topic)
+        end
+
+        def handle_error(message)
+          false
+        end
+
+        def is_invite?(message)
+          !message.x.nil? && message.x.kind_of?(XMUCUser) && message.x.first.kind_of?(XMUCUserInvite)
+        end
+      end
+    end
+  end
+end

data/lib/xmpp4r/hipchat/version.rb

@@ -0,0 +1,7 @@
+module Jabber
+  module MUC
+    module Hipchat
+      VERSION = '0.0.1'
+    end
+  end
+end

data/xmpp4r-hipchat.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xmpp4r/hipchat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'xmpp4r-hipchat'
+  spec.version       = Jabber::MUC::Hipchat::VERSION
+  spec.authors       = ['Bartosz Kopiński']
+  spec.email         = ['bartosz.kopinski@gmail.com']
+  spec.description   = 'HipChat client extension to xmpp4r'
+  spec.summary       = 'HipChat client extension to xmpp4r'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'xmpp4r', ['~> 0.5']
+  spec.add_development_dependency 'bundler', '~> 1.4'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: xmpp4r-hipchat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bartosz Kopiński
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xmpp4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HipChat client extension to xmpp4r
+email:
+- bartosz.kopinski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xmpp4r/hipchat.rb
+- lib/xmpp4r/hipchat/client.rb
+- lib/xmpp4r/hipchat/version.rb
+- xmpp4r-hipchat.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: HipChat client extension to xmpp4r
+test_files: []