logstash-filter-mautic 0.1

data/spec/filters/leads_spec.rb

@@ -0,0 +1,303 @@
+require 'logstash/devutils/rspec/spec_helper'
+require "logstash/filters/mautic"
+
+RUBY_ENGINE == "jruby" and describe LogStash::Filters::Mautic do
+  
+
+  describe "Check the id field" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{ "mautic.lead_post_save_new": [
+    {"lead": {
+        "id": 25,
+        "points": 0,
+        "dateIdentified": "2015-08-26T01:25:36.000Z"
+        }
+      }
+    ]}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include('leadid')
+      expect(subject['leadid']).to eq(25)
+      expect(subject['type']).to eq("lead")
+      expect(subject).not_to include('fields')
+
+    end
+  end  
+
+  describe "Check when no array is returned field" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{ "mautic.lead_post_save_new": 
+    {"lead": {
+        "id": 80,
+        "points": 0
+        }
+      }
+    }'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include('leadid')
+      expect(subject['leadid']).to eq(80)
+    end
+  end  
+
+    describe "Check the firstname field" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{ "mautic.lead_post_save_new": [
+    {"lead": {
+        "id": 25,
+        "points": 0,
+        "fields": {"core": { "firstname": {"value" : "New"}}}
+        }
+      }
+    ]}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include("firstname")
+      expect(subject['firstname']).to eq("New")
+    end
+  end
+
+  describe "Check the tags " do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{ "mautic.lead_post_save_new": [
+    {"lead": {
+        "id": 25,
+        "points": 0,
+        "fields": {"core": {"firstname": {"value": "test"}}},
+        "tags": ["test", "test2"]
+        }
+      }
+    ]}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include("mautic_tags")
+      expect(subject['mautic_tags'][0]).to eq("test")
+      expect(subject['mautic_tags'][1]).to eq("test2")
+      expect(subject).not_to include('fields')
+
+    end
+  end
+
+
+    describe "Check the ip addresses field" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    #entered_fields = LogStash::Fixtures::MauticFixtures.newLeadEntry
+    entered_fields = '{ "mautic.lead_post_save_new": [
+    {"lead": {
+        "id": 25,
+        "points": 0,
+        "fields": {"core": {"firstname": {"value": "test"}}},
+        "ipAddresses" : {
+          "123.14.945.113": {
+            "ipDetails": {
+              "city": "New Prague",
+              "region": "Minnesota",
+              "country": "United States",
+              "latitude": 44.8978,
+              "longitude": -93.382,
+              "isp": "",
+              "organization": "Communications Company, LLC",
+              "timezone": "America/Chicago",
+              "extra": "",
+              "offset": "-5",
+              "area_code": "0",
+              "dma_code": "0",
+              "country_code3": "USA",
+              "postal_code": "8989",
+              "continent_code": "NA",
+              "country_code": "US",
+              "region_code": "MN"
+            }
+          }, "89.14.945.55": {
+            "ipDetails": {
+              "city": "New Prague",
+              "region": "Minnesota",
+              "country": "United States",
+              "latitude": 44.8978,
+              "longitude": -93.382,
+              "isp": "",
+              "organization": "Communications Company, LLC",
+              "timezone": "America/Chicago",
+              "extra": "",
+              "offset": "-5",
+              "area_code": "0",
+              "dma_code": "0",
+              "country_code3": "USA",
+              "postal_code": "8989",
+              "continent_code": "NA",
+              "country_code": "US",
+              "region_code": "MN"
+            }
+          }
+        }
+        }
+      }
+    ]}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include("ipAddresses")
+      expect(subject['ipAddresses'][0]).to eq("123.14.945.113")
+      expect(subject['ipAddresses'][1]).to eq("89.14.945.55")
+      expect(subject).not_to include('fields')
+
+    end
+  end 
+
+  describe "Check multiple events" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{ "mautic.lead_post_save_new": [
+    {"lead": {
+        "id": 25,
+        "points": 0,
+        "fields": {"core": {"firstname": {"value": "test"}}},
+        "tags": ["test", "test2"]
+        }
+      },
+      {"lead": {
+        "id": 21,
+        "points": 10,
+        "fields": {"core": {"firstname": {"value": "test"}}},
+        "tags": ["test", "test2"]
+        }
+      }
+    ]}'
+
+    sample entered_fields  do
+      expect(subject[0]).to include('leadid')
+      expect(subject[1]).to include('leadid')
+      expect(subject[0]['leadid']).to eq(25)
+      expect(subject[1]['leadid']).to eq(21)
+      expect(subject[0]['points']).to eq(0)
+      expect(subject[1]['points']).to eq(10)
+      expect(subject[1]).not_to include('fields')
+
+    end # end sample
+  end
+
+
+    describe "Check the id field" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{ "mautic.lead_post_save_update": [
+    {"lead": {
+        "id": 25,
+        "points": 0,
+        "fields": {"core": {"firstname": {"value": "test"}}},
+
+        "dateIdentified": "2015-08-26T01:25:36.000Z"
+        }
+      }
+    ]}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include('leadid')
+      expect(subject['leadid']).to eq(25)
+      expect(subject).not_to include('fields')
+    end
+  end
+
+
+  describe "Check updated lead" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{
+  "mautic.lead_post_save_update": {
+    "lead": {
+      "id": 25,
+      "points": 0,
+      "color": "",
+      "fields": {"core": {"firstname": {"value": "test"}}},
+      "lastActive": null,
+      "owner": {
+        "id": 1,
+        "username": "drmmr763",
+        "firstName": "Chad",
+        "lastName": "Windnagle"
+      },
+      "ipAddresses": [],
+      "dateIdentified": "2015-08-26T01:25:36+00:00",
+      "preferredProfileImage": "gravatar"
+    }
+  },
+  "timestamp": "2015-11-12T10:40:19+11:00"
+}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include('leadid')
+      expect(subject).not_to include('fields')
+      expect(subject).to include('firstname')
+      expect(subject['leadid']).to eq(25)
+      expect(subject['type']).to eq("lead")
+      expect(subject['firstname']).to eq("test")
+    end
+  end          
+end

data/spec/spec_helper.rb

@@ -0,0 +1,90 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-mautic
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Zac Petterd
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This plugin lets you get the majority of you Mautic data into Elasticsearch for viewing using Kibana. Just setup a http input for logstash and a filter like so mautic { source => 'message'}. See the GitHub repository for more information
+email: zac@sproutlabs.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/filters/mautic.rb
+- logstash-filter-mautic.gemspec
+- spec/filters/emails_spec.rb
+- spec/filters/forms_spec.rb
+- spec/filters/hit_spec.rb
+- spec/filters/leads_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zapur1/logstash-filter-mautic
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+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: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Receives Mautic webhook data to view in Elasticsearch
+test_files:
+- spec/filters/emails_spec.rb
+- spec/filters/forms_spec.rb
+- spec/filters/hit_spec.rb
+- spec/filters/leads_spec.rb
+- spec/spec_helper.rb