はてなブックマーク

Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? これは Enchant の開発者である Vinay Sahni さんが書いた記事「Best Practices for Designing a Pragmatic RESTful API」1を、ご本人の許可を得て翻訳したものです。 RESTful な WebAPI を設計しようとすると、細かなところで長考したり議論したりすると思います。また、他の API に倣ってやってはみたものの、本当にそれでいいのか、どうしてそうしているのか分からない、何てことも少なくはないと思います。 この記事では、そのようなハマリどころについて Vinay さん

Phoenix の開発者である Chris McCord さんが 2015/11/18 に書いた記事「Phoenix is not Rails」の翻訳です。 僕は Rails 未経験の状態で Phoenix を始めたクチなのですが、最近 Rails もやるようになり、両者を比較して考えることが多くなってきたので、いい機会だと思い翻訳してみました。 誤訳があれば編集リクエストを頂けると幸いです。 まえがき 昨年12月、ブライアン1は年次総括で 開発を Elixir と Phoenix に移行する計画を公表しました。それから1年、実際に Rails から Phoenix へ移行してみて分かったのは、この作業はそれほど大変ではないということです。というのも、Phoenix は Rails と非常によく似た作りをしているからです。もちろん、フレームワークのきちんとした理解にはそれなりの学習が必要で

defmodule PhoenixTail.TailChannel do use Phoenix.Channel def join("tails:sample", auth_msg, socket) do {:ok, socket} end def join("tails:" <> _private_room_id, _auth_msg, socket) do {:error, %{reason: "unauthorized"}} end end ログファイルを監視するプロセスを作る 次に、tail の対象とするログファイルを監視する部分を実装します。 処理の流れとしては、 定期的に対象のファイルをチェック 変更が入っていれば、前回取得行以降の行を取得 取得した内容を WebSocket に broadcast という感じで、サーバへのリクエストなどとは一切関係ないものとなります。 つまり

Mac に Elasticsearch をインストールして、シンプルなデータ投入・検索・削除をやってみます。 環境 Mac OSX 10.10.2 Java のインストール まずは Java を入れるところから始めます。 Oracle の Java ダウンロードページより最新の JDK をダウンロードしましょう。 現時点 (2015/05/09) で最新版は 1.8.0_45 なので、 jdk-8u45-macosx-x64.dmg を選択します。 これはインストーラですので、ダウンロード後はファイルを開いて指示に従っていけば完了します。 ターミナルで確認するとこんな感じ。 $ java -version java version "1.8.0_45" Java(TM) SE Runtime Environment (build 1.8.0_45-b14) Java HotSpot(TM)

GitHub 風味の Qiita マイページを作ってみます。 Let's 芝生駆動投稿！ ことの始まり GitHub のプロフィールページといえば 芝生 でおなじみですね。 青々としていく芝生をみていると、不思議と Contribution に対するモチベーションも上がるものです。 「この芝生が Qiita にもあれば、もっともっと記事を投稿するに違いない」と漠然に思ったのがことの始まり。 完成イメージ 結論、こんな感じになりました。 そう、ほぼほぼ GitHub です。記事の投稿で草が生えます。 fake_qiita : https://fakeqiita.herokuapp.com/ （Qiita アカウントをお持ちの方は是非お試しください！） ソースコードは GitHub で公開しています。 https://github.com/mserizawa/fake_qiita 主に使うもの

Phoenix + AngularJS で Markdown 同時編集ツールを作ってみます。 イメージとしては HackMD のようなものを目指します。 ことの始まり ElixirConf 2015 のタイムラインを眺めていたら、 I'm collaboratively editing a doc with 60 of my closest @ElixirConf friends. #phoenixframework pic.twitter.com/PlVexa3Anx — David Raffauf (@draffauf) 2015, 10月 1 Phoenix で同時編集ツールを作っている人がいて、「こういうのって自分でも作れるのかな」と漠然に思ったのがことの始まり。 完成イメージ 結論、こういうツールができました。 GitHub で公開しています。 collabo_marker :

JSON ベースの API では JSON Schema を使った Validation が非常に有効です。 Elixir で JSON Schema を使った JSON の妥当性検証をしてみます。 Phoenix アプリケーションをセットアップする json_schema_sample というアプリケーションを作ります。

WebSocket を利用するアプリケーションは Pub/Sub サーバを使ってスケールアウトさせるのが一般的です。 今回は Redis の Pub/Sub 機能を使って Phoenix の WebSocket をスケールアウトさせてみます。 Phoenix で WebSocket 通信をさせる方法はコチラをご参照ください。 事前知識: WebSocket アプリケーションのスケールアウトについて 通常の Web アプリケーションにおけるスケールアウトは、サーバ台数を増やしてロードバランサでリクエストを分散させる、というのが一般的ですが、WebSocket アプリケーションではこの手法が使えません。 なぜかというと、WebSocket アプリケーションはコネクションをサーバ内で管理するステートフルな作りになっているためです。冗長化させたサーバにリクエストを分散させてしまうと、他サーバで接続

デフォルトの状態だと対応していない日本語全文検索を、kuromoji を入れることで対応させます。 Elasticsearch のインストールについてはコチラを参考にしてください。 kuromoji のインストール Elasticsearch には plugin というコマンドが用意されていて、これを使うことで簡単に各種プラグインをインストールできます。 今回はコチラのプラグインを入れてみます。 インストール済みの Elasticsearch のバージョンが 1.5.2 ですので、プラグインのバージョンは 2.5.0 を指定します。

エラーログのハンドリングはサービスを運用する上で欠かせません。 今回は Elixir の Logger を使って、ログのファイル出力とメール送信をやってみます。 Phoenix アプリケーションでの外部 API リクエストについてはコチラを参照してください。 事前知識: Elixir の Logger について Elixir Logger - http://elixir-lang.org/docs/v1.0/logger/Logger.html Elixir には標準でロギングライブラリが組み込まれています。 一般的なロギングと同様に、:debug :info :warn :error という出力レベルの分類（ちょっと少ない？）があったり、出力フォーマットのカスタマイズが可能です。 ただし、標準ままではコンソールへの出力しかサポートしていなくて、それ以上のことをする場合は各自で実装してね、

Phoenix で外部 API にリクエストする API を作ってみます。OpenWeatherMap API に問い合わせて、指定された緯度経度の天気を JSON で返却するという 無駄な挙動をさせてみましょう。 Phoenix で JSON API 作る方法はコチラを参照してください。 依存関係に HTTPoison を追加する Elixir 版のサードパーティライブラリアーカイブ（PyPI や npm といった類のもの）には Hex があります。 ここに公開されているライブラリは Mix を使うことで簡単にプロジェクトに追加でき、またこれらの依存関係は mix.exs というファイルで管理できます。 今回は HTTP Client として HTTPoison を利用しますので、以下のように追記します。 ... # Specifies your project dependencies

Elixir で XML のパース処理を実装してみます。 今回は郵便番号検索 API に問い合わせて、その返却結果（XML）を JSON に変換して返す API を作ってみます。 比較的軽めの XML パース処理...ということで上記の API を選びましたが、このテクニックを応用させれば Web スクレイピングなども実装可能と思います。 なお、今回は Erlang の xmerl という XML ライブラリを直で使ってみます。 Phoenix アプリケーションでの外部 API リクエストについてはコチラを参照してください。 Phoenix アプリケーションをセットアップする xmlparse_sample というアプリケーションを作り、mix.exs に以下のように追記しましょう。 defmodule XmlparseSample.Mixfile do ... defp deps do

Elixir はプロセス指向なだけあって、カジュアルに並列処理を使えます。 今回はこの並列処理を活用して、複数の勉強会サイトの WebAPI に対して一気にリクエストを投げる、いわゆるメタサーチ的な API を作ってみたいと思います。 Phoenix アプリケーションでの外部 API リクエストについてはコチラを参照してください。 事前準備: 各勉強会サイトの API 理解する ATND, Connpass, Zusaar, Doorkeeper のいずれも、アクセスキー無し（！）で利用できる WebAPI が用意されています。 大変ありがたいことに、これらの API については sharow さんが以下の記事にとても良くまとめてくださっていますので、こちらを参考にしたいと思います。 勉強会サイトのAPI比較 http://qiita.com/sharow/items/508bc876ff

Phoenix には Ecto と呼ばれるデータベース操作ライブラリがあり、PostgreSQL や MySQL（MariaDB）、SQLite といったものに対応しています。 Ecto を使うと定義したモデルを元に簡単に（SQL を書かずに）CRUD 操作ができるようなのですが、今回はあえて生の SQL を発行して MariaDB に問い合わせることをしたいと思います。 Phoenix アプリケーションの作成についてはコチラを参照してください。 なぜ生 SQL なのか Ecto はモデル定義さえすれば、それを使った CRUD 操作やテーブルの作成、果ては JSON API や HTML までも生成してくれる優れものです。 ただ、自分の経験上、DB 操作を伴う大規模な WebAPI を開発していくと、以下のようなケースに遭遇し、どうしても生 SQL を書きたくなることが多いです。 レコード

Phoenix に Cache 機構をいれてみます。 今回は ConCache を使って OpenWeatherMap API のレスポンスをキャッシュしてみます。 Phoenix アプリケーションでの外部 API リクエストについてはコチラを参照してください。 Elixir におけるキャッシュについて キャッシュ機構の実装というと、シングルトンクラスを作って処理することをイメージするかもしれませんが、これは オブジェクト指向 な考え方であり、Elixir のような プロセス指向 な言語には当てはめられません。 プロセス指向では、その名の通り データをストアしておくプロセス を作成して処理します。プロセスの作成と聞くとなにやら大変そうな気がしますが、Erlang/OTP のおかげでシンプルに実装できるようになっています。 では早速、ConCache を利用してプロセスを用いたキャッシュを体

Phoenix には Channel という概念があり、これを JavaScript と組み合わせて使うことでブラウザと WebSocket 通信ができるようになります。 今回は公式ドキュメントを参考に、Channel を使ったサンプルアプリケーションを作ってみます。 チャットだと地味なので、d3.js のこの Example を使って遊んでみようと思います。 Phoenix アプリケーションの作成についてはコチラを参照してください。 サーバサイドを実装する channel_sample という名前でアプリケーションを作ります

Phoenix で OAuth 認証をやってみます。 今回は GitHub の OAuth を使いますが、Twitter や Facebook といったものにもつかえると思います。 また、認証用ライブラリはコチラを利用します。実装はこちらに公開されているサンプルを追っていくカタチとなります。 Phoenix アプリケーションの作成についてはコチラをご参照ください。 下準備: GitHub アプリケーションを登録する まずは GitHub にアプリケーションを登録して、各種キーを手に入れます。 GitHub にログインした状態で登録ページに行き、フォームを埋めていきます。 今回はテスト用のアプリケーションなので、基本的には適当に埋めていけば良いのですが、callback URL だけ以下のように設定します。 http://localhost:4000/auth/callback Regist

Elasticsearch でスキーマを定義してデータを投入する方法を試してみます。 Elasticsearch のインストールについてはコチラ、 kuromoji のインストーラについてはコチラを参考にしてください。 Elasticsearch のスキーマについて Elasticsearch ではスキーマを マッピング、型を タイプ という概念で扱います。 マッピングを定義していない場合は、投入されたデータの値からタイプを自動で判定して、マッピングされます。 これはとても便利な機能である反面、意図しない・不必要なインデクシングが発生してしまう可能性もあります。 安定した運用が求められるケースでは、しっかりとスキーマを定義したほうが良いですね。 マッピングの指定 今回はランドマークの「名前、緯度軽度、説明」を投入してみます。 項目 プロパティ名 説明