chief 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43e891423fff261cdfa3c8628c904e0f83c1366a
+  data.tar.gz: 9f3194873b6521259c4fcbb1ebf8f96ab94e5d4e
+SHA512:
+  metadata.gz: 6866cfb6bf47cfd54b1860ffca624d85e55e1d22a9f63b2d55751d771e978b45053b76b474afa0c3b782cd149237bff5cb13dff5f6d30653350a1c089b8a0113
+  data.tar.gz: 846e0283854e262dccf00d746dbe43df427be5809751340bc470caeef74f15ff90e3527a5a4383584b0282015abd67c3f6d8e150512d6bb83e55d76311704512

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 PolicyGenius
+
+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,82 @@
+# Chief
+
+A simple command pattern for Ruby.
+
+[![Code Climate](https://codeclimate.com/github/policygenius/chief/badges/gpa.svg)](https://codeclimate.com/github/policygenius/chief)
+
+
+## Usage
+
+A `Chief::Command`'s primary interface is the `.call` method, executes the command and returns a `Chief::Result` instance.
+
+A `Chief::Result` encapsulates whether the command succeeding, including the return values and (optionally) any errors encountered.
+
+Suppose we have an ExampleApplication, that needs to notify an external service with a message. First, we create the command:
+
+```Ruby
+require 'net/http'
+
+module ExampleApplication
+  module SomeExternalService
+    class Notify < Chief::Command
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+
+      def call
+        response = report_to_external_service
+
+        if response.code == 200
+          success!(message)
+        else
+          fail!(false, 'Could not notify the external service')
+        end
+      rescue => exception
+        fail!(exception, 'Unexpected error while notifying service')
+      end
+
+      private
+
+      def report_to_external_service
+        Net::HTTP.post_form(
+          URI.parse('https://some_external_service/messages'),
+          message: message
+        )
+      end
+    end
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chief'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chief
+
+## 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/policygenius/chief.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 'chief'
+
+# 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

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/chief.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chief/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chief'
+  spec.version       = Chief::VERSION
+  spec.authors       = ['Ian Yamey']
+  spec.email         = ['ian@policygenius.com']
+
+  spec.summary       = 'A simple Command Object pattern for Ruby'
+  spec.homepage      = 'https://github.com/policygenius/chief'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/chief.rb

@@ -0,0 +1,6 @@
+require 'chief/version'
+require 'chief/result'
+require 'chief/command'
+
+module Chief
+end

data/lib/chief/command.rb

@@ -0,0 +1,23 @@
+module Chief
+  class Command
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def self.value(*args)
+      call(*args).value
+    end
+
+    def call
+      fail NotImplementedError, 'Implement #call in subclass'
+    end
+
+    def success!(value = true)
+      Result.new(value, nil)
+    end
+
+    def fail!(value = false, errors = true)
+      Result.new(value, errors)
+    end
+  end
+end

data/lib/chief/result.rb

@@ -0,0 +1,22 @@
+module Chief
+  class Result
+    attr_reader :value, :errors
+
+    def initialize(value, errors)
+      @value = value
+      @errors = errors
+    end
+
+    def success?
+      errors.nil?
+    end
+
+    def failure?
+      !success?
+    end
+
+    def to_ary
+      [self, value, errors]
+    end
+  end
+end

data/lib/chief/version.rb

@@ -0,0 +1,3 @@
+module Chief
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: chief
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Yamey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: 
+email:
+- ian@policygenius.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chief.gemspec
+- lib/chief.rb
+- lib/chief/command.rb
+- lib/chief/result.rb
+- lib/chief/version.rb
+homepage: https://github.com/policygenius/chief
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple Command Object pattern for Ruby
+test_files: []