Bit Journey Blog

サブドメインでデータを分けたい（例えばhttps://bitjourney.slack.comみたいな）場合、RailscastsにあるMultitenancy with Scopesみたいに実現するのもありですが、その中でも参照されている、apartmentというgemを使うと、一つのRailsアプリケーションから複数のDBを扱う実装が、簡単にできそうです。

まずGemfileにapartmentを追加してbundle。

source 'https://rubygems.org' do ... gem 'apartment', '1.0.0' ... end

apartmentの設定ファイルをつくります。

rails g apartment:install

テナントを管理するモデルをつくります、今回はそのままTenantという名前で。nameでそれぞれを識別することにします。null: false等適宜つけておきましょう。

rails g model tenant name:string rake db:migrate

config/initializers/apartment.rbがつくられるので、中を編集。サブドメインで分ける場合は以下な感じになると思います。

require 'apartment/elevators/subdomain' Apartment.configure do |config| config.excluded_models = %w(Tenant) config.tenant_names = -> { Tenant.pluck(:name) } config.prepend_environment = !Rails.env.production? end Rails.application.config.middleware.use 'Apartment::Elevators::Subdomain'

一点、config.prepent_environmentはデフォルトではコメントアウトされていて、ドキュメントによると

By default, and only when not using PostgreSQL schemas, Apartment will prepend the environment to the tenant name to ensure there is no conflict between your environments. This is mainly for the benefit of your development and test environments. Uncomment the line below if you want to disable this behaviour in production.

とのことなので、デフォルトでRails.envをDB名の頭につけてくれそうに読めたのですが、つけてくれなかったのでコメントを外しています。 上記の設定だとproductionのときはfalseになるので、TenantのnameでDBがつくられそうです。

で、試しに一つテナントをつくってみます。通常db/seeds.rbとかseed-fuとかを使うんだと思います。

rails c [1] pry(main)> Tenant.create(name: 'bitjourney')

で、テナントを作成。

rake apartment:create

これでdevelopment_bitjourneyというDBがつくられます。 その後はマイグレーションを実行すると、これらのDB全てに反映されていきます。

rake db:migrate

これで、bitjourney.lvh.me:3000等、Tenantがある場合にはページが表示されますし、unknown.lvh.me:3000等Tenantがない場合はApartment::TenantNotFoundが発生します。いい感じですね。

RSpecでアップロードされたファイルをつくってテストしたい、という場合、以下のようなファイルをshared contextとして作成し、必要な箇所でincludeして使うようにしています。

spec/support/shared_contexts/uploaded_file.rb

include ActionDispatch::TestProcess RSpec.shared_context 'uploaded file' do let(:uploaded_file) do uploaded_file = fixture_file_upload('images/ハレアカラ.jpg', 'image/jpeg') allow(uploaded_file).to receive(:tempfile).and_return(uploaded_file) uploaded_file end end

fixture_file_uploadに渡している実ファイルは、spec/fixtures以下につくってあげれば良いです。この場合だと、spec/fixtures/images/ハレアカラ.jpgですね。 あとは、tempfileが呼ばれたときに自分自身を返すようにしてあげているくらいです。

例えば、Dragonflyでサーバ上に一時的に画像ファイルを保存するメソッドを持つ以下のようなサービスオブジェクトがあった場合、

class UserProfilePhotoUpdating def initialize(user, params) @user = user @params = params end def retained_image app = Dragonfly.app uid = app.store(@params[:user_profile_photo][:image].tempfile) app.fetch(uid) end end

retained_imageはアップロードされたファイルにアクセスするため、上記のuploaded fileを使っています。

require 'rails_helper' RSpec.describe UserProfilePhotoUpdating do subject { UserProfilePhotoUpdating.new(user, params) } let(:user) { FactoryGirl.create(:user) } describe '#retained_image' do include_context 'uploaded file' let(:params) { { user_profile_photo: { image: uploaded_file } } } it 'stores uploaded file and creates the image' do expect(subject.retained_image).to be_a(Dragonfly::Job) end end end

elasticsearch-extensionsのTest::Clusterを使ってESのテストを書いているときに、ローカルの環境のまま動かそうとすると、

Starting 1 Elasticsearch nodes..sh: 1: elasticsearch: not found

とelasticsearchコマンドが見つからないと怒られてしまう場合、TEST_CLUSTER_COMMANDでコマンドの場所を指定してあげましょう。

circle.ymlの関連する部分は以下のようになりました。（YOUR_RAILS_ROOT部分はそれぞれの環境に合わせて変えてください）

dependencies: bundler: without: [production] cache_directories: - elasticsearch-1.3.2 post: - if [[ ! -e elasticsearch-1.3.2 ]]; then wget https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticsearch-1.3.2.tar.gz && tar -xvf elasticsearch-1.3.2.tar.gz && elasticsearch-1.3.2/bin/plugin -install elasticsearch/elasticsearch-analysis-kuromoji/2.3.0; fi test: override: - TEST_CLUSTER_COMMAND=/home/ubuntu/#{YOUR_RAILS_ROOT}/elasticsearch-1.3.2/bin/elasticsearch bundle exec rake

起動時にCircle CIにElasticsearchを動かしてもらうこともできますが、自前で1.3.2とプラグインを持ってきてキャッシュする設定だけやっておきます。 あとは以下のようなファイルをつくって必要な箇所でのみ:elasticsearchを指定して起動してあげるのは、ローカルでテストするときと同様です。

spec/support/elasticsearch.rb

RSpec.configure do |config| config.before(:all, :elasticsearch) do Elasticsearch::Extensions::Test::Cluster.start(nodes: 1) unless Elasticsearch::Extensions::Test::Cluster.running? end config.after(:all, :elasticsearch) do Elasticsearch::Extensions::Test::Cluster.stop if Elasticsearch::Extensions::Test::Cluster.running? end end

サービスへのログイン時に、メールアドレスがexample.comかgmail.comなユーザなら許可する、みたいなことを、以下のように実装してみました。

ENV['USER_DOMAIN']には'example.com gmail.com'みたいにスペースで区切ったドメインの文字列が入っているとして、

app/models/user.rb

class User < ActiveRecord::Base VALID_EMAIL_REGEXP = /\A(.+)@#{Regexp.union(ENV['USER_DOMAIN'].split)}\z/ validates :email, format: { with: VALID_EMAIL_REGEXP } end

こんな感じですか。

omniauth-google-oauth2を使ってログイン機能を実装する際に、Google Appsの特定のドメインのユーザのみにログインを制限するので、アカウントを選ぶ画面を出して欲しくない、みたいな場合、以下のようにhdにドメインを指定してあげると良いようです。

Rails.application.config.middleware.use OmniAuth::Builder do options = { prompt: 'consent', hd: 'example.com } provider Rails.application.config.auth, ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET'], options end

以下のようにElasticsearchを使って検索するアクションがあり、RSpecでこのコントローラスペックを書きたい！という場合にどうしようって話です。

class PostsController < ApplicationController def search @records = Post.search(params[:query]).page(params[:page]).records end end

Gemfileにelasticsearch-extensionsを追加します。バージョンは適当なもので。 このgemがデフォルトで9250ポートで立ち上がるテスト用のElasticsearchのクラスタを用意してくれるので、9200で立ち上がる開発用のクラスタとかぶりません。

group :test do gem 'elasticsearch-extensions', '0.0.15'

で、毎回立ち上げたり落としたりしていると時間がかかって仕方がないので、:elasticsearchなときだけ動かすようにします。

require 'elasticsearch/extensions/test/cluster' RSpec.configure do |config| config.before(:all, :elasticsearch) do Elasticsearch::Extensions::Test::Cluster.start(nodes: 1) unless Elasticsearch::Extensions::Test::Cluster.running? end config.after(:all, :elasticsearch) do Elasticsearch::Extensions::Test::Cluster.stop if Elasticsearch::Extensions::Test::Cluster.running? end end

Elasticsearchのクライアントが使うホストやポートは、環境変数なりで変えられるようにしておいた方が良いですね。

config/initializers/elasticsearch.rb

Elasticsearch::Model.client = Elasticsearch::Client.new(host: ENV['ELASTICSEARCH_HOST'], logs: Rails.env.development?, trace: Rails.env.development?)

僕はdotenvを使って、.env.testでテスト用の環境変数を設定するようにしています。 テスト用なのでlocalhostの9250番を見るようにしておきます。

.env.test

ELASTICSEARCH_HOST='localhost:9250'

コントローラスペックはこんな感じ。

spec/controllers/posts_controller_spec.rb

RSpec.describe PostsController, :elasticsearch do let(:page) { FactoryGirl.create(:page, content: 'ページ') } before do Post.__elasticsearch__.create_index! force: true Post.__elasticsearch__.refresh_index! page Post.import # Wait test cluster to index the created objects sleep 1 end after { Post.__elasticsearch__.client.indices.delete index: Post.index_name } context 'when the result exists' do it 'assigns the result to @results' do get :search, query: 'ページ' expect(assigns(:records)).to contain_exactly(page) end end end

最初に:elasticsearchを指定しているので、このテスト全体が動く前にテスト用のElasticsearchのクラスタが立ち上がり、終わる前にクラスタが終了します。

あとは、各テストの前でインデックスがつくられるようにbeforeにデータを突っ込む処理を書き、afterでつくられたインデックスを削除しています。つくったデータがインデックスに反映されるのを待つために1秒スリープしているのがダサいですが、仕方ないですかね。。

RSpecでActionMailerのdeliver_later!が呼び出されることをテストするコードを書いてみます。

コメントがあったときにメールで通知するサービスオブジェクトをつくり、それは中でActionMailerのdeliver_later!等を呼び出しているとします。こんな感じ。

app/services/comment_notification.rb

class CommentNotification def initialize(comment) CommentNotificationMailer.notify(comment).deliver_later! end end

このサービスオブジェクトをnewしたときに、これらのメソッドが呼び出されることを保証するRSpecのテストを書こうとしてみました。

spec/services/comment_notification_spec.rb

require 'rails_helper' RSpec.describe CommentNotification do describe 'new' do let(:blog) { FactoryGirl.build_stubbed(:blog) } let(:comment) { FactoryGirl.build_stubbed(:comment, commentable: blog) } let(:mailer) { double('mailer', deliver_later!: true) } it 'calls mailer methods' do expect(CommentNotificationMailer).to receive(:notify).with(comment).and_return(mailer) expect(mailer).to receive(:deliver_later!) CommentNotification.new(comment) end end end

テストの中身を見てみると、

expect(CommentNotificationMailer).to receive(:notify).with(comment).and_return(mailer)

で、CommentNotificationMailerのnotifyメソッドがcommentを引数に呼び出されてmailerを返し、

expect(mailer).to receive(:deliver_later!)

で、そのmailerがdeliver_later!を呼び出されることをテストする、みたいな。

expect(CommentNotificationMailer).to recieve_message_chain(:notify, :deliver_later!)

とメソッドチェインのテストを書くこともできたのですが、commentを引数にnotifyが呼び出されていることをテストしておきたかったので、このようなかたちになりました。

今つくっているRailsアプリケーションのデプロイにはCapistrano 3を使っています。

slackistranoというgemを使うとデプロイの開始や終了を簡単にSlackに通知できるようになるのですが、終了の通知にgitの最後のコミットの内容とそれへのリンクが含まれるように、ちょっとカスタマイズしてみます。

通知されるようにする設定自体は、slackistranoのREADME通りにやればさくっとできると思います。

で、slack_msg_finishedという値でデプロイ終了時のメッセージを設定できるようなのでそれを変更します。

config/deproy.rb

set :slack_msg_finished, -> { "#{ENV['USER'] || ENV['USERNAME']} has finished deploying branch #{fetch(:branch)} of #{fetch(:application)} to #{fetch(:rails_env, 'production')}.\n> #{fetch(:git_last_commit_message)}" }

get_last_commit_messageという値は別のタスクをつくってそちらで設定します。 （repo_urlが[email protected]であることを前提にしているので、ここをもう少し賢くしてあげると良さそうですね。）

lib/capistrano/tasks/git.rake

namespace :git do task :last_commit_message do repository_path = "#{fetch(:deploy_to)}/repo" on roles(:db) do within repository_path do repo_path = fetch(:repo_url).scan(/git@github\.com:(.*)\.git/).flatten[0] message = capture :git, 'log', '-1', %{--pretty=format:'<https://github.com/#{repo_path}/commit/%h|%h> - %an: "%s"' HEAD} set :git_last_commit_message, message.force_encoding('UTF-8') end end end end

あとは、Slackへの通知が終了する前に、このgit:last_commit_messageを呼び出してgit_last_commit_messageに値が設定されるようにしましょう。

config/deploy.rb

before 'slack:deploy:finished', 'git:last_commit_message'

slackistranoのREADMEにあるように、

$ cap production slack:deploy:finished

で通知のテストができるので実行してみると、こんな感じの通知になっていると思います。