magellan-rails 0.0.1

data/lib/magellan/subscriber/executor.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+require 'magellan/rails'
+
+ActiveSupport::Dependencies.autoload_paths << Rails.root.join("app/subscribers").to_s
+
+class Magellan::Subscriber::Executor
+  def initialize
+    @map = Magellan::Subscriber::Mapper.new
+  end
+
+  def execute(request_message)
+    request  = Magellan::Subscriber::Request.new()
+    request.parse_message(request_message)
+
+    # ロード済み定数をクリア
+    # TODO: 更新時刻をチェックする
+    ActiveSupport::Dependencies.clear
+
+    @map.call(request)
+  end
+end

data/lib/magellan/subscriber/mapper.rb

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+require 'magellan/rails'
+
+class Magellan::Subscriber::RoutingError < StandardError
+end
+
+class Magellan::Subscriber::Mapper
+  def initialize(map_file_path=Rails.root.join("config/subscribes.yml"))
+    # テストのため nil で初期化できるようにしています
+    if map_file_path
+      @config_file = map_file_path.to_s
+      @config_file_size = nil
+      @config_file_mtime = nil
+      load_mapper_file
+    end
+  end
+
+  def load_mapper_file
+    if @config_file
+      st = File.stat(@config_file)
+      if st.size != @config_file_size or st.mtime > @config_file_mtime
+        @config = YAML.load(File.read(@config_file))
+        self.map = @config
+      end
+    end
+  end
+
+  def topic_regexp(topic)
+    # "#" は特別に任意の1文字以上のトピックにマッチするとする(MQTT の仕様上空文字列はトピックとして不正)
+    return /.+/ if topic == "#"
+
+    words = topic.split("/", -1) # 末尾の a/ を ["a", ""] と分離するため第2引数の-1が必要
+    # 前処理ととして連続している "#" は冗長なので1つに正規化する
+    words.each_cons(2).each_with_index{|(w1, w2), idx| words[idx] = nil if w1 == "#" and w2 == "#" }
+    words.compact!
+    first, *remain = words
+    optional_sep = false
+    # 先頭の要素を正規表現文字列にする
+    regexp_str = "\\A"
+    case first
+    when "#"
+      # 先頭が "#" の場合 "#/a" は "a" にもマッチするので後続の要素の "/" の正規表現はここで追加する
+      optional_sep = true
+      # #/〜 の場合 # はなくてもマッチするので、空文字列もしくは任意のword+"/"とする
+      regexp_str += "(?:.*/|)"
+    when "+"
+      regexp_str += "[^/]*"
+    else
+      regexp_str += Regexp.escape(first)
+    end
+    remain.each do |w|
+      case w
+      when "#"
+        # "〜/#" の場合 "/" はなくてもマッチする(# はレベル0でもマッチする)ので、空文字列もしくは"/"+任意のwordとする
+        regexp_str += "(?:|/.*)"
+      when "+"
+        regexp_str += "/" unless optional_sep
+        regexp_str += "[^/]*"
+      else
+        regexp_str += "/" unless optional_sep
+        regexp_str += Regexp.escape(w)
+      end
+      optional_sep = false
+    end
+    regexp_str += "\\z"
+    Regexp.compile(regexp_str)
+  end
+  private :topic_regexp
+
+  def map=(config)
+    @map = config.each_with_object({}) do |(key, value), tbl|
+      regexp = topic_regexp(key)
+      controller, action = value.split("#", 2)
+      controller_name = (controller.classify + "Subscriber")
+      tbl[regexp] = [controller_name, action]
+    end
+  end
+
+  def map
+    if Rails.env.development?
+      load_mapper_file
+    end
+    @map
+  end
+
+  def map_action(topic)
+    self.map.select do |re, _|
+      re.match(topic)
+    end.map do |_, (controller_name, action)|
+      [controller_name, action]
+    end
+  end
+
+  def call(request)
+    actions = map_action(request.topic)
+    actions.each do |controller_name, action|
+      controller_class = ActiveSupport::Dependencies.constantize(controller_name)
+      controller = controller_class.new(request)
+      return controller.process_action(action)
+    end
+    if actions.empty?
+      raise Magellan::Subscriber::RoutingError, "topic #{request.topic} has no matched subscriber"
+    end
+  end
+end

data/lib/magellan/subscriber/request.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+require 'magellan/rails'
+require 'set'
+
+class Magellan::Subscriber::Request
+  attr_reader :headers, :options, :topic, :body
+
+  def option(key)
+    options[key]
+  end
+
+  def parse_message(request_message)
+    # @options = request_message['options']
+    # TRから送られるメッセージのoptionsの型が本来はHash型なのですが、配列型になってしまっているため、暫定的に空のHashをセットします
+    @options = {}
+    @headers = request_message['headers']
+    @topic = request_message["headers"]["Path-Info"]
+    case request_message["body_encoding"]
+    when /\Aplain\z/i, nil
+      @body = request_message["body"]
+    when /\Abase64\z/i
+      @body = Base64.decode64(request_message['body'])
+    end
+  end
+end

data/lib/magellan/subscriber/rspec.rb

@@ -0,0 +1,7 @@
+require "magellan/subscriber/testing/integration"
+
+require "rspec/rails/example/request_example_group"
+
+module RSpec::Rails::RequestExampleGroup
+  include Magellan::Subscriber::Testing::Integration
+end

data/lib/magellan/subscriber/testing/integration.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+require "base64"
+require "magellan/subscriber"
+
+module Magellan::Subscriber::Testing
+  module Integration
+    def publish(topic, body="")
+      executor = Magellan::Subscriber::Executor.new
+      request_message = {
+        "headers" => {
+          "Method" => "PUBLISH",
+          "Path-Info" => topic,
+        },
+        "body" => Base64.strict_encode64(body),
+        "body_encoding" => "base64",
+      }
+      executor.execute(request_message)
+    end
+  end
+end
+

data/lib/magellan/subscriber.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+require "magellan"
+require "magellan/rails"
+
+module Magellan::Subscriber
+  autoload :Executor, "magellan/subscriber/executor"
+  autoload :Request, "magellan/subscriber/request"
+  autoload :Mapper,  "magellan/subscriber/mapper"
+  autoload :Base, "magellan/subscriber/base"
+end

data/lib/magellan/worker/config.rb

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+require 'magellan/rails'
+require 'yaml'
+
+module Magellan::Worker::Config
+  class << self
+
+    def parse_boolean(val, default_value=false)
+      case val
+      when /\A1\z/, /\Atrue\z/i, /\Ayes\z/i, /\Aon\z/
+        true
+      when /\A0\z/, /\Afalse\z/i, /\Ano\z/i, /\Aoff\z/
+        false
+      else
+        default_value
+      end
+    end
+
+    def load_config()
+      config = {}
+      config[:host]              = ENV['RABBITMQ_PORT_5672_TCP_ADDR']
+      config[:port]              = ENV['RABBITMQ_PORT_5672_TCP_PORT']
+      config[:vhost]             = ENV['VHOST']
+      config[:rabbitmq_user]     = ENV['RABBITMQ_USER']
+      config[:rabbitmq_password] = ENV['RABBITMQ_PASS']
+      config[:request_queue]     = ENV['REQUEST_QUEUE']
+      config[:response_exchange] = ENV['RESPONSE_EXCHANGE']
+      config[:http_worker]       = parse_boolean(ENV['MAGELLAN_HTTP_WORKER'], true)
+      config[:subscriber_worker] = parse_boolean(ENV['MAGELLAN_SUBSCRIBER_WORKER'], true)
+      config
+    end
+  end
+end

data/lib/magellan/worker/core.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+require 'magellan/rails'
+require "magellan/worker"
+require "magellan/extentions"
+
+require 'json'
+require "bunny"
+
+class Magellan::Worker::Core
+
+  attr_reader :config
+
+  def initialize()
+    # ワーカーの設定ファイルを読み込む
+    @config = Magellan::Worker::Config.load_config
+  end
+
+  def initialize!
+    # 設定ファイルからRabbitMQへの接続設定を作成
+    connection_settings = {
+      host:    @config[:host],
+      port:    @config[:port],
+      vhost:   @config[:vhost],
+      user:    @config[:rabbitmq_user],
+      pass:    @config[:rabbitmq_password],
+      timeout: 0.3
+    }
+
+    @conn = Bunny.new(connection_settings)
+    @conn.start
+    @channel  = @conn.create_channel
+
+    queue_name     = @config[:request_queue]
+    exchange_name  = @config[:response_exchange]
+
+    # no_declareを設定しない場合、キューやエクスチェンジに対してdeclareを実行してしまい、
+    # Acess Contorolにひっかかりエラーとなります
+    # queueとexchange及びbindはmagellan-conductorによって作成済みの想定です
+    @queue    = @channel.queue(queue_name, no_declare: true)
+    @exchange = @channel.exchange(exchange_name, no_declare: true)
+
+    @executor = Magellan::Worker::Executor.new(@exchange)
+
+    self
+  end
+
+  def run
+    Magellan.logger.info("====== Magellan Worker start ======")
+    @queue.subscribe(block: true, ack: true) do |delivery_info, properties, payload|
+      reply_to       = properties.reply_to        # ワーカー実行結果返却時のルーティングキー
+      correlation_id = properties.correlation_id  # ワーカー実行結果返却時にどのリクエストに対応するメッセージか判別するための識別子
+      delivery_tag   = delivery_info.delivery_tag # ackを返却時に使用
+
+      # ワーカーロジック実行中に落ちたとしてもRabbitMQから再送させないために
+      # メッセージを取得した直後にackを返します
+      # 第1引数: ackを返す対象のメッセージを指定
+      # 第2引数: ackを返す対象以前のメッセージもackを返すか
+      #  true:  指定したメッセージ以前に受信したメッセージ全てが対象
+      #  false: 指定したメッセージのみが対象
+      @channel.basic_ack(delivery_tag, false)
+
+      begin
+        request_message = JSON.parse(payload)
+        @executor.execute(reply_to, correlation_id, delivery_tag, request_message)
+      rescue
+        Magellan.logger.error("Magellan Worker request execution error: #{$!}\n" + $@.join("\n"))
+      end
+    end
+  end
+end

data/lib/magellan/worker/executor.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+require 'magellan/rails'
+require "magellan/subscriber"
+require "bunny"
+
+class Magellan::Worker::Executor
+  def initialize(exchange)
+    @exchange     = exchange
+    @rails_executor = nil
+    @subscriber_executor = nil
+
+    # Rails 環境の初期化は Subscriber だけの時も実施する
+    # Rails.root やら Rails.application.config がないと困ることが多いと思うので
+    require File.expand_path('config/environment')
+
+    # production 環境で subscriber として動作する時は eager loading しておく
+    if Rails.env.production? and Magellan::Worker.worker.config[:subscriber_worker]
+      subscriber_executor
+    end
+  end
+
+  def rails_executor
+    @rails_executor ||= Magellan::Rails::Executor.new(@exchange)
+  end
+
+  def subscriber_executor
+    @subscriber_executor ||= Magellan::Subscriber::Executor.new
+  end
+
+  def execute(reply_to, correlation_id, delivery_tag, request_message)
+    case request_message["headers"]["Method"]
+    when /\Apublish\z/i
+      subscriber_executor.execute(request_message)
+    else
+      rails_executor.execute(reply_to, correlation_id, delivery_tag, request_message)
+    end
+  end
+end

data/lib/magellan/worker.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+require "magellan"
+
+module Magellan::Worker
+  autoload :Core,     'magellan/worker/core'
+  autoload :Executor, 'magellan/worker/executor'
+  autoload :Config,   'magellan/worker/config'
+
+  class << self
+    def worker
+      @worker ||= Magellan::Worker::Core.new
+    end
+  end
+end

data/lib/magellan.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+require 'logger'
+require 'fileutils'
+
+module Magellan
+  autoload :Rails,     'magellan/rails'
+
+  class << self
+    attr_accessor :logger
+
+    # loggerの設定
+    # ログレベルは環境変数: MAGELLAN_RAILS_LOG_LEVEL に設定して必要に応じて変更してください
+    environment = ENV['RAILS_ENV'] || 'development'
+    log_dir = File.expand_path("log")
+    FileUtils.makedirs(log_dir) unless File.exists?(log_dir)
+    logger = ::Logger.new(File.expand_path("log/#{environment}.log"))
+
+    log_level_env = ENV['MAGELLAN_RAILS_LOG_LEVEL']
+    log_levels = ['debug', 'info', 'warn', 'error', 'fatal', 'unknown']
+    if log_level_env && log_levels.include?(log_level_env)
+      log_level = Logger.const_get(log_level_env.upcase.to_sym)
+    else
+      log_level = Logger::INFO
+    end
+    logger.level    = log_level
+    Magellan.logger = logger
+  end
+end

data/magellan-rails.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magellan/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "magellan-rails"
+  spec.version       = Magellan::Rails::VERSION
+  spec.authors       = ["Yuuki Noguchi"]
+  spec.email         = ["otonakaoru@gmail.com"]
+  spec.summary       = %q{}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "railties", '~> 4.1.0'
+  spec.add_runtime_dependency "bunny"
+  spec.add_runtime_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec"
+  # spec.add_development_dependency "bunny_mock"
+end

data/spec/magellan/rails/request_spec.rb

@@ -0,0 +1,103 @@
+# -*- coding: utf-8 -*-
+
+require "spec_helper"
+require 'json'
+
+describe Magellan::Rails::Request do
+  describe '#parse_message' do
+    before(:all) do
+      @request_message_base = {
+        'headers' => {
+          'Title'                => 'groovenauts-app',
+          'Interface-Version'    => '1.0.0',
+          'Title-Runtime-Version'=> '1.0.0',
+          'Reference-Id'         => '192.168.1.110',
+          'Url'                  => 'http://magellan-clouds.com/worker/test',
+          'Oauth-Requester-Id'   => 'tarou',
+          'Content-Type'         => 'application/json',
+          'Method'               => 'GET',
+          "Server-Name"          => "localhost",
+          "Server-Port"          => 3000,
+          "Path-Info"            => "/hello/index",
+          "Query-String"         => "qs1=abc&qs2=def"
+        },
+        'body' => '',
+        'body_encoding' => 'plain',
+        'options' => {
+          # 当分実装される予定がなく、空のハッシュが渡されます
+          # 'reply_ttl' => 1000
+        }
+      }
+    end
+
+    context "valid format" do
+      context "body_encoding=nil" do
+        let(:request){ Magellan::Rails::Request.new }
+
+        before do
+          @request_message = @request_message_base.dup
+          @request_message.delete("body_encoding")
+        end
+
+        subject{ request }
+
+        it do
+          request.parse_message(@request_message)
+          expect(request.headers).to eq(@request_message['headers'])
+          expect(request.body   ).to eq(@request_message['body'])
+          expect(request.options).to eq(@request_message['options'])
+        end
+      end
+
+      context "body_encoding=plain" do
+        let(:request){ Magellan::Rails::Request.new }
+
+        before do
+          @request_message = @request_message_base.dup
+        end
+
+        subject{ request }
+
+        it do
+          request.parse_message(@request_message)
+          expect(request.headers).to eq(@request_message['headers'])
+          expect(request.body   ).to eq(@request_message['body'])
+          expect(request.options).to eq(@request_message['options'])
+        end
+      end
+
+      context "body_encoding=base64" do
+        let(:request){ Magellan::Rails::Request.new }
+
+        before do
+          @request_body = "\xff"
+          @request_message = @request_message_base.dup
+          @request_message['body'] = Base64.strict_encode64(@request_body)
+          @request_message['body_encoding'] = 'base64'
+        end
+
+        subject{ request }
+
+        it do
+          request.parse_message(@request_message)
+          expect(request.headers).to eq(@request_message['headers'])
+          expect(request.body.inspect).to eq(@request_body.inspect)
+          expect(request.options).to eq(@request_message['options'])
+        end
+      end
+    end
+
+    context "invalid format" do
+      it 'raise invalid format exception'
+    end
+  end
+
+  describe '#option' do
+  end
+
+  describe '#reply_ttl' do
+  end
+
+  describe '#to_rack_env' do
+  end
+end