eye-s3 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30b56144e82786fa946982a3671d0e714dbeb1d2
+  data.tar.gz: 6c8fbd4170ff33990909d04205614097011801de
+SHA512:
+  metadata.gz: 29ac58399d2a4e67eade9dd9dc6d0086f44331533e75eb94423d43880e64160852d2295b4eb4971b71731bca6cc8915360110f40d8af505630554eabfafc4212
+  data.tar.gz: 465f2e4e2e272364e775a7d515cd23d92319057875ab6c41233243cb4d27d4d8eb3635e0e933aa50c0888e217ed51b141f471beef730f1490bd9a8b6c4770241

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Ricardo Mota
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Eye::S3
+<!-- TODO: add gem version and link -->
+<!-- [![Gem Version]()]() -->
+
+A notifier plugin for [eye](https://github.com/kostya/eye) to send state changes to AWS S3
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eye'
+gem 'eye-s3
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eye-s3
+
+## Usage
+
+S3 notifier takes the following parameters:
+
+- `bucket_name` - **required**, a string with the S3 bucket name
+- `region` - optional, the AWS region for the `S3::Client`, uses `us-east-1` by default
+
+Declare inside eye config like this:
+
+```ruby
+require 'eye/notify/eye_s3'
+
+Eye.config do
+  eye_s3 bucket_name: 'your-bucket-name'
+end
+```
+
+### Authentication
+
+EyeS3 notifier assumes the runtime environment is already configured to use the
+AWS SDK for ruby, for more info on how to do it check the
+[official documentation.](https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html)
+
+It also assumes the client has the correct permissions to put objects on the correspondent S3 bucket.
+
+## Contributing
+
+1. Fork it ( https://github.com/ricardosllm/eye-s3/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/eye-s3.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eye/notify/eye_s3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eye-s3"
+  spec.version       = Eye::Notify::EyeS3::VERSION
+  spec.authors       = ["Ricardo Mota"]
+  spec.email         = ["ricardo@mota.cloud"]
+  spec.summary       = %q{eye state change events to s3 JSON object}
+  spec.description   = %q{eye to s3 object}
+  spec.homepage      = "https://github.com/ricardosllm/eye-s3"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency "aws-sdk", "~> 3.0"
+  spec.add_runtime_dependency "eye", ">= 0.9"
+end

data/lib/eye/notify/eye_s3/version.rb

@@ -0,0 +1,10 @@
+module Eye
+  class Notify
+    # to satisfy gem packaking
+    class Eye::Notify::Custom < Eye::Notify; end
+
+    class EyeS3 < Eye::Notify::Custom
+      VERSION = '0.0.1'
+    end
+  end
+end

data/lib/eye/notify/eye_s3.rb

@@ -0,0 +1,63 @@
+require 'eye'
+require 'eye/notify/eye_s3/version'
+require 'aws-sdk'
+
+module Eye
+  class Notify
+    class EyeS3 < Eye::Notify::Custom
+
+      # Eye.config do
+      #   s3 bucket_name: 'your-bucket-name'
+      # end
+
+      param :bucket_name, String, true
+      param :region,      String, false, 'us-east-1'
+      param :key,         String, false, default_object_key
+
+      def execute
+        Aws::S3::Object.new(options).put object
+      end
+
+      private
+
+      def options
+        {
+          bucket_name: bucket_name,
+          key:         key,
+          client:      client
+        }
+      end
+
+      def object
+        {
+          acl:          'authenticated-read',
+          content_type: 'application/json',
+          body:         body,
+        }
+      end
+
+      def client
+        Aws::S3::Client.new(region: region)
+      end
+
+      def body
+        JSON.generate event
+      end
+
+      def event
+        {
+          host:      msg_host,
+          timestamp: msg_at,
+          message:   msg_message,
+          name:      msg_name,
+          level:     msg_level
+        }
+      end
+
+      def default_object_key
+        now = Time.now
+        [now.year, now.month, now.day, "#{now.to_i}_#{msg_host}.json"].join '/'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: eye-s3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ricardo Mota
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: eye
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: eye to s3 object
+email:
+- ricardo@mota.cloud
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- eye-s3.gemspec
+- lib/eye/notify/eye_s3.rb
+- lib/eye/notify/eye_s3/version.rb
+homepage: https://github.com/ricardosllm/eye-s3
+licenses:
+- MIT
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: eye state change events to s3 JSON object
+test_files: []