rg-service 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a58613378aa4c5e5c7f81d3e794d2f84f497ec0
+  data.tar.gz: e320b6f211d831070672102127e52f694414e6b3
+SHA512:
+  metadata.gz: 4ebed8ba8c2616db4eafe30f3e67a536b188b769d181fea4bb02031b6e28f2885efb2fb0f9d2a679b3e671d63d24a5278ddaa1ee73e938ad569f1978585f24f7
+  data.tar.gz: f656f405ea84b26a2284fd1a3c3fb73d3367a1d0e771e5b0ace8242bc21827879f247755a38b6b9a587018326015d42f610d2df43d7f818b17fd4ca5499a05c9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,65 @@
+# RG::Service
+
+This is a basic service object framework for use in Rails applications
+at Real Geeks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rg-service', git: "git@github.com:RealGeeks/rg-service.git", tag: "v1.0.0"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rg-service
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` 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/realgeeks/rg-service.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Real Geeks, LLC
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rg/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/lib/rg/clock.rb

@@ -0,0 +1,48 @@
+module RG
+  class Clock
+    SUBSECOND_PRECISION_DIGITS = 6 # microseconds are Quite Good Enough, Thank You(tm)
+
+    # Convenience constructor for use in specs.
+    # Example use: Clock.as_of( 1.hour.from_now )
+    def self.as_of(time)
+      new(time)
+    end
+
+    # Apparently stubbing .new doesn't work so well, so we'll go with
+    # Clock.for_current_time instead.
+    def self.for_current_time
+      new( Time.now )
+    end
+
+    # Another quick convenience method
+    def self.current_time
+      for_current_time.to_time
+    end
+
+    def initialize(time)
+      @time = time.utc
+    end
+
+    def to_time
+      time.round(SUBSECOND_PRECISION_DIGITS)
+    end
+
+    def plus( duration )
+      Clock.as_of( time + duration )
+    end
+
+    def minus( duration )
+      Clock.as_of( time - duration )
+    end
+
+    # This is here to facilitate tests of sleep-based behavior.
+    # (Obviously, this should be stubbed in tests.)
+    def sleep(duration)
+      super # invoke Kernel#sleep
+    end
+
+    private
+    attr_reader :time
+
+  end
+end

data/lib/rg/service.rb

@@ -0,0 +1,65 @@
+require "active_support"
+require "virtus"
+
+require_relative "service/version"
+require_relative "service/kill_switch"
+require_relative "service/result"
+require_relative "service/convenience_constructors"
+require_relative "service/exception_formatting"
+require_relative "clock"
+
+module RG
+  class Service
+    extend ConvenienceConstructors
+    extend ExceptionFormatting
+
+    # This allows us to declare attributes at the top of a service file
+    # (which should help us notice when a given service starts having too
+    # many dependencies), and it also allows us to support named
+    # parameters when invoking a service.
+    #
+    # As of this writing, I haven't been able to get Virtus' default
+    # attributes to work as described, so be sure to check that you got
+    # any required parameters before proceeding...
+    include Virtus.model
+
+    # All services have a :clock attribute that can be passed on construction.
+    attribute :clock, Clock, default: :default_clock
+
+    # If not provided, this will default to Clock.for_current_time.
+    private def default_clock
+      Clock.for_current_time
+    end
+
+    # Services are performed by instances, but this provides a more
+    # convenient way of invoking them.
+    def self.perform(**kwargs)
+
+      result = new(**kwargs).perform
+
+      unless result.is_a?(Service::Result)
+        raise TypeError, "Expected #{self.name} to return a Service::Result, but got:\n#{result.inspect}"
+      end
+
+      return result
+
+    rescue StandardError => e
+      handle_exception e
+    end
+
+    def perform
+      raise NotImplementedError, "Subclass must implement!"
+    end
+
+    private
+
+    # NOTE: subclasses may override
+    def self.handle_exception(e)
+      if defined?(Raven)
+        Raven.capture_exception e
+      end
+
+      raise e
+    end
+  end
+end

data/lib/rg/service/convenience_constructors.rb

@@ -0,0 +1,36 @@
+module RG
+class Service
+
+  module ConvenienceConstructors
+    def success(message: nil, object: nil, data: {}, errors: [])
+      ::RG::Service::Result.new( status: :success, message: message, object: object, data: data, errors: errors )
+    end
+
+    def disabled
+      RG::Service::Result.new( status: :success )
+    end
+
+    def nothingtodohere(message=nil)
+      RG::Service::Result.new( status: :success, message: message )
+    end
+
+    def failure(message: nil, object: nil, data: {}, errors: [])
+      RG::Service::Result.new( status: :failure, message: message, object: object, data: data, errors: errors )
+    end
+
+    def result_from_exception(e)
+      message = format_exception(e)
+      data = {
+        error: {
+          class:     e.class.name,
+          msg:       e.message,
+          backtrace: e.backtrace,
+        },
+        exception: e,
+      }
+      RG::Service::Result.new( status: :failure, message: message, data: data )
+    end
+  end
+
+end
+end

data/lib/rg/service/exception_formatting.rb

@@ -0,0 +1,35 @@
+module RG
+class Service
+
+  module ExceptionFormatting
+    EXCEPTION_TEMPLATE = <<-EOF
+Exception:  %<err_class>s
+Message:    %<err_msg>s
+
+Backtrace:
+%<err_backtrace>s"
+    EOF
+
+    def format_exception(e, originating_file: nil)
+      EXCEPTION_TEMPLATE % {
+        err_class:     e.class.name,
+        err_msg:       e.message,
+        err_backtrace: format_backtrace( e, originating_file: originating_file ),
+      }
+    end
+
+    def format_backtrace(e, originating_file: nil)
+      if originating_file.present?
+        truncate_below = e.backtrace.index {|line|
+          line.include?(originating_file)
+        }
+        range = (0..truncate_below)
+        e.backtrace[range].join("\n")
+      else
+        e.backtrace.join("\n")
+      end
+    end
+  end
+
+end
+end

data/lib/rg/service/kill_switch.rb

@@ -0,0 +1,53 @@
+module RG
+class Service
+
+  # Some services may need to be enabled or disabled for testing.
+  # DRY up the boilerplate that makes this happen, so that service
+  # classes may choose when to self-terminate as follows:
+  #
+  # def perform
+  #   return if disabled?
+  #   # side-effect-having code
+  # end
+  #
+  # To turn a service on or off, call .enable! or .disable! on the
+  # service class.  Including services will be enabled by default.
+  module KillSwitch
+    INCLUDING_CLASSES = []
+
+    mattr_accessor :all_enabled
+    self.all_enabled = true
+
+    def self.included(receiver)
+      receiver.mattr_accessor :enabled
+
+      receiver.extend ClassMethods
+      receiver.extend Predicates
+      receiver.include Predicates
+      INCLUDING_CLASSES << receiver
+    end
+
+    module ClassMethods
+      def enable!  ; self.enabled = true  ; end
+      def disable! ; self.enabled = false ; end
+    end
+
+    module Predicates
+      def enabled?
+        if self.enabled.nil?
+          self.enabled = ::Service::KillSwitch.all_enabled
+        end
+
+        !!self.enabled
+      end
+
+      def disabled? ; !enabled? ; end
+    end
+  end
+
+  #                       Set the global flag              Set all the services that have been loaded so far
+  def self.disable_all! ; KillSwitch.all_enabled = false ; KillSwitch::INCLUDING_CLASSES.each(&:disable!) ; end
+  def self.enable_all!  ; KillSwitch.all_enabled = true  ; KillSwitch::INCLUDING_CLASSES.each(&:enable!)  ; end
+
+end
+end

data/lib/rg/service/result.rb

@@ -0,0 +1,53 @@
+module RG
+class Service
+
+  # Some services may need to return success/failure results with
+  # additional information.  They may use this to do so.
+  class Result
+    include Virtus.model
+    attribute :status,  Symbol
+    attribute :message, String
+    attribute :object
+    attribute :data,    Hash
+    attribute :errors,  Array[String]
+
+    VALID_STATUSES = [
+      :success,
+      :failure,
+    ]
+
+    def initialize(**kwargs)
+      unless VALID_STATUSES.include?(kwargs[:status])
+        fail ArgumentError, "The :status attribute must be one of: #{VALID_STATUSES.inspect}"
+      end
+
+      super # hey, don't overlook this ;)
+
+      # If given a (non-nil) object: arg, put it in #data[:object]
+      if object.present?
+        data[:object] ||= object
+      end
+
+      # Always make sure there's a :status field in #data
+      data[:status] ||= friendly_status
+    end
+
+    def success? ; :success == status ; end
+    def failure? ; :failure == status ; end
+
+    def description
+      "%<status>s:\n%<message>s" % {
+        status: friendly_status,
+        message: message,
+      }
+    end
+
+    private
+
+    def friendly_status
+      status.to_s.capitalize
+    end
+  end
+
+end
+end

data/lib/rg/service/version.rb

@@ -0,0 +1,5 @@
+module Rg
+  class Service
+    VERSION = "1.0.0"
+  end
+end

data/rg-service.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rg/service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rg-service"
+  spec.version       = Rg::Service::VERSION
+  spec.authors       = ["Sam Livingston-Gray"]
+  spec.email         = ["geeksam@gmail.com"]
+
+  spec.summary       = %q{Service framework for Real Geeks}
+  spec.description   = %q{Service framework for Real Geeks}
+  spec.homepage      = "https://github.com/realgeeks/rg-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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "activesupport", ">= 4.0"
+  spec.add_runtime_dependency "virtus", ">= 1.0.5"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rg-service
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sam Livingston-Gray
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+description: Service framework for Real Geeks
+email:
+- geeksam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rg/clock.rb
+- lib/rg/service.rb
+- lib/rg/service/convenience_constructors.rb
+- lib/rg/service/exception_formatting.rb
+- lib/rg/service/kill_switch.rb
+- lib/rg/service/result.rb
+- lib/rg/service/version.rb
+- rg-service.gemspec
+homepage: https://github.com/realgeeks/rg-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.6.11
+signing_key: 
+specification_version: 4
+summary: Service framework for Real Geeks
+test_files: []