services 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d822d6579be3909fe382b950cd93d69303fa06a0
-  data.tar.gz: 528251f7a5177f619d09402b32aaaf2a84bb9b2c
+  metadata.gz: 06b81795775cc40d634101b8736c934f9bb64b75
+  data.tar.gz: 5a80029a0b5da7660e4ecad40e6868f5ea444919
 SHA512:
-  metadata.gz: d6a2fc3cefd633a743bb5e86e8ffc2163e2a42c7f4b1406a912b7108f2603ca9f770644f90d6e9b9aa409087b19cf7f4064943ea045bdd425a2f504c458fc331
-  data.tar.gz: 23805aad75f6806727fb430eef2bdec3b943ed7c3750ae5e479c97268a76884af1b001d90dc2ebb362cee5d6a1e96c556070856e6f90e8553ba9d4e63d97f87e
+  metadata.gz: e5148f72b9f1bd8ee35592bb106e0e25222c284d0eed74a94ec41dfd2daffe3fc2f90223f701e2dc2b24b42f33f27dbd38c0653adf1b703602738cccef1642bc
+  data.tar.gz: 03b295a1abdda5f1377c720ffe4d292a360dd108dcd2ec0fc347477a44304382775f38b183c384b6e0069f668975ebd59cca3ce4a5d03d4fa15e8a475ae89a1a

data/README.md

@@ -49,7 +49,7 @@ The SQL `Services::BaseFinder` (discussed further down) generates is optimized f
 
 The following service takes one or more users or user IDs as an argument.
 
-```
+```ruby
 module Services
   module Users
     class Delete < Services::Base
@@ -72,7 +72,7 @@ It's good practice to always return the objects a service has been operating on
 
 Another example, this time using `Services::BaseFinder`:
 
-```
+```ruby
 module Services
   module Users
     class Find < Services::BaseFinder

data/lib/services.rb

@@ -7,13 +7,14 @@ module Services
 
   with_configuration do
     has :host, classes: String
-    has :log_dir, classes: [String, Pathname]
+    has :logger
     has :redis
   end
 end
 
 require_relative 'services/version'
-require_relative 'services/logger'
+require_relative 'services/logger/file'
+require_relative 'services/logger/redis'
 begin
   require_relative 'services/asyncable'
 rescue Services::BackgroundProcessorNotFound

data/lib/services/{logger.rb → logger/file.rb}

@@ -1,17 +1,15 @@
 require 'active_support/tagged_logging'
 
 module Services
-  class Logger
-    def initialize
-      unless Services.configuration.log_dir.nil?
-        log_file = File.join(Services.configuration.log_dir, 'services.log')
+  module Logger
+    class File
+      def initialize(log_dir)
+        log_file = ::File.join(log_dir, 'services.log')
         @logger = ActiveSupport::TaggedLogging.new(::Logger.new(log_file))
         @logger.clear_tags!
       end
-    end
 
-    def log(tags, message, severity = :info)
-      unless @logger.nil?
+      def log(message, tags = [], severity = :info)
         @logger.tagged Time.now, severity.upcase, *tags do
           @logger.send severity, message
         end

data/lib/services/logger/redis.rb

@@ -0,0 +1,28 @@
+module Services
+  module Logger
+    class Redis
+      def initialize(redis, key = 'logs')
+        @redis, @key = redis, key
+      end
+
+      def log(message, tags = [], severity = :info)
+        value = {
+          time:     Time.now.to_i,
+          message:  message,
+          severity: severity,
+          tags:     tags
+        }
+        @redis.lpush @key, value.to_json
+      end
+
+      def clear
+        @redis.multi do
+          @redis.lrange @key, 0, -1
+          @redis.del @key
+        end.first.map do |json|
+          JSON.load json
+        end
+      end
+    end
+  end
+end

data/lib/services/modules/call_logger.rb

@@ -2,12 +2,14 @@ module Services
   class Base
     module CallLogger
       def call(*args)
+        return super if Services.configuration.logger.nil?
+
         log "START with args #{args}"
         log "CALLED BY #{caller || '(not found)'}"
         start = Time.now
         begin
           result = super
-        rescue StandardError => e
+        rescue => e
           log_exception e
           raise e
         ensure
@@ -19,8 +21,7 @@ module Services
       private
 
       def log(message, severity = :info)
-        @logger ||= Logger.new
-        @logger.log [self.class, @id], message, severity
+        Services.configuration.logger.log message, [self.class, @id], severity
       end
 
       def log_exception(e, cause = false)

data/lib/services/railtie.rb

@@ -5,9 +5,5 @@ module Services
     initializer 'services.load_base_finder' do
       require 'services/base_finder'
     end
-
-    config.after_initialize do
-      Services.configuration.log_dir = Rails.root.join('log')
-    end
   end
 end

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = '0.4.0'
+  VERSION = '1.0.0'
 end

data/services.gemspec

@@ -6,27 +6,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'services/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = 'services'
-  gem.version       = Services::VERSION
-  gem.platform      = Gem::Platform::RUBY
-  gem.author        = 'Manuel Meurer'
-  gem.email         = 'manuel@krautcomputing.com'
-  gem.summary       = 'A nifty service layer for your Rails app'
-  gem.description   = 'A nifty service layer for your Rails app'
-  gem.homepage      = 'http://krautcomputing.github.io/services'
-  gem.license       = 'MIT'
+  gem.name                  = 'services'
+  gem.version               = Services::VERSION
+  gem.platform              = Gem::Platform::RUBY
+  gem.author                = 'Manuel Meurer'
+  gem.email                 = 'manuel@krautcomputing.com'
+  gem.summary               = 'A nifty service layer for your Rails app'
+  gem.description           = 'A nifty service layer for your Rails app'
+  gem.homepage              = 'http://krautcomputing.github.io/services'
+  gem.license               = 'MIT'
+  gem.required_ruby_version = '~> 2.0'
+  gem.files                 = `git ls-files`.split($/)
+  gem.executables           = gem.files.grep(%r(^bin/)).map { |f| File.basename(f) }
+  gem.test_files            = gem.files.grep(%r(^(test|spec|features)/))
+  gem.require_paths         = ['lib']
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r(^bin/)).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r(^(test|spec|features)/))
-  gem.require_paths = ['lib']
-
-  gem.add_development_dependency 'rake', '>= 0.9.0'
+  gem.add_development_dependency 'rake',        '>= 0.9.0'
   gem.add_development_dependency 'guard-rspec', '~> 4.2'
-  gem.add_development_dependency 'rspec', '~> 3.0'
-  gem.add_development_dependency 'sidekiq', '~> 3.0'
-  gem.add_development_dependency 'redis', '~> 3.0'
-  gem.add_development_dependency 'tries', '~> 0.3'
-  gem.add_runtime_dependency 'rails', '>= 3.0.0'
-  gem.add_runtime_dependency 'gem_config', '~> 0.3'
+  gem.add_development_dependency 'rspec',       '~> 3.0'
+  gem.add_development_dependency 'sidekiq',     '~> 3.0'
+  gem.add_development_dependency 'redis',       '~> 3.0'
+  gem.add_development_dependency 'tries',       '~> 0.3'
+  gem.add_development_dependency 'timecop',     '~> 0.7'
+  gem.add_runtime_dependency     'rails',       '>= 3.0.0'
+  gem.add_runtime_dependency     'gem_config',  '~> 0.3'
 end

data/spec/services/logger/redis_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Services::Logger::Redis do
+  let(:tags)        { %w(foo bar baz) }
+  let(:message)     { "One day baby we'll be old" }
+  let(:severity)    { 'critical' }
+  let(:key)         { 'custom_log_key' }
+  let(:redis)       { Redis.new }
+  let(:logger)      { described_class.new(redis, key) }
+
+  def log_entries
+    redis.lrange(key, 0, -1).map do |json|
+      JSON.load json
+    end
+  end
+
+  describe '#log' do
+    it 'logs properly' do
+      Timecop.freeze do
+        payload = {
+          'time'     => Time.now.to_i,
+          'message'  => message,
+          'severity' => severity,
+          'tags'     => tags
+        }
+        expect do
+          logger.log message, tags, severity
+        end.to change { log_entries }.from([]).to([payload])
+      end
+    end
+  end
+
+  describe '#clear' do
+    before do
+      (2.days.ago.to_i..Time.now.to_i).step(1.hour) do |timestamp|
+        time = Time.at(timestamp)
+        Timecop.freeze time do
+          tags = [time.strftime('%a')]
+          logger.log tags, time.to_s(:long)
+        end
+      end
+      expect(log_entries.size).to be > 0
+    end
+
+    it 'returns all log entries' do
+      expect(log_entries).to eq(logger.clear)
+    end
+
+    it 'clears all log entries' do
+      expect do
+        logger.clear
+      end.to change { log_entries }.to([])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require 'rspec'
 require 'tries'
 require 'redis'
 require 'sidekiq'
+require 'timecop'
+require 'active_support/core_ext'
 
 require_relative '../lib/services'
 
@@ -26,8 +28,8 @@ sidekiq_pidfile = support_dir.join('sidekiq.pid')
 sidekiq_timeout = 20
 
 Services.configure do |config|
-  config.redis   = Redis.new
-  config.log_dir = log_dir
+  config.redis  = Redis.new
+  config.logger = Services::Logger::File.new(log_dir)
 end
 
 Sidekiq.configure_client do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +153,8 @@ files:
 - lib/services/asyncable.rb
 - lib/services/base.rb
 - lib/services/base_finder.rb
-- lib/services/logger.rb
+- lib/services/logger/file.rb
+- lib/services/logger/redis.rb
 - lib/services/modules/call_logger.rb
 - lib/services/modules/exception_wrapper.rb
 - lib/services/modules/uniqueness_checker.rb
@@ -147,6 +162,7 @@ files:
 - lib/services/version.rb
 - services.gemspec
 - spec/services/base_spec.rb
+- spec/services/logger/redis_spec.rb
 - spec/services/modules/call_logger_spec.rb
 - spec/services/modules/exception_wrapper_spec.rb
 - spec/services/modules/uniqueness_checker_spec.rb
@@ -167,9 +183,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -183,6 +199,7 @@ specification_version: 4
 summary: A nifty service layer for your Rails app
 test_files:
 - spec/services/base_spec.rb
+- spec/services/logger/redis_spec.rb
 - spec/services/modules/call_logger_spec.rb
 - spec/services/modules/exception_wrapper_spec.rb
 - spec/services/modules/uniqueness_checker_spec.rb