fluent-plugin-everysense 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c77e04a5016b57e7dc362cfcad0fbb920cce6807
-  data.tar.gz: f98ffde7cf600e3653b1ede752fa854623684b55
+  metadata.gz: 71732bc5a744276424c6081b7aa3c5b0c0ac9a80
+  data.tar.gz: e0a0cf71e1db33a9556b28b67861cd85ccb5d098
 SHA512:
-  metadata.gz: 80d75ae58e2500dab081e641606738e0f966ee0b2fc4a0b65525a96c27ce2db2656b0b8208d5308fc08c9653c7c381f966a2f436f845840e65ef697a13d99c66
-  data.tar.gz: 3028ecae8d2185213aebffebb2d628deda3bc61f2a5dadef59c02181859b9109d10351980185d0478e0436ce7dd510e9cfacec4851681cb7b1ce635e50f1a565
+  metadata.gz: 0b2280bab8f9d46c6ce0f76ce449df84d4bba414897a4a83e15da9137d1254252d9234356bbd51d99db8c86c188eaada473f21dddcba499c896c3168009964c8
+  data.tar.gz: 079d63d4938f6c8c28f53db240c11accaa20d18cf207205ec02921b142c5a6281f7d3aaf8fa2be6615f9d9a7ea5f94855f9a7097512c590db6715b2fe4d4bdd8

data/README.md

@@ -22,7 +22,7 @@ fluent-plugin-everysense has Input and Output Plugins for EverySense platform.
 
 ### Input Plugin (Fluent::EverySenseInput)
 
-Input Plugin can be used via source directive in the configuration.
+Input Plugin can receive events from EverySense Server. It can be used via source directive in the configuration.
 
 ```
 <source>
@@ -49,19 +49,20 @@ Since each device may have multiple sensors, time field is generated when Input
 ```
 {"json":
   [
-    {"data": {
+    { "data": {
         "at": "2016-05-15 12:14:30 +0900",
         "unit":"degree Celsius",
         "value":23
       },
-     "sensor_name":"collection_data_1"
+      "sensor_name":"collection_data_1"
     },
-    {"data": {
+    { "data": {
         "at":"2016-05-15 12:14:30 +0900",
         "unit":"%RH",
         "value":30
       },
-     "sensor_name":"collection_data_2"}
+      "sensor_name":"collection_data_2"
+    }
   ]
 }
 ```
@@ -70,7 +71,7 @@ While fluentd record must be a map (Hash), the output of EverySense becomes an a
 
 ### Output Plugin (Fluent::EverySenseOutput)
 
-Output Plugin can be used via match directive. Output Plugin assumes the input format as described above.
+Output Plugin can send events to EverySense server. It can be used via match directive. Output Plugin assumes the input format as described above.
 
 ```
 <match tag_name>
@@ -103,6 +104,63 @@ Output Plugin can be used via match directive. Output Plugin assumes the input f
   - **output_name**: sensor_name of the output sensor data.
   - **type_of_value**: type of value (default: Integer)
 
+## Filter Plugin (Fluent::EverySenseFilter)
+
+Filter Plugin can split an EverySense Server event into multiple fluentd events if it has multiple data. It can be used via filter directive.
+
+```
+<filter tag_name>
+  @type everysense
+</filter>
+```
+
+The following input data from EverySense Server will be splitted into multiple fluentd events.
+
+```
+{"json":
+  [
+    { "farm_uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
+      "sensor_name":"collection_data_1",
+      "data_class_name":"Illuminance",
+      "data": {
+        "at":"2016-08-24 00:15:00 UTC",
+        "value":137.0,
+        "unit":"lx"
+      }
+    },
+    { "farm_uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
+      "sensor_name":"collection_data_2",
+      "data_class_name":"Location",
+      "data": {
+        "at":"2016-08-24 00:15:00 UTC",
+        "values":[138.442062,35.8162422,671.599975],
+        "unit":"degree"
+      }
+    }
+  ]
+}
+```
+
+```
+{ "farm_uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
+  "sensor_name":"collection_data_1",
+  "data_class_name":"Illuminance",
+  "data": {
+    "at":"2016-08-24 00:15:00 UTC",
+    "value":137.0,
+    "unit":"lx"
+  }
+},
+{ "farm_uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
+  "sensor_name":"collection_data_2",
+  "data_class_name":"Location",
+  "data": {
+    "at":"2016-08-24 00:15:00 UTC",
+    "values":[138.442062,35.8162422,671.599975],
+    "unit":"degree"
+  }
+}
+```
 
 ## Contributing
 

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.5"
+  spec.version       = "0.0.6"
   spec.authors       = ["Toyokazu Akiyama"]
   spec.email         = ["toyokazu@gmail.com"]
 
@@ -18,9 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.1.0'
 
-  spec.add_dependency 'fluentd', '>= 0.10.0'
+  spec.add_dependency 'fluentd', '~> 0.12.0'
+  #spec.add_dependency 'fluentd', '>= 0.10.0'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/fluent/plugin/filter_everysense.rb

@@ -0,0 +1,27 @@
+module Fluent
+  # EverySenseFilter
+  # Split EverySense data into multiple output entries
+  # to store each datum separately
+  class EverySenseFilter < Filter
+    Plugin.register_filter('everysense', self)
+
+    def filter_stream(tag, es)
+      new_es = MultiEventStream.new
+      es.each do |time, record|
+        # puts "filter_everysense: #{record}"
+        split(time, record, new_es)
+      end
+      new_es
+    end
+
+    private
+
+    def split(time, record, new_es)
+      if record[:json].instance_of?(Array)
+        record[:json].each { |r| new_es.add(time, r) }
+      else
+        new_es.add(time, record)
+      end
+    end
+  end
+end

data/lib/fluent/plugin/in_everysense.rb

@@ -66,7 +66,7 @@ module Fluent
     end
 
     desc 'Tag name assigned to inputs'
-    config_param :tag, :string, :default => nil # TODO: mandatory option
+    config_param :tag, :string, :default => 'everysense'
     desc 'Polling interval to get message from EverySense API'
     config_param :polling_interval, :integer, :default => 60
     desc 'Device ID'
@@ -91,7 +91,7 @@ module Fluent
     end
 
     def start
-      raise StandardError.new if @tag.nil?
+      #raise StandardError.new if @tag.nil?
       super
       start_proxy
       @proxy_thread = Thread.new do

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-everysense
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Toyokazu Akiyama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-15 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,7 @@ files:
 - Rakefile
 - fluent-plugin-everysense.gemspec
 - lib/fluent/plugin/everysense_proxy.rb
+- lib/fluent/plugin/filter_everysense.rb
 - lib/fluent/plugin/in_everysense.rb
 - lib/fluent/plugin/out_everysense.rb
 - tutorial/ja/json_over_http_api_tutorial.md
@@ -81,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="