fluent-plugin-everysense 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 662ac79c0cd9386365f14c66e536661f1b373ffc
-  data.tar.gz: 1a7d012016819e509d6a4a90fc303be3ec85e3d5
+  metadata.gz: eaba80f1227fbc540073342d36982663872274a0
+  data.tar.gz: 986c0cc8303e9fa35bec5ac632f61d594bdb9810
 SHA512:
-  metadata.gz: bfbf5110f932e922e9b51220f121091bf3794801122d445260840687f4769570987f560789fc3aed2dcf09f9c17ab3ab4f2389d3898763115435f1ae6d9f04e9
-  data.tar.gz: cb02c84c32f87d5f3d06bdf6102017b9753a15bc06274bfe7fcb0d22cdaac4114623d56621431b147b0c7ef7102ba5497fd6f7010b34faeeb28ec581089bf9f1
+  metadata.gz: 778e010bfb2b9bb86988e8bfd53c1f7c888c4284f84e25507735ed4557302e3ea4aa2acc03356b89cc497820e0d204937f979e8e3a036a5570c7f785a50771ff
+  data.tar.gz: dcf47c0851d377bb9fee2e7c200d1f9498676cf3c301a5f2dc0d929ac3b703bbb1251f521f1df2a9beb19b21ca6cddc74bc63dbe19bbc796dc544233c9b97a03

data/fluent-plugin-everysense.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-everysense"
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["Toyokazu Akiyama"]
   spec.email         = ["toyokazu@gmail.com"]
 
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/toyokazu/fluent-plugin-everysense"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.gsub(/images\/[\w\.]+\n/, "").split($/)
+  spec.files         = `git ls-files`.gsub(/.+images\/[\w\.-]+\n/, "").split($/)
   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"]

data/tutorial/ja/json_over_http_api_tutorial.md

@@ -1,16 +1,19 @@
 # Ruby を使って EverySense の API で遊んでみよう！
 
-Ruby のインタラクティブシェル irb あるいは pry などを利用して EverySense の API で遊んでみましょう。遊ぶ前にまず EverySense 基礎用語を抑えておきましょう。
+Ruby のインタラクティブシェル irb あるいは pry などを利用して EverySense の API で遊んでみましょう。遊ぶ前にまず EverySense 基礎用語をおさえておきましょう。
 
 ## EverySense 基礎用語
 
 https://service.every-sense.com で遊ぶためには最低限以下の用語を抑えておく必要があります。
 
-- **ファームオーナー**: EverySenseにアップロードするデータを持っている人。デバイスのクラスを使って自分のデバイスを登録できます。デバイスを登録すると **デバイスのUUID** を取得できます。
+- **ファームオーナー**: EverySenseにアップロードするデータを持っている人。デバイスのクラスを使って自分のデバイスを **ファーム** に登録できます。デバイスを登録すると **デバイスのUUID** を取得できます。
 - **レストランオーナー**: EverySenseからデータをダウンロードして活用する人。自分が欲しいデータの条件を **レシピ** として登録し、**レシピのUUID** を取得します。**レシピ** は検索条件で指定した **ファームオーナー** に送ることができます。検索条件はファームオーナーのキーワードから指定できます。
 - **デバイスベンダー**: デバイスの開発元やデバイスにとっても詳しいデバイス所有者。デバイスのクラスを定義する権限をもちます。
 - **レシピ**: **レストランオーナー** から **ファームオーナー** に送られる欲しいデータの条件。**レストランオーナー** は送られてきたレシピに対してデータを送信しても良いかどうか承認処理を行います。承認されたレシピでは承認した **ファームオーナー** のデバイス or ファーム (?)に送られたデータを取得することができます。
 - **デバイスのクラス**: スマートフォンのようにデバイスには複数のセンサが搭載されていると想定されています。デバイスにどのような精度のセンサが搭載されているのか、例えば製品ごとに事前にクラスとして登録しておくことができます。**ファームオーナー** は保持しているデバイスに対応するクラスを選択して、EverySenseに登録することになります。
+- **デバイスとセンサ**: **デバイスのクラス** を定義する際には、デバイスに接続された **センサ** を登録する必要があります。１つのデバイスに対して複数の **センサ** が取り付けられることが想定されています。**センサ** は無線接続されたものも含むため、センサごとに設置箇所を登録できます。登録時に指定した **センサ** の名称はデータアップロード時に利用するのでメモしておきましょう。
+
+![EverySense基礎用語の概説図](https://github.com/toyokazu/fluent-plugin-everysense/tree/master/tutorial/ja/images/every-sense-overview.png "EverySense基礎用語の概説図]")
 
 ## アカウントの登録
 
@@ -53,29 +56,44 @@ irb(main):013:0* session_res.code
 irb(main):014:0> session_res.message
 => "OK"
 irb(main):015:0> session_res.body
-=> "{\"code\":0,\"session_key\":\"YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYYY\"}"
+=> "{\"code\":0,\"session_key\":\"SSSSSSSS-SSSS-SSSS-SSSS-SSSSSSSSSSSS\"}"
 ```
 
-ここで取得したsession_keyは、デバイスのAPI（/device_data）およびレシピのAPI（/recipe_data）を読み出す際に必要となります。デバイスのAPI (/device_data)は自分自身が登録したデバイスの情報を EverySense のプラットフォームを経由して取得したい場合に利用します。一方、レシピのAPI (/recipe_data) は、ファームオーナーに送ったレシピのうち、承認されたレシピからデータを取得したい場合に利用します。@session_keyに格納しておきましょう。
+ここで取得したsession_keyは、デバイスのAPI（/device_data）およびレシピのAPI（/recipe_data）を読み出す際に必要となります。デバイスのAPI (/device_data)は自分自身が登録したデバイスの情報を EverySense のプラットフォームを経由して取得したい場合に利用します。一方、レシピのAPI (/recipe_data) は、ファームオーナーに送ったレシピのうち、承認されたレシピからデータを取得したい場合に利用します。`@session_key`に格納しておきましょう。
 
 ```ruby
 @session_key = JSON.parse(session_res.body)["session_key"]
 ```
 
-このあと、ここで作成した @uri, @https, @session_key を使ってデバイスやレシピにアクセスしていきます。
+このあと、ここで作成した `@uri`, `@https`, `@session_key` を使ってデバイスやレシピにアクセスしていきます。
+
+もし、上記の`@https`で接続がうまくいかなかった場合は、本番環境では使えませんが、以下の`@http`で試してみてください。変更点は、`use_ssl`を`true`にしていないこと、APIのURIが7001番ポートになっていることです。こちらを使う場合は、以降のコードで`@https`を`@http`に置き換えてください。
 
+```ruby
+require 'uri'
+require 'net/http'
+require 'json'
+require 'time'
+
+@uri = URI.parse('http://api.every-sense.com:7001/')
+@http = Net::HTTP.new(@uri.host, @uri.port)
+session_req = Net::HTTP::Post.new(@uri + '/session')
+session_req.body = {login_name: 'your_name', password: 'your_password'}.to_json
+session_req.content_type = 'application/json'
+session_res = @http.request(session_req)
+```
 
 ### デバイスのデータのアップロードとダウンロード
 
-次にデバイスのデータのアップロード、ダウンロードについて試してみるため、テスト用のデバイス Test_Device を登録してください。デバイスの登録は以下から行えます。
+次にデバイスのデータのアップロード、ダウンロードについて試してみるため、テスト用のデバイスを登録してください。以下では仮に TestDevice という名称でデバイスを登録するものとして記述します。なお、デバイスの登録は以下から行えます。
 
 https://service.every-sense.com/ja/devices
 
-デバイスクラスとしてTest_Deviceを選択し、「追加」します。
-登録できると、UUIDが表示されます。下記の "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" の部分を表示されたUUIDに置き換えて @device_id に保存し、以降続けていきましょう。
+デバイス登録時には、登録されているデバイスのクラスから登録するデバイスの種類を選択します。としてTestDeviceを選択し、「追加」します。
+登録できると、UUIDが表示されます。下記の `"DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD"` の部分を表示されたUUIDに置き換えて `@device_id` に保存し、以降続けていきましょう。
 
 ```ruby
-@device_id = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
+@device_id = "DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD"
 ```
 
 デバイスのデータのアップロード、ダウンロードをする際にUUIDが必要になります。
@@ -84,23 +102,72 @@ https://service.every-sense.com/ja/devices
 
 まずはアップロードから試してみましょう。なんと、アップロードには認証は不要です。ということは、デバイスのUUIDを知っている人は誰でもアップロードできてしまうということですね。皆さんUUIDの取り扱いには注意しましょう。
 
-以下のようにURIにデバイスのUUIDを指定して、アップロードしたいデータをPOSTします。ここでは content_type に 'application/json' を指定して、JSON形式のデータをアップロードしてみます。
+以下のようにURIにデバイスのUUIDを指定して、アップロードしたいデータをPOSTします。ここでは `content_type` に `'application/json'` を指定して、JSON形式のデータをアップロードしてみます。
+
+ここでデバイスには複数のセンサが接続できるので、デバイス登録時に指定したデバイスクラスに指定されたセンサの数だけデータをアップロードできます。ただし、指定されたセンサ数よりも少ない数のデータだけアップロードすることもできます。
+
+アップロードするデータの形式はJSON形式です。センサが１つの場合のサンプル（気温センサの例）を以下に示します。
+
+```
+{
+  "data": {
+    "at":"2016-04-14 17:15:00 +0900",
+    "unit":"degree Celsius",
+    "value":23
+  },
+  "sensor_name":"FESTIVAL_Test1_Sensor"
+}
+```
+
+`"unit"`はデフォルト値が設定されているため、省略できます。また、`"sensor_name"`はデバイスクラスで定義したセンサの名称です。
+
+センサが複数の場合は、Arrayで複数のデータを並べる形になります。センサが２つの場合のサンプル（気温センサ、湿度センサの例、データ部分のみ）を示します。
+
+```
+[
+  {
+    "data": {
+      "at": "2016-04-14 17:21:31 +0900",
+      "unit": "degree Celsius",
+      "value": 23
+    },
+    "sensor_name":"FESTIVAL_Test1_Sensor"
+  },
+  {
+    "data": {
+      "at": "2016-04-14 17:21:31 +0900",
+      "unit": "%RH",
+      "value": 30
+    },
+    "sensor_name": "FESTIVAL_Test1_Sensor2"
+  }
+]
+```
+
+以下単一センサの場合のアップロードの例を示します。
 
 ```ruby
 upload_req = Net::HTTP::Post.new(@uri + "/device_data/#{@device_id}")
-upload_req.body = {test_data: {data1: "hoge", data2: 123}}.to_json
+upload_req.body = {"data" => {"at" => Time.now.to_s, "unit" => "degree Celsius", "value" => 23}, "sensor_name" => "FESTIVAL_Test1_Sensor"}.to_json
 upload_req.content_type = 'application/json'
 upload_res = @https.request(upload_req)
 upload_res.body
 ```
 
-最後の応答に以下のように 'code: 0' が返されていればアップロード成功です。
+最後の応答に以下のように `'code: 0'` が返されていればアップロード成功です。
 
 ```
 irb(main):023:0> upload_res.body
 => "{\"code\":0}"
 ```
 
+以下に複数センサの場合の例（HTTPリクエストbody部分のみ）を示します。
+
+```ruby
+upload_req.body = [{"data" => {"at" => Time.now.to_s, "unit" => "degree Celsius", "value" => 23}, "sensor_name" => "FESTIVAL_Test1_Sensor"}, {"data" => {"at" => Time.now.to_s, "unit" => "%RH", "value" => 30}, "sensor_name" => "FESTIVAL_Test1_Sensor2"}].to_json
+```
+
+
 #### デバイスのデータのダウンロード
 
 データの取得にはログインID (UUID) + パスワードあるいは、session_keyが要求されます。以下では session_key を利用しています。
@@ -111,7 +178,7 @@ device_data_res.body
 ```
 
 しばらくはキャッシュされているので、getすると同じデータがダウンロードされます。そのため、
-実際には from, to でデータが登録された期間を指定して必要なデータをすることになります。
+実際には `from`, `to` でデータが登録された期間を指定して必要なデータをすることになります。
 
 ```ruby
 @from = (Time.now.utc - 86400).iso8601 # 1日前から 例) "2016-03-11T03:57:23Z"
@@ -124,16 +191,12 @@ device_data_res.body
 
 ```
 [50] pry(main)> device_data_res.body
-=> "[{\"test_data\":{\"data1\":\"hoge\",\"data2\":123}},{\"test_data\":{\"data1\":\"hoge\",\"data2\":123}},{\"test_data\":{\"data1\":\"hoge\",\"data2\":123}},{\"test_data\":{\"data1\":\"hoge\",\"data2\":123}},{\"test_data\":{\"data1\":\"hoge\",\"data2\":123}}]"
+=>  "[{\"test_data\":{\"data1\":\"hoge\",\"data2\":123}},{\"data\":{\"at\":\"2016-04-14 17:33:59 +0900\",\"unit\":\"degree Celsius\",\"value\":23},\"sensor_name\":\"FESTIVAL_Test1_Sensor\"},{\"data\":{\"at\":\"2016-04-14 17:34:05 +0900\",\"unit\":\"degree Celsius\",\"value\":23},\"sensor_name\":\"FESTIVAL_Test1_Sensor\"},{\"data\":{\"at\":\"2016-04-14 17:34:32 +0900\",\"unit\":\"degree Celsius\",\"value\":23},\"sensor_name\":\"FESTIVAL_Test1_Sensor\"},{\"data\":{\"at\":\"2016-04-14 17:34:35 +0900\",\"unit\":\"degree Celsius\",\"value\":23},\"sensor_name\":\"FESTIVAL_Test1_Sensor\"}]"
 [51] pry(main)> JSON.parse(device_data_res.body)
-=> [{"test_data"=>{"data1"=>"hoge", "data2"=>123}},
- {"test_data"=>{"data1"=>"hoge", "data2"=>123}},
- {"test_data"=>{"data1"=>"hoge", "data2"=>123}},
- {"test_data"=>{"data1"=>"hoge", "data2"=>123}},
- {"test_data"=>{"data1"=>"hoge", "data2"=>123}}]
+=> [{"test_data":{"data1":"hoge","data2":123}},{"data":{"at":"2016-04-14 17:33:59 +0900","unit":"degree Celsius","value":23},"sensor_name":"FESTIVAL_Test1_Sensor"},{"data":{"at":"2016-04-14 17:34:05 +0900","unit":"degree Celsius","value":23},"sensor_name":"FESTIVAL_Test1_Sensor"},{"data":{"at":"2016-04-14 17:34:32 +0900","unit":"degree Celsius","value":23},"sensor_name":"FESTIVAL_Test1_Sensor"},{"data":{"at":"2016-04-14 17:34:35 +0900","unit":"degree Celsius","value":23},"sensor_name":"FESTIVAL_Test1_Sensor"}]
 ```
 
-データが含まれない場合は空の配列が返されます。from, to の時刻はUTCで指定してください。 @from を適当に変えて、先ほどアップロードしたデータが表示される場合と表示されない場合をそれぞれ確認してみてください。
+データが含まれない場合は空の配列が返されます。`from`, `to` の時刻はUTCで指定してください。 `@from` を適当に変えて、先ほどアップロードしたデータが表示される場合と表示されない場合をそれぞれ確認してみてください。
 
 
 ### レシピからのデータのダウンロード
@@ -144,7 +207,7 @@ https://service.every-sense.com/
 
 レストランオーナーに切り替えると、トップ画面に「レシピを作成」というメニューが表示されます。このメニューからレシピを作成してください。
 
-レシピの作成が完了するとレシピのUUIDが表示されます。以降ではこのUUIDを @recipe_id に保存して利用します。また、ダウンロードする際のデータ形式として @format に 'json' を指定しておきましょう。
+レシピの作成が完了するとレシピのUUIDが表示されます。以降ではこのUUIDを `@recipe_id` に保存して利用します。また、ダウンロードする際のデータ形式として `@format` に `'json'` を指定しておきましょう。
 
 ```ruby
 @recipe_id = "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ"
@@ -158,8 +221,12 @@ https://service.every-sense.com/
 ```ruby
 recipe_data_res = @https.get(@uri + "/recipe_data/#{@recipe_id}.#{@format}?session_key=#{@session_key}&from=#{@from}&to=#{@to}")
 recipe_data_res.body
+=> "[[{\"farm_uuid\":\"FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF\",\"sensor_name\":\"collection_data_1\",\"data_class_name\":\"AirTemperature\",\"data\":{\"at\":\"2016-04-13 07:26:12 UTC\",\"memo\":null,\"value\":23.0,\"unit\":\"degree Celsius\"}}],[{\"farm_uuid\":\"FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF\",\"sensor_name\":\"collection_data_1\",\"data_class_name\":\"AirTemperature\",\"data\":{\"at\":\"2016-04-13 07:27:48 UTC\",\"memo\":null,\"value\":23.0,\"unit\":\"degree Celsius\"}}],[{\"farm_uuid\":\"FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF\",\"sensor_name\":\"collection_data_1\",\"data_class_name\":\"AirTemperature\",\"data\":{\"at\":\"2016-04-13 07:30:06 UTC\",\"memo\":null,\"value\":23.0,\"unit\":\"degree Celsius\"}}],[{\"farm_uuid\":\"FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF\",\"sensor_name\":\"collection_data_1\",\"data_class_name\":\"AirTemperature\",\"data\":{\"at\":\"2016-04-14 08:33:59 UTC\",\"memo\":null,\"value\":23.0,\"unit\":\"degree Celsius\"}}]]"
 ```
 
+取得したデータ中の `"FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF"` はファームのUUIDを示しています。
+
+
 ### session_keyの無効化について
 
 device_dataにはlogin_name、passwordでもアクセスできますが、毎回提示すると login_name、passwordが奪われる可能性が高くなるため、今回代わりにsession_keyを用いてアクセスしました。ただし、session_keyが他人に奪われるとsession_keyが有効な期間不正にアクセスされる可能性があるため、利用が終わったらsession_keyを無効化するようにしましょう。以下の手順でsession_keyを無効化できます。
@@ -170,7 +237,7 @@ del_session_res = @https.request(del_session_req)
 del_session_res.body
 ```
 
-以下のように 'code: 0' が返されていれば削除成功です。
+以下のように `'code: 0'` が返されていれば削除成功です。
 
 ```
 irb(main):037:0> del_session_res.body

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-everysense
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Toyokazu Akiyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd