logstash-filter-mautic 0.1

data/logstash-filter-mautic.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-filter-mautic'
+  s.version         = '0.1'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "Receives Mautic webhook data to view in Elasticsearch"
+  s.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"
+  s.authors = ["Zac Petterd"]
+  s.email = 'zac@sproutlabs.com.au'
+  s.homepage = "https://github.com/zapur1/logstash-filter-mautic"
+  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" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0", "< 3.0.0"
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/emails_spec.rb

@@ -0,0 +1,139 @@
+require 'logstash/devutils/rspec/spec_helper'
+require "logstash/filters/mautic"
+
+RUBY_ENGINE == "jruby" and describe LogStash::Filters::Mautic do
+  
+
+  describe "Check the top-level fields" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{
+  "mautic.email_on_open": {
+    "stat": {
+      "id": 8,
+      "emailAddress": "chad.windnagle@websparkinc.com",
+      "ipAddress": [],
+      "dateSent": "2015-08-26T01:34:37+00:00",
+      "isRead": true,
+      "isFailed": false,
+      "dateRead": "2015-08-26T01:35:53+00:00",
+      "retryCount": 0,
+      "source": "email",
+      "openCount": 1,
+      "lastOpened": "2015-08-26T01:35:53+00:00",
+      "sourceId": 5,
+      "trackingHash": "55dd17adace91",
+      "viewedInBrowser": false,
+      "lead": {
+        "id": 26,
+        "points": 10,
+        "color": "",
+        "fields": {}
+      },
+      "email": {
+        "id": 5,
+        "name": "Email",
+        "subject": "Email",
+        "language": "en",
+        "category": null,
+        "fromAddress": null,
+        "fromName": null,
+        "replyToAddress": null,
+        "bccAddress": null,
+        "publishUp": null,
+        "publishDown": null,
+        "readCount": 1,
+        "sentCount": 3,
+        "revision": 1,
+        "assetAttachments": [],
+        "variantStartDate": null,
+        "variantSentCount": 0,
+        "variantReadCount": 0,
+        "variantParent": null,
+        "variantChildren": []
+      }
+    }
+  },
+  "timestamp": "2015-11-11T22:44:51+11:00"
+}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include('emailopenid')
+      expect(subject).not_to include("lead")
+      expect(subject['emailopenid']).to eq(8)
+      expect(subject['leadid']).to eq(26)
+    end
+  end
+
+  describe "Check when not an array" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{
+      "mautic.email_on_open": {
+        "stat": {
+          "id": 5745,
+          "lead": {"id" : 123}
+        }
+      }
+      }'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include('emailopenid')
+      expect(subject).not_to include("lead")
+      expect(subject['emailopenid']).to eq(5745)
+      expect(subject['leadid']).to eq(123)
+    end
+  end    
+
+  describe "Check when multiple" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{
+      "mautic.email_on_open": [{
+        "stat": {
+          "id": 5745,
+          "lead": {"id" : 123}
+        }
+      },
+    {
+        "stat": {
+          "id": 128,
+          "lead": {"id" : 153}
+        }
+      }]
+      }'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject[0]).to include('emailopenid')
+      expect(subject[0]).not_to include("lead")
+      expect(subject[0]['emailopenid']).to eq(5745)
+      expect(subject[0]['leadid']).to eq(123)
+      expect(subject[1]['emailopenid']).to eq(128)
+      expect(subject[1]['leadid']).to eq(153)
+    end
+  end
+end

data/spec/filters/forms_spec.rb

@@ -0,0 +1,181 @@
+require 'logstash/devutils/rspec/spec_helper'
+require "logstash/filters/mautic"
+
+RUBY_ENGINE == "jruby" and describe LogStash::Filters::Mautic do
+  
+
+  describe "Check the top-level fields" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{
+  "mautic.form_on_submit": {
+    "submission": {
+      "id": 89,
+      "ipAddress": [],
+      "form": {
+        "id": 4,
+        "name": "lead points",
+        "alias": "leadpoints",
+        "category": null
+      },
+      "lead": {
+        "id": 26,
+        "points": 10,
+        "color": null,
+        "fields": {}
+      },
+      "trackingId": "dd4adafdabe75184bc206037a15d9f840adb5ec0",
+      "dateSubmitted": "2015-08-26T01:30:34+00:00",
+      "referer": "http://mautic-gh.com/index_dev.php/s/forms/preview/4",
+      "page": null,
+      "results": {
+        "email": "email@formsubmit.com"
+      }
+    }
+  },
+  "timestamp": "2015-11-11T22:37:31+11:00"
+}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include('submissionid')
+      expect(subject).not_to include("lead")
+      expect(subject).to include("form")
+      expect(subject['submissionid']).to eq(89)
+      expect(subject['leadid']).to eq(26)
+      expect(subject['type']).to eq("form_submission")
+      expect(subject['results']['email']).to eq ("email@formsubmit.com")
+    end
+  end  
+
+  describe "Check when not an array" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{
+  "mautic.form_on_submit": {
+    "submission": {
+      "id": 34,
+      "ipAddress": [],
+      "form": {},
+      "lead": {
+        "id": 26
+      },
+      "results": {
+        "email": "email@formsubmit.com"
+        }
+      }
+    }   
+  }'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include('submissionid')
+      expect(subject).not_to include("lead")
+      expect(subject).to include("form")
+      expect(subject['submissionid']).to eq(34)
+      expect(subject['leadid']).to eq(26)
+    end
+  end  
+
+
+  describe "Check multiple events" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{
+  "mautic.form_on_submit": [
+    {
+      "submission": {
+        "id": 893,
+        "ipAddress": {
+          "ipDetails": {
+          }
+        },
+        "form": {
+          "id": 25,
+          "name": "nhkjhjk",
+          "alias": "internalwe",
+          "category": []
+        },
+        "lead": {
+          "id": 89,
+          "points": 0,
+          "color": null,
+          "fields": {}
+        },
+        "trackingId": null,
+        "dateSubmitted": "2015-11-12T07:55:39+11:00",
+        "referer": "http://mautic.ghgjhg.com.au/s/forms/preview/25",
+        "page": null,
+        "results": {
+          "email": "example@afads.com"
+        }
+      },
+      "timestamp": "2015-11-11T20:55:42+00:00"
+    },
+    {
+      "submission": {
+        "id": 894,
+        "ipAddress": {
+          "ipDetails": {
+          }
+        },
+        "form": {
+          "id": 25,
+          "name": "jhjkhkj",
+          "alias": "kjhjk",
+          "category": []
+        },
+        "lead": {
+          "id": 897,
+          "points": 0,
+          "color": null,
+          "fields": {}
+            
+        },
+        "trackingId": null,
+        "dateSubmitted": "2015-11-12T07:55:42+11:00",
+        "referer": "http://mautic.mjhjk.com/s/forms/preview/25",
+        "page": null,
+        "results": {
+          "email": "jkhj@hgjh.com."
+        }
+      },
+      "timestamp": "2015-11-11T20:55:43+00:00"
+    }
+  ]
+}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject[0]).to include('submissionid')
+      expect(subject[0]).not_to include("lead")
+      expect(subject[0]).to include("form")
+      expect(subject[0]['submissionid']).to eq(893)
+      expect(subject[0]['leadid']).to eq(89)
+      expect(subject[0]['type']).to eq("form_submission")
+      expect(subject[1]['submissionid']).to eq(894)
+      expect(subject[1]['leadid']).to eq(897)
+    end
+  end  
+end

data/spec/filters/hit_spec.rb

@@ -0,0 +1,132 @@
+require 'logstash/devutils/rspec/spec_helper'
+require "logstash/filters/mautic"
+
+RUBY_ENGINE == "jruby" and describe LogStash::Filters::Mautic do
+  
+
+  describe "Check a basic hit" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{
+  "mautic.page_on_hit": {
+    "hit": {
+      "dateHit": "2015-08-26T01:32:39+00:00",
+      "dateLeft": null,
+      "page": {
+        "id": 1,
+        "title": "PageHit",
+        "alias": "pagehit",
+        "category": null
+      },
+      "redirect": null,
+      "email": null,
+      "lead": {
+        "id": 26,
+        "points": 10,
+        "color": null,
+        "fields": {}
+      },
+      "ipAddress": [],
+      "country": null,
+      "region": null,
+      "city": null,
+      "isp": null,
+      "organization": null,
+      "code": 200,
+      "referer": null,
+      "url": "http://mautic-gh.com/index_dev.php/pagehit",
+      "urlTitle": null,
+      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.157 Safari/537.36",
+      "remoteHost": "localhost",
+      "pageLanguage": "en",
+      "browserLanguages": [
+        "en-US",
+        "en;q=0.8"
+      ],
+      "trackingId": "833fecc93e16d37baf1530df643b6a8b10714c65",
+      "source": null,
+      "sourceId": null
+    }
+  },
+  "timestamp": "2015-11-11T22:42:59+11:00"
+}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject).to include("leadid")
+      expect(subject).not_to include("lead")
+      expect(subject).to include("url")
+      expect(subject['leadid']).to eq(26)
+      expect(subject['code']).to eq(200)
+      expect(subject['type']).to eq("page_hit")
+    end
+  end 
+
+    describe "Check multiple hits" do
+    let(:config) do <<-CONFIG
+      filter {
+        mautic {
+          source => "message"
+        }
+      }
+    CONFIG
+    end
+
+    entered_fields = '{
+  "mautic.page_on_hit": [
+    {
+      "hit": {
+        "dateHit": "2015-08-26T01:32:39+00:00",
+        "dateLeft": null,
+        "lead": {
+          "id": 26,
+          "points": 10,
+          "color": null
+        },
+        "code": 200,
+        "referer": null,
+        "url": "http://mautic-gh.com/index_dev.php/pagehit",
+        "urlTitle": null
+      }
+    },
+    {
+      "hit": {
+        "dateHit": "2015-08-26T01:32:39+00:00",
+        "dateLeft": null,
+        "lead": {
+          "id": 70,
+          "points": 10,
+          "color": null
+        },
+        "code": 400,
+        "referer": null,
+        "url": "http://mautic-gh.com/index_dev.php/pagehit",
+        "urlTitle": null
+      }
+    }
+  ]
+}'
+    #it "should contain points"
+    sample entered_fields  do
+      #insist { subject["points"] } == 25
+      expect(subject[0]).to include("leadid")
+      expect(subject[0]).to include("url")
+      expect(subject[0]['leadid']).to eq(26)
+      expect(subject[0]['code']).to eq(200)
+      expect(subject[1]['leadid']).to eq(70)
+      expect(subject[1]['code']).to eq(400)
+      expect(subject[1]['type']).to eq("page_hit")
+    end
+  end 
+
+
+        
+end
+