wildcloud-logger 0.0.1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (30.12.2011)
+
+* first extracted version

data/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/README.md

@@ -0,0 +1,71 @@
+# Wildcloud - Logger
+
+Logging library extracted from Wildcloud project.
+
+## Status
+
+More work needed.
+
+## Example
+
+The library is distributed as a gem
+
+    gem install wildcloud-logger
+
+Or if you use Bundler (and you should!)
+
+    gem 'wildcloud-logger', :require => 'wildcloud/logger'
+
+Now you can create logger instance and give it an application name
+
+    @logger = Wildcloud::Logger::Logger.new
+    @logger.application = 'MyCoolApplication'
+
+Your logger is ready to be used, however all messages will be lost.
+
+To process messages you got to add some middleware.
+
+Most common example during the development is to output messages to console (stdout)
+
+    require 'wildcloud/logger/middleware/console'
+    @logger.add(Wildcloud::Logger::Middleware::Console)
+
+More complex example is to publish to some AMQP exchange
+
+    require 'wildcloud/logger/middleware/amqp'
+    @topic = AMQP::Channel.new(AMQP.connect()).topic('<<some_exchange_name>>')
+    @logger.add(Wildcloud::Logger::Middleware::Amqp, :exchange => @topic, :routing_key => '<<some_routing_key>>')
+
+It's very simple to write new middleware.
+
+## Middleware
+
+* Console - output to $stdout
+* Json - encodes message into JSON (JSON.dump(message)) and puts it into the messages as :json_encoded key
+* Amqp - publishes message to AMQP exchange, by default takes :json_encoded key
+
+## Design
+
+Logger is inspired by Rack architecture. Wildcloud::Logger::Logger serves as entry point for accepting logging messages,
+which are then passed to middleware for further processing.
+
+Logger allows adding custom logging levels and modifying the default ones. Levels are specified as Ruby symbols with
+specific score that is used to compare importance. By default Logger provides these levels:
+
+        { :debug => 10, :info => 20, :warn => 30, :error => 40, :fatal => 50 }
+
+## License
+
+Copyright 2011 Marek Jelen
+
+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/lib/wildcloud/logger.rb

@@ -0,0 +1,16 @@
+# Copyright 2011 Marek Jelen
+#
+# 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.
+
+require 'wildcloud/logger/version'
+require 'wildcloud/logger/logger'

data/lib/wildcloud/logger/logger.rb

@@ -0,0 +1,87 @@
+# Copyright 2011 Marek Jelen
+#
+# 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.
+
+module Wildcloud
+  module Logger
+    class Logger
+
+      LEVELS = {:debug => 10, :info => 20, :warn => 30, :error => 40, :fatal => 50}
+
+      attr_accessor :level, :application
+
+      def initialize(application = 'default', level = :debug)
+        @level = level
+        @stack = []
+        @base = proc { |msg|}
+        @application = application
+        @app = nil
+      end
+
+      def base=(base)
+        @base = base
+        @app = nil
+      end
+
+      def add(middleware, options = nil)
+        @stack << [middleware, options]
+        @app = nil
+      end
+
+      def build
+        @app = @stack.reverse.inject(@base) do |app, middleware|
+          clazz, options = middleware
+          if options
+            clazz.new(app, options)
+          else
+            clazz.new(app)
+          end
+        end
+      end
+
+      def add_level(name, score)
+        LEVELS[name] = score
+      end
+
+      def remove_level(name)
+        LEVELS.delete(name)
+      end
+
+      def log(level, component=nil, message = nil, options = nil)
+        return if LEVELS[level] < LEVELS[self.level]
+        message = yield if block_given?
+        component, message = nil, component unless message
+        options ||= {}
+        msg = options.merge!({
+                                 :level => level,
+                                 :application => @application,
+                                 :component => component,
+                                 :message => message,
+                                 :timestamp => Time.now.to_i
+                             })
+        call(msg)
+      end
+
+      def call(msg)
+        build unless @app
+        @app.call(msg)
+      end
+
+      def method_missing(name, *args, &block)
+        return super(name, *args, &block) unless LEVELS.has_key?(name)
+        log(name, args[0], args[1], args[2], &block)
+      end
+
+    end
+  end
+end

data/lib/wildcloud/logger/middleware/amqp.rb

@@ -0,0 +1,36 @@
+# Copyright 2011 Marek Jelen
+#
+# 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.
+
+module Wildcloud
+  module Logger
+    module Middleware
+      class Amqp
+
+        def initialize(app, options = {})
+          @app = app
+          @exchange = options[:exchange]
+          @key = options[:key] ? options[:key] : :json_encoded
+          @options = {}
+          @options[:routing_key] = options[:routing_key] if options[:routing_key]
+        end
+
+        def call(msg)
+          @exchange.publish(msg[@key], @options)
+          @app.call(msg)
+        end
+
+      end
+    end
+  end
+end

data/lib/wildcloud/logger/middleware/console.rb

@@ -0,0 +1,50 @@
+# Copyright 2011 Marek Jelen
+#
+# 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.
+
+module Wildcloud
+  module Logger
+    module Middleware
+
+      class Console
+
+        COLORS = {:debug => "\e[36m", :info => "\e[32m", :warn => "\e[33m", :error => "\e[31m", :fatal => "\e[35m"}
+
+        def initialize(app, options = {})
+          @app = app
+          @options = {
+              :level_length => 8,
+              :component_length => 10
+          }.merge(options)
+        end
+
+        def call(msg)
+          level = msg[:level]
+          stdout = "#{COLORS[level]}#{level.to_s.rjust(@options[:level_length])}\e[0m"
+          stdout << " (#{Time.at(msg[:timestamp])})"
+          stdout << " :"
+          stdout << " #{msg[:application]}" if msg[:application]
+          stdout << " :"
+          stdout << " #{msg[:component].to_s.ljust(@options[:component_length])}" if msg[:component]
+          stdout << " :"
+          stdout << " #{msg[:message]}"
+          stdout << "\n"
+          $stdout << stdout
+          @app.call(msg)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/wildcloud/logger/middleware/json.rb

@@ -0,0 +1,32 @@
+# Copyright 2011 Marek Jelen
+#
+# 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.
+
+module Wildcloud
+  module Logger
+    module Middleware
+      class Json
+
+        def initialize(app)
+          @app = app
+        end
+
+        def call(msg)
+          msg[:json_encoded] = ::JSON.dump(msg)
+          @app.call(msg)
+        end
+
+      end
+    end
+  end
+end

data/lib/wildcloud/logger/version.rb

@@ -0,0 +1,19 @@
+# Copyright 2011 Marek Jelen
+#
+# 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.
+
+module Wildcloud
+  module Logger
+    VERSION = '0.0.1' unless const_defined?(:VERSION)
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: wildcloud-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marek Jelen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-30 00:00:00.000000000 Z
+dependencies: []
+description: Simple logging library inspired by Rack architecture
+email:
+- marek@jelen.biz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/wildcloud/logger/logger.rb
+- lib/wildcloud/logger/middleware/amqp.rb
+- lib/wildcloud/logger/middleware/console.rb
+- lib/wildcloud/logger/middleware/json.rb
+- lib/wildcloud/logger/version.rb
+- lib/wildcloud/logger.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+homepage: http://github.com/wildcloud
+licenses:
+- Apache2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Logging library extracted from Wildcloud project
+test_files: []