logstash-input-airthings 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 56f55efa19883141d45444ffe73ec75843a87daf31ada2dccd0c50b0939ec513
+  data.tar.gz: dd14c9309040acb8d395968ed2a3b430ca8de78d95630c9350a699107f40e430
+SHA512:
+  metadata.gz: 37e2832143c829773a0f846302708a1ce17f98edd208f26f93fddbceb0786146db4a94200248b617c0fbae1f34290a539fbd682a145c7d8c8ffa11c84e638696
+  data.tar.gz: b11fb6c327ae9c5fd488b3989de00d45418e61ab4c7815e44383b5653e2579362a07dbe9937d2c5efb7b44215ded8e8ba15e30b01c7d1704fecc0f7b6830219a

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Matthew Haugen - mhaugen@haugenapplications.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-airthings
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/main/CONTRIBUTING.md) file.

data/lib/logstash/inputs/airthings.rb

@@ -0,0 +1,173 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+
+# Generate a repeating message.
+#
+# This plugin is intented only as an example.
+
+class AirThingsApiConnection
+  def initialize(client_id, client_secret, logger)
+    @session = Net::HTTP.start("ext-api.airthings.com", 443, use_ssl: true)
+    
+    @logger = logger
+    @client_id = client_id
+    @client_secret = client_secret
+
+    @token_hash = {
+      expires: 0
+    }
+  end
+
+  def get_token
+    now = Time.now.to_i
+
+    expires = @token_hash[:expires]
+
+    if expires < now
+      @logger.debug("Getting new Airthings API access token")
+      
+      req = Net::HTTP::Post.new("https://accounts-api.airthings.com/v1/token")
+      req.body = JSON.generate({
+        grant_type: "client_credentials",
+        client_id: @client_id,
+        client_secret: @client_secret.value,
+        scope: [ "read:device:current_values" ]
+      })
+      req["Content-Type"] = "application/json"
+      
+      resp = @session.request(req)
+
+      resp_json = JSON.parse(resp.body)
+
+      @token_hash = {
+        expires: now + resp_json["expires_in"] - 60,
+        response: resp_json
+      }
+    end
+
+    return @token_hash[:response]["access_token"]
+  end
+
+  def send_request(method_class, path)
+    unless path.start_with?("/")
+      path = "/" + path
+    end
+    
+    req = method_class.new("https://ext-api.airthings.com" + path)
+    req["Accept"] = "application/json"
+    req["Authorization"] = "Bearer " + self.get_token
+    
+    resp = @session.request(req)
+
+    resp_json = JSON.parse(resp.body)
+
+    error = resp_json["error_description"]
+    if error
+      @logger.error("Error received from Airthings API", :error => error)
+    end
+
+    return resp_json
+  end
+
+  def get_devices
+    resp = self.send_request(Net::HTTP::Get, "/v1/devices")
+
+    return resp["devices"]
+  end
+
+  def get_latest_values(device_id)
+    resp = self.send_request(Net::HTTP::Get, "/v1/devices/#{device_id}/latest-samples")
+
+    return resp["data"]
+  end
+end
+
+class LogStash::Inputs::Airthings < LogStash::Inputs::Base
+  config_name "airthings"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain"
+
+  # The message string to use in the event.
+  config :client_id, :validate => :string
+  config :client_secret, :validate => :password
+  
+  # Set how frequently messages should be sent.
+  #
+  # The default, `1`, means send a message every second.
+  config :interval, :validate => :number, :default => 60
+
+  config :device_list_interval, :validate => :number, :default => 600
+
+  public
+  def register
+    @logger.info("Connecting to Airthings API", :client_id => @client_id)
+    @conn = AirThingsApiConnection.new(@client_id, @client_secret, @logger)
+  end # def register
+
+  def run(queue)
+    # we can abort the loop if stop? becomes true
+    reload_devices_at = 0
+    devices = []
+    time_by_device = {}
+    
+    while !stop?
+      now = Time.now.to_i
+
+      if !devices || now >= reload_devices_at
+        @logger.info("Getting devices from Airthings API")
+        devices = @conn.get_devices
+
+        unless devices
+          devices = []
+        end
+
+        reload_devices_at = now + @device_list_interval
+      end
+      
+      devices.each { |device|
+        device_id = device["id"]
+        
+        @logger.debug("Getting latest values from Airthings API", :device_id => device_id)
+        latest_values = @conn.get_latest_values(device_id)
+
+        time = latest_values.delete("time")
+
+        unless time_by_device[device_id] == time
+          time_by_device[device_id] = time
+          
+          airthings = {
+            device: {
+              id: device_id,
+              type: device["deviceType"],
+              segment: device["segment"],
+              location: device["location"]
+            },
+            time: time,
+            metrics: latest_values
+          }
+
+          event = LogStash::Event.new("airthings" => airthings)
+          decorate(event)
+          queue << event
+        end
+      }
+    
+      # because the sleep interval can be big, when shutdown happens
+      # we want to be able to abort the sleep
+      # Stud.stoppable_sleep will frequently evaluate the given block
+      # and abort the sleep(@interval) if the return value is true
+      Stud.stoppable_sleep(@interval) { stop? }
+    end # loop
+  end # def run
+
+  def stop
+    # nothing to do in this case so it is not necessary to define stop
+    # examples of common "stop" tasks:
+    #  * close sockets (unblocking blocking reads/accepts)
+    #  * cleanup temporary files
+    #  * terminate spawned threads
+  end
+end # class LogStash::Inputs::Airthings

data/logstash-input-airthings.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-input-airthings'
+  s.version       = '0.1.1'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Connect to AirThings API'
+  s.description   = 'Connect to AirThings API'
+  s.homepage      = 'https://www.haugenapplications.com'
+  s.authors       = ['Matthew Haugen']
+  s.email         = 'mhaugen@haugenapplications.com'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '>= 0.0.22'
+  s.add_development_dependency 'logstash-devutils', '>= 0.0.16'
+end

data/spec/inputs/airthings_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/airthings"
+
+describe LogStash::Inputs::Airthings do
+
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) { { "interval" => 100 } }
+  end
+
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-airthings
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matthew Haugen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+description: Connect to AirThings API
+email: mhaugen@haugenapplications.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/airthings.rb
+- logstash-input-airthings.gemspec
+- spec/inputs/airthings_spec.rb
+homepage: https://www.haugenapplications.com
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Connect to AirThings API
+test_files:
+- spec/inputs/airthings_spec.rb