WEB EGG

Alfred2のWorflowsを自作して作業を効率化する

May 22, 2013 · 13 min read

こんにちは。
最近は、Alfredというアプリに大変お世話になっております。
アプリを起動するのにいちいちトラックパッドを使わなくて済むので、すごく捗ります。

Alfred には、色々な便利機能があるのですが、

今回はもう少し突っ込んだことについて書きたいので、
参考になった記事を貼っておきます。

Mac 仕事効率化！Spotlight を完全に超えた神ランチャーアプリ「Alfred 2」の使い方とおすすめ Workflows10 選。[Mac] | MacWin Ver.1.0

[太]Mac のランチャーアプリ Alfred ver2 の新機能「workflows」が結構凄そう。 | Fujitaiju Blog

ここからが本題です。
Alfred にはWorkflowsという機能があります。

この Workflows が非常に強力で、

Evernote のクリップしてある記事から検索をかけたり
リマインダーにワンライナーでタスクを追加したり
Amazon の商品検索のサジェスト機能を使ったり
カラーコードを入力すると該当する色を表示してくれたり
URL を入力すると、短縮 URL が生成されてクリップボードにコピーできたり

と、他にも色々ありますが、 Alfred というアプリ上で、一つのまとまった作業を一気に行うことができます。

で、この中から
Web で API が公開されているサービスに何らかの問い合わせをし、
その結果を元に、何かアクションを起こす

といったタスクを行う Workflows を作ってみようと思います。

ググっても、チュートリアル系の記事が１件も見つからなかったので、ソースを読んで作り方を学んでいきます。

今回は、日付を入力すると、
速水もこみちが MOCO’s キッチンで使ったオリーブオイルの量を検索出来る API
MOCO’S キッチンオリーブオイル APIを利用した Workflows を作ります。

Alfred Workflows の前提知識

まず、Alfred というアプリをインストールしないと始まらないので、
公式か App Store からインストールをします。
インストール+利用は無料です。

Alfred

カテゴリ: 仕事効率化
価格: 無料

そして、残念ですが、注意事項です。

Alfred Workflows(以下 workflows)を利用するには、課金が必要です。

価格にして、15 英ポンド、2013/05/21 現在¥2,300 くらいです。
しかし、それだけのお金を払う価値は十分にあると思います。

ここから先の内容は、
Alfred の有料機能を使うための PowerPack を買った人を対象に進めます。

サンプルの Google Suggest を利用してみる

PowerPack を購入すると、workflows が利用できるようになります。

まずは感覚をつかむために、
Google Suggest というサンプルを利用します。

1. Google Suggest を作成

Googl

workflows の下の方にある**[+]**を押し、
Examples→Google Suggestをクリックすると、作成完了です。 workflows のリストに Google Suggest というのが表示されたと思います。

Googl

これは、Alfred にあらかじめサンプルとして入っている workflows で、
このまま利用できます。

2. 使ってみる

では早速使ってみます。
Alfred を起動し、g 検索ワード(何でもいい)と入力します。

例えばg jQと入力すると、このようなリストが表示されます。

Googl

表示されたものを選択し、Enter を押すと、
その検索結果ページがブラウザで開かれます。

3. つまり

このように、Google の検索窓で打つのと同じことを、
Alfred 上で完結できます。

今回、
url を叩いて json やら xml を入手して、その結果を元に処理を行うことがしたいので、
このサンプルは非常に参考になります。

Examples に、同様の機能を持ったAmazon Suggestというものもあるんですが、
こちらはコードがあまりシンプルじゃなかったので、Google Suggest の方を見ていきます。

サンプルのコードを読む

まず、Google Suggest のコードを、全部貼っつけてみます。
あまり行数はないです。PHP で書かれています。

require_once("workflows.php");
$wf = new Workflows();
$orig = '{query}';
$xml = $wf->request( 'http://google.com/complete/search?output=toolbar&q='.urlencode( $orig ) );
$xml = simplexml_load_string( utf8_encode($xml) );
$int = 1;
foreach( $xml as $sugg ):
  $data = $sugg->suggestion->attributes()->data;
  $wf->result( $int.".".time(), '$data', '$data', "Search Google for ".$data, "icon.png" );
  $int++;
endforeach;
$results = $wf->results();
if ( count( $results ) == 0 ):
  $wf->result( "googlesuggest", $orig, "No Suggestions", "No search suggestions found. Search Google for ".$orig, "icon.png" );
endif;
echo $wf->toxml();

これで分かる方なら、もう早速作り始められると思います。
備忘録のために、これを部分的に掻い摘んでいきます。

0. 言語について

その前に、workflows 作成に利用できる言語について。

Google Suggest も Amazon Suggest もPHPで書かれています。
ですが、もちろん他の言語でも書くことができます。

他に対応している言語は、

bash
zsh
Ruby
Python
Perl

があります。

PHP で書く際の注意点は、
ファイルの先頭、末尾に<\?phpと?>を入れないこと、くらいです。

今回は、Google Suggest に倣って書くので、PHP で書きます。
ご了承下さい。

というか PHP 以外の言語あまり分かりません。

1. workflows.php と Workflows クラス

require_once('workflows.php');
$wf = new Workflows();

この部分、いかにもなクラスを require しています。
Workflows クラスは、workflows を作る上でのユーティリティです。

これのお陰で、通信などの処理を自前で書かずとも、
簡単に workflows が作成できるようになっています。

workflows.php は、workflows を作成すると自動的に生成されるので、
自前で揃える必要はありません。

2. 入力値の格納

$orig = "{query}";

とありますが、これは workflows 上でのおまじないです。

"{query}"という文字列は、Google Suggest で設定されている、
gキーワード以降に入力された文字列に置き換えられます。

例えば、g jQueryと入力すると、
$orig には、"{query}"ではなく、変換後のjQueryという文字列が入ります。

どのタイミングで置換が行われるかは、調査はしていません。

3. $wf->requesr( url )

Workflows クラス大活躍です。
url を渡すだけでレスポンスを取得できます。

必要に応じて、urlencodeを使ってエンコードして下さい。

4. $wf->result()

foreach( $xml as $sugg ):
    $data = $sugg->suggestion->attributes()->data;
    $wf->result( $int.'.'.time(), "$data", "$data", 'Search Google for '.$data, 'icon.png' );
    $int++;
endforeach;

レスポンスを取得したら、
必要なデータを抜き出して$wf->resultに突っ込んでいます。

result()に突っ込まれたデータが、Alfred 上で表示されます。

この$wf->result()の引数が分かりにくいので、
Workflows.php の中身を見てみました。

/**
 * Description:
 * Helper function that just makes it easier to pass values into a function
 * and create an array result to be passed back to Alfred
 *
 * @param $uid – the uid of the result, should be unique
 * @param $arg – the argument that will be passed on
 * @param $title – The title of the result item
 * @param $sub – The subtitle text for the result item
 * @param $icon – the icon to use for the result item
 * @param $valid – sets whether the result item can be actioned
 * @param $auto – the autocomplete value for the result item
 * @return array – array item to be passed back to Alfred
 */
public function result( $uid, $arg, $title, $sub, $icon, $valid='yes', $auto=null, $type=null ) {
    // …
}

という引数になっています。
リストに見える部分は、$titleと$sub、$icon です。

$arg は、取得結果を表示した次のアクションに渡される値です。

例えば、取得結果に URL が存在する場合には、その URL を$argに渡しておくと、
次のURLを開くアクションなどで$arg の値を渡すことができます。

5. echo $wf->toxml();

workflows は、echo $wf->toxml()で echo された xml 文字列を受け取って、リスト表示するようです。

6. まとめ

これらの処理をすごくざっくりまとめると、

$wf->request()で API を叩く
レスポンスから、使いたいデータを$wf->result()に突っ込む
echo $wf->toXML()でリスト表示させる

と言った３ステップになると思います。

補足. キーワード？？？

g 検索ワードのように、
gというキーワードにこの workflows が反応させるように決めます。

Scrip

反応させるキーワードは、図の上部に書かれた文字を見れば分かります。

反応させたいキーワードを入力する

反応キーワードを変更したい場合には、
この図をダブルクリックして、keyword を変更すれば OK です。

今回作るものの詳細

冒頭でも話しましたが、
今回は、MOCO’s キッチンオリーブ APIを利用したサンプルを作ります。

今回使用するキーワードは、mocosとして、

mocos 日付(YYYY-MM-DD)[,日付…]と入力する
該当する日付に使われたオリーブの数とレシピの名前を表示
レシピを選択して Enter キーを押すとブラウザでレシピが見れる
YYYY/MM/DD形式でも入力を受け付ける

と言った機能を作ります。完成図はこんな感じ。

MOCO'sキッチンオリーブAPIのWorkflow完成図

この API はパラメータは１種類しか取らず、
その書式もはっきりしているので Hello world に最適だと思います。

今回利用する API について学ぶ

MOCO’s キッチンオリーブ API の URL は、
GET: です。

パラメータはdateのみで、
値は、YYYY-MM-DD形式の日付です。
カンマ区切りで複数書くこともできます。

にアクセスして、レスポンスを整形したものが以下です。

{ "2013-05-21": { "menu": "もこみち流　ペンネのミネストローネ", "url": "http://www.ntv.co.jp/zip/mokomichi/397800.html", "olive": "大２", "thumb": "http://pastak.cosmio.net/mocoDB/oliveAPI/img/thumb_800.jpg" } }

レスポンスは、上記の形式で得られます。

コードの説明

先ほどの Google Suggest にならって作ったコードがこちらです。

<?php

 require_once('workflows.php'); $wf = new Workflows(); $in = "{query}"; define("REQUEST_URL", "http://pastak.cosmio.net/mocoDB/oliveAPI/getJson.php"); // YYYY/MM/DD形式の場合パラメータを変換 $in = str_replace("/", "-", $in); $url = REQUEST_URL."?date=".$in; $json = json_decode($wf->request($url)); // エラーがある場合 if ( $json->error ) { $wf->result(time(), ", $json->error, ", 'icon.png'); // 正常に取得ができた場合 } else { foreach($json as $menu => $info) { $title = $menu.": ".$info->olive."オリーブ"; $wf->result(time(), $info->url, $title, $info->menu, 'icon.png'); } } echo $wf->toXML();