logstash-mixin-http_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3be85aa47707c0efff5108ef847692de49ff1c2b
+  data.tar.gz: 84c250cb85d7af53eff7c3e98c68ed0583b4e4be
+SHA512:
+  metadata.gz: ad251e9bd636dda5e6f6914967a2f965d183cb5aca111428d0cc6c5e3319e3a7d1fcbb4558ec687034a44fe7aa132dab2f8442babf740252a742a83b835727a9
+  data.tar.gz: bb7c09d980bdf6dca16a3527184f679784aa6481099d9ff5ccce4f2d2a66de620636765e2222d3d8ae6a5cc3ce8b0d2358a4a12ff99876d5ae1da46ebacfed84

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+Gemfile.lock
+.bundle
+vendor
+.idea
+*~

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 1.0.0
+  * Allow to use either V1 or V2 of the `AWS-SDK` in your plugins. Fixes: https://github.com/logstash-plugins/logstash-mixin-aws/issues/8

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Andrew Cholakian (andrewvc)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 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,131 @@
+# Usage
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/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.
+
+This plugin exposes the following options:
+
+```ruby
+# Timeout (in seconds) for the entire request
+request_timeout, :validate => :number, :default => 60
+
+# Timeout (in seconds) to wait for data on the socket. Default is 10s
+config :socket_timeout, :validate => :number, :default => 10
+
+# Timeout (in seconds) to wait for a connection to be established. Default is 10s
+config :connect_timeout, :validate => :number, :default => 10
+
+# Should redirects be followed? Defaults to true
+config :follow_redirects, :validate => :boolean, :default => true
+
+# Max number of concurrent connections. Defaults to 50
+config :pool_max, :validate => :number, :default => 50
+
+# Max number of concurrent connections to a single host. Defaults to 25
+config :pool_max_per_route, :validate => :number, :default => 25
+
+# How many times should the client retry a failing URL? Default is 3
+config :automatic_retries, :validate => :number, :default => 3
+
+# If you need to use a custom X.509 CA (.pem certs) specify the path to that here
+config :ca_path, :validate => :path
+
+# If you need to use a custom keystore (.jks) specify that here
+config :truststore_path, :validate => :path
+
+# Specify the keystore password here.
+# Note, most .jks files created with keytool require a password!
+config :truststore_password, :validate => :string
+
+# Enable cookie support. With this enabled the client will persist cookies
+# across requests as a normal web browser would. Enabled by default
+config :cookies, :validate => :boolean, :default => true
+
+# If you'd like to use an HTTP proxy . This supports multiple configuration syntaxes:
+# 1. Proxy host in form: http://proxy.org:1234
+# 2. Proxy host in form: {host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
+# 3. Proxy host in form: {url =>  'http://proxy.org:1234', user => 'username@host', password => 'password'}
+config :proxy
+```
+
+## 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.elasticsearch.org/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/elasticsearch/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
+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
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- 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/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1,7 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+
+require "logstash/devutils/rake"

data/lib/logstash/plugin_mixins/http_client.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+require "logstash/config/mixin"
+
+# This module provides helper for the `AWS-SDK` v1,
+# and it will be deprecated in the near future, please use the V2 module
+# for any new development.
+module LogStash::PluginMixins::HttpClient
+  def self.included(base)
+    require 'manticore'
+    base.extend(self)
+    base.setup_http_client_config
+  end
+
+  public
+  def setup_http_client_config
+    # Timeout (in seconds) for the entire request
+    config :request_timeout, :validate => :number, :default => 60
+
+    # Timeout (in seconds) to wait for data on the socket. Default is 10s
+    config :socket_timeout, :validate => :number, :default => 10
+
+    # Timeout (in seconds) to wait for a connection to be established. Default is 10s
+    config :connect_timeout, :validate => :number, :default => 10
+
+    # Should redirects be followed? Defaults to true
+    config :follow_redirects, :validate => :boolean, :default => true
+
+    # Max number of concurrent connections. Defaults to 50
+    config :pool_max, :validate => :number, :default => 50
+
+    # Max number of concurrent connections to a single host. Defaults to 25
+    config :pool_max_per_route, :validate => :number, :default => 25
+
+    # How many times should the client retry a failing URL? Default is 3
+    config :automatic_retries, :validate => :number, :default => 3
+
+    # If you need to use a custom X.509 CA (.pem certs) specify the path to that here
+    config :ca_path, :validate => :path
+
+    # If you need to use a custom keystore (.jks) specify that here
+    config :truststore_path, :validate => :path
+
+    # Specify the keystore password here.
+    # Note, most .jks files created with keytool require a password!
+    config :truststore_password, :validate => :string
+
+    # Enable cookie support. With this enabled the client will persist cookies
+    # across requests as a normal web browser would. Enabled by default
+    config :cookies, :validate => :boolean, :default => true
+
+    # If you'd like to use an HTTP proxy . This supports multiple configuration syntaxes:
+    # 1. Proxy host in form: http://proxy.org:1234
+    # 2. Proxy host in form: {host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
+    # 3. Proxy host in form: {url =>  'http://proxy.org:1234', user => 'username@host', password => 'password'}
+    config :proxy
+  end
+
+  public
+  def client_config
+    c = {
+      connect_timeout: @connect_timeout,
+      socket_timeout: @socket_timeout,
+      request_timeout: @request_timeout,
+      follow_redirects: @follow_redirects,
+      automatic_retries: @automatic_retries,
+      pool_max: @pool_max,
+      pool_max_per_route: @pool_max_per_route,
+      cookies: @cookies,
+    }
+
+    if @proxy
+      # Symbolize keys if necessary
+      c[:proxy] = @proxy.is_a?(Hash) ?
+        @proxy.reduce({}) {|memo,(k,v)| memo[k.to_sym] = v; memo} :
+        @proxy
+    end
+
+    c[:ssl] = {}
+    if @ca_path
+      c[:ssl][:ca_file] = @ca_path
+    end
+    if (@truststore_path)
+      c[:ssl].merge!(
+        truststore: @truststore_path
+      )
+
+      # JKS files have optional passwords if programatically created
+      if (@truststore_password)
+        c[:ssl].merge!(truststore_password: @truststore_password)
+      end
+    end
+
+    c
+  end
+
+  private
+  def make_client
+    Manticore::Client.new(client_config)
+  end
+
+  public
+  def client
+    @client ||= make_client
+  end
+end

data/logstash-mixin-http_client.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-mixin-http_client'
+  s.version         = '0.0.1'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "AWS mixins to provide a unified interface for Amazon Webservice"
+  s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors         = ["Elastic"]
+  s.email           = 'info@elastic.co'
+  s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'manticore', '>= 0.4.1'
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'stud'
+end

data/spec/plugin_mixin/http_client_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/plugin_mixins/http_client"
+require "stud/temporary"
+
+class Dummy < LogStash::Inputs::Base
+  include LogStash::PluginMixins::HttpClient
+end
+
+describe LogStash::PluginMixins::HttpClient do
+  let(:basic_config) { {} }
+  let(:impl) { Dummy.new(basic_config)  }
+
+  it "should initialize with no extra settings" do
+    expect {
+      impl
+    }.not_to raise_error
+  end
+
+  it "should create a client with defaults" do
+    expect(impl.send(:make_client)).to be_a(Manticore::Client)
+  end
+
+  it "#client should return the client" do
+    expect(impl.client).to be_a(Manticore::Client)
+  end
+
+  it "#client should return the same client" do
+    expect(impl.client).to eql(impl.client)
+  end
+
+  shared_examples "setting ca bundles" do |key|
+    subject { Dummy.new(conf).client_config }
+
+    it "should correctly set the path" do
+      expect(subject[:ssl][key]).to eql(path)
+    end
+  end
+
+  describe "with a custom ssl bundle" do
+    let(:file) { Stud::Temporary.file }
+    let(:path) { file.path }
+    after { File.unlink(path)}
+
+    context "with x509" do
+      let(:conf) { basic_config.merge("ca_path" => path) }
+
+      include_examples("setting ca bundles", :ca_file)
+    end
+
+    context "with JKS" do
+      let(:conf) { basic_config.merge("truststore_path" => path) }
+
+      include_examples("setting ca bundles", :truststore)
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: logstash-mixin-http_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: manticore
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: stud
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/plugin_mixins/http_client.rb
+- logstash-mixin-http_client.gemspec
+- spec/plugin_mixin/http_client_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+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: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: AWS mixins to provide a unified interface for Amazon Webservice
+test_files:
+- spec/plugin_mixin/http_client_spec.rb