plain_service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc597e6835083bc0cd92c2d93857f4f30b4aa96f
+  data.tar.gz: 5a2636f49606ec957874ac45ea1ef09570ec47df
+SHA512:
+  metadata.gz: 01589ce872ad275d1f48c0157ec035380d3adc3e1a3e9dc82668bfc9565d0144f57c2002f64955d7292c02cecb208c3812bd055df0f5ecdbec7b0d0e6bf437aa
+  data.tar.gz: 2b5692a39468b23c9246b630abff2aadbd8e2efb931ae9840e013266dc5191d1c2f11328e6a4d1a06dedb971ec645d89a7eddb7167493ec51a912a021767a28c

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "2.1.3"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in plain_service.gemspec
+gemspec
+
+gem 'virtus'
+gem 'activemodel', '>= 3.2'
+gem 'activesupport', '>= 3.2'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 yratanov
+
+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,93 @@
+# PlainService
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'plain_service'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plain_service
+
+## Why?
+
+To keep your controller and model thin.
+
+## Usage
+
+Example (simple password change service):
+
+1. Define your service: 
+  
+  ```ruby
+  # app/services/user_service/change_password
+  
+  module UserService
+    class ChangePassword
+      attribute :user  
+      attribute :password  
+      attribute :password_confirmation
+        
+      validates :password, presence: true, confirmation: true
+      
+      def process
+        user.password = password
+        user.save
+      end
+    end
+  end
+  ```
+2. Use it in your controller:
+
+  ```ruby
+  def change_password
+    change_password = UserService::ChangePassword.new(params)
+    change_password.user = current_user
+    
+    # you can also call UserService::ChangePassword.perform(params) as shortcut
+    
+    if change_password.perform
+      render #good response
+    else
+      render #bad response, see change_password.errors to get standard rails Errors object
+    end
+  end
+  ```
+
+Advantages of such approach: 
+
+1. Simple and readable controller code. All action-related logic will be in service object.
+2. Validations that are related with specific action also hidden in service to keep model clean and easy to use.
+3. Easy to test. No callback hell, just plain ruby object.
+  
+# Passing errors from model to service
+
+Sometimes you want to have some specific model errors in service object. For example you are saving model with uniqueness validation on some field. Then you can do the following:
+
+```ruby
+def process
+ if user.save
+   true
+ else
+   pass_errors_from user
+   false
+ end
+end
+
+# usage
+service.perform
+service.errors # => will include all errors from user object 
+```
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/plain_service/base.rb

@@ -0,0 +1,35 @@
+require 'virtus'
+require 'active_model'
+
+module PlainService
+  class Base
+    include Virtus.model
+    include ActiveModel::Validations
+
+    def self.perform(params)
+      new(params).perform
+    end
+
+    def perform
+      if valid?
+        process
+      else
+        false
+      end
+    end
+
+    # Should return whether true or false value depending on success/fail status of service object actions
+    def process
+      raise NotImplementedError('You should implement #process method in your child class')
+    end
+
+    protected
+
+    # Use it if you want to delegate errors from underlying object to service
+    def pass_errors_from(object)
+      object.errors.each do |key, error|
+        errors.add key, error
+      end
+    end
+  end
+end

data/lib/plain_service/version.rb

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

data/lib/plain_service.rb

@@ -0,0 +1,5 @@
+require "plain_service/version"
+
+module PlainService
+  # Your code goes here...
+end

data/plain_service.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plain_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "plain_service"
+  spec.version       = PlainService::VERSION
+  spec.authors       = ["yratanov"]
+  spec.email         = ["organium@gmail.com"]
+  spec.description   = "Plain Service object implementation"
+  spec.summary       = "Base class for your service objects"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"
+end

data/spec/plain_service/base_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe PlainService::Base do
+  subject { described_class.new(params) }
+  let(:params) { {} }
+
+  context '#perform' do
+    context 'valid' do
+      before do
+        allow(subject).to receive(:valid?).and_return true
+      end
+
+      context 'process succeeds' do
+        before do
+          allow(subject).to receive(:process).and_return true
+        end
+
+        it 'should be truthy' do
+          expect(subject.perform).to be_truthy
+        end
+      end
+
+      context 'process fails' do
+        before do
+          allow(subject).to receive(:process).and_return false
+        end
+
+        it 'should be falsey' do
+          expect(subject.perform).to be_falsey
+        end
+      end
+    end
+
+    context 'invalid' do
+      before do
+        allow(subject).to receive(:valid?).and_return false
+      end
+
+      it 'should be falsey' do
+        expect(subject.perform).to be_falsey
+      end
+    end
+  end
+
+  context '.perform' do
+    it 'should instantiate and perform' do
+      expect(PlainService::Base).
+        to receive(:new).with(params).and_call_original
+      expect_any_instance_of(PlainService::Base).
+        to receive(:perform).and_return true
+
+      expect(described_class.perform(params)).to be_truthy
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'plain_service'
+require 'plain_service/base'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: plain_service
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- yratanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-12 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'
+description: Plain Service object implementation
+email:
+- organium@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/plain_service.rb
+- lib/plain_service/base.rb
+- lib/plain_service/version.rb
+- plain_service.gemspec
+- spec/plain_service/base_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Base class for your service objects
+test_files:
+- spec/plain_service/base_spec.rb
+- spec/spec_helper.rb