logging-flowdock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 474bf9b3b497b8d828768baf72fe6d8610978ceb
+  data.tar.gz: ead54931ad1e9cf297a1cd0b87bdd17b381f9b84
+SHA512:
+  metadata.gz: 1d606e2115ba6df580e43326091596bfec30c259a21dee3ec86a29bdf070d10980b486f4e8e53d6df924f940a337a5280b8a14d0c8c1d597576be390fc95f0fd
+  data.tar.gz: c542d32da8296cb2e1fb962790e4c1aa66dcd37f9c10758e71a31321550756265930a1c4cc80503a73cf3a39c5ef6b7697d9e295c798aac831e976265ee7b86c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,38 @@
+# Most of these are disabling existing cops, primarily
+# due to a smattering of different styles and loose
+# guidlines for contributions.
+#
+# Any of these may be changed.
+
+# I personally believe double-quotes is more-idiomatic Ruby
+# StringLiterals:
+#   EnforcedStyle: double_quotes
+#  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%': '{}'
+    '%i': '{}'
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+    '%s': '{}'
+    '%w': '{}'
+    '%W': '{}'
+    '%x': '{}'
+
+SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+LineLength:
+  Max: 120
+
+# Style/ClassAndModuleChildren:
+#   EnforcedStyle: compact
+
+Style/FileName:
+  Enabled: false
+
+# TODO: Disable before release
+# Documentation:
+#   Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at wildjim+dev@kiwinet.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 mexisme
+
+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,83 @@
+# Logging::Flowdock
+
+This is an "Appender" for the [Logging](https://rubygems.org/gems/logging) gem, to allow you to forward Logs directly to an
+[Flowdock](https://flowdock.com) Service.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logging'
+gem 'logging-flowdock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logging-flowdock
+
+## Usage
+
+
+The Logging gem uses [little-plugger](https://rubygems.org/gems/little-plugger) gem to manage
+[extending Logger](https://github.com/TwP/logging#extending).
+This means it will automatically load and initialise the `logging-flowdock` code as soon as it loads the Logging code.
+
+To configure Logging to use Flowdock, you simply have to add the appender to your configuring of Logging.
+
+e.g. The following will send the "Wootles" log-output to STDERR and the Flowdock service running on the localhost:
+
+```ruby
+l = Logging.logger["The Wild Wild Test"]
+l.add_appenders(
+  Logging.appenders.stderr,
+  Logging.appenders.flowdock("Wicky wicky wild", api_token: "AKSDHKSAHDKJAHSDKH-IS-MADE-UP", flow_user: "Bot")
+)
+
+l.info "Wootles"
+```
+
+You must provide an `api_token` and a `flow_user`.
+
+### Logging Defaults
+
+Sending messages to the Flowdock service can be quite slow, so by default I've set the `flush_period` to 1 second.
+This means a `log.info("MESSAGE")` call should return immediately, and a background thread will flush all logging messages to the Flowdock
+service once every second.
+
+If you prefer to *not* do this (e.g. thread-unsafe code) you can disable it:
+
+```
+[...]
+
+l.add_appenders(
+  Logging.appenders.flowdock(name, ..., flush_period: nil)
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console ${API_TOKEN} ${FLOWDOCK_USER}` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### To Do's
+
+I track major "To Do's" in a [TODO.org](TODO.org) file.
+
+I track context-sensitive and minor ones with `TODO` and `FIXME` comments in the source code.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mexisme/logging-flowdock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TODO.org

@@ -0,0 +1,6 @@
+* Tasks
+** DONE Add docs to the README!
+   :LOGBOOK:
+   - State "DONE"       from "TODO"       [2016-02-03 Wed 17:01]
+   :END:
+** TODO Add better doc-comments!

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logging"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+name, api_token = ARGV
+
+::Logging.logger.root.add_appenders(::Logging.appenders.stderr)
+::Logging.logger.root.add_appenders(Logging.appenders.flowdock(name, api_token: api_token, flow_user: "TEST-#{name}"))
+::Logging.logger.root.level = :debug
+
+log = Logging.logger["Console Test"]
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logging/appenders/flowdock.rb

@@ -0,0 +1,74 @@
+require 'flowdock'
+
+module Logging
+  module Appenders
+    # Factory for the Flowdock appender.
+    def self.flowdock(*args)
+      fail ArgumentError, '::Logging::Appenders::Flowdock needs a name as first argument.' if args.empty?
+      ::Logging::Appenders::Flowdock.new(*args)
+    end
+
+    # This class provides an Appender that can write to a Flowdock service over UDP.
+    class Flowdock < ::Logging::Appender
+      include Buffering
+
+      # We use a background flusher instead, as the connection to Flowdock can be quite slow:
+      DEFAULT_OPTS = {
+        flush_period: 1,
+      }
+      attr_reader :api_token, :flow_user, :flow
+
+      # Creates a new Flowdock Appender that will use the given host and port
+      # as the Flowdock server destination.
+      #
+      # @param name [String] Stream ID to differentiate in the Flowdock server
+      # @param api_token [String]
+      # @param flow_user [String]
+      def initialize(name, opts = {})
+        @api_token = opts[:api_token]
+        @flow_user = opts[:flow_user]
+
+        fail ArgumentError, 'Empty api_token and flow_user is not appropriate' unless api_token && !api_token.empty? && flow_user && !flow_user.empty?
+
+        # Initialise flow var:
+        flow
+
+        super
+        configure_buffering(DEFAULT_OPTS.merge(opts))
+      end
+
+      def flow
+        @flow ||= connect(api_token, flow_user)
+      end
+
+      def close(*args)
+        super
+        @flow = nil
+
+        self
+      end
+
+      private
+
+      def connect(host, port)
+        ::Flowdock::Flow.new(api_token: api_token, external_user_name: flow_user)
+      end
+
+      def canonical_write(str)
+        return self if @flow.nil?
+
+        str = str.force_encoding(encoding) if encoding && str.encoding != encoding
+        timestamp = Time.now.to_s
+        message = "#{name} - #{timestamp}:\n#{str}"
+        flow.push_to_chat(content: message)
+
+        self
+
+      rescue StandardError => err
+        self.level = :off
+        ::Logging.log_internal { "appender #{name.inspect} has been disabled" }
+        ::Logging.log_internal_error(err)
+      end
+    end
+  end
+end

data/lib/logging/plugins/flowdock.rb

@@ -0,0 +1,15 @@
+module Logging
+  module Plugins
+    # This is plugin-intialisation module used by `little-plugger` to find the code:
+    module Flowdock
+      extend self
+
+      VERSION = '0.1.0'.freeze unless defined? VERSION
+
+      # Initialiser for `little-plugger`:
+      def initialize_flowdock
+        require File.expand_path('../../appenders/flowdock', __FILE__)
+      end
+    end
+  end
+end

data/logging-flowdock.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logging/plugins/flowdock'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logging-flowdock"
+  spec.version       = Logging::Plugins::Flowdock::VERSION
+  spec.authors       = ["mexisme"]
+  spec.email         = ["wildjim+dev@kiwinet.org"]
+
+  spec.summary       = 'An appender for the Logging gem that sends messages to a Flowdock channel'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/fairfaxmedia/logging-flowdock'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency 'pry-byebug', '~> 3.2'
+
+  spec.add_runtime_dependency 'little-plugger', '~> 1.1'
+  spec.add_runtime_dependency 'logging', '~> 2.0'
+  spec.add_runtime_dependency 'flowdock'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: logging-flowdock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mexisme
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: little-plugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: flowdock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- wildjim+dev@kiwinet.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.org
+- bin/console
+- bin/setup
+- lib/logging/appenders/flowdock.rb
+- lib/logging/plugins/flowdock.rb
+- logging-flowdock.gemspec
+homepage: https://github.com/fairfaxmedia/logging-flowdock
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: An appender for the Logging gem that sends messages to a Flowdock channel
+test_files: []
+has_rdoc: