opto-task 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abf39a045cdd0c3399cfb624351a3e35c27b00b9
+  data.tar.gz: cbd38003c0627e33077a3781b4eb24d1d1cd3dca
+SHA512:
+  metadata.gz: 08fe35b5c021b7f5e3930b91130ef7f9acec5e5b0752027fa8bb5749c491f9704da1dd6ad4e2d11400832c3c491132ce4591b05d2c0a7779f583366fb9fbc525
+  data.tar.gz: 99c6763ba639b993f5762e9217aa0ca10bf795ee411ceda2389c1238c39bf596bab45526d559056804b2de4f60c5640b8e4e6130a7c776aea10ec9feb695bf92

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+  - 2.0.0-p648
+  - 2.1.8
+  - 2.2.3
+  - 2.3.1
+  - 2.3.3
+  - 2.4.0-preview3
+  - jruby-9.1.5.0
+env:
+  - secure: "jnnVCJDc8TalUrEk9urgKsv0HXzg0S/5yY2W2Hy6/R3gihpK7w1hnbk/yDjXpOD6aqp76Ts5nbCpPVeNT2XMC8najCY7/bxQhFp89Ild7JNnpOWOTOqVcjTkoJFXI+zH2WVHwmOvl5Zz/DJISu5hLxPIGlHkYuKnbGtcmyXaeaMfbrDzLLG2Egxp6Sd/6Sn3BxHxtYDq1QlHACrKRauL0ulIg1NjUyMWAPXI280ZRe8cYKlZYkNXWMqM7Uscg/fA5mCB1LoVyaj549EmZwpcBriTNmrm4QPX6LMKjJiRoq194v2pNuD6G3NaV5zmtuai14EoAgg/F0sn1IUtqZpCAb2ggoRsf44Tik+YX9BFeiUJglOzOMrQvEsaNABMoE9KNk0L8SN7uPWA7ZTPUnvx+rBDCr3MKnNQ2wHq8SbJ3sMQd5Wzd/QLnAf6PBncgRVd99HmWwAPciTdT9iYcXTUjZlGIwkGgr+fcz1RG4zsicVYZ3zOHAJk5u18YeqmTic3ZDPGyKKuLuHVa2eK0s4JGgvx5jqK07kKkqHvKkUinTGTIjeRXPZ15FdT1d6e3r78KNfpDf9O/3o4mx4eQx/0dYlkXv+2ztweu3yZ4f1EUn2K6PF0dPCAi4gXxdIdi7GhI10jRaEAQw9LftLXgzFjpvxGKiB7apkfP5dkdoHb8ps="
+before_install: gem install bundler -v 1.12.5
+cache: bundler
+script: bundle install && bundle exec rspec spec/
+deploy:
+  provider: rubygems
+  api_key: $GEM_TOKEN
+  gem: opto-task
+  on:
+    tags: true
+    rvm: 2.3.1

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in opto-task.gemspec
+gemspec
+
+group :development do
+  gem 'simplecov', require: false, platforms: :ruby
+  gem 'byebug', require: false, platforms: :ruby
+  gem 'travis', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2015 Kontena, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,79 @@
+# Opto/Task
+
+[![Build Status](https://travis-ci.org/kontena/opto-task.svg?branch=master)](https://travis-ci.org/kontena/opto-task)
+
+Uses [Opto](https://github.com/kontena/opto/) based [Opto/Model](https://github.com/kontena/opto-model/) to create [Mutations](https://github.com/cypriss/mutations) kind of runnable tasks or service objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'opto-task'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opto-task
+
+## Usage
+
+You can define tasks:
+
+```ruby
+require 'opto-task'
+
+class RemoveFileTask
+  include Opto.task
+
+  attribute :path, :string
+
+  def validate
+    add_error :path, :not_found, "The file isn't there" unless File.exist?(Path)
+  end
+
+  def perform
+    begin
+      File.unlink(path)
+      "great success"
+    rescue Errno::EACCES
+      add_error :path, :no_access, "You don't have the rights"
+    end
+  end
+
+  def after
+    puts "Your file will be missed"
+  end
+end
+```
+
+And then run them:
+
+```ruby
+task = RemoveFileTask.new(path: '/tmp/foo.txt')
+result = task.run
+result.success?
+=> true
+result.outcome
+=> "great success"
+```
+
+..unless they're not valid:
+
+```ruby
+task = RemoveFileTask.new(path: '/tmp/foobar.txt')
+task.valid?
+=> false
+result = task.run
+result.success?
+=> false
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kontena/opto-task.
+

data/Rakefile

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

data/lib/opto/task/result.rb

@@ -0,0 +1,21 @@
+module Opto
+  module Task
+    class Result
+      attr_reader :task, :errors
+      attr_accessor :outcome
+
+      def initialize(task = nil)
+        @task = task
+        @errors = {}
+      end
+
+      def success?
+        errors.empty?
+      end
+
+      def failure?
+        !success?
+      end
+    end
+  end
+end

data/lib/opto/task/runner.rb

@@ -0,0 +1,67 @@
+require_relative 'result'
+
+module Opto
+  module Task
+    module Runner
+
+      def errors
+        wait_for_lock
+        super.merge(runner_errors)
+      end
+
+      def valid?
+        wait_for_lock
+        runner_errors.clear
+        validate if self.respond_to?(:validate)
+        errors.empty? && super
+      end
+
+      def wait_for_lock
+        sleep 0.001 until !mutex.locked? || mutex.owned?
+      end
+
+      def mutex
+        @mutex ||= Mutex.new
+      end
+
+      def runner_errors
+        wait_for_lock
+        @runner_errors ||= {}
+      end
+
+      def add_error(field, classification, message)
+        runner_errors[field] ||= {}
+        runner_errors[field][classification] =
+          case runner_errors[field][classification]
+          when String
+            runner_errors[field][classification] == message ? runner_errors[field][classification] : [runner_errors[field][classification], message]
+          when Array
+            runner_errors[field][classification].include?(message) ? runner_errors[field][classification] : (runner_errors[field][classification] + [message])
+          else
+            message
+          end
+      end
+
+      def run
+        mutex.synchronize do
+          current_run = Opto::Task::Result.new(self)
+
+          if valid?
+
+            runner_errors.clear
+            outcome = perform
+            current_run.errors.merge!(runner_errors)
+            if current_run.success?
+              current_run.outcome = outcome
+              after if self.respond_to?(:after)
+            end
+            runner_errors.clear
+          else
+            current_run.errors.merge!(errors)
+          end
+          return current_run
+        end
+      end
+    end
+  end
+end

data/lib/opto/task/version.rb

@@ -0,0 +1,5 @@
+module Opto
+  module Task
+    VERSION = "0.1.0"
+  end
+end

data/lib/opto/task.rb

@@ -0,0 +1,16 @@
+require "opto/task/version"
+require "opto/task/runner"
+require 'opto/model'
+
+module Opto
+  module Task
+    def self.included(where)
+      where.send(:include, Opto::Model)
+      where.send(:include, Opto::Task::Runner)
+    end
+  end
+
+  def self.task
+    Task
+  end
+end

data/opto-task.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opto/task/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opto-task"
+  spec.version       = Opto::Task::VERSION
+  spec.authors       = ["Kimmo Lehto"]
+  spec.email         = ["info@kontena.io"]
+
+  spec.summary       = %q{Create tasks or service objects from Opto::Models}
+  spec.homepage      = "https://github.com/kontena/opto-task"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "opto-model", "~> 0.1"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: opto-task
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kimmo Lehto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opto-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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:
+- info@kontena.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/opto/task.rb
+- lib/opto/task/result.rb
+- lib/opto/task/runner.rb
+- lib/opto/task/version.rb
+- opto-task.gemspec
+homepage: https://github.com/kontena/opto-task
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Create tasks or service objects from Opto::Models
+test_files: []