responsive_service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e260d3381714a7a7260e52ace95f3468db7670f3
+  data.tar.gz: 150db5b50d0a77943a02678e037b0d28df22b560
+SHA512:
+  metadata.gz: 01a7ce6348cf94b5496142e5ba0ed1c7d817a565a4a85c5497ca98f505c9d5f560557dfff919d7791467b22b87585ff0fa331c0f5df441d6c7df86c92b17122b
+  data.tar.gz: 7f9f2b025e83cf696a5eda50360bb70faec7e83b8d05434e3123b57d0baaffb27bde5930921b9d06476fd1c2bf1cdd335c19181d4731046ce260ea9ddffd16cd

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,62 @@
+# ResponsiveService
+
+The ResponsiveService gem is at this point little more than a light wrapper on a suggested pattern
+for implementing service classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'responsive_service'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install responsive_service
+
+## Usage
+
+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)
+  end
+end
+```
+
+You must implement a `call` method if you subclass `ResponsiveService::ResponsiveService`.
+Your call method should yield with a `ResponsiveService::Responder`.
+
+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.
+
+```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'}
+```
+
+Your service can now be used as such:
+
+```ruby
+service = MyService.new
+service.call 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 @@
+require "bundler/gem_tasks"

data/lib/responsive_service/responder.rb

@@ -0,0 +1,16 @@
+module ResponsiveService
+  class Responder
+
+    attr_reader :type, :message, :context
+
+    def initialize(type, message=nil, context=nil)
+      @type = type
+      @context = context
+      @message = message
+    end
+
+    def method_missing(method, *args, &block)
+      yield if method == type
+    end
+  end
+end

data/lib/responsive_service/responsive_service.rb

@@ -0,0 +1,7 @@
+module ResponsiveService
+  class ResponsiveService
+    def call(&block)
+      yield Responder.new(:unimplemented, "A ResponsiveService should implement the call method.\nThe call method should perform the relevant work of the service and yield a ResponsiveService::Responder object.\n")
+    end
+  end
+end

data/lib/responsive_service/version.rb

@@ -0,0 +1,3 @@
+module ResponsiveService
+  VERSION = "0.0.1"
+end

data/lib/responsive_service.rb

@@ -0,0 +1,6 @@
+require "responsive_service/version"
+require "responsive_service/responsive_service"
+require "responsive_service/responder"
+
+module ResponsiveService
+end

data/responsive_service.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'responsive_service/version'
+
+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.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/lib/responsive_service/responder_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module ResponsiveService
+  describe Responder do
+    subject(:responder) { Responder.new(type) }
+    let(:type) { :success }
+
+    it 'yields when sent :success with a type of :success' do
+      expect { |b| responder.success(&b) }.to yield_control
+    end
+
+    it 'does not yield when sent :failure with a type of :success' do
+      expect { |b| responder.failure(&b) }.to_not yield_control
+    end
+
+    context 'when initialized with a message' do
+      subject(:responder) { Responder.new(type, message) }
+      let(:message) { double(:message) }
+
+      specify { expect(responder.message).to eq message }
+
+      context 'when additionally initialized with a context' do
+        subject(:responder) { Responder.new(type, message, context) }
+        let(:context) { double(:context) }
+
+        specify { expect(responder.context).to eq context }
+      end
+    end
+  end
+end

data/spec/lib/responsive_service/responsive_service_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module ResponsiveService
+  describe ResponsiveService do
+    subject(:service) { ResponsiveService.new }
+
+    describe '#call' do
+      it 'yields with a responder indicating instructions' do
+        service.call do |response|
+          expect(response.type).to eq :unimplemented
+          expect(response.message).to eq "A ResponsiveService should implement the call method.\nThe call method should perform the relevant work of the service and yield a ResponsiveService::Responder object.\n"
+        end
+      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 'responsive_service'
+
+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,117 @@
+--- !ruby/object:Gem::Specification
+name: responsive_service
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- alexpeachey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-26 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 responsive service pattern
+email:
+- alex.peachey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/responsive_service.rb
+- lib/responsive_service/responder.rb
+- lib/responsive_service/responsive_service.rb
+- lib/responsive_service/version.rb
+- responsive_service.gemspec
+- spec/lib/responsive_service/responder_spec.rb
+- spec/lib/responsive_service/responsive_service_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/alexpeachey/responsive_service
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Easy to use responsive service pattern
+test_files:
+- spec/lib/responsive_service/responder_spec.rb
+- spec/lib/responsive_service/responsive_service_spec.rb
+- spec/spec_helper.rb