responsive_service 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d201035ae2b1931491a0cdefb73867927a105026
-  data.tar.gz: e18b6ce1c12afc5b857985d6d172837970d57d56
+  metadata.gz: 5613d9e5f1add88d5b60cbe10659ac1fe968d815
+  data.tar.gz: eb8e0e330a4d96a647a7bf72aa5c5146e4e328ba
 SHA512:
-  metadata.gz: 4c24e42a63f3fe65f9600afb95b700e261aa301c1a1ca7d6463d880cf348b79fec0f4eaee4bdbbec1d9094ece7471c630bd5b20059d2d7ad85a54d686dd950b8
-  data.tar.gz: 725f27ea43686a14e3bd3ab6eb9655e595a90b29f605458543b8b7f261ad7b4597d3872b35c49bc29141be431aaaaabd8734712e4ffa12a2b2c9700184e41475
+  metadata.gz: 739afba739f4c4beceb23d53e0cb52c8817240503b6d0eea4955a90df32e6e9187328e4830f0ee6c7b5d54efda1418371f3c4138ea1c81cf3d6499eb8d6d9724
+  data.tar.gz: 7dcc8dd1aa178e2519ff7c0e9e34dbdd36955b81c1e56f75c1547923a0daaa7874df6c2cecd9df3c1a7a51689e11e9d9beed330bbde720997f216f6e277ebfac

data/README.md

@@ -19,30 +19,61 @@ Or install it yourself as:
 
 ## Usage
 
+### ResponsiveService
+
 Create a service class, either your own or feel free to subclass from `ResponsiveService::ResponsiveService`.
 
 ```ruby
 class MyService < ResponsiveService::ResponsiveService
   def call(&block)
     # do some work
-    yield ResponsiveService::Responder.new(:success)
+    yield ResponsiveService::Response.new(:success)
   end
 end
 ```
 
 You must implement a `call` method if you subclass `ResponsiveService::ResponsiveService`.
-Your call method should yield with a `ResponsiveService::Responder`.
+Your call method should yield with a `ResponsiveService::Response`.
+
+### Response
+
+A `ResponsiveService::Response` can take up to 4 arguments but must at least have the first argument which is the type of the response. In addition it can take a message, a context, and a set of valid states. The message by convention should
+be a string but there are no restrictions. The context can be any object. The valid states should be an array of symbols
+that are the allowed states. An exception will be thrown if initialized with a type of response that is not in the valid states if a set of valid states was specified.
+
+```ruby
+response = Response.new(:success, 'You win!', {an_important_value: 'some value'})
+response.type    # :success
+response.message # 'You win!'
+response.context  # {an_important_value: 'some value'}
+
+response.success { puts 'I succeeded' }  # I succeeded
+response.failure { puts 'I failed' }     # nil
 
-A `ResponsiveService::Responder` can take up to 3 arguments but must at least have the first argument which is the type of the response. In addition it can take a message and a context. The message by convention should
-be a string but there are no restrictions. The context can be any object.
+response = Response.new(:foo, 'FOO!', {}, [:success, :failure])
+# exception => Invalid type of response: foo
+
+response = Response.new(:success, '', {}, [:success, :failure])
+response.foo { puts 'Not going to work' }
+# exception => NoMethodError: undefined method `foo'
+```
+
+You can also choose to subclass `ResponsiveService::Response` and define valid states for all instances of that class.
 
 ```ruby
-responder = Responder.new(:success, 'You win!', {an_important_value: 'some value'})
-responder.type    # :success
-responder.message # 'You win!'
-responder.context  # {an_important_value: 'some value'}
+class MyResponse < ResponsiveService::Response
+  valid_states :success, :failure
+end
+
+response = MyResponse.new(:success)
+response.success { puts 'I succeeded' }  # I succeeded
+response.failure { puts 'I failed' }     # nil
+response.foo { puts 'Not going to work' }
+# exception => NoMethodError: undefined method `foo'
 ```
 
+### Your service API
+
 Your service can now be used as such:
 
 ```ruby

data/lib/responsive_service/version.rb

@@ -1,3 +1,3 @@
 module ResponsiveService
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/responsive_service.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = 'responsive_service'
   spec.version       = ResponsiveService::VERSION
   spec.authors       = ['alexpeachey']
-  spec.email         = ['alex.peachey@gmail.com']
-  spec.description   = 'Easy to use responsive service pattern'
-  spec.summary       = 'Easy to use responsive service pattern'
-  spec.homepage      = 'http://github.com/alexpeachey/responsive_service'
+  spec.email         = ['alex.peachey@originate.com']
+  spec.description   = 'Easy to use response state pattern'
+  spec.summary       = 'Easy to use response state pattern'
+  spec.homepage      = 'http://github.com/Originate/response_state'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: responsive_service
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - alexpeachey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,9 +66,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Easy to use responsive service pattern
+description: Easy to use response state pattern
 email:
-- alex.peachey@gmail.com
+- alex.peachey@originate.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -87,7 +87,7 @@ files:
 - spec/lib/responsive_service/response_spec.rb
 - spec/lib/responsive_service/responsive_service_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/alexpeachey/responsive_service
+homepage: http://github.com/Originate/response_state
 licenses:
 - MIT
 metadata: {}
@@ -107,10 +107,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Easy to use responsive service pattern
+summary: Easy to use response state pattern
 test_files:
 - spec/lib/responsive_service/response_spec.rb
 - spec/lib/responsive_service/responsive_service_spec.rb