simple_service 1.4.1 → 2.1.0

data/lib/simple_service/version.rb

@@ -1,3 +1,3 @@
 module SimpleService
-  VERSION = '1.4.1'
+  VERSION = '2.1.0'
 end

data/spec/simple_service_spec.rb

@@ -1,5 +1,180 @@
 require 'spec_helper'
+require_relative 'support/basic_service'
+require_relative 'support/looping_service'
 
-describe SimpleService do
+RSpec.describe SimpleService do
 
+  let(:params) do
+    {
+      foo: 'asdf',
+      bar: 'qwer',
+      command_one_success: true,
+      command_two_success: true,
+    }
+  end
+
+  let(:result) do
+    BasicService.call(params)
+  end
+
+  before do
+    SimpleService.configure do |config|
+      config.verbose_tracking = false
+    end
+  end
+
+  context '#call is successful' do
+    it 'returns a result object' do
+      expect(result).to be_a SimpleService::Result
+    end
+
+    it 'returns success' do
+      expect(result.success?).to eq true
+    end
+
+    it 'returns the correct result value' do
+      expect(result.value).to eq(
+        combined_foo_bar: 'combined modified FOO modified BAR'
+      )
+    end
+  end
+
+  context '#call that fails on step one' do
+    let(:result) do
+      BasicService.call(params.merge(command_one_success: false))
+    end
+
+    it 'returns a result object' do
+      expect(result).to be_a SimpleService::Result
+    end
+
+    it 'returns failure' do
+      expect(result.success?).to eq false
+      expect(result.failure?).to eq true
+    end
+
+    it 'returns the correct result value' do
+      expect(result.value).to eq(
+        message: 'stuff went wrong with command one'
+      )
+    end
+  end
+
+  context '#call that fails on step two' do
+    it 'returns the correct result value' do
+      result = BasicService.call(params.merge(command_two_success: false))
+      expect(result.value).to eq(
+        message: 'stuff went wrong with command two'
+      )
+    end
+  end
+
+  context 'LoopingService' do
+    it 'returns a result object' do
+      expect(LoopingService.call(count: 0)).to be_a SimpleService::Result
+    end
+
+    it 'returns a result object' do
+      expect(LoopingService.call(count: 0).value).to eq(count: 3)
+    end
+  end
+
+  context 'record commands' do
+    it 'records normal command execution' do
+      expect(result.recorded_commands).to eq(
+        [
+          {
+            class_name: 'BasicService',
+            command_name: :command_one,
+            success: true,
+          },
+          {
+            class_name: 'BasicService',
+            command_name: :command_two,
+            success: true,
+          },
+          {
+            class_name: 'CommandOne',
+            command_name: :modify_foo_bar,
+            success: true,
+          },
+          {
+            class_name: 'CommandTwo',
+            command_name: :combine_foo_bar,
+            success: true,
+          },
+        ]
+      )
+    end
+
+    it 'records verbose command execution' do
+      SimpleService.configure do |config|
+        config.verbose_tracking = true
+      end
+
+      expect(result.recorded_commands).to eq(
+        [
+          {
+            class_name: 'BasicService',
+            command_name: :command_one,
+            received_args: {
+              foo: 'asdf',
+              bar: 'qwer',
+              command_one_success: true,
+              command_two_success: true
+            },
+            success: {
+              foo: 'FOO',
+              bar: 'qwer',
+              command_one_success: true,
+              command_two_success: true,
+            },
+          },
+          {
+            class_name: 'BasicService',
+            command_name: :command_two,
+            received_args: {
+              foo: 'FOO',
+              bar: 'qwer',
+              command_one_success: true,
+              command_two_success: true
+            },
+            success: {
+              foo: 'FOO',
+              bar: 'BAR',
+              command_one_success: true,
+              command_two_success: true,
+            },
+          },
+          {
+            class_name: 'CommandOne',
+            command_name: :modify_foo_bar,
+            received_args: {
+              foo: 'FOO',
+              bar: 'BAR',
+              command_one_success: true,
+              command_two_success: true,
+            },
+            success: {
+              modified_foo: 'modified FOO',
+              modified_bar: 'modified BAR',
+              command_two_success: true,
+            },
+          },
+          {
+            class_name: 'CommandTwo',
+            command_name: :combine_foo_bar,
+            received_args: {
+              modified_foo: 'modified FOO',
+              modified_bar: 'modified BAR',
+              command_two_success: true,
+            },
+            success: {
+              combined_foo_bar: 'combined modified FOO modified BAR',
+            },
+          },
+        ]
+      )
+    end
+  end
 end

data/spec/support/basic_service.rb

@@ -0,0 +1,19 @@
+require_relative 'command_one'
+require_relative 'command_two'
+
+class BasicService
+  include SimpleService
+
+  command :command_one
+  command :command_two
+  commands CommandOne, CommandTwo
+
+  def command_one(**kwargs)
+    success(kwargs.merge(foo: 'FOO'))
+  end
+
+  def command_two(**kwargs)
+    success(kwargs.merge(bar: 'BAR'))
+  end
+end
+

data/spec/support/command_one.rb

@@ -0,0 +1,21 @@
+class CommandOne
+  include SimpleService
+
+  command :modify_foo_bar
+
+  def modify_foo_bar(foo:, bar:, command_one_success:, command_two_success:)
+    modified_foo = "modified #{foo}"
+    modified_bar = "modified #{bar}"
+
+    if command_one_success
+      success(
+        modified_foo: modified_foo,
+        modified_bar: modified_bar,
+        command_two_success: command_two_success,
+      )
+    else
+      failure(message: 'stuff went wrong with command one')
+    end
+  end
+end
+

data/spec/support/command_two.rb

@@ -0,0 +1,15 @@
+class CommandTwo
+  include SimpleService
+
+  command :combine_foo_bar
+
+  def combine_foo_bar(modified_foo:, modified_bar:, command_two_success:)
+    combined_foo_bar = "combined #{modified_foo} #{modified_bar}"
+
+    if command_two_success
+      success(combined_foo_bar: combined_foo_bar)
+    else
+      failure(message: 'stuff went wrong with command two')
+    end
+  end
+end

data/spec/support/looping_service.rb

@@ -0,0 +1,20 @@
+class LoopingService
+  include SimpleService
+
+  commands :add_one
+
+  def call(kwargs)
+    count = kwargs
+
+    3.times do
+      count = super(count)
+    end
+
+    count
+  end
+
+  def add_one(count:)
+    success(count: count + 1)
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_service
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Jarrod Spillers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,30 +110,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- example/hello_world.rb
-- example/nested_organizer.rb
-- example/nested_services.rb
-- example/override_organizer_call_method.rb
 - lib/simple_service.rb
-- lib/simple_service/command.rb
-- lib/simple_service/commands/validates_commands_not_empty.rb
-- lib/simple_service/commands/validates_commands_properly_inherit.rb
-- lib/simple_service/commands/validates_expected_keys.rb
-- lib/simple_service/context.rb
-- lib/simple_service/ensure_organizer_is_valid.rb
-- lib/simple_service/exceptions.rb
-- lib/simple_service/organizer.rb
-- lib/simple_service/service_base.rb
+- lib/simple_service/configuration.rb
+- lib/simple_service/result.rb
 - lib/simple_service/version.rb
 - simple_service.gemspec
-- spec/lib/command_spec.rb
-- spec/lib/commands/validates_commands_not_empty_spec.rb
-- spec/lib/commands/validates_commands_properly_inherit_spec.rb
-- spec/lib/commands/validates_expected_keys_spec.rb
-- spec/lib/ensure_organizer_is_valid_spec.rb
-- spec/lib/organizer_spec.rb
 - spec/simple_service_spec.rb
 - spec/spec_helper.rb
+- spec/support/basic_service.rb
+- spec/support/command_one.rb
+- spec/support/command_two.rb
+- spec/support/looping_service.rb
 homepage: https://github.com/jspillers/simple_service
 licenses:
 - MIT
@@ -160,12 +147,9 @@ specification_version: 4
 summary: A minimal service object composer with support for individual commands and
   top level organizer objects
 test_files:
-- spec/lib/command_spec.rb
-- spec/lib/commands/validates_commands_not_empty_spec.rb
-- spec/lib/commands/validates_commands_properly_inherit_spec.rb
-- spec/lib/commands/validates_expected_keys_spec.rb
-- spec/lib/ensure_organizer_is_valid_spec.rb
-- spec/lib/organizer_spec.rb
 - spec/simple_service_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/support/basic_service.rb
+- spec/support/command_one.rb
+- spec/support/command_two.rb
+- spec/support/looping_service.rb

data/example/hello_world.rb

@@ -1,29 +0,0 @@
-require 'rubygems'
-require 'simple_service'
-
-class ConcatName < SimpleService::Command
-  expects :first_name, :last_name
-  returns :name
-
-  def call
-    self.name = "#{first_name} #{last_name}"
-  end
-end
-
-class CreateHelloString < SimpleService::Command
-  expects :name
-  returns :hello
-
-  def call
-    self.hello = "#{name}, say hello world!"
-  end
-end
-
-class SayHello < SimpleService::Organizer
-  expects :first_name, :last_name
-  returns :hello
-  commands ConcatName, CreateHelloString
-end
-
-result = SayHello.new(first_name: 'Ruby', last_name: 'Gem').call
-puts result[:hello]

data/example/nested_organizer.rb

@@ -1,29 +0,0 @@
-require 'rubygems'
-require 'simple_service'
-
-class Increment < SimpleService::Command
-  expects :counter
-  returns :counter
-
-  def call
-    self.counter += 1
-  end
-end
-
-class IncrementCounter < SimpleService::Organizer
-  expects :counter
-  returns :counter
-  commands Increment, Increment, Increment
-end
-
-class ReallyIncrementThatCounter < SimpleService::Organizer
-  expects :counter
-  returns :counter
-  commands IncrementCounter, IncrementCounter, IncrementCounter
-end
-
-result = IncrementCounter.new(counter: 0).call
-puts "IncrementCounter: #{result[:counter]}"
-
-result = ReallyIncrementThatCounter.new(counter: 0).call
-puts "ReallyIncrementThatCounter: #{result[:counter]}"

data/example/nested_services.rb

@@ -1,29 +0,0 @@
-require 'rubygems'
-require 'simple_service'
-
-class Increment < SimpleService::Command
-  expects :counter
-  returns :counter
-
-  def execute
-    self.counter += 1
-  end
-end
-
-class IncrementCounter < SimpleService::Organizer
-  expects :counter
-  returns :counter
-  commands Increment, Increment, Increment
-end
-
-class ReallyIncrementThatCounter < SimpleService::Organizer
-  expects :counter
-  returns :counter
-  commands IncrementCounter, IncrementCounter, IncrementCounter
-end
-
-result = IncrementCounter.new(counter: 0).execute
-puts "IncrementCounter: #{result[:counter]}"
-
-result = ReallyIncrementThatCounter.new(counter: 0).execute
-puts "ReallyIncrementThatCounter: #{result[:counter]}"

data/example/override_organizer_call_method.rb

@@ -1,39 +0,0 @@
-require 'rubygems'
-require 'simple_service'
-
-class ConcatAnotherName < SimpleService::Command
-  expects :first_name, :last_name
-  returns :name
-
-  def call
-    self.name = "#{first_name} #{last_name}"
-  end
-end
-
-class CreateAnotherHelloString < SimpleService::Command
-  expects :name
-  returns :hello
-
-  def call
-    self.hello ||= ''
-    self.hello += "#{name}, say hello world!"
-  end
-end
-
-class SayHelloMultipleTimes < SimpleService::Organizer
-  expects :first_name, :last_name, :num_times
-  returns :hello
-  commands ConcatAnotherName, CreateAnotherHelloString
-
-  # overriding the #call method on the organizer allows
-  # you to do things like loop and call the service commands
-  # multiple times
-  def call
-    num_times.times do
-      super
-    end
-  end
-end
-
-result = SayHelloMultipleTimes.new(first_name: 'Ruby', last_name: 'Gem', num_times: 3).call
-puts result[:hello]