huginn_sqlite3_agent 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2951a871135a650ed36aab2ab6e24c51aac90f6b432b2806eb8b975efb8c291
+  data.tar.gz: e94d85208b6e984946a8d5433669a1d9abc11e6c625406b9a681629c117e9f28
+SHA512:
+  metadata.gz: 0e87cc0841b5756b8ca985287649b657bb39329c9276ad3432cd2fe3b6a2a6f8b9b7429202da668aa8a0b7d7c32b25941d70925601f20aeadfd4d586d9f373f5
+  data.tar.gz: fec988e750e7c99278864532d5dec0e4c3cbda606248d21e9dcd694867ffe4dd748b55bbf0a9966f38eabeec97769872b9abc68c564f5b100a08dc445af9d5a8

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2021 Steve Gattuso
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/huginn_sqlite3_agent.rb

@@ -0,0 +1,3 @@
+require 'huginn_agent'
+
+HuginnAgent.register 'huginn_sqlite3_agent/sqlite3_write_agent'

data/lib/huginn_sqlite3_agent/sqlite3_agent.rb

@@ -0,0 +1,68 @@
+require 'sqlite3'
+
+module Agents
+  class Sqlite3WriteAgent < Agent
+    include FormConfigurable
+
+    cannot_be_scheduled!
+
+    description <<-MD
+      This agent allows data to be written to a SQLite3 database. You can use
+      this as a means to pass data into a format that is perhaps a more durable
+      than Huginn's internal database + be a bit more queryable than the
+      `events` table. Generally you'll want to use this in combination with a
+      Javascript agent, which will allow you to intake arbitrary events and
+      properly format them into the event schema expected by this agent.
+
+      Note that the agent expects the sqlite3 database at `database_path` to
+      already exist. You are responsible for setting up this db file and its
+      tables yourself.
+
+      ## Writing Data
+      This agent accepts events in the following format:
+      
+          {
+            "query": "INSERT INTO some_table (col1, col2) VALUES(?, ?)",
+            "parameters": ["abc", 123]
+          }
+
+      Regardless of the result, the agent will _not_ transmit any outgoing
+      events. It will, however, log whether or not the query was successful.
+    MD
+
+    form_configurable :database_path, type: :string
+    def validate_options
+      if options['database_path'].blank?
+        errors.add(:database_path, 'cannot be blank')
+      elsif !File.file?(options['database_path'])
+        errors.add(:database_path, 'does not exist')
+      end
+    end
+
+    def default_options
+      {
+        'database_path' => '/path/to/some/sqlite3.db',
+      }
+    end
+
+    def working?
+      if memory['last_success'].nil?
+        true
+      else
+        memory['last_success']
+      end
+    end
+
+    def receive(incoming_events)
+      memory['last_success'] = false
+
+      db = SQLite3::Database.new options['database_path']
+      incoming_events.each do |event|
+        db.execute event.payload['query'], event.payload['parameters']
+        log("Executed query '#{event.payload['query']}' with params: #{event.payload['parameters']}")
+      end
+
+      memory['last_success'] = true
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: huginn_sqlite3_agent
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Steve Gattuso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: A huginn agent for writing data to SQLite3 databases
+email:
+- steve@stevegattuso.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_sqlite3_agent.rb
+- lib/huginn_sqlite3_agent/sqlite3_agent.rb
+homepage: https://github.com/stevenleeg/huginn_sqlite3_agent
+licenses:
+- MIT
+metadata: {}
+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.1.2
+signing_key: 
+specification_version: 4
+summary: A huginn agent for writing data to SQLite3 databases
+test_files: []