civil_service 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3505ccbce978bbeeea7a494316cd161eee31460207b6b3b2c322315089bd1442
+  data.tar.gz: cf203b21b33f1f3b5e87a010bc3c2b8006703ca1cf1b53b1328b107264b21890
+SHA512:
+  metadata.gz: 8d99b796b01ecaa22eacf3b4bea961037749c927b798d7f2b153a7114192b6a40b8d1833e014abc2c736a929d2c5250f6ea8e4f2c94445c1df4df97a1fb41ae4
+  data.tar.gz: 73885e7a905e506e0f7c65324b370af89ed21f5df44755b40b7b44e414a5ffc75e635b6ab93e767fd910b107a18f66ac6ba20cd8ed3a34e40dca7b99fcc68068

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at natbudin@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in civil_service.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    civil_service (1.0.0)
+      activemodel (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  civil_service!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 New England Interactive Literature
+
+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,88 @@
+# CivilService
+
+[![Build Status](https://travis-ci.org/neinteractiveliterature/civil_service.svg?branch=master)](https://travis-ci.org/neinteractiveliterature/civil_service)
+
+CivilService is a tiny framework for [service objects in Rails apps](https://hackernoon.com/service-objects-in-ruby-on-rails-and-you-79ca8a1c946e). With CivilService, you can use ActiveModel validations to do pre-flight checks before the service runs, and create your own result object classes to capture the results of complex operations.
+
+CivilService was extracted from [Intercode](https://github.com/neinteractiveliterature/intercode), a web app for convention organizers and participants.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'civil_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install civil_service
+
+## What CivilService does
+
+CivilService::Service is really a pretty tiny class.  It does, however, have some opinions that create a potentially-useful abstraction for app developers:
+
+* When called, services always return a result object that responds to (at least) `#success?`, `#failure?`, and `#errors`.  This lets your code paths that call services be consistent and simple.  (If you want to return more information as a result of running the service, it's easy to define a custom result class for your service.)
+* Services include `ActiveModel::Validations` so they can easily do pre-flight checks.  That means you can call `my_service.valid?` and `my_service.errors` just like you can for a model, and it also means that the service will fail if it's not valid.
+
+## Basic example
+
+Here's a simple service that changes a user's password in a hypothetical Rails app, and sends a
+notification email about it:
+
+```ruby
+class PasswordChangeService < CivilService::Service
+  validate :ensure_valid_password
+
+  attr_reader :user, :new_password
+
+  def initialize(user:, new_password:)
+    @user = user
+    @new_password = new_password
+  end
+
+  private
+
+  def inner_call
+    user.update!(password: new_password)
+    UserMailer.password_changed(user).deliver_later
+    success
+  end
+
+  def ensure_valid
+    return if new_password.length >= 8
+    errors.add(:base, "Passwords must be at least 8 characters long")
+  end
+end
+```
+
+You might call this from a controller action like this:
+
+```ruby
+class UsersController < ApplicationController
+  def change_password
+    service = PasswordChangeService.new(user: current_user, new_password: params[:password])
+    result = service.call
+
+    if result.success?
+      redirect_to root_url, notice: "Your password has been changed."
+    else
+      flash[:alert] = result.errors.full_messages.join(', ')
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/neinteractiveliterature/civil_service.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "civil_service"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/civil_service.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "civil_service/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "civil_service"
+  spec.version       = CivilService::VERSION
+  spec.authors       = ["Nat Budin"]
+  spec.email         = ["nbudin@patientslikeme.com"]
+
+  spec.summary       = %q{A tiny service object framework for Rails apps}
+  spec.description   = %q{CivilService provides a base class for your service objects.  With CivilService, you can use ActiveModel validations to do pre-flight checks before the service runs, and create your own result object classes to capture the results of complex operations.}
+  spec.homepage      = "https://github.com/neinteractiveliterature/civil_service"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel", ">= 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/civil_service.rb

@@ -0,0 +1,5 @@
+require "civil_service/version"
+require "active_model"
+require "civil_service/result"
+require "civil_service/service_failure"
+require "civil_service/service"

data/lib/civil_service/result.rb

@@ -0,0 +1,20 @@
+class CivilService::Result
+  include ActiveModel::Model
+  attr_accessor :success, :errors
+
+  def self.success(attributes = {})
+    new(attributes.merge(success: true))
+  end
+
+  def self.failure(attributes = {})
+    new(attributes.merge(success: false))
+  end
+
+  def success?
+    @success
+  end
+
+  def failure?
+    !success?
+  end
+end

data/lib/civil_service/service.rb

@@ -0,0 +1,50 @@
+class CivilService::Service
+  include ActiveModel::Validations
+
+  attr_writer :logger
+
+  class << self
+    attr_accessor :validate_manually
+    attr_writer :result_class
+
+    def result_class
+      @result_class || CivilService::Result
+    end
+  end
+
+  def call
+    unless self.class.validate_manually
+      return failure(errors) unless valid?
+    end
+
+    inner_call
+  end
+
+  def call!
+    unless self.class.validate_manually
+      raise CivilService::ServiceFailure.new(self, failure(errors)) unless valid?
+    end
+
+    result = inner_call
+    raise CivilService::ServiceFailure.new(self, result) if result.failure?
+    result
+  end
+
+  def logger
+    @logger || Rails.logger
+  end
+
+  private
+
+  def success(attributes = {})
+    self.class.result_class.success(attributes)
+  end
+
+  def failure(errors, attributes = {})
+    self.class.result_class.failure(attributes.merge(errors: errors))
+  end
+
+  def inner_call
+    raise 'Service classes are expected to implement #inner_call'
+  end
+end

data/lib/civil_service/service_failure.rb

@@ -0,0 +1,9 @@
+class CivilService::ServiceFailure < StandardError
+  attr_reader :service, :result
+
+  def initialize(service, result)
+    @service = service
+    @result = result
+    super("#{service.class.name} failed: #{result.errors.full_messages.join(', ')}")
+  end
+end

data/lib/civil_service/version.rb

@@ -0,0 +1,3 @@
+module CivilService
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: civil_service
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nat Budin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: CivilService provides a base class for your service objects.  With CivilService,
+  you can use ActiveModel validations to do pre-flight checks before the service runs,
+  and create your own result object classes to capture the results of complex operations.
+email:
+- nbudin@patientslikeme.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- civil_service.gemspec
+- lib/civil_service.rb
+- lib/civil_service/result.rb
+- lib/civil_service/service.rb
+- lib/civil_service/service_failure.rb
+- lib/civil_service/version.rb
+homepage: https://github.com/neinteractiveliterature/civil_service
+licenses: []
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A tiny service object framework for Rails apps
+test_files: []