simple_service 1.3.8 → 1.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53bc7180191d536a538cebcce463f372e699f9e9
-  data.tar.gz: 589d9e66591fe266abb81fb215b1570aa45fae4e
+  metadata.gz: 9d1fd9d6d46d6946f325a672bb447d015966972b
+  data.tar.gz: 3512dab5a7c70201e2f1ae10e5053edb40c5e469
 SHA512:
-  metadata.gz: 2c1202dc463df6be66e8349f8c5d93c6bbf612ef5b4757f3805a83be6ee355cb5fd84d1b1ced17e9e431eaff6e7b45ed52bf65a11e7212d9552cd46c380af6f7
-  data.tar.gz: 2f6724c18598ca132e6f1a157bb9050ce05beb1b14dc4fc3601f959c8d68a10beaa5cb7981ec54cb7ed1ffebd0915a3961abd86752c179612a2e551e7a69052b
+  metadata.gz: 20464b3d21dfb4258b0a615c6a579949f83b33ca35f016a2f77e003433041f3e187577478cfeb5497051304eb163cd92f2a458368830f9f07a39eded82e28073
+  data.tar.gz: 87fcc9920a8534a960210a54eb4bbe15b121189d96ce3d6c117eec81200e762aff88d300c39da58846de1bf7ed0108f681d6136636326024e5a92397b27fba2d

data/lib/simple_service/exceptions.rb

@@ -5,4 +5,6 @@ module SimpleService
   class ExpectedKeyError < StandardError; end;
   class CallNotDefinedError < StandardError; end;
   class ReturnKeyError < StandardError; end;
+  class InvalidArgumentError < StandardError; end;
+
 end

data/lib/simple_service/organizer.rb

@@ -6,8 +6,8 @@ module SimpleService
 
     attr_accessor :context
 
-    def initialize(context = {})
-      @context = context
+    def initialize(_context = {})
+      @context = validate_context(_context)
 
       symbolize_context_keys
       setup_call_chain
@@ -41,11 +41,16 @@ module SimpleService
             context
           end
 
+          # also merge any optional keys
+          command.get_optional.each do |key|
+            _context[key] = context[key]
+          end
+
           # instantiate and call the command
-          new_context = command.new(_context).call
+          resulting_context = command.new(_context).call
 
           # update the master context with the results of the command
-          @context.merge!(new_context)
+          @context.merge!(resulting_context)
         end
       end
     end
@@ -58,6 +63,15 @@ module SimpleService
 
     private
 
+    def validate_context(_context)
+      unless _context.class == Hash
+        raise InvalidArgumentError,
+          "Hash required as argument, but was given a #{_context.class}"
+      end
+
+      _context
+    end
+
     def with_validation
       # don't mess with the context if we are doing internal validation
       add_validation_keys_to_context unless skip_validation

data/lib/simple_service/service_base.rb

@@ -10,6 +10,14 @@ module SimpleService
         @expects || []
       end
 
+      def optional(*args)
+        @optional = args
+      end
+
+      def get_optional
+        @optional || []
+      end
+
       def returns(*args)
         @returns = args
       end
@@ -101,6 +109,10 @@ module SimpleService
         self.class.get_expects
       end
 
+      def optional
+        self.class.get_optional
+      end
+
       def returns
         self.class.get_returns
       end
@@ -110,7 +122,7 @@ module SimpleService
       end
 
       def all_context_keys
-        (expects + returns + ['message', 'success']).uniq
+        (expects + optional + returns + ['message', 'success']).uniq
       end
 
       def organizer?

data/lib/simple_service/version.rb

@@ -1,3 +1,3 @@
 module SimpleService
-  VERSION = '1.3.8'
+  VERSION = '1.3.9'
 end

data/spec/lib/command_spec.rb

@@ -4,10 +4,11 @@ describe SimpleService::Command do
 
   class ValidCommand < SimpleService::Command
     expects :foo, :bar
+    optional :stuff
     returns :bar, :baz
     def call
       context.merge!(
-        bar: 'modified',
+        bar: ['modified', self.stuff].compact.join(' '),
         baz: 'blah'
       )
     end
@@ -31,6 +32,12 @@ describe SimpleService::Command do
       ).to eql(bar: 'modified', baz: 'blah')
     end
 
+    it 'provides optional arguments as getters' do
+      expect(
+        ValidCommand.call(foo: 'blah', bar: 'meh', stuff: 'something')
+      ).to eql(bar: 'modified something', baz: 'blah')
+    end
+
   end
 
   describe '#call' do

data/spec/lib/organizer_spec.rb

@@ -2,26 +2,29 @@ require 'spec_helper'
 
 describe SimpleService::Organizer do
 
-  context 'classes with expects and returns' do
+  context 'classes with .expects, .optional, and .returns' do
 
     class TestCommandOne < SimpleService::Command
       expects :foo
+      optional :blah
       returns :foo, :bar
       def call
-        context.merge!(bar: 'bar')
+        context.merge!(bar: ['bar', self.blah].compact.join(' '))
       end
     end
 
     class TestCommandTwo < SimpleService::Command
       expects :foo, :bar
+      optional :blarg
       returns :foo, :bar, :baz
       def call
-        context.merge!(baz: 'baz')
+        context.merge!(baz: ['baz', self.blarg].compact.join(' '))
       end
     end
 
     class TestOrganizer < SimpleService::Organizer
       expects :foo
+      optional :blah, :blarg
       returns :foo, :bar, :baz
       commands TestCommandOne, TestCommandTwo
     end
@@ -32,6 +35,12 @@ describe SimpleService::Organizer do
           TestOrganizer.call(foo: 'foo')
         ).to eql(foo: 'foo', bar: 'bar', baz: 'baz', success: true)
       end
+
+      it 'returns the correct hash when optional arguments provided' do
+        expect(
+          TestOrganizer.call(foo: 'foo', blah: 'blah', blarg: 'blarg')
+        ).to eql(foo: 'foo', bar: 'bar blah', baz: 'baz blarg', success: true)
+      end
     end
 
     describe '#call' do
@@ -149,4 +158,24 @@ describe SimpleService::Organizer do
 
   end
 
+  context 'when arguments are not a hash' do
+
+    class DoNothingCommand < SimpleService::Command
+      def call
+        'do nothing'
+      end
+    end
+
+    class DoNothingOrganizer < SimpleService::Organizer
+      commands DoNothingCommand
+    end
+
+    it 'raises an error' do
+      expect { DoNothingOrganizer.new('not a hash').call }.to raise_error(
+        SimpleService::InvalidArgumentError,
+        'Hash required as argument, but was given a String'
+      )
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_service
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.3.9
 platform: ruby
 authors:
 - Jarrod Spillers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler