response_state 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07191e8d424f92fed0fef312a55e39af9bfb7167
+  data.tar.gz: 704aa92961c5bed9a8b6f3214ec81c8d16c75dd8
+SHA512:
+  metadata.gz: 5f98c261f52b66717c562f1b3c76bbf761971ad7b9154468c7618a5ca6aaa876a8151f2de684e0a7a3ce3bb11ca1aa7ae79e401597f0f3a2eb82f375c7d406c6
+  data.tar.gz: 35943cdbbc29d7145b80718b6b812cbd3a52c00450f584ed762efdd36733984c9ff1eee10abaa229bdba2e27c66094f5e3dd009d64455680b691ca1cc5c0f8f4

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+.ruby-gemset
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in responsive_service.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 alexpeachey
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# Response State
+
+The Response State gem is an implementation of the Response State pattern by @brianvh
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'response_state'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install response_state
+
+## Usage
+
+### ResponseState::Service
+
+Create a service class and subclass ResponseState::Service.
+
+```ruby
+class MyService < ResponseState::Service
+  def initialize(param)
+    @param = param
+  end
+
+  def call(&block)
+    # do some work
+    yield ResponseState::Response.new(:success)
+  end
+end
+```
+
+You must implement a `call` method.
+Your call method should yield with a `ResponseState::Response`.
+
+### Response
+
+A `ResponseState::Response` can take up to 4 arguments but must at least have the first argument which is the state 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
+
+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 `ResponseState::Response` and define valid states for all instances of that class.
+If you want to only allow certain states, this is the prefered method,
+rather than passing the 4th argument in the construction of the object.
+
+```ruby
+class MyResponse < ResponseState::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
+MyService.('Some param') do |response|
+  response.success { puts 'I was successful.' }
+  response.failure { puts 'I failed.' }
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'response_state'
+  ARGV.clear
+  IRB.start
+end

data/lib/response_state/response.rb

@@ -0,0 +1,37 @@
+module ResponseState
+  class Response
+    attr_reader :state, :message, :context, :valid_states
+
+    def initialize(state, message=nil, context=nil, valid_states=nil)
+      @valid_states = Array(valid_states || self.class.class_valid_states)
+      raise "Invalid state of response: #{state}" unless (@valid_states.empty? || @valid_states.include?(state))
+      @state = state
+      @context = context
+      @message = message
+    end
+
+    def self.valid_states(*args)
+      @class_valid_states = Array(args)
+    end
+
+    def self.class_valid_states
+      @class_valid_states
+    end
+
+    def method_missing(method, *args, &block)
+      if validate_state?(method)
+        yield if method == state
+      else
+        super
+      end
+    end
+
+    private
+
+    def validate_state?(call_state)
+      return true if valid_states.empty?
+      return true if valid_states.include?(call_state)
+      raise "Invalid state: #{call_state}"
+    end
+  end
+end

data/lib/response_state/service.rb

@@ -0,0 +1,12 @@
+module ResponseState
+  class Service
+
+    def self.call(*args, &block)
+      self.new(*args).call(&block)
+    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")
+    end
+  end
+end

data/lib/response_state/version.rb

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

data/lib/response_state.rb

@@ -0,0 +1,6 @@
+require 'response_state/version'
+require 'response_state/response'
+require 'response_state/service'
+
+module ResponseState
+end

data/response_state.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'response_state/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'response_state'
+  spec.version       = ResponseState::VERSION
+  spec.authors       = ['alexpeachey']
+  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")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/features/full_example_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+class MyResponse < ResponseState::Response
+  valid_states :success, :failure
+end
+
+class MyService < ResponseState::Service
+  attr_reader :object, :pass
+
+  def initialize(object, pass)
+    @object = object
+    @pass = pass
+  end
+
+  def call
+    yield (success_response or failure_response)
+  end
+
+  private
+
+  def success_response
+    return unless pass
+    MyResponse.new(:success, 'Yay! It works.', object)
+  end
+
+  def failure_response
+    MyResponse.new(:failure, 'Boo! It failed.')
+  end
+end
+
+describe 'Using the service' do
+  let(:object) { Object.new }
+  let(:yielded) { OpenStruct.new(message: nil, context: nil) }
+  before do
+    MyService.(object, pass) do |response|
+      response.success { yielded.message = response.message; yielded.context = response.context }
+      response.failure { yielded.message = response.message; yielded.context = response.context }
+    end
+  end
+
+  context 'when pass is true' do
+    let(:pass) { true }
+
+    it 'has a happy message' do
+      expect(yielded.message).to eq 'Yay! It works.'
+    end
+
+    it 'has a valid context' do
+      expect(yielded.context).to eq object
+    end
+  end
+
+  context 'when pass is false' do
+    let(:pass) { false }
+
+    it 'has a sad message' do
+      expect(yielded.message).to eq 'Boo! It failed.'
+    end
+
+    it 'has a nil context' do
+      expect(yielded.context).to eq nil
+    end
+  end
+end

data/spec/lib/response_state/response_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+
+module ResponseState
+  describe Response do
+    subject(:response) { Response.new(state) }
+    let(:state) { :success }
+    before { Response.instance_variable_set :@class_valid_states, nil }
+
+    it 'yields when sent :success with a state of :success' do
+      expect { |b| response.success(&b) }.to yield_control
+    end
+
+    it 'does not yield when sent :failure with a state of :success' do
+      expect { |b| response.failure(&b) }.not_to yield_control
+    end
+
+    context 'when initialized with a message' do
+      subject(:response) { Response.new(state, message) }
+      let(:message) { double(:message) }
+
+      specify { expect(response.message).to eq message }
+
+      context 'when additionally initialized with a context' do
+        subject(:response) { Response.new(state, message, context) }
+        let(:context) { double(:context) }
+
+        specify { expect(response.context).to eq context }
+
+        context 'when additionally initiaized with a set of valid states' do
+          subject(:response) { Response.new(state, message, context, valid_states) }
+          let(:valid_states) { [:success, :failure] }
+
+          it 'yields when sent :success with a state of :success' do
+            expect { |b| response.success(&b) }.to yield_control
+          end
+
+          it 'does not yield when sent :failure with a state of :success' do
+            expect { |b| response.failure(&b) }.not_to yield_control
+          end
+
+          it 'throws method missing exception if sent a non-valid state' do
+            expect { |b| response.foo(&b) }.to raise_exception
+          end
+
+          it 'reflects the valid_states' do
+            expect(response.valid_states).to eq [:success, :failure]
+          end
+
+          context 'when initialized with an invalid state' do
+            let(:state) { :foo }
+            
+            it 'raises an exception' do
+              expect { response }.to raise_exception('Invalid state of response: foo')
+            end
+          end
+        end
+      end
+    end
+
+    describe '.valid_states' do
+      context 'when set to an array of states' do
+        before { Response.valid_states(:success, :failure) }
+
+        context 'when the response state is :success' do
+          subject(:response) { Response.new(:success) }
+
+          it 'yields when sent :success' do
+            expect { |b| response.success(&b) }.to yield_control
+          end
+
+          it 'does not yield when sent :failure' do
+            expect { |b| response.failure(&b) }.not_to yield_control
+          end
+
+          it 'throws method missing exception if sent a non-valid state' do
+            expect { |b| response.foo(&b) }.to raise_exception
+          end
+        end
+
+        context 'when initialized with an invalid state' do
+          subject(:response) { Response.new(:foo) }
+          
+          it 'raises an exception' do
+            expect { response }.to raise_exception('Invalid state of response: foo')
+          end
+        end
+
+        describe '#valid_states' do
+          subject(:response) { Response.new(:success) }
+
+          it 'reflects the valid_states' do
+            expect(response.valid_states).to eq [:success, :failure]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/response_state/service_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'ostruct'
+
+module ResponseState
+  describe Service do
+    subject(:service) { Service.new }
+    before { Response.instance_variable_set :@class_valid_states, nil }
+
+    describe '.call' do
+      it 'news up an instance and passes the block on to #call' do
+        expect { |b| Service.(&b) }.to yield_control
+      end
+    end
+
+    describe '#call' do
+      let(:yielded) { OpenStruct.new(response: nil) }
+      let(:response) { yielded.response }
+      before { service.call { |response| yielded.response = response} }
+
+      it 'yields an unimplemented response' do
+        expect(response.state).to eq :unimplemented
+      end
+
+      it 'yields with a response indicating instructions' do
+        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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+
+SimpleCov.start do
+  command_name     'spec'
+  add_filter       'config/'
+  add_filter       'spec'
+  add_filter       '.bundle'
+  minimum_coverage 100
+end
+
+require 'rspec'
+require 'response_state'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: response_state
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- alexpeachey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy to use response state pattern
+email:
+- alex.peachey@originate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/response_state.rb
+- lib/response_state/response.rb
+- lib/response_state/service.rb
+- lib/response_state/version.rb
+- response_state.gemspec
+- spec/features/full_example_spec.rb
+- spec/lib/response_state/response_spec.rb
+- spec/lib/response_state/service_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Originate/response_state
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Easy to use response state pattern
+test_files:
+- spec/features/full_example_spec.rb
+- spec/lib/response_state/response_spec.rb
+- spec/lib/response_state/service_spec.rb
+- spec/spec_helper.rb