hiptail 0.0.1

data/lib/hiptail/util.rb

@@ -0,0 +1,78 @@
+module HipTail
+  module Util
+    # Build capability object.
+    # @param [Hash] params
+    # @option params [String] :key Identical key for add-on
+    # @option params [String] :name Add-on name
+    # @option params [String] :base_url Base URL for add-on
+    # @option params [String] :capability_url URL for capability
+    # @option params [String] :webhook_url URL for event webhook
+    # @option params [String] :installed_url URL for installed / uninstalled event webhook
+    # @option params [String] :description (same as :name) Add-on description (optional)
+    # @option params [String] :vendor_name (same as :name) Vendor name (optional)
+    # @option params [String] :vendor_url (same as :base_url) Vendor URL (optional)
+    # @option params [String] :homepage_url (same as :base_url) Homepage (optional)
+    # @option params [String] :sender_name (same as :name) Name of notification sender (optional)
+    # @option params [String] :allow_global (true) Allow global installation (optional)
+    # @option params [String] :allow_room (true) Allow room installation (optional)
+    # @option params [String] :message_filter Room message filter regexp (optional)
+    def create_capability(params)
+      requireds = %w( key name
+                      base_url capability_url webhook_url installed_url )
+      missings = requireds.select { |k| ! params.include?(k.to_sym) }
+      if missings.length > 0
+        raise "missing parameters: " + missings.join(%q{, })
+      end
+
+      capability = {
+        key: params[:key],
+        name: params[:name],
+        description: params[:description] || params[:name],
+        vendor: {
+          name: params[:vendor_name] || params[:name],
+          url: (params[:vendor_url] || params[:base_url]).to_s,
+        },
+        links: {
+          self: params[:capability_url].to_s,
+          homepage: (params[:homepage_url] || params[:base_url]).to_s,
+        },
+        capabilities: {
+          webhook: [],
+          hipchatApiConsumer: {
+            scopes: %w( send_notification send_message admin_room view_group ),
+            fromName: params[:sender_name] || params[:name],
+          },
+          installable: {
+            allowGlobal: params.include?(:allow_global) ? params[:allow_global] : true,
+            allowRoom: params.include?(:allow_room) ? params[:allow_room] : true,
+            callbackUrl: params[:installed_url].to_s,
+          }
+        },
+      }
+
+      event_names = %w( room_notification room_topic_change
+                        room_enter room_exit )
+      webhook_url = params[:webhook_url].to_s
+
+      capability[:capabilities][:webhook] = event_names.map { |key|
+          {
+            name: key,
+            event: key,
+            url: webhook_url,
+          }
+      }
+      message_webhook = {
+        name: 'room_message',
+        event: 'room_message',
+        url: webhook_url,
+      }
+      if params[:message_filter]
+        message_webhook[:pattern] = params[:message_filter].to_s
+      end
+      capability[:capabilities][:webhook] << message_webhook
+
+      capability
+    end
+    module_function :create_capability
+  end
+end

data/lib/hiptail/version.rb

@@ -0,0 +1,3 @@
+module HipTail
+  VERSION = "0.0.1"
+end

data/lib/hiptail/web/handler.rb

@@ -0,0 +1,99 @@
+require 'json'
+require 'uri'
+require 'hiptail/util'
+
+module HipTail
+  module Web; end
+
+  class Web::Handler
+    # @return [HipTail::Manager] Returns HipTail::Manager.
+    attr_reader :manager
+
+    # @param [HipTail::Manager] manager
+    def initialize(manager)
+      @manager = manager
+    end
+
+    # Handles installing request.
+    # @param [Rack::Request] request
+    # @return [Array] Rack response.
+    def handle_install(request)
+      request.body.rewind
+      @manager.handle_install(JSON.parse(request.body.read))
+      create_response({})
+    end
+
+    # Handles uninstalling request.
+    # @note Uninstall event will be fired after uninstallation on the server.
+    #       So you cannot use oauth information to do something (e.g. sending notification) on uninstallation phase.
+    # @param [Rack::Request] request
+    # @param [String] oauth_id Corresponding OAuth ID
+    # @return [Array] Rack response.
+    def handle_uninstall(request, oauth_id)
+      @manager.handle_uninstall(oauth_id)
+      create_response({})
+    end
+
+    # Handles events (room_message, room_enter, etc.).
+    # @param [Rack::Request] request
+    # @return [Array] Rack response.
+    def handle_event(request)
+      request.body.rewind
+      @manager.handle_event(JSON.parse(request.body.read))
+      create_response({})
+    end
+
+    # Handles retrieving capability request.
+    # @param [Rack::Request] request
+    # @param [Hash] params Capability parameters
+    # @option params [String] :key Identical key for add-on
+    # @option params [String] :name Add-on name
+    # @option params [String] :base_url Base URL for add-on
+    # @option params [String] :capability_url URL for capability
+    # @option params [String] :webhook_url URL for event webhook
+    # @option params [String] :installed_url URL for installed / uninstalled event webhook
+    # @option params [String] :description (same as :name) Add-on description (optional)
+    # @option params [String] :vendor_name (same as :name) Vendor name (optional)
+    # @option params [String] :vendor_url (same as :base_url) Vendor URL (optional)
+    # @option params [String] :homepage_url (same as :base_url) Homepage (optional)
+    # @option params [String] :sender_name (same as :name) Name of notification sender (optional)
+    # @option params [String] :allow_global (true) Allow global installation (optional)
+    # @option params [String] :allow_room (true) Allow room installation (optional)
+    # @option params [String] :message_filter Room message filter regexp (optional)
+    # @return [Array] Rack response.
+    def handle_capability(request, params)
+      requireds = %w( key name
+                      webhook_path installed_path )
+      missings = requireds.select { |k| ! params.include?(k.to_sym) }
+      if missings.length > 0
+        raise "missing parameters: " + missings.join(%q{, })
+      end
+      params = params.dup
+
+      params[:capability_url] = request.url.to_s
+
+      base_url = URI.parse(request.url).merge(params[:base_path] || '/')
+      params[:base_url] = base_url.to_s
+
+      params[:webhook_url]   = base_url.merge('./' + params[:webhook_path])
+      params[:installed_url] = base_url.merge('./' + params[:installed_path])
+
+      capability = HipTail::Util::create_capability(params)
+      create_response(capability)
+    end
+
+    # @param [Hash] data
+    # @param [Integer] status (200)
+    def create_response(data, status = 200)
+      body = JSON.generate(data)
+
+      body.gsub!(/[\u{007f}-\u{10ffff}]+/) { |match| match.unpack("U*").map! { |i| "\\u#{i.to_s(16)}" }.join }
+
+      headers = {
+        'Content-Type'   => 'application/json; charset=UTF-8',
+        'Content-Length' => body.bytesize.to_s,
+      }
+      return [ status, headers, [ body ] ]
+    end
+  end
+end

data/lib/hiptail/web/rack_app.rb

@@ -0,0 +1,100 @@
+require 'uri'
+require 'rack'
+
+require 'hiptail/web/handler'
+
+module HipTail
+  module Web; end
+
+  class Web::RackApp
+    # @return [HipTail::Manager] Returns HipTail::Manager.
+    attr_reader :manager
+
+    # @param [Hash] params Capability parameters (and manager)
+    # @option params [HipTail::Manager] :manager HipTail::Manager instance (optional)
+    # @option params [String] :key Identical key for add-on
+    # @option params [String] :name Add-on name
+    # @option params [String] :base_url Base URL for add-on
+    # @option params [String] :capability_url URL for capability
+    # @option params [String] :webhook_url URL for event webhook
+    # @option params [String] :installed_url URL for installed / uninstalled event webhook
+    # @option params [String] :description (same as :name) Add-on description (optional)
+    # @option params [String] :vendor_name (same as :name) Vendor name (optional)
+    # @option params [String] :vendor_url (same as :base_url) Vendor URL (optional)
+    # @option params [String] :homepage_url (same as :base_url) Homepage (optional)
+    # @option params [String] :sender_name (same as :name) Name of notification sender (optional)
+    # @option params [String] :allow_global (true) Allow global installation (optional)
+    # @option params [String] :allow_room (true) Allow room installation (optional)
+    # @option params [String] :message_filter Room message filter regexp (optional)
+    def initialize(params)
+      params = params.dup
+      @manager = params.delete(:manager) || Manager.new
+      @handler = Web::Handler.new(@manager)
+
+      params[:base_path]       ||= '/'
+      params[:webhook_path]    ||= '/event'
+      params[:installed_path]  ||= '/install'
+      params[:capability_path] ||= '/cap'
+      @capability_params = params
+
+      base_url = URI.parse('http://example.com/').merge(params[:base_path])
+      path = {
+        :base => base_url.request_uri,
+      }
+      [ :webhook, :installed, :capability ].each do |key|
+        path[key] = base_url.merge('./' + params["#{key}_path".to_sym]).request_uri
+      end
+
+      @regex = {}
+      @regex[:capability] = %r{\A #{Regexp.escape(path[:capability])} \z}xm
+      @regex[:event]      = %r{\A #{Regexp.escape(path[:webhook])} \z}xm
+
+      @regex[:install]   = %r{\A #{Regexp.escape(path[:installed])} \z}xm
+      @regex[:uninstall] = %r{\A #{Regexp.escape(path[:installed])} / ([-0-9a-fA-F]+) \z}xm
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+
+      case req.path_info
+      when @regex[:capability]
+        if req.get?
+          return on_capability(req)
+        end
+      when @regex[:event]
+        if req.post?
+          return on_event(req)
+        end
+      when @regex[:install]
+        if req.post?
+          return on_install(req)
+        end
+      when @regex[:uninstall]
+        if req.delete?
+          return on_uninstall(req, $1)
+        end
+      end
+
+      return @handler.create_response({}, 404)
+    end
+
+    private
+
+    def on_capability(request)
+      @capability_cached ||= @handler.handle_capability(request, @capability_params)
+      @capability_cached
+    end
+
+    def on_event(request)
+      @handler.handle_event(request)
+    end
+
+    def on_install(request)
+      @handler.handle_install(request)
+    end
+
+    def on_uninstall(request, oauth_id)
+      @handler.handle_uninstall(request, oauth_id)
+    end
+  end
+end

data/lib/hiptail.rb

@@ -0,0 +1,9 @@
+require 'hiptail/version'
+require 'hiptail/atom'
+require 'hiptail/event'
+require 'hiptail/authority'
+require 'hiptail/authority/provider'
+require 'hiptail/manager'
+require 'hiptail/web/handler'
+require 'hiptail/web/rack_app'
+require 'hiptail/util'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: hiptail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ITO Nobuaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: HipChat Add-on Framework
+email:
+- daydream.trippers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/integrate_sinatra/Gemfile
+- examples/integrate_sinatra/README.md
+- examples/integrate_sinatra/app.rb
+- examples/simple_rack_app_1/Gemfile
+- examples/simple_rack_app_1/README.md
+- examples/simple_rack_app_1/config.ru
+- examples/simple_rack_app_2/Gemfile
+- examples/simple_rack_app_2/README.md
+- examples/simple_rack_app_2/app.rb
+- examples/simple_rack_app_2/config.ru
+- hiptail.gemspec
+- 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/util.rb
+- lib/hiptail/version.rb
+- lib/hiptail/web/handler.rb
+- lib/hiptail/web/rack_app.rb
+homepage: https://github.com/dayflower/hiptail
+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.2.2
+signing_key: 
+specification_version: 4
+summary: HipChat Add-on Framework
+test_files: []