logstash-input-intercom 0.0.1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 232dd14453ab0a06312dde7fa09bc9e240ecba21
+  data.tar.gz: 9292b28e6cdbce588c7728fc49afb7064eb027dc
+SHA512:
+  metadata.gz: 04cd065ec0897f3d1718c0cb21996c0be34429a36e1124347dc93da9ccb963f7117c9a062ba70a983fcd8790d88d85fa4b810d7e827dd1f78ac71a3ca4848c28
+  data.tar.gz: 0ed59beed7fc3379c666a43c0b9d152b7769a8ca55b20ea1b4166fa1961ad3b9e35ace992afb5b1f917d6793c3738c19d65325b7ced29d1eaadb70d8f13a62de

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+ - Very basic implementation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logstash-input-intercom.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
+
+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,98 @@
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/cogniteev/logstash-input-intercom.svg)](https://travis-ci.org/logstash-plugins/logstash-input-intercom)
+
+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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/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
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- 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/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/intercom.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "logstash/timestamp"
+require "logstash/util"
+require "intercom"
+
+# This plugin was created as a way to ingest data from Intercom into Logstash.
+#
+# ==== Usage:
+#
+# Here is an example of setting up the plugin to fetch data from Intercom.
+#
+# [source,ruby]
+# ----------------------------------
+# input {
+#   intercom {
+#     app_id => ":appId"
+#     app_api_key => ":appApiKey"
+#   }
+# }
+# ----------------------------------
+#
+class LogStash::Inputs::Intercom < LogStash::Inputs::Base
+  config_name "intercom"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain"
+
+  # Application ID
+  config :app_id, :validate => :string
+
+  # Application API Key
+  config :app_api_key, :validate => :string
+
+  # Set if we want to synchronize events
+  config :sync_events, :validate => :boolean, :default => true
+
+  #Set if we want to synchronize users
+  config :sync_users, :validate => :boolean, :default => true
+
+  public
+
+  def register
+    configure_intercom_client
+  end # def register
+
+  def run(queue)
+    sync_all(queue)
+  end # def run
+
+  def stop
+  end
+
+  private
+
+  def configure_intercom_client
+    Intercom.app_id = @app_id
+    Intercom.app_api_key = @app_api_key
+  end
+
+  def sync_all(queue)
+    sync_users queue if @sync_users
+    sync_events queue if @sync_events
+  end
+
+  def sync_users(queue)
+    begin
+      get_users.each { |user| push_event queue, from_user(user) }
+    rescue Intercom::IntercomError => error
+      @logger.error? @logger.error("Failed to sync users", :error => error.to_s)
+    end
+  end
+
+  def sync_events(queue)
+    begin
+      get_users.each { |user| sync_events_for queue, user.id }
+    rescue Intercom::IntercomError => error
+      @logger.error? @logger.error("Failed to sync events", :error => error.to_s)
+    end
+  end
+
+  def sync_events_for(queue, intercom_user_id)
+    begin
+      get_events(intercom_user_id).each { |event| push_event queue, from_event(event) }
+    rescue Intercom::IntercomError => error
+      @logger.error? @logger.error("Failed to sync events for user", :intercom_user_id => intercom_user_id, :error => error.to_s)
+    end
+  end
+
+  def get_users
+    Intercom::User.all
+  end
+
+  def get_events(intercom_user_id)
+    Intercom::Event.find_all(:type => 'user', :intercom_user_id => intercom_user_id)
+  end
+
+  def from_user(intercom_user)
+    hash = intercom_object_to_hash intercom_user, 'user'
+    hash_to_logstash_event hash, intercom_user.created_at
+  end
+
+  def from_event(intercom_event)
+    hash = intercom_object_to_hash intercom_event, 'event'
+    hash_to_logstash_event hash, intercom_event.created_at
+  end
+
+  def hash_to_logstash_event(hash, timestamp)
+    event = LogStash::Event.new LogStash::Util.stringify_symbols(hash)
+    event.timestamp = LogStash::Timestamp.new timestamp
+    event
+  end
+
+  def intercom_object_to_hash(intercom_object, type)
+    # flatten object
+    hash = flatten_hash intercom_object.to_hash
+
+    # prefix all keys by the object type (avoid collision between fields names)
+    hash = prefix_keys hash, "#{type}_"
+
+    # adds identity
+    hash['type'] = type
+    hash['document_id'] = "#{type}_#{intercom_object.id}"
+
+    hash
+  end
+
+  def prefix_keys(hash, prefix)
+    hash.each_with_object({}) do |(k, v), h|
+      if k.start_with? prefix
+        h[k] = v
+      else
+        h["#{prefix}#{k}"] = v
+      end
+    end
+  end
+
+  def flatten_hash(hash)
+    hash.each_with_object({}) do |(k, v), h|
+      if v.respond_to? :to_hash
+        flatten_hash(v.to_hash).map do |h_k, h_v|
+          h["#{k}_#{h_k}"] = h_v
+        end
+      else
+        h[k] = v
+      end
+    end
+  end
+
+  def push_event(queue, event)
+    decorate(event)
+    queue << event
+  end
+
+end # class LogStash::Inputs::Intercom

data/logstash-input-intercom.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-input-intercom'
+  s.version         = '0.0.1'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Experimental Logstash input plugin for Intercom API."
+  s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
+  s.authors         = ["Cogniteev"]
+  s.email           = 'techteam@cogniteev.com'
+  s.homepage        = 'https://github.com/cogniteev/logstash-input-intercom'
+  s.require_paths   = ["lib"]
+  s.platform        = "java"
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE']
+
+  # 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', '~> 1.0'
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'cogniteev-intercom', '~> 2.3'
+
+end

data/spec/inputs/intercom_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/intercom"
+
+describe LogStash::Inputs::Intercom do
+
+  # TODO: write tests !
+
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-intercom
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: java
+authors:
+- Cogniteev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  name: cogniteev-intercom
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
+email: techteam@cogniteev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/intercom.rb
+- logstash-input-intercom.gemspec
+- spec/inputs/intercom_spec.rb
+homepage: https://github.com/cogniteev/logstash-input-intercom
+licenses:
+- Apache License (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: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Experimental Logstash input plugin for Intercom API.
+test_files:
+- spec/inputs/intercom_spec.rb