hiptail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0e93d540b2f1571b8f569104d2e18f4d7e06821
+  data.tar.gz: 5fa982bc4db63b72ddc5d9332a88b6712813d16a
+SHA512:
+  metadata.gz: 2cbabffdc336194845becc62302485913d814847ae763b371a03a1709e8326c841b43426af5e61833c0e5d8347c9a5772ddf071474111a45e0f4285d5bf555e4
+  data.tar.gz: b9f9bafe8438cbd34cfc9044c76c296aa70138b6919b2cf0b9814c10849775ab62d61a46841235cde8e3120301e1f6c018c04236d7fcfdf0284fbf87f683cf1f

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 dayflower
+
+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,31 @@
+# HipTail
+
+HipChat Add-on Framework
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hiptail'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hiptail
+
+## Usage
+
+See examples.
+
+## Contributing
+
+1. Fork it ( https://github.com/dayflower/hiptail/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/examples/integrate_sinatra/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'hiptail'
+gem 'sqlite3'   # for HipTail::SQLite3AuthorityProvider
+gem 'sinatra'

data/examples/integrate_sinatra/README.md

@@ -0,0 +1,9 @@
+# Sinatra Integration Example with HipTail
+
+## Installation
+
+    $ bundle install
+    $ bundle exec -- rackup
+
+Then install this add-on on integrations page in HipChat administration page.
+Specify the application capability URL (e.g. http://example.com:4567/cap).

data/examples/integrate_sinatra/app.rb

@@ -0,0 +1,58 @@
+require 'sinatra'
+require 'hiptail'
+require 'hiptail/authority/sqlite3_provider'
+require 'sqlite3'
+
+db = SQLite3::Database.new('hiptail.db')
+
+manager = HipTail::Manager.new(:authority_provider => HipTail::SQLite3AuthorityProvider.new(db))
+
+manager.on_room_message do |event|
+  message = event.message.message
+  if message =~ %r{(yellow|green|red|purple|gray)}xm
+    color = $1
+  else
+    color = 'random'
+  end
+
+  event.authority.send_notification(
+    :room_id => event.room.id,
+    :color => color,
+    :message => message,
+    :notify => true,
+    :message_format => 'text',
+  )
+end
+
+handler = HipTail::Web::Handler.new(manager)
+
+get '/' do
+  'Hello, World!'
+end
+
+get '/cap' do
+  capability_params = {
+    :key             => "com.example.hiptail.sinatra",
+    :name            => "Colorizer",
+    :vendor_name     => "hiptail",
+    :message_filter  => "(yellow|green|red|purple|gray)",
+    :base_path       => "/",
+    :capability_path => "/cap",
+    :webhook_path    => "/event",
+    :installed_path  => "/install",
+  }
+
+  handler.handle_capability(request, capability_params)
+end
+
+post '/install' do
+  handler.handle_install(request)
+end
+
+delete '/install/:oauth_id' do
+  handler.handle_uninstall(request, params[:oauth_id])
+end
+
+post '/event' do
+  handler.handle_event(request)
+end

data/examples/simple_rack_app_1/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'hiptail'
+gem 'sqlite3'   # for HipTail::SQLite3AuthorityProvider

data/examples/simple_rack_app_1/README.md

@@ -0,0 +1,9 @@
+# Simple Rack Application Example with HipTail
+
+## Installation
+
+    $ bundle install
+    $ bundle exec -- rackup
+
+Then install this add-on on integrations page in HipChat administration page.
+Specify the application capability URL (e.g. http://example.com:9292/cap).

data/examples/simple_rack_app_1/config.ru

@@ -0,0 +1,56 @@
+require 'bundler/setup'
+require 'rack'
+require 'hiptail'
+require 'hiptail/authority/sqlite3_provider'
+require 'sqlite3'
+
+db = SQLite3::Database.new('hiptail.db')
+
+manager = HipTail::Manager.new(:authority_provider => HipTail::SQLite3AuthorityProvider.new(db))
+
+manager.on_install do |authority|
+  if authority.global?
+    authority.get_all_rooms.rooms.each do |room|
+      authority.send_notification(
+        :room_id => room.id,
+        :message => "Installed.",
+        :notify => false,
+        :message_format => 'text',
+      )
+    end
+  else
+    authority.send_notification(
+      :room_id => authority.room_id,
+      :message => "Installed.",
+      :notify => false,
+      :message_format => 'text',
+    )
+  end
+end
+
+manager.on_room_message do |event|
+  event.authority.send_notification(
+    :room_id => event.room.id,
+    :color => 'green',
+    :message => event.message.message.reverse,
+    :notify => true,
+    :message_format => 'text',
+  )
+end
+
+manager.on_room_enter do |event|
+  event.authority.send_notification(
+    :room_id => event.room.id,
+    :color => 'red',
+    :message => "Welcome, @#{event.sender.mention_name}!",
+    :notify => true,
+    :message_format => "text",
+  )
+end
+
+run HipTail::Web::RackApp.new(
+  :manager => manager,
+  :key => "com.example.hiptail.simple1",
+  :name => "Mr. Reverse",
+  :vendor_name => "hiptail",
+)

data/examples/simple_rack_app_2/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'hiptail'
+gem 'sqlite3'   # for HipTail::SQLite3AuthorityProvider

data/examples/simple_rack_app_2/README.md

@@ -0,0 +1,9 @@
+# Simple Rack Application Example with HipTail
+
+## Installation
+
+    $ bundle install
+    $ bundle exec -- rackup
+
+Then install this add-on on integrations page in HipChat administration page.
+Specify the application capability URL (e.g. http://example.com:9292/cap).

data/examples/simple_rack_app_2/app.rb

@@ -0,0 +1,42 @@
+require 'hiptail'
+require 'hiptail/authority/sqlite3_provider'
+require 'sqlite3'
+
+class SimpleAddon2 < HipTail::Web::RackApp
+  def initialize
+    super(
+      :manager => setup_manager(),
+      :key => "com.example.hiptail.simple2",
+      :name => "Colorizer",
+      :vendor_name => "hiptail",
+      :message_filter => "(yellow|green|red|purple|gray)",
+    )
+  end
+
+  private
+
+  def setup_manager
+    db = SQLite3::Database.new('hiptail.db')
+
+    manager = HipTail::Manager.new(:authority_provider => HipTail::SQLite3AuthorityProvider.new(db))
+
+    manager.on_room_message do |event|
+      message = event.message.message
+      if message =~ %r{(yellow|green|red|purple|gray)}xm
+        color = $1
+      else
+        color = 'random'
+      end
+
+      event.authority.send_notification(
+        :room_id => event.room.id,
+        :color => color,
+        :message => message,
+        :notify => true,
+        :message_format => 'text',
+      )
+    end
+
+    manager
+  end
+end

data/examples/simple_rack_app_2/config.ru

@@ -0,0 +1,4 @@
+require 'rack'
+require './app.rb'
+
+run SimpleAddon2.new()

data/hiptail.gemspec

@@ -0,0 +1,53 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hiptail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hiptail"
+  spec.version       = HipTail::VERSION
+  spec.authors       = ["ITO Nobuaki"]
+  spec.email         = ["daydream.trippers@gmail.com"]
+  spec.summary       = %q{HipChat Add-on Framework}
+  spec.description   = %q{HipChat Add-on Framework}
+  spec.homepage      = "https://github.com/dayflower/hiptail"
+  spec.license       = "MIT"
+
+  spec.files         = %w[
+    hiptail.gemspec
+    README.md
+    LICENSE.txt
+    Gemfile
+    Rakefile
+    lib/hiptail.rb
+    lib/hiptail/atom.rb
+    lib/hiptail/authority.rb
+    lib/hiptail/authority/provider.rb
+    lib/hiptail/authority/sqlite3_provider.rb
+    lib/hiptail/event.rb
+    lib/hiptail/manager.rb
+    lib/hiptail/web/handler.rb
+    lib/hiptail/web/rack_app.rb
+    lib/hiptail/util.rb
+    lib/hiptail/version.rb
+    examples/simple_rack_app_1/Gemfile
+    examples/simple_rack_app_1/config.ru
+    examples/simple_rack_app_1/README.md
+    examples/simple_rack_app_2/Gemfile
+    examples/simple_rack_app_2/app.rb
+    examples/simple_rack_app_2/config.ru
+    examples/simple_rack_app_2/README.md
+    examples/integrate_sinatra/Gemfile
+    examples/integrate_sinatra/app.rb
+    examples/integrate_sinatra/README.md
+  ]
+  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_dependency "rack"
+  spec.add_dependency "oauth2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hiptail/atom.rb

@@ -0,0 +1,303 @@
+require 'time'
+
+module HipTail
+  class User
+    attr_reader :raw
+
+    # @return [HipTail::User]
+    def initialize(params)
+      @raw = params.dup
+    end
+
+    class << self
+      # @return [HipTail::User]
+      def create(params)
+        if params.is_a?(String)
+          return User::Notify.new({ :name => params })
+        else
+          return User::Person.new(params)
+        end
+      end
+    end
+  end
+
+  class User::Notify < User
+    # @attribute [r] name
+    # @return [String]
+    def name
+      @raw['name']
+    end
+  end
+
+  class User::Person < User
+    # @attribute [r] id
+    # @return [String]
+    def id
+      @raw['id']
+    end
+
+    # @attribute [r] mention_name
+    # @return [String]
+    def mention_name
+      @raw['mention_name']
+    end
+
+    # @attribute [r] name
+    # @return [String]
+    def name
+      @raw['name']
+    end
+  end
+
+  class Message
+    attr_reader :raw
+
+    def initialize(params)
+      @raw = params.dup
+    end
+
+    # @attribute [r] id
+    # @return [String]
+    def id
+      @raw['id']
+    end
+
+    # @attribute [r] date
+    # @return [Time]
+    def date
+      @date ||= Time.parse(@raw['date'])
+      @date
+    end
+
+    # @attribute [r] from
+    # @return [HipTail::User]
+    def from
+      @from ||= User.create(@raw['from'])
+      @from
+    end
+
+    # @attribute [r] mentions
+    # @return [Array] Array of HipTail::User.
+    def mentions
+      @mentions ||= (@raw['mentions'] || []).map { |data| User.create(data) }
+      @mentions
+    end
+
+    # @attribute [r] message
+    # @return [String]
+    def message
+      @raw['message']
+    end
+
+    # @attribute [r] text
+    # @return [String]
+    def text
+      message
+    end
+
+    # @attribute [r] is_talk?
+    def is_talk?
+      false
+    end
+
+    # @attribute [r] is_notification?
+    def is_notification?
+      false
+    end
+  end
+
+  class Message::Talk < Message
+    def is_talk?;         true;  end
+    def is_notification?; false; end
+  end
+
+  class Message::Notification < Message
+    def is_talk?;         false; end
+    def is_notification?; true;  end
+
+    # @attribute [r] message_format
+    # @return [String]
+    def message_format
+      @raw['message_format']
+    end
+
+    # @attribute [r] is_text?
+    # @return [Boolean]
+    def is_text?
+      message_format == 'text'
+    end
+
+    # @attribute [r] is_html?
+    # @return [Boolean]
+    def is_html?
+      message_format == 'html'
+    end
+
+    # @attribute [r] html?
+    # @return [String]
+    def html
+      message
+    end
+
+    # @attribute [r] color
+    # @return [String]
+    def color
+      @raw['color']
+    end
+  end
+
+  class Room
+    attr_reader :raw
+
+    def initialize(params)
+      @raw = params.dup
+    end
+
+    def detailed?
+      false
+    end
+
+    # @attribute [r] id
+    # @return [String]
+    def id
+      @raw['id']
+    end
+
+    # @attribute [r] name
+    # @return [String]
+    def name
+      @raw['name']
+    end
+  end
+
+  class Room::Detail < Room
+    # @attribute [r] created
+    # @return [Time]
+    def created
+      @created ||= Time.parse(@raw['created'])
+      @created
+    end
+
+    # @attribute [r] last_active
+    # @return [Time]
+    def last_active
+      @last_active ||= Time.parse(@raw['last_active'])
+      @last_active
+    end
+
+    # @attribute [r] privacy
+    # @return [String]
+    def privacy
+      @raw['privacy']
+    end
+
+    # @attribute [r] is_public
+    # @return [Boolean]
+    def is_public
+      privacy == 'public'
+    end
+    alias public? is_public
+
+    # @attribute [r] is_private
+    # @return [Boolean]
+    def is_private
+      privacy == 'private'
+    end
+    alias private? is_private
+
+    # @attribute [r] is_archived
+    # @return [Boolean]
+    def is_archived
+      @raw['is_archived']
+    end
+    alias archived? is_archived
+
+    # @attribute [r] is_guest_accessible
+    # @return [Boolean]
+    def is_guest_accessible
+      @raw['is_guest_accessible']
+    end
+    alias guest_accessible? is_guest_accessible
+
+    # @attribute [r] guest_access_url
+    # @return [String]
+    def guest_access_url
+      @raw['guest_access_url']
+    end
+
+    # @attribute [r] owner
+    # @return [User]
+    def owner
+      @owner ||= User.new(@raw['owner'])
+    end
+
+    # @attribute [r] participants
+    # @return [Array] Array of HipTail::User.
+    def participants
+      @participants ||= @raw['participants'].map { |user| User.new(user) }
+      @participants
+    end
+
+    # @attribute [r] topic
+    # @return [String]
+    def topic
+      @raw['topic']
+    end
+
+    # @attribute [r] xmpp_jid
+    # @return [String]
+    def xmpp_jid
+      @raw['xmpp_jid']
+    end
+  end
+
+  class Rooms
+    attr_reader :raw
+
+    def initialize(params)
+      @raw = params.dup
+    end
+
+    # @attribute [r] rooms
+    # @return [Array] Array of HipTail::Room.
+    def rooms
+      @rooms ||= @raw['items'].map { |item| Room.new(item) }
+      @rooms
+    end
+
+    # @attribute [r] start_index
+    def start_index
+      @raw['startIndex']
+    end
+
+    # @attribute [r] max_results
+    def max_results
+      @raw['maxResults']
+    end
+  end
+
+  class Users
+    attr_reader :raw
+
+    def initialize(params)
+      @raw = params.dup
+    end
+
+    # @attribute [r] users
+    # @return [Array] Array of HipTail::User.
+    def users
+      @users ||= @raw['items'].map { |item| User.new(item) }
+      @users
+    end
+
+    # @attribute [r] start_index
+    def start_index
+      @raw['startIndex']
+    end
+
+    # @attribute [r] max_results
+    def max_results
+      @raw['maxResults']
+    end
+  end
+end

data/lib/hiptail/authority/provider.rb

@@ -0,0 +1,65 @@
+module HipTail
+  # @abstract
+  class AuthorityProvider
+    # @param [String] oauth_id
+    # @return [HipTail::Authority]
+    def [](oauth_id)
+      get(oauth_id)
+    end
+
+    # @param [String] oauth_id
+    # @param [HipTail::Authority] authority
+    # @return [HipTail::Authority]
+    def []=(oauth_id, authority)
+      register(oauth_id, authority)
+    end
+
+    # @abstract
+    # @param [String] oauth_id
+    # @return [HipTail::Authority]
+    def get(oauth_id)
+      raise
+    end
+
+    # @abstract
+    # @param [String] oauth_id
+    # @param [HipTail::Authority] authority
+    # @return [HipTail::Authority]
+    def register(oauth_id, authority)
+      raise
+    end
+
+    # @abstract
+    # @param [String] oauth_id
+    # @return [void]
+    def unregister(oauth_id)
+      raise
+    end
+  end
+
+  class MemoryAuthorityProvider < AuthorityProvider
+    # @return [HipTail::MemoryAuthorityProvider]
+    def initialize
+      @authorities = {}
+    end
+
+    # @param [String] oauth_id
+    # @return [HipTail::Authority]
+    def get(oauth_id)
+      @authorities[oauth_id]
+    end
+
+    # @param [String] oauth_id
+    # @param [HipTail::Authority] authority
+    # @return [HipTail::Authority]
+    def register(oauth_id, authority)
+      @authorities[oauth_id] = authority
+    end
+
+    # @param [String] oauth_id
+    # @return [void]
+    def unregister(oauth_id)
+      @authorities.delete(oauth_id)
+    end
+  end
+end