services 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 497d42516b9a0d6a95bdf84cc5387fddae35c1a0
-  data.tar.gz: 25e03e9ceea6e04dadac955e5027c654d0a95dda
+  metadata.gz: 3957769bb927ced167265444d98a3a10992e8eb6
+  data.tar.gz: 230cfe057c104954db348751127dea932c661b69
 SHA512:
-  metadata.gz: 8ea3bb811cc4b5f55e3e8eefda6b6d64731250b46b143ea2ed1a456819d605727e58fca08417cb15a3e3e9eb37741dee8684c225af5ba4ef83d6f3162cb821d9
-  data.tar.gz: 757435307628879d21fe2a7106630e39901c1f806a7e4b024215d4fbdb98f336a85d6752fb88055b74c60863d29d508228d51275c27ebf69c75b123dbe47f1ea
+  metadata.gz: 8f0643545a27ab417933795342a71e898778bf752477ab889ac4b63ab22962dc0f4297a2a779673ff5a264b7495c9a6c1fcf530241eadf1635be6928d3d473e7
+  data.tar.gz: d76942f091238687ae52cb3fbeffe1f6d61f3d93c3d3e926f3eb092936937ef5f4da5fcb58bcdff8868d4c89dbcf1b1220f3cd995e9df08d872aac081d2fb3af

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.0.2
+
+* Make BaseFinder smarter, don't create SQL subquery if not necessary
+
+## 2.0.1
+
+* Fix disabling call logging
+
 ## 2.0.0
 
 * Improve call logging

data/Guardfile

@@ -1,54 +1,61 @@
-# require 'guard/rspec'
-
-# module ::Guard
-#   class RSpec < Plugin
-#     # Add `stop` method if not defined
-#     # so that `stop_*` callbacks work.
-#     unless instance_methods.include?(:stop)
-#       def stop; end
-#     end
-#   end
-# end
-
-# class Guard::StartRedisAndSidekiq
-#   def call(guard_class, event, *args)
-#     # Start Redis
-#     redis_options = {
-#       daemonize:  'yes',
-#       port:       redis_port,
-#       dir:        support_dir,
-#       dbfilename: 'redis.rdb',
-#       logfile:    log_dir.join('redis.log'),
-#       pidfile:    redis_pidfile
-#     }
-#     redis = support_dir.join('redis-server')
-#     system "#{redis} #{options_hash_to_string(redis_options)}"
-
-#     # Copy call proxy
-#     FileUtils.cp CALL_PROXY_SOURCE, CALL_PROXY_DESTINATION
-#   end
-# end
-
-# class Guard::StopRedisAndSidekiq
-#   def call(guard_class, event, *args)
-#     # Delete call proxy
-#     FileUtils.rm CALL_PROXY_DESTINATION
-
-#     # Stop Redis
-#     redis_cli = support_dir.join('redis-cli')
-#     system "#{redis_cli} -p #{redis_port} shutdown"
-
-#     # Truncate log files
-#     max_len = 1024 * 1024 # 1 MB
-#     Dir[File.join(log_dir, '*.log')].each do |file|
-#       File.truncate file, max_len if File.size(file) > max_len
-#     end
-#   end
-# end
+require 'guard/rspec'
+
+module ::Guard
+  class RSpec < Plugin
+    # Add `stop` method if not defined
+    # so that `stop_*` callbacks work.
+    unless instance_methods.include?(:stop)
+      def stop; end
+    end
+  end
+
+  module ServicesGemHelpers
+    SPEC_SUPPORT_DIR = Pathname.new(File.expand_path('../spec/support', __FILE__))
+    REDIS_BIN        = SPEC_SUPPORT_DIR.join('redis-server')
+    REDIS_CLI        = SPEC_SUPPORT_DIR.join('redis-cli')
+    REDIS_PIDFILE    = SPEC_SUPPORT_DIR.join('redis.pid')
+    REDIS_LOGFILE    = SPEC_SUPPORT_DIR.join('log', 'redis.log')
+
+    class OnStart
+      def call(guard_class, event, *args)
+        redis_options = {
+          daemonize:  'yes',
+          dir:        SPEC_SUPPORT_DIR,
+          dbfilename: 'redis.rdb',
+          logfile:    REDIS_LOGFILE,
+          pidfile:    REDIS_PIDFILE,
+        }
+        system "#{REDIS_BIN} #{redis_options.map { |k, v| "--#{k} #{v}" }.join(' ')}"
+
+        i = 0
+        while !File.exist?(REDIS_PIDFILE)
+          puts 'Waiting for Redis to start...'
+          sleep 1
+          i += 1
+          raise "Redis didn't start in #{i} seconds." if i >= 5
+        end
+      end
+    end
+
+    class OnStop
+      def call(guard_class, event, *args)
+        system "#{REDIS_CLI} shutdown"
+
+        i = 0
+        while File.exist?(REDIS_PIDFILE)
+          puts 'Waiting for Redis to stop...'
+          sleep 1
+          i += 1
+          raise "Redis didn't stop in #{i} seconds." if i >= 5
+        end
+      end
+    end
+  end
+end
 
 guard 'rspec', cmd: 'bundle exec rspec' do
-  # callback StartRedisAndSidekiq.new, :start_begin
-  # callback StopRedisAndSidekiq.new, :stop_begin
+  callback ServicesGemHelpers::OnStart.new, :start_begin
+  callback ServicesGemHelpers::OnStop.new,  :stop_begin
 
   # Specs
   watch(%r(^spec/.+_spec\.rb$))

data/README.md

@@ -17,6 +17,24 @@ A lot has been written about service layers in Rails apps. There are of course a
 
 For disambiguation, we let's write Services with a uppercase "S" when we mean this gem, and services with a lowercase "s" when we mean, well, the plural of service.
 
+### Requirements
+
+#### Rails
+
+to be described...
+
+#### Redis
+
+to be described...
+
+#### Sidekiq
+
+To process services in the background, Services uses [Sidekiq](https://github.com/mperham/sidekiq). Sidekiq is not required to use Services though. If it's not present when Services is loaded, a service will raise an exception when you try to enqueue it for background processing. If you use Sidekiq, make sure to load the Services gem after the Sidekiq gem.
+
+#### Postgres
+
+The SQL that `Services::BaseFinder` (discussed further down) generates is optimized for Postgres. It might work with other databases but it's not guaranteed. If you're not using Postgres, don't use `Services::BaseFinder` or, even better, submit a [pull request](https://github.com/krautcomputing/services/issues) that fixes it to work with your database!
+
 ### Basic principles
 
 Services is based on a couple of basic principles of what a service should be and do in your app:
@@ -41,6 +59,18 @@ Follow these conventions when using Services in your Rails app:
 * services are namespaced with the model they operate on and their names are verbs, e.g. `app/services/users/delete.rb` defines `Services::Users::Delete`. If a service operates on multiple models or no models at all, don't namespace them (`Services::DoStuff`) or namespace them by logical groups unrelated to models (`Services::Maintenance::CleanOldUsers`, `Services::Maintenance::SendDailySummary`, etc.)
 * some services call other services. Try to not combine multiple calls to other services and business logic in one service. Instead, some services should contain only business logic and other services only a bunch of service calls but no (or little) business logic. This keeps your services nice and modular.
 
+### Configure
+
+You can set some configuration options in an initializer:
+
+```ruby
+# config/initializers/services.rb
+Services.configure do |config|
+  config.logger = Services::Logger::Redis.new(REDIS) # or Services::Logger::File.new(Rails.root.join('log'))
+  config.redis  = REDIS
+end
+```
+
 ### Rails autoload fix
 
 By default, Rails expects `app/services/users/delete.rb` to define `Users::Delete`, but we want it to expect `Services::Users::Delete`. To make this work, add the `app` folder to the autoload path:
@@ -50,20 +80,6 @@ By default, Rails expects `app/services/users/delete.rb` to define `Users::Delet
 config.autoload_paths += [config.root.join('app')]
 ```
 
-### Dependence
-
-#### Redis
-
-to be described...
-
-#### Sidekiq
-
-To process services in the background, Services uses [Sidekiq](https://github.com/mperham/sidekiq). Sidekiq is not required to use Services though. If it's not present when Services is loaded, a service will raise an exception when you try to enqueue it for background processing. If you use Sidekiq, make sure to load the Services gem after the Sidekiq gem.
-
-#### Postgres
-
-The SQL that `Services::BaseFinder` (discussed further down) generates is optimized for Postgres. It might work with other databases but it's not guaranteed. If you're not using Postgres, don't use `Services::BaseFinder` or, even better, submit a [pull request](https://github.com/krautcomputing/services/issues) that fixes it to work with your database!
-
 ### Examples
 
 The following service takes one or more users or user IDs as an argument.
@@ -150,7 +166,12 @@ Your services also automatically get a custom `Error` class, so you can `raise E
 
 ### Logging
 
-to be described...
+You can choose between logging to Redis or to a file.
+
+
+#### Redis
+
+
 
 ### Exception wrapping
 
@@ -189,3 +210,7 @@ Or install it yourself as:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Testing
+
+You need Redis to run tests, check out the Guardfile!

data/lib/services/asyncable.rb

@@ -7,11 +7,6 @@ rescue LoadError
   raise Services::BackgroundProcessorNotFound
 end
 
-begin
-  require 'sidetiq'
-rescue LoadError
-end
-
 module Services
   module Asyncable
     extend ActiveSupport::Concern
@@ -21,7 +16,6 @@ module Services
 
     included do
       include Sidekiq::Worker
-      include Sidetiq::Schedulable if defined?(Sidetiq)
     end
 
     module ClassMethods
@@ -53,24 +47,5 @@ module Services
 
       target.send *args
     end
-
-    def own_worker
-      return @own_worker if defined?(@own_worker)
-      @own_worker = if self.jid.nil?
-        nil
-      else
-        own_worker = Sidekiq::Workers.new.detect do |_, _, work|
-          work['payload']['jid'] == self.jid
-        end
-        raise self.class::Error, "Could not find own worker with jid #{self.jid}: #{Sidekiq::Workers.new.map { |*args| args }}" if own_worker.nil?
-        own_worker
-      end
-    end
-
-    def sibling_workers
-      @sibling_workers ||= Sidekiq::Workers.new.select do |_, _, work|
-        work['payload']['class'] == self.class.to_s && (own_worker.nil? || work['payload']['jid'] != own_worker[2]['payload']['jid'])
-      end
-    end
   end
 end

data/lib/services/base.rb

@@ -60,6 +60,9 @@ module Services
 
     def controller
       @controller ||= begin
+        # raise "You must use Rails to use the `controller` helper." unless defined?(Rails)
+        # host = Rails.application.routes.default_url_options[:host] || ActionMailer::Base.default_url_options[:host]
+        # Rails.application.routes.default_url_options[:host]
         raise 'Please configure host.' if Services.configuration.host.nil?
         request = ActionDispatch::TestRequest.new
         request.host = Services.configuration.host

data/lib/services/base_finder.rb

@@ -5,14 +5,20 @@ module Services
     def call(ids = [], conditions = {})
       ids, conditions = Array(ids), conditions.symbolize_keys
       special_conditions = conditions.extract!(:order, :limit, :page, :per_page)
-      scope = object_class
-        .select("DISTINCT #{object_class.table_name}.id")
-        .order("#{object_class.table_name}.id")
-      scope = scope.where(id: ids) unless ids.empty?
 
-      scope = process(scope, conditions)
+      object_table_id = "#{object_class.table_name}.id"
+
+      scope = object_class.public_send(Rails::VERSION::MAJOR == 3 ? :scoped : :all)
+      scope = scope.where(object_table_id => ids) unless ids.empty?
+
+      unless conditions.empty?
+        scope = scope
+          .select("DISTINCT #{object_table_id}")
+          .order(object_table_id)
+        scope = process(scope, conditions)
+        scope = object_class.where(id: scope)
+      end
 
-      scope = object_class.where(id: scope)
       special_conditions.each do |k, v|
         case k
         when :order
@@ -32,6 +38,7 @@ module Services
           raise ArgumentError, "Unexpected special condition: #{k}"
         end
       end
+
       scope
     end
   end

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

data/services.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |gem|
   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     'rails',       '>= 3.2.0'
   gem.add_runtime_dependency     'gem_config',  '~> 0.3'
 end

data/spec/services/base_finder_spec.rb

@@ -3,8 +3,10 @@ require 'spec_helper'
 describe Services::BaseFinder do
   include_context 'capture logs'
 
+  let(:base_find) { Services::Models::BaseFind }
+
   it 'has call logging disabled by default' do
-    expect(Services::Models::BaseFind.call_logging_disabled).to eq(true)
-    expect { Services::Models::BaseFind.call }.to_not change { logs }
+    expect(base_find.call_logging_disabled).to eq(true)
+    expect { base_find.call }.to_not change { logs }
   end
 end

data/spec/services/base_spec.rb

@@ -57,24 +57,4 @@ describe Services::Base do
       end
     end
   end
-
-  context 'when executed asynchronously' do
-    it 'finds its own worker' do
-      3.times { OwnWorkerService.perform_async }
-      jid = OwnWorkerService.perform_async
-      own_worker_data = wait_for { Services.configuration.redis.get(jid) }
-      own_worker_json = JSON.parse(own_worker_data)
-      expect(own_worker_json[2]['payload']['jid']).to eq(jid)
-    end
-
-    it 'finds its sibling workers' do
-      sibling_worker_jids = (1..3).map { SiblingWorkersService.perform_async }
-      jid = SiblingWorkersService.perform_async
-      sibling_worker_data = wait_for { Services.configuration.redis.get(jid) }
-      sibling_worker_json = JSON.parse(sibling_worker_data)
-      expect(sibling_worker_json.size).to eq(3)
-      expected_sibling_worker_jids = sibling_worker_json.map { |_, _, work| work['payload']['jid'] }
-      expect(expected_sibling_worker_jids).to match_array(sibling_worker_jids)
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -3,40 +3,34 @@ require 'tries'
 require 'redis'
 require 'sidekiq'
 require 'timecop'
+require 'active_support'
 require 'active_support/core_ext'
 
 require_relative '../lib/services'
 
-PROJECT_ROOT       = Pathname.new(File.expand_path('../..', __FILE__))
-TEST_SERVICES_PATH = Pathname.new(File.join('spec', 'support', 'test_services.rb'))
-support_dir        = Pathname.new(File.expand_path('../support', __FILE__))
-log_dir            = support_dir.join('log')
-
-CALL_PROXY_SOURCE      = support_dir.join('call_proxy.rb')
+PROJECT_ROOT           = Pathname.new(File.expand_path('../..', __FILE__))
+SUPPORT_DIR            = Pathname.new(File.expand_path('../support', __FILE__))
+TEST_SERVICES_PATH     = Pathname.new(File.join('spec', 'support', 'test_services.rb'))
 CALL_PROXY_DESTINATION = PROJECT_ROOT.join('lib', 'services', 'call_proxy.rb')
+CALL_PROXY_SOURCE      = SUPPORT_DIR.join('call_proxy.rb')
+SIDEKIQ_PIDFILE        = SUPPORT_DIR.join('sidekiq.pid')
 WAIT                   = 0.5
 START_TIMEOUT          = 5
-STOP_TIMEOUT           = 20
-
-Dir[support_dir.join('**', '*.rb')].each { |f| require f }
+SIDEKIQ_TIMEOUT        = 20
 
-redis_port    = 6379
-redis_pidfile = support_dir.join('redis.pid')
-redis_url     = "redis://localhost:#{redis_port}/0"
+Dir[SUPPORT_DIR.join('**', '*.rb')].each { |f| require f }
 
-sidekiq_pidfile = support_dir.join('sidekiq.pid')
-sidekiq_timeout = 20
 
 Services.configure do |config|
-  config.redis  = Redis.new
+  config.redis = Redis.new
 end
 
 Sidekiq.configure_client do |config|
-  config.redis = { redis: redis_url, namespace: 'sidekiq', size: 1 }
+  config.redis = { redis: 'redis://localhost:6379/0', namespace: 'sidekiq', size: 1 }
 end
 
 Sidekiq.configure_server do |config|
-  config.redis = { redis: redis_url, namespace: 'sidekiq' }
+  config.redis = { redis: 'redis://localhost:6379/0', namespace: 'sidekiq' }
 end
 
 RSpec.configure do |config|
@@ -45,78 +39,44 @@ RSpec.configure do |config|
   config.order = 'random'
 
   config.before :suite do
-    unless ENV['TRAVIS']
-      # Start Redis
-      redis_options = {
-        daemonize:  'yes',
-        port:       redis_port,
-        dir:        support_dir,
-        dbfilename: 'redis.rdb',
-        logfile:    log_dir.join('redis.log'),
-        pidfile:    redis_pidfile
-      }
-      redis = support_dir.join('redis-server')
-      system "#{redis} #{options_hash_to_string(redis_options)}"
-    end
-
     # Start Sidekiq
     sidekiq_options = {
       concurrency: 10,
       daemon:      true,
-      timeout:     sidekiq_timeout,
+      timeout:     SIDEKIQ_TIMEOUT,
       verbose:     true,
       require:     __FILE__,
-      logfile:     log_dir.join('sidekiq.log'),
-      pidfile:     sidekiq_pidfile
+      logfile:     SUPPORT_DIR.join('log', 'sidekiq.log'),
+      pidfile:     SIDEKIQ_PIDFILE
     }
     system "bundle exec sidekiq #{options_hash_to_string(sidekiq_options)}"
 
     # Copy call proxy
     FileUtils.cp CALL_PROXY_SOURCE, CALL_PROXY_DESTINATION
 
-    # Wait until Redis and Sidekiq are started
-    @processes = {
-      'Sidekiq' => sidekiq_pidfile
-    }
-    @processes['Redis'] = redis_pidfile unless ENV['TRAVIS']
-    @processes.each do |process, pidfile|
-      i = 0
-      while !File.exist?(pidfile)
-        puts "Waiting for #{process} to start..."
-        sleep WAIT
-        i += WAIT
-        raise "#{process} didn't start in #{i} seconds." if i >= START_TIMEOUT
-      end
+    # Wait for Sidekiq to start
+    i = 0
+    while !File.exist?(SIDEKIQ_PIDFILE)
+      puts 'Waiting for Sidekiq to start...'
+      sleep WAIT
+      i += WAIT
+      raise "Sidekiq didn't start in #{i} seconds." if i >= START_TIMEOUT
     end
   end
 
   config.after :suite do
-    # Delete call proxy
-    FileUtils.rm CALL_PROXY_DESTINATION
-
     # Stop Sidekiq
-    system "bundle exec sidekiqctl stop #{sidekiq_pidfile} #{sidekiq_timeout}"
-
-    unless ENV['TRAVIS']
-      # Stop Redis
-      redis_cli = support_dir.join('redis-cli')
-      system "#{redis_cli} -p #{redis_port} shutdown"
-    end
+    system "bundle exec sidekiqctl stop #{SIDEKIQ_PIDFILE} #{SIDEKIQ_TIMEOUT}"
 
-    @processes.each do |process, pidfile|
-      i = 0
-      while File.exist?(pidfile)
-        puts "Waiting for #{process} to stop..."
-        sleep WAIT
-        i += WAIT
-        raise "#{process} didn't stop in #{i} seconds." if i >= STOP_TIMEOUT
-      end
-    end
+    # Delete call proxy
+    FileUtils.rm CALL_PROXY_DESTINATION
 
-    # Truncate log files
-    max_len = 1024 * 1024 # 1 MB
-    Dir[File.join(log_dir, '*.log')].each do |file|
-      File.truncate file, max_len if File.size(file) > max_len
+    i = 0
+    while File.exist?(SIDEKIQ_PIDFILE)
+      puts 'Waiting for Sidekiq to stop...'
+      sleep WAIT
+      i += WAIT
+      raise "Sidekiq didn't stop in #{i} seconds." if i >= SIDEKIQ_TIMEOUT + 1
     end
   end
 

data/spec/support/shared.rb

@@ -1,4 +1,4 @@
-shared_context 'capture logs' do
+RSpec.shared_context 'capture logs' do
   let(:logger) { spy('logger') }
   let(:logs)   { [] }
 

data/spec/support/test_services.rb

@@ -131,28 +131,6 @@ class NonUniqueService < Services::Base
   end
 end
 
-class OwnWorkerService < Services::Base
-  def call
-    if own_worker.nil?
-      logger.error 'Could not find own worker!'
-    else
-      Services.configuration.redis.set self.jid, own_worker.to_json
-    end
-    sleep 0.5
-  end
-end
-
-class SiblingWorkersService < Services::Base
-  def call
-    if sibling_workers.empty?
-      logger.info 'No sibling workers found.'
-    else
-      Services.configuration.redis.set self.jid, sibling_workers.to_json
-    end
-    sleep 0.5
-  end
-end
-
 class NestedExceptionService < Services::Base
   NestedError1 = Class.new(Error)
   NestedError2 = Class.new(Error)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: gem_config
   requirement: !ruby/object:Gem::Requirement