logstash-mixin-aws 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25a7589cd0a440855b84089ebd593f1313f14b50
-  data.tar.gz: 971fd6a774425844aaebb50e10a1142558531546
+  metadata.gz: bde334ed24960529b1f8abafbc95324516aaf338
+  data.tar.gz: d08c1fc0692a0bca830172112915fa75d949d2f1
 SHA512:
-  metadata.gz: f31976bcb6beaf283b6fe8043fb3b6560dfa881f2357464d3f1c6449d232fccf95b512953dfcfd6b42bf83a3c380221ae254b273932e6a74f953871b6af45996
-  data.tar.gz: 7f69de4174db11ac870b381700c4192daca1a5d289a8a289dee11edd548f8f42ed8ceaf9c5e01feb3733c19569562bcdddf2b377f7d4538f4876a5ad6be1c032
+  metadata.gz: 1acae776591222fdf759c19cdabad18ddfa9efe1470d7c6e82f2b01590f336f9262787f03efbe9758e8ae9e9fec5a640015cede2d6f28280c47275b93e54e1b0
+  data.tar.gz: 02292f1b153ab00661018f61880d01b0508a48f69564d1566a2aa985299247368fe413f16703cfae2f2ca3e0a871b921d71ed179cd59822a6058695d4bebac81

data/CONTRIBUTORS

@@ -0,0 +1,12 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Jordan Sissel (jordansissel)
+* Malthe Borch (malthe)
+* Pier-Hugues Pellerin (ph)
+
+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/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+Copyright (c) 2012-2015 Elasticsearch <http://www.elasticsearch.org>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -0,0 +1,95 @@
+# Logstash Plugin
+
+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.
+
+## 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 logstash-users@googlegroups.com mailing list.
+
+## 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.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- 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
+
+- 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 me 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/lib/logstash/plugin_mixins/aws_config.rb

@@ -13,7 +13,7 @@ module LogStash::PluginMixins::AwsConfig
   end
 
   US_EAST_1 = "us-east-1"
-  
+
   public
   def setup_aws_config
     # The AWS Region
@@ -21,25 +21,28 @@ module LogStash::PluginMixins::AwsConfig
                                   "eu-west-1", "ap-southeast-1", "ap-southeast-2",
                                   "ap-northeast-1", "sa-east-1", "us-gov-west-1"], :default => US_EAST_1
 
-    # This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order...   
-    # 1. Static configuration, using `access_key_id` and `secret_access_key` params in logstash plugin config   
-    # 2. External credentials file specified by `aws_credentials_file`   
-    # 3. Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`   
-    # 4. Environment variables `AMAZON_ACCESS_KEY_ID` and `AMAZON_SECRET_ACCESS_KEY`   
-    # 5. IAM Instance Profile (available when running inside EC2)   
+    # This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order...
+    # 1. Static configuration, using `access_key_id` and `secret_access_key` params in logstash plugin config
+    # 2. External credentials file specified by `aws_credentials_file`
+    # 3. Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
+    # 4. Environment variables `AMAZON_ACCESS_KEY_ID` and `AMAZON_SECRET_ACCESS_KEY`
+    # 5. IAM Instance Profile (available when running inside EC2)
     config :access_key_id, :validate => :string
 
     # The AWS Secret Access Key
     config :secret_access_key, :validate => :string
 
-    # Should we require (true) or disable (false) using SSL for communicating with the AWS API   
+    # The AWS Session token for temprory credential
+    config :session_token, :validate => :string
+
+    # Should we require (true) or disable (false) using SSL for communicating with the AWS API
     # The AWS SDK for Ruby defaults to SSL so we preserve that
     config :use_ssl, :validate => :boolean, :default => true
 
     # URI to proxy server if required
     config :proxy_uri, :validate => :string
 
-    # Path to YAML file containing a hash of AWS credentials.   
+    # Path to YAML file containing a hash of AWS credentials.
     # This file will only be loaded if `access_key_id` and
     # `secret_access_key` aren't set. The contents of the
     # file should look like this:
@@ -56,25 +59,19 @@ module LogStash::PluginMixins::AwsConfig
       @logger.warn("Likely config error: Only one of access_key_id or secret_access_key was provided but not both.")
     end
 
-    if ((!@access_key_id || !@secret_access_key)) && @aws_credentials_file
-      access_creds = YAML.load_file(@aws_credentials_file)
-
-      @access_key_id = access_creds[:access_key_id]
-      @secret_access_key = access_creds[:secret_access_key]
-    end
-
-    opts = {}
-
-    if (@access_key_id && @secret_access_key)
-      opts[:access_key_id] = @access_key_id
-      opts[:secret_access_key] = @secret_access_key
+    if @access_key_id && @secret_access_key
+      opts = {
+        :access_key_id => @access_key_id,
+        :secret_access_key => @secret_access_key
+      }
+      opts[:session_token] = @session_token if @session_token
+    elsif @aws_credentials_file
+      opts = YAML.load_file(@aws_credentials_file)
     end
 
+    opts[:proxy_uri] = @proxy_uri if @proxy_uri
     opts[:use_ssl] = @use_ssl
 
-    if (@proxy_uri)
-      opts[:proxy_uri] = @proxy_uri
-    end
 
     # The AWS SDK for Ruby doesn't know how to make an endpoint hostname from a region
     # for example us-west-1 -> foosvc.us-west-1.amazonaws.com
@@ -86,7 +83,7 @@ module LogStash::PluginMixins::AwsConfig
     # for example, CloudWatch, { :cloud_watch_endpoint => "monitoring.#{region}.amazonaws.com" }
     # For a list, see https://github.com/aws/aws-sdk-ruby/blob/master/lib/aws/core/configuration.rb
     opts.merge!(self.aws_service_endpoint(@region))
-    
+
     return opts
   end # def aws_options_hash
 

data/logstash-mixin-aws.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-mixin-aws'
-  s.version         = '0.1.3'
+  s.version         = '0.1.4'
   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"

data/spec/fixtures/aws_temporary_credentials_file_sample_test.yml

@@ -0,0 +1,3 @@
+:access_key_id: '1234'
+:secret_access_key: secret
+:session_token: session_token

data/spec/plugin_mixin/aws_config_spec.rb

@@ -6,7 +6,6 @@ require 'aws-sdk'
 class DummyInputAwsConfig < LogStash::Inputs::Base
   include LogStash::PluginMixins::AwsConfig
 
-  milestone 1
 
   def aws_service_endpoint(region)
     { :dummy_input_aws_config_region => "#{region}.awswebservice.local" }
@@ -14,25 +13,62 @@ class DummyInputAwsConfig < LogStash::Inputs::Base
 end
 
 describe LogStash::PluginMixins::AwsConfig do
-  it 'should support passing credentials as key, value' do
-    settings = { 'access_key_id' => '1234',  'secret_access_key' => 'secret' }
 
-    config = DummyInputAwsConfig.new(settings)
-    config.aws_options_hash[:access_key_id].should == settings['access_key_id']
-    config.aws_options_hash[:secret_access_key].should == settings['secret_access_key']
-  end
+  let(:settings) { {} }
+
+  subject { DummyInputAwsConfig.new(settings).aws_options_hash }
+
+  describe 'config credential' do
+
+    context 'in credential file' do
+      let(:settings) { { 'aws_credentials_file' => File.join(File.dirname(__FILE__), '..', 'fixtures/aws_credentials_file_sample_test.yml') } }
+
+      it 'should support reading configuration from a yaml file' do
+        subject[:access_key_id].should == '1234'
+        subject[:secret_access_key].should == 'secret'
+      end
+    end
+
+    context 'inline' do
+      context 'temporary credential' do
+        let(:settings) { { 'access_key_id' => '1234', 'secret_access_key' => 'secret', 'session_token' => 'session_token' } }
+
+        it "should support passing as key, value, and session_token" do
+          subject[:access_key_id].should == settings['access_key_id']
+          subject[:secret_access_key].should == settings['secret_access_key']
+          subject[:session_token].should == settings['session_token']
+        end
+      end
+
+      context 'normal credential' do
+        let(:settings) { { 'access_key_id' => '1234',  'secret_access_key' => 'secret' } }
+
+        it 'should support passing credentials as key, value' do
+          subject[:access_key_id].should == settings['access_key_id']
+          subject[:secret_access_key].should == settings['secret_access_key']
+        end
+      end
+    end
 
-  it 'should support reading configuration from a yaml file' do
-    settings = { 'aws_credentials_file' => File.join(File.dirname(__FILE__), '..', 'fixtures/aws_credentials_file_sample_test.yml') }
-    config = DummyInputAwsConfig.new(settings)
-    config.aws_options_hash[:access_key_id].should == '1234'
-    config.aws_options_hash[:secret_access_key].should == 'secret'
   end
 
-  it 'should call the class to generate the endpoint configuration' do
-    settings = { 'access_key_id' => '1234',  'secret_access_key' => 'secret', 'region' => 'us-west-2' }
+  describe 'config region' do
+
+    context 'region provided' do
+      let(:settings) { { 'access_key_id' => '1234',  'secret_access_key' => 'secret', 'region' => 'us-west-2' } }
+
+      it 'should use provided region to generate the endpoint configuration' do
+        subject[:dummy_input_aws_config_region].should == "us-west-2.awswebservice.local"
+      end
+    end
+
+    context "region not provided" do
+      let(:settings) { { 'access_key_id' => '1234',  'secret_access_key' => 'secret'} }
+
+      it 'should use default region to generate the endpoint configuration' do
+        subject[:dummy_input_aws_config_region].should == "us-east-1.awswebservice.local"
+      end
+    end
 
-    config = DummyInputAwsConfig.new(settings)
-    config.aws_options_hash[:dummy_input_aws_config_region].should == "us-west-2.awswebservice.local"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-mixin-aws
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -79,12 +79,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTORS
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
 - lib/logstash/plugin_mixins/aws_config.rb
 - logstash-mixin-aws.gemspec
 - spec/fixtures/aws_credentials_file_sample_test.yml
+- spec/fixtures/aws_temporary_credentials_file_sample_test.yml
 - spec/plugin_mixin/aws_config_spec.rb
 homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
 licenses:
@@ -114,4 +117,5 @@ specification_version: 4
 summary: AWS mixins to provide a unified interface for Amazon Webservice
 test_files:
 - spec/fixtures/aws_credentials_file_sample_test.yml
+- spec/fixtures/aws_temporary_credentials_file_sample_test.yml
 - spec/plugin_mixin/aws_config_spec.rb