response_state 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07191e8d424f92fed0fef312a55e39af9bfb7167
-  data.tar.gz: 704aa92961c5bed9a8b6f3214ec81c8d16c75dd8
+  metadata.gz: 4e0cea61825ed6f590a0b2510a4a6a0f368e4b93
+  data.tar.gz: d7e616a314b7073920d2be12b22724a4166f75cf
 SHA512:
-  metadata.gz: 5f98c261f52b66717c562f1b3c76bbf761971ad7b9154468c7618a5ca6aaa876a8151f2de684e0a7a3ce3bb11ca1aa7ae79e401597f0f3a2eb82f375c7d406c6
-  data.tar.gz: 35943cdbbc29d7145b80718b6b812cbd3a52c00450f584ed762efdd36733984c9ff1eee10abaa229bdba2e27c66094f5e3dd009d64455680b691ca1cc5c0f8f4
+  metadata.gz: d530ace92af0e4e98345fbacaf69cb02047dfe6c6f11a2352794796d14b25a55b2badd9cb36cf345c9328c7d58866eb51c8b1b1d37427a44f1e587c14d690944
+  data.tar.gz: 3cfc434592e2ab21ba32d25f5374cb1cbcaa604f9a8c73cae9597560fe9d7468f7633b3553d860c3ee56ab524050ca55112d871ffcab955128b943e1eef622e6

data/README.md

@@ -30,13 +30,14 @@ class MyService < ResponseState::Service
 
   def call(&block)
     # do some work
-    yield ResponseState::Response.new(:success)
+    yield send_state(:success)
   end
 end
 ```
 
 You must implement a `call` method.
 Your call method should yield with a `ResponseState::Response`.
+The response can be generated with a helper method `send_state` in your service class.
 
 ### Response
 

data/lib/response_state/response.rb

@@ -34,4 +34,4 @@ module ResponseState
       raise "Invalid state: #{call_state}"
     end
   end
-end
+end

data/lib/response_state/service.rb

@@ -6,7 +6,11 @@ module ResponseState
     end
 
     def call(&block)
-      yield Response.new(:unimplemented, "A ResponseState::Service should implement the call method.\nThe call method should perform the relevant work of the service and yield a ResponseState::Response object.\n")
+      yield send_state(:unimplemented, "A ResponseState::Service should implement the call method.\nThe call method should perform the relevant work of the service and yield a ResponseState::Response object.\n")
+    end
+
+    def send_state(state, message=nil, context=nil, valid_states=nil)
+      ResponseState::Response.new(state, message, context, valid_states)
     end
   end
-end
+end

data/lib/response_state/version.rb

@@ -1,3 +1,3 @@
 module ResponseState
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/lib/response_state/service_spec.rb

@@ -25,5 +25,87 @@ module ResponseState
         expect(response.message).to eq "A ResponseState::Service should implement the call method.\nThe call method should perform the relevant work of the service and yield a ResponseState::Response object.\n"
       end
     end
+
+    describe '#send_state' do
+      context 'given :success, "a message", {}, [:success, :failure]' do
+        let(:response) { service.send_state(:success, 'a message', {}, [:success, :failure]) }
+
+        it 'has a success state' do
+          expect(response.state).to eq :success
+        end
+
+        it 'has the message "a message"' do
+          expect(response.message).to eq 'a message'
+        end
+
+        it 'has the context {}' do
+          expect(response.context).to eq Hash.new
+        end
+
+        it 'has valid_states [:success, :failure]' do
+          expect(response.valid_states).to eq [:success, :failure]
+        end
+      end
+
+      context 'given :success, "a message", {}' do
+        let(:response) { service.send_state(:success, 'a message', {}) }
+
+        it 'has a success state' do
+          expect(response.state).to eq :success
+        end
+
+        it 'has the message "a message"' do
+          expect(response.message).to eq 'a message'
+        end
+
+        it 'has the context {}' do
+          expect(response.context).to eq Hash.new
+        end
+
+        it 'has valid_states nil' do
+          expect(response.valid_states).to eq []
+        end
+      end
+
+      context 'given :success, "a message"' do
+        let(:response) { service.send_state(:success, 'a message') }
+
+        it 'has a success state' do
+          expect(response.state).to eq :success
+        end
+
+        it 'has the message "a message"' do
+          expect(response.message).to eq 'a message'
+        end
+
+        it 'has the context nil' do
+          expect(response.context).to be_nil
+        end
+
+        it 'has valid_states nil' do
+          expect(response.valid_states).to eq []
+        end
+      end
+
+      context 'given :success' do
+        let(:response) { service.send_state(:success) }
+
+        it 'has a success state' do
+          expect(response.state).to eq :success
+        end
+
+        it 'has the message nil' do
+          expect(response.message).to be_nil
+        end
+
+        it 'has the context nil' do
+          expect(response.context).to be_nil
+        end
+
+        it 'has valid_states nil' do
+          expect(response.valid_states).to eq []
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: response_state
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - alexpeachey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-16 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler