huginn_state_code_agent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70b1cc96a4c69a948feda15ec9e0cd9db959254b4c8191d0b9594297ebd29f43
+  data.tar.gz: a2d9440fd82d48f7b6d79b56280ffed66ff699c0cce9b38c271fb0214280e6bf
+SHA512:
+  metadata.gz: f2f346e3a05041a3a5ff422008aae0129bf04b900291f8009656e18974f5152a7d13819f466a711af9d21f2f4d46c488143f3f6b72fcdec2b290924a75331d3e
+  data.tar.gz: e61d7e9ce25a610275dc3084661c9a53a86d69d95015b38d203f6b45aa75e1750e1c7d8bbcd998066dabb3140c2ab96b8214b493590d83c24a1d72227fcd54d1

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2020 Jacob Spizziri
+
+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_state_code_agent/state_code_agent.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Agents
+    class StateCodeAgent < Agent
+        include Carmen
+
+        default_schedule '12h'
+
+        can_dry_run!
+        default_schedule 'never'
+
+        description <<-MD
+        This is a lightweight agent for deriving the abbreviation for a state/province
+        given a country name and a region name. The logic of this agent is backed by Carmen
+
+        ## Agent Options
+        The following outlines the available options in this agent
+
+        * `output_mode`  - not required ('clean' or 'merge', defaults to 'clean')
+        * `country` - The name of the country
+        * `region` - The name of the region
+
+
+        ## Event Status
+
+        ### 200 (Success)
+
+        `status: 200` indicates a true success. In this case, Carmen was able to
+        return a valid abbreviation with the data provided:
+
+        ```
+        {
+          status: 200,
+          derived_state_code: 'IL',
+          { ... }
+        }
+        ```
+
+        ### 404 (Not Found)
+
+        `status: 404` indicates a potential failure. In this case, Carmen was
+        unable to find an abreviation given the data provided.
+
+        In this scenario, the agent will return the original `region` value as the
+        `derived_state_code` for convenience. It is up to the end user to decide
+        if this result should be handled as an error:
+
+        ```
+        {
+          status: 404,
+          derived_state_code: 'Illinois';
+          { ... }
+        }
+        ```
+
+        ### 500 (Error)
+
+        `status: 500` indicates a true error. In this case, something has gone
+        wrong in the agent's process and we were unable to return a useful result:
+
+        ```
+        {
+          status: 500,
+          message: 'Failed to derive a state code with the data provided',
+          data: { country: 'United States', region: 'Illinois' },
+        }
+        ```
+
+        MD
+
+        def default_options
+            {
+                'country' => '',
+                'region' => '',
+                'output_mode' => 'clean',
+            }
+        end
+
+        def validate_options
+            unless options['country'].present?
+                errors.add(:base, 'country is a required field')
+            end
+
+            unless options['region'].present?
+                errors.add(:base, 'region is a required field')
+            end
+
+            if options['output_mode'].present? && !options['output_mode'].to_s.include?('{') && !%[clean merge].include?(options['output_mode'].to_s)
+              errors.add(:base, "if provided, output_mode must be 'clean' or 'merge'")
+            end
+
+        end
+
+        def working?
+            received_event_without_error?
+        end
+
+        def check
+            handle interpolated(event.payload)['payload'].presence || {}
+        end
+
+        def receive(incoming_events)
+            incoming_events.each do |event|
+                handle(event)
+            end
+       end
+
+        private
+
+        def handle(event)
+          log('------------------------------')
+              log(interpolated(event.payload))
+          log('------------------------------')
+            # Process agent options
+            new_event = interpolated(event.payload)['output_mode'].to_s == 'merge' ? event.payload : {}
+
+            begin
+                country = Country.named(interpolated(event.payload)['country'])
+                region = country.nil? ? nil : country.subregions.named(interpolated(event.payload)['region'])
+
+                status = region.nil? ? 404 : 200
+                state_code = region.nil? ? interpolated(event.payload)['region'] : region.code
+
+                create_event payload: new_event.merge(
+                  status: status,
+                  derived_state_code: state_code,
+                )
+
+            rescue e
+              create_event payload: new_event.merge(
+                status: 500,
+                message: e.message,
+                data: { country: country, region: interpolated(event.payload)['region'] },
+              )
+            end
+        end
+
+    end
+end

data/lib/huginn_state_code_agent.rb

@@ -0,0 +1,3 @@
+require 'huginn_agent'
+
+HuginnAgent.register 'huginn_state_code_agent/state_code_agent'

data/spec/state_code_agent_spec.rb

@@ -0,0 +1,15 @@
+require 'rails_helper'
+require 'huginn_agent/spec_helper'
+
+spec_folder = File.expand_path(File.dirname(__FILE__))
+
+
+
+describe Agents::StateCodeAgent do
+  before(:each) do
+    @valid_options = Agents::StateCodeAgent.new.default_options
+    @checker = Agents::StateCodeAgent.new(:name => "StateCodeAgent", :options => @valid_options)
+    @checker.user = users(:bob)
+    @checker.save!
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: huginn_state_code_agent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- 5 Stones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-09-27 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A light weight agent that leverages the Carmen gem to derive a state
+  code given the name of a country and region.
+email:
+- it@weare5stones.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/huginn_state_code_agent.rb
+- lib/huginn_state_code_agent/state_code_agent.rb
+- spec/state_code_agent_spec.rb
+homepage: https://github.com/5-stones/huginn_state_code_agent
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Agent that derives a state code from a country & region name using Carmen.
+test_files:
+- spec/state_code_agent_spec.rb