the_help 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fda021c7ce6ae5e97854b12c2743fbba2a70fcfd
+  data.tar.gz: dd1fc76b50edeaafb2b66883508e9872a3a27489
+SHA512:
+  metadata.gz: abe91a6085dc0a63c3010a68466b42e8379fa96edd342c30fa86040dae5210b505b33fb3f9dd2c90963234664442d5eda7686b41c89ef6bb2c6ff140f2c62544
+  data.tar.gz: b7de07b572853f4dafd09a380d75c37cc8fa25fa27f14baed8274f3a7b81ea32492a1f42e80e64c28a3747edfebb076ccc24752d8ead7c958217b71048146cab

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Metrics/BlockLength:
+  ExcludedMethods: context, describe, shared_examples_for
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0.pre.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 john@johnwilger.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in the_help.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    the_help (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    diff-lcs (1.3)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.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.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.50.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.50)
+  the_help!
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John Wilger
+
+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,43 @@
+# TheHelp
+
+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/the_help`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'the_help'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install the_help
+
+## 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/jwilger/the_help. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TheHelp project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jwilger/the_help/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'the_help'
+
+# 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/the_help.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'the_help/version'
+
+module TheHelp
+  # Your code goes here...
+end

data/lib/the_help/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TheHelp
+  class AbstractClassError < StandardError; end
+  class ServiceNotImplementedError < StandardError; end
+  class NotAuthorizedError < RuntimeError; end
+end

data/lib/the_help/provides_callbacks.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module TheHelp
+  # Adds a callback DSL to including classes
+  #
+  # @example
+  # class Foo
+  #   attr_accessor :collaborator
+  #
+  #   def do_something
+  #     collaborator.do_some_other_thing(when_done: callback(:it_was_done))
+  #   end
+  #
+  #   callback(:it_was_done) do |some_arg:|
+  #     puts "Yay! #{some_arg}"
+  #   end
+  # end
+  #
+  # class Bar
+  #  def do_some_other_thing(when_done:)
+  #    when_done.call('done by Bar')
+  #  end
+  # end
+  #
+  # f = Foo.new
+  # f.collaborator = Bar.new
+  # f.do_something
+  # # STDOUT: "Yay! done by Bar"
+  #
+  # Callbacks can be given to collaborating objects, but the actual methods are
+  # defined as private methods. This allows the object to control which other
+  # objects are able to invoke the callbacks (at least to the extent that Ruby
+  # lets you do so.)
+  #
+  # If the including class defines a #logger instance method, a debug-level
+  # message will be logged indicating that the callback was invoked.
+  module ProvidesCallbacks
+    def self.included(other)
+      other.class_eval do
+        extend TheHelp::ProvidesCallbacks::ClassMethods
+        alias_method :callback, :method
+      end
+    end
+
+    # Classes that include ProvidesCallbacks are extended with these
+    # ClassMethods
+    module ClassMethods
+      # Defines a callback method on the class
+      #
+      # The provided block will be used to define an instance method. This
+      # behaves similarly to #define_method, however it will ensure that
+      # callbacks are logged if the object has a #logger method defined.
+      #
+      # @param name [Symbol] The name of the callback
+      # @param block [Proc] The code that will be executed in the context of the
+      #   object when the callback is invoked.
+      def callback(name, &block)
+        define_method("#{name}_without_logging", &block)
+        define_method(name) do
+          if defined?(logger)
+            logger.debug("#{inspect} received callback :#{name}.")
+          end
+          send("#{name}_without_logging")
+        end
+        private name
+        self
+      end
+    end
+  end
+end

data/lib/the_help/service.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'the_help/errors'
+require 'the_help/provides_callbacks'
+
+module TheHelp
+  # An Abstract Service Class with Authorization and Logging
+  #
+  # Define subclasses of Service to build out the service layer of your
+  # application.
+  #
+  # @example
+  # class CreateNewUserAccount < TheHelp::Service
+  #   input :user
+  #   input :send_welcome_message, default: true
+  #
+  #   authorization_policy do
+  #     authorized = false
+  #     call_service(Authorize, permission: :admin_users,
+  #                  allowed: ->() { authorized = true })
+  #     authorized
+  #   end
+  #
+  #   main do
+  #     # do something to create the user account
+  #     if send_welcome_message
+  #       call_service(SendWelcomeMessage, user: user,
+  #                    success: callback(:message_sent))
+  #     end
+  #   end
+  #
+  #   callback(:message_sent) do
+  #     # do something really important, I'm sure
+  #   end
+  # end
+  #
+  # class Authorize < TheHelp::Service
+  #   input :permission
+  #   input :allowed
+  #
+  #   authorization_policy allow_all: true
+  #
+  #   main do
+  #     if user_has_permission?
+  #       allowed.call
+  #     end
+  #   end
+  # end
+  #
+  # class SendWelcomeMessage < TheHelp::Service
+  #   input :user
+  #   input :success, default: ->() { }
+  #
+  #   main do
+  #     # whatever
+  #     success.call
+  #   end
+  # end
+  #
+  # CreateNewUserAccount.(context: current_user, user: new_user_object)
+  class Service
+    include ProvidesCallbacks
+
+    # The default :not_authorized callback
+    #
+    # It will raise a TheHelp::NotAuthorizedError when the context is not
+    # authorized to perform the service.
+    CB_NOT_AUTHORIZED = ->(service:, context:) {
+      raise NotAuthorizedError,
+            "Not authorized to access #{service.name} as #{context.inspect}."
+    }
+
+    class << self
+      # Convenience method to instantiate the service and immediately call it
+      #
+      # Any arguments are passed to #initialize
+      #
+      # @return [Class] Returns the receiver
+      def call(*args)
+        new(*args).call
+        self
+      end
+
+      # :nodoc:
+      def inherited(other)
+        other.instance_variable_set(:@required_inputs, required_inputs.dup)
+      end
+
+      # :nodoc:
+      # instances need access to this, otherwise it would be made private
+      def required_inputs
+        @required_inputs ||= Set.new
+      end
+
+      # Defines the primary routine of the service
+      #
+      # The code that will be run when the service is called, assuming it is
+      # unauthorized.
+      def main(&block)
+        define_method(:main, &block)
+        private :main
+        self
+      end
+
+      # Defines the service authorization policy
+      #
+      # If allow_all is set to true, or if the provided block (executed in the
+      # context of the service object) returns true, then the service will be
+      # run when called. Otherwise, the not_authorized callback will be invoked.
+      #
+      # @param allow_all [Boolean]
+      # @param block [Proc] executed in the context of the service instance (and
+      #   can therefore access all inputs to the service)
+      def authorization_policy(allow_all: false, &block)
+        if allow_all
+          define_method(:authorized?) { true }
+        else
+          define_method(:authorized?, &block)
+        end
+        private :authorized?
+        self
+      end
+
+      def input(name, **options)
+        attr_accessor name
+        if options.key?(:default)
+          required_inputs.delete(name)
+          define_method(name) do
+            instance_variable_get("@#{name}") || options[:default]
+          end
+        else
+          required_inputs << name
+        end
+        private name, "#{name}="
+        self
+      end
+    end
+
+    def initialize(context:, logger: Logger.new($stdout),
+                   not_authorized: CB_NOT_AUTHORIZED, **inputs)
+      self.context = context
+      self.logger = logger
+      self.not_authorized = not_authorized
+      self.inputs = inputs
+    end
+
+    def call
+      validate_service_definition
+      catch(:stop) do
+        authorize
+        log_service_call
+        main
+      end
+      self
+    end
+
+    private
+
+    attr_accessor :context, :logger, :not_authorized
+    attr_reader :inputs
+
+    def inputs=(inputs)
+      @inputs = inputs
+      inputs.each { |name, value| send("#{name}=", value) }
+      validate_inputs
+    end
+
+    def validate_inputs
+      self.class.required_inputs.each do |r_input_name|
+        next if inputs.key?(r_input_name)
+        raise ArgumentError, "Missing required input: #{r_input_name}."
+      end
+    end
+
+    def validate_service_definition
+      raise AbstractClassError if self.class == TheHelp::Service
+      raise ServiceNotImplementedError unless defined?(main)
+    end
+
+    def log_service_call
+      logger.info("Service call to #{self.class.name} for #{context.inspect}")
+    end
+
+    def authorized?
+      false
+    end
+
+    def authorize
+      return if authorized?
+      logger.warn("Unauthorized attempt to access #{self.class.name} " \
+                  "as #{context.inspect}")
+      not_authorized.call(service: self.class, context: context)
+      throw :stop
+    end
+  end
+end

data/lib/the_help/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TheHelp
+  VERSION = '1.0.0'
+end

data/the_help.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'the_help/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'the_help'
+  spec.version       = TheHelp::VERSION
+  spec.authors       = ['John Wilger']
+  spec.email         = ['john@johnwilger.com']
+
+  spec.summary       = 'A service layer framework'
+  spec.description   = 'A service layer framework'
+  spec.homepage      = 'https://github.com/jwilger/the_help'
+  spec.license       = 'MIT'
+
+  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 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.50'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: the_help
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Wilger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-13 00:00:00.000000000 Z
+dependencies:
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+description: A service layer framework
+email:
+- john@johnwilger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/the_help.rb
+- lib/the_help/errors.rb
+- lib/the_help/provides_callbacks.rb
+- lib/the_help/service.rb
+- lib/the_help/version.rb
+- the_help.gemspec
+homepage: https://github.com/jwilger/the_help
+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.6.12
+signing_key: 
+specification_version: 4
+summary: A service layer framework
+test_files: []