opie 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f3af112187a2390363fe9bcb389ed828eeaea29
-  data.tar.gz: e7f2c4d31314ba73317612f72d1dab3ecd234aa7
+  metadata.gz: 9f6c49cd8b64674b706842336d7efb1972825655
+  data.tar.gz: 1624b5f8578aadee872bfd6cedfd44072dbc68fd
 SHA512:
-  metadata.gz: 3c7b9d9ce3250ec523633999c61340f3a44529ef1f2af5f5bec7048d68d428f166f242cfc32142fdf22b26c80ad5f64790453eafe67d6ba0240f7e472a72ed7b
-  data.tar.gz: 0bc5a6dbd668167fca6242b4d090214ec9d2dd8be77daae440b2a1dbb44b01abd2077e43df809d9b5c7dc63c7199a5fee6c490b1d9bd900bb9b68e2cb4959e1d
+  metadata.gz: fab9a96f80f7e41ad0fbdc4b9bf9f8dc72910c369d003eb8cb818df8c61a6aec6e4f2a52c88c47e525622bca9d7fa727f1f473c3e6250870040fbdd9208d6fd0
+  data.tar.gz: fc31a533ca2591911ca13f3181a1fcff7e030ec98ea0fa140f53d88d2b6215fc36aab0b97c0377be0d829275fd7599055909130767e81a60c104c9013f7a4b0d

data/.rubocop.yml

@@ -3,6 +3,7 @@
 AllCops:
   Exclude:
     - 'spec/**/*'
+    - 'bin/*'
     - '*.gemspec'
   TargetRubyVersion: 2.3
 

data/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "ruby.lint": {
+    "reek": true,
+    "rubocop": true
+  }
+}

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# CHANGELOG
+
+<a name="1.1.0"></a>
+# [1.1.0](https://github.com/guzart/opie/compare/v1.0.0...v1.1.0) (2017-12-16)
+
+
+### Features
+
+* Add support for optional context argument ([b4938ed](https://github.com/guzart/opie/commit/b4938ed))
+
+
+
 <a name="1.0.0"></a>
 # [1.0.0](https://github.com/guzart/opie/compare/v0.1.0...v1.0.0) (2017-03-20)
 

data/README.md

@@ -8,6 +8,35 @@
 **Opie gives you a simple API for creating Operations using the
 [Railsway oriented programming](https://vimeo.com/113707214) paradigm.**
 
+## API
+
+The `Opie::Operation` API:
+  * `::step(Symbol) -> void` indicates a method that is executed in the operation sequence
+  * `#success? -> Boolean` indicates  whether the operation was successful
+  * `#failure? -> Boolean` indicates  whether the operation was a failure
+  * `#failure -> Hash | nil` the erorr if the operation is a `failure?`, nil when it's a success
+  * `#failures -> Array<Hash> | nil` an array with all errors
+  * `#output -> *` if succcessful, it returns the operation final output validation error
+  * `#step_name(Any, Any?) -> Any` the step signature. First argument is the input and the second argument is an optional context
+
+Executing an operation:
+
+```ruby
+input = { first_name: 'John', last_name: 'McClane', email: 'john@example.com' }
+context = { current_user: 'admin' }
+
+CreateUserOperation.(input, context)
+```
+
+Internal API:
+  * `#fail(error_type: Symbol, error_data: *) -> Hash` 
+
+_Tentative API_
+
+  * `::step(Array<Symbol>) -> void` a series of methods to be called in parallel
+  * `::step(Opie::Step) -> void` an enforcer of a step signature which helps to compose other steps
+  * `::failure(Symbol) -> void` indicates the method that handles failures
+
 ## Usage
 
 **Simple Usage:**
@@ -66,7 +95,7 @@ class HabitsController < ApplicationController
   # POST /habits
   def create
     # run the `operation` – since it's a modification we can call it a `command`
-    result = People::AddHabit.(habit_params)
+    result = People::AddHabit.(habit_params, operation_context)
 
     # render response based on operation result
     if result.success?
@@ -81,6 +110,7 @@ class HabitsController < ApplicationController
   # the HTTP status depends on the error type, which separating the domain from the infrastructure
   def error_http_status(error_type)
     case(error_type) 
+    when :unauthorized then :unauthorized
     when :validation then :unprocessable_entity 
     when :not_found then :not_found
     else :server_error
@@ -97,6 +127,10 @@ class HabitsController < ApplicationController
       color: 'DeepPink'
     }
   end
+
+  def operation_context
+    { current_user: current_user }
+  end
 end
 ```
 
@@ -142,11 +176,18 @@ module People
     ]
 
     # first step receives ::call first argument, then the output of the step is the argument of the next step
+    step :authorize
     step :validate
     step :find_person
     step :persist_habit
     step :send_event
 
+    def authorize(params, context)
+      # Authorize using Pundit's policy api
+      return fail(:unauthorized) if HabitPolicy.new(context, Habit).add?
+      params
+    end
+
     # receives the first input
     def validate(params)
       schema = AddHabitSchema.(params)
@@ -180,26 +221,6 @@ module People
 end
 ```
 
-## API
-
-The `Opie::Operation` API:
-  * `::step(Symbol) -> void` indicates a method that is executed in the operation sequence
-  * `#success? -> Boolean` indicates  whether the operation was successful
-  * `#failure? -> Boolean` indicates  whether the operation was a failure
-  * `#failure -> Hash | nil` the erorr if the operation is a `failure?`, nil when it's a success
-  * `#failures -> Array<Hash> | nil` an array with all errors
-  * `#output -> *` if succcessful, it returns the operation final output
-  validation error
-
-Internal API:
-  * `#fail(error_type: Symbol, error_data: *) -> Hash` 
-
-_Tentative API_
-
-  * `::step(Array<Symbol>) -> void` a series of methods to be called in parallel
-  * `::step(Opie::Step) -> void` an enforcer of a step signature which helps to compose other steps
-  * `::failure(Symbol) -> void` indicates the method that handles failures
-
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/opie/operation.rb

@@ -1,22 +1,21 @@
-require 'dry-container'
-
 module Opie
   class Operation
     FAIL = '__STEP_FAILED__'.freeze
 
-    attr_reader :failure, :output
+    attr_reader :failure, :output, :context
 
-    def call(input = nil)
+    def call(input = nil, context = nil)
+      @context = context
       execute_steps(input)
       self
     end
 
     def failure?
-      !success?
+      failure
     end
 
     def success?
-      failure.nil?
+      !failure?
     end
 
     def failures
@@ -24,8 +23,8 @@ module Opie
     end
 
     class << self
-      def call(input = nil)
-        new.call(input)
+      def call(input = nil, context = nil)
+        new.call(input, context)
       end
 
       def step(name)
@@ -51,13 +50,19 @@ module Opie
 
       next_input = input
       step_list.find do |name|
-        next_input = public_send(name, next_input)
+        next_input = execute_step(name, next_input)
         failure?
       end
 
       @output = next_input if success?
     end
 
+    def execute_step(name, input)
+      args = [name, input]
+      args = args.push(context) if method(name).arity == 2
+      public_send(*args)
+    end
+
     def fail(type, data = nil)
       @failure = Failure.new(type, data)
     end

data/lib/opie/version.rb

@@ -1,3 +1,3 @@
 module Opie
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/opie.gemspec

@@ -24,15 +24,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'dry-container', '~> 0.6'
-
   spec.add_development_dependency 'awesome_print', '~> 1.7'
+  spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'byebug', '~> 9.0'
   spec.add_development_dependency 'codecov', '~> 0'
-  spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'minitest', '~> 5.0'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: opie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Arturo Guzman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dry-container
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
+        version: '1.7'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !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: guard
   requirement: !ruby/object:Gem::Requirement
@@ -109,47 +95,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.5'
 description: |
   Opie provides an API for building your application operations/transactions using
   the Railway oriented programming paradigm
@@ -166,6 +152,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- ".vscode/settings.json"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -202,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Operations API for Railway oriented programming in Ruby