light-services 0.4.0 → 0.5.0

data/.ruby-gemset

@@ -0,0 +1 @@
+light-services

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+2.4.1

data/.travis.yml

@@ -1,17 +1,29 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=dedf6049120e32b166263dd9e07b2abea3991a18b2d0c8dc86792776ca7578ce
+    - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
 sudo: false
 language: ruby
-
 rvm:
-  - 2.3.3
-
-before_install: gem install bundler -v 1.12.5
-
+  - 2.4.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+before_install: gem install bundler
 gemfile:
   - gemfiles/rails_4_0.gemfile
   - gemfiles/rails_4_1.gemfile
   - gemfiles/rails_4_2.gemfile
   - gemfiles/rails_5_0.gemfile
-
-addons:
-  code_climate:
-    repo_token: dedf6049120e32b166263dd9e07b2abea3991a18b2d0c8dc86792776ca7578ce
+  - gemfiles/rails_5_1.gemfile
+script:
+  - bundle exec rake
+after_script:
+  # Preferably you will run test-reporter on branch update events. But
+  # if you setup travis to build PR updates only, you don't need to run
+  # the line below
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi
+  # In the case where travis is setup to build PR updates only,
+  # uncomment the line below
+  # - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'rails-4-0' do
   gem 'rails', '4.0.13'
 end
@@ -11,6 +13,9 @@ appraise 'rails-4-2' do
 end
 
 appraise 'rails-5-0' do
-  gem 'rails', '5.0.0.rc1'
+  gem 'rails', '5.0.5'
 end
 
+appraise 'rails-5-1' do
+  gem 'rails', '5.1.3'
+end

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in light-services.gemspec

data/README.md

@@ -4,18 +4,18 @@
 [![Code Climate](https://codeclimate.com/github/light-ruby/light-services/badges/gpa.svg)](https://codeclimate.com/github/light-ruby/light-services)
 [![Test Coverage](https://codeclimate.com/github/light-ruby/light-services/badges/coverage.svg)](https://codeclimate.com/github/light-ruby/light-services/coverage)
 
-# WARNING! GEM IN DEVELOPMENT!
+Implementation of Service Object Pattern for Ruby/Rails. Compatible with Rails 5.1 and 5.0, 4.2, 4.1, 4.0.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/light/service`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Service Object Pattern – What is it? Check it here:
+- [Wikipedia](https://en.wikipedia.org/wiki/Service_layer_pattern)
+- [Essential RubyOnRails patterns — part 1: Service Objects](https://medium.com/selleo/essential-rubyonrails-patterns-part-1-service-objects-1af9f9573ca1)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'light-services', '~> 0.4' 
+gem 'light-services', '~> 0.5' 
 ```
 
 And then execute:
@@ -28,7 +28,110 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Examples of usage:
+
+**Change state of the record:**
+```ruby
+class Painting::Publish < ApplicationService
+  # Parameters
+  param :painting, type: Painting
+  param :user,     type: User
+
+  # Callbacks
+  before :authorize
+  after  :send_email_notification
+
+  def run
+    painting.publish!
+  end
+
+  private
+
+  def authorize
+    pundit_authorize!(painting, user, :publish?)
+  end
+
+  def send_email_notification
+    PaintingMailer.publish_email(painting).deliver_now
+  end
+end
+```
+
+**Create a new record:**
+```ruby
+class Owner::Create < ApplicationService
+  # Parameters
+  param :params, type: ActionController::Parameters
+  param :user,   type: User
+
+  # Outputs
+  output :owner
+
+  # Callbacks
+  before :assign_attributes
+  before :authorize
+  before :validate
+
+  def run
+    owner.save!
+  end
+
+  private
+
+  def assign_attributes
+    self.owner = Owner.new(owner_params)
+  end
+
+  def authorize
+    pundit_authorize!(owner, user, :create?)
+  end
+
+  def validate
+    return if owner.valid?
+    errors.from_record(owner)
+  end
+
+  def owner_params
+    params
+      .require(:owner)
+      .permit(:name)
+  end
+end
+```
+
+**Integration with Pundit:**
+```ruby
+class ApplicationService < Light::Services::Base
+  def pundit_authorize!(record, user, action = nil)
+    action = convert_action(action, :show?)
+    policy = Pundit.policy!(user, record)
+
+    return true if policy.public_send(action)
+
+    Rails.logger.info "Pundit: not allowed to #{action} this #{record.inspect}"
+    raise Pundit::NotAuthorizedError, query: action, policy: policy, record: record
+  end
+
+  def pundit_scope!(scope, user, action = nil)
+    action = convert_action(action, :index?)
+    pundit_authorize!(scope, user, action)
+
+    Pundit.policy_scope!(user, scope)
+  end
+  
+  private
+
+  def convert_action(action, default)
+    action = action.to_s
+
+    return default if action.blank?
+    return action if action.ends_with?('?')
+
+    action + '?'
+  end
+end
+
+```
 
 ## Development
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'light/services'

data/gemfiles/rails_4_0.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "4.0.13"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_4_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    light-services (0.4.0)
+    light-services (0.5.0)
       rails (> 4.0)
 
 GEM
@@ -112,4 +112,4 @@ DEPENDENCIES
   simplecov (~> 0.11.2)
 
 BUNDLED WITH
-   1.14.4
+   1.15.4

data/gemfiles/rails_4_1.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "4.1.15"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_4_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    light-services (0.4.0)
+    light-services (0.5.0)
       rails (> 4.0)
 
 GEM
@@ -116,4 +116,4 @@ DEPENDENCIES
   simplecov (~> 0.11.2)
 
 BUNDLED WITH
-   1.14.4
+   1.15.4

data/gemfiles/rails_4_2.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "rails", "4.2.6"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_4_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    light-services (0.4.0)
+    light-services (0.5.0)
       rails (> 4.0)
 
 GEM
@@ -143,4 +143,4 @@ DEPENDENCIES
   simplecov (~> 0.11.2)
 
 BUNDLED WITH
-   1.14.4
+   1.15.4

data/gemfiles/rails_5_0.gemfile

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.0.0.rc1"
+gem "rails", "5.0.5"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile.lock

@@ -1,141 +1,135 @@
 PATH
   remote: ..
   specs:
-    light-services (0.4.0)
+    light-services (0.5.0)
       rails (> 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.0.0.rc1)
-      actionpack (= 5.0.0.rc1)
-      nio4r (~> 1.2)
+    actioncable (5.0.5)
+      actionpack (= 5.0.5)
+      nio4r (>= 1.2, < 3.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.0.0.rc1)
-      actionpack (= 5.0.0.rc1)
-      actionview (= 5.0.0.rc1)
-      activejob (= 5.0.0.rc1)
+    actionmailer (5.0.5)
+      actionpack (= 5.0.5)
+      actionview (= 5.0.5)
+      activejob (= 5.0.5)
       mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (5.0.0.rc1)
-      actionview (= 5.0.0.rc1)
-      activesupport (= 5.0.0.rc1)
-      rack (~> 2.x)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.5)
+      actionview (= 5.0.5)
+      activesupport (= 5.0.5)
+      rack (~> 2.0)
       rack-test (~> 0.6.3)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.0.rc1)
-      activesupport (= 5.0.0.rc1)
+    actionview (5.0.5)
+      activesupport (= 5.0.5)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-      rails-dom-testing (~> 1.0, >= 1.0.5)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (5.0.0.rc1)
-      activesupport (= 5.0.0.rc1)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.5)
+      activesupport (= 5.0.5)
       globalid (>= 0.3.6)
-    activemodel (5.0.0.rc1)
-      activesupport (= 5.0.0.rc1)
-    activerecord (5.0.0.rc1)
-      activemodel (= 5.0.0.rc1)
-      activesupport (= 5.0.0.rc1)
+    activemodel (5.0.5)
+      activesupport (= 5.0.5)
+    activerecord (5.0.5)
+      activemodel (= 5.0.5)
+      activesupport (= 5.0.5)
       arel (~> 7.0)
-    activesupport (5.0.0.rc1)
+    activesupport (5.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    appraisal (2.1.0)
+    appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
-    arel (7.0.0)
-    builder (3.2.2)
-    codeclimate-test-reporter (0.5.1)
-      simplecov (>= 0.7.1, < 1.0.0)
-    concurrent-ruby (1.0.2)
-    diff-lcs (1.2.5)
+    arel (7.1.4)
+    builder (3.2.3)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
     docile (1.1.5)
     erubis (2.7.0)
-    globalid (0.3.6)
-      activesupport (>= 4.1.0)
-    i18n (0.7.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
     json (1.8.6)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
-    mail (2.6.4)
+    mail (2.6.6)
       mime-types (>= 1.16, < 4)
     method_source (0.8.2)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
-    minitest (5.9.0)
-    nio4r (1.2.1)
-    nokogiri (1.6.8)
-      mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    pkg-config (1.1.7)
-    rack (2.0.0.rc1)
-      json
+    mini_portile2 (2.2.0)
+    minitest (5.10.3)
+    nio4r (2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
+    rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (5.0.0.rc1)
-      actioncable (= 5.0.0.rc1)
-      actionmailer (= 5.0.0.rc1)
-      actionpack (= 5.0.0.rc1)
-      actionview (= 5.0.0.rc1)
-      activejob (= 5.0.0.rc1)
-      activemodel (= 5.0.0.rc1)
-      activerecord (= 5.0.0.rc1)
-      activesupport (= 5.0.0.rc1)
-      bundler (>= 1.3.0, < 2.0)
-      railties (= 5.0.0.rc1)
+    rails (5.0.5)
+      actioncable (= 5.0.5)
+      actionmailer (= 5.0.5)
+      actionpack (= 5.0.5)
+      actionview (= 5.0.5)
+      activejob (= 5.0.5)
+      activemodel (= 5.0.5)
+      activerecord (= 5.0.5)
+      activesupport (= 5.0.5)
+      bundler (>= 1.3.0)
+      railties (= 5.0.5)
       sprockets-rails (>= 2.0.0)
-    rails-deprecated_sanitizer (1.0.3)
-      activesupport (>= 4.2.0.alpha)
-    rails-dom-testing (1.0.7)
-      activesupport (>= 4.2.0.beta, < 5.0)
-      nokogiri (~> 1.6.0)
-      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.0.0.rc1)
-      actionpack (= 5.0.0.rc1)
-      activesupport (= 5.0.0.rc1)
+    railties (5.0.5)
+      actionpack (= 5.0.5)
+      activesupport (= 5.0.5)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
     simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    sprockets (3.6.1)
+    simplecov-html (0.10.2)
+    sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.0.4)
+    sprockets-rails (3.2.0)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
-    websocket-driver (0.6.4)
+    websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
 
@@ -147,10 +141,10 @@ DEPENDENCIES
   bundler (~> 1.12)
   codeclimate-test-reporter
   light-services!
-  rails (= 5.0.0.rc1)
+  rails (= 5.0.5)
   rake (~> 10.0)
   rspec (~> 3.0)
   simplecov (~> 0.11.2)
 
 BUNDLED WITH
-   1.14.4
+   1.15.4