zenaton 0.1.0

data/lib/zenaton/traits/with_timestamp.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/ClassVars
+require 'active_support'
+require 'zenaton/exceptions'
+require 'zenaton/traits/with_duration'
+
+module Zenaton
+  module Traits
+    # Module to calculate unix timestamps for events
+    module WithTimestamp
+      include WithDuration
+      extend ActiveSupport::Concern
+
+      # Array of weekdays as symbols from ActiveSupport
+      WEEKDAYS = DateAndTime::Calculations::DAYS_INTO_WEEK.keys
+      MODE_AT = 'AT' # When specifying a time
+      MODE_WEEK_DAY = 'WEEK_DAY' # When specifying a day of the week
+      MODE_MONTH_DAY = 'MONTH_DAY' # When specifying a day of the month
+      MODE_TIMESTAMP = 'TIMESTAMP' # When specifying a unix timestamp
+
+      included do
+        @@_timezone = nil
+      end
+
+      # Calculates the timestamp based on either timestamp or duration methods
+      # @return Array<Integer, NilClass>
+      def _get_timestamp_or_duration
+        return [nil, nil] unless @buffer
+        now, now_dup = _init_now_then
+        @_mode = nil
+        @buffer.each do |time_unit, time_value|
+          now_dup = _apply(time_unit, time_value, now, now_dup)
+        end
+        return [nil, diff_in_seconds(now, now_dup)] if @_mode.nil?
+        [now_dup.to_i, nil]
+      end
+
+      %i[
+        timestamp at on_day monday tuesday wednesday thursday
+        friday saturday sunday
+      ]. each do |method_name|
+        define_method method_name do |value = 1|
+          _push(method_name, value)
+          self
+        end
+      end
+
+      private
+
+      # rubocop:disable Metrics/MethodLength
+      def _apply(method, value, now, now_dup)
+        if WEEKDAYS.include?(method)
+          _weekday(value, method, now_dup)
+        elsif method == :timestamp
+          _timestamp(value)
+        elsif method == :at
+          _at(value, now, now_dup)
+        elsif method == :on_day
+          _on_day(value, now, now_dup)
+        else
+          _apply_duration(method, value, now_dup)
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def _weekday(value, day, now_dup)
+        _set_mode(MODE_WEEK_DAY)
+        value.times { |_n| now_dup = now_dup.next_occurring(day) }
+        now_dup
+      end
+
+      def _timestamp(timestamp)
+        _set_mode(MODE_TIMESTAMP)
+        timestamp
+      end
+
+      def _at(time, now, now_dup)
+        _set_mode(MODE_AT)
+        hour, min, sec = time.split(':').map(&:to_i)
+        now_dup = now_dup.change(hour: hour, min: min, sec: sec || 0)
+        now_dup += delay if now > now_dup
+        now_dup
+      end
+
+      def delay
+        case @_mode
+        when MODE_AT
+          1.day
+        when MODE_WEEK_DAY
+          1.week
+        when MODE_MONTH_DAY
+          1.month
+        else
+          raise InternalError "Unknown mode: #{@_mode}"
+        end
+      end
+
+      def _on_day(day, now, now_dup)
+        _set_mode(MODE_MONTH_DAY)
+        now_dup = now_dup.change(day: day)
+        now_dup += 1.month if now > now_dup
+        now_dup
+      end
+
+      def _set_mode(mode)
+        error = 'Incompatible definition in Wait methods'
+        raise ExternalError,  error if mode == @_mode
+        raise ExternalError, error if timestamp_mode_set?(mode)
+        @_mode = mode if @_mode.nil? || @_mode == MODE_AT
+      end
+
+      def timestamp_mode_set?(mode)
+        (!@_mode.nil? && MODE_TIMESTAMP == mode) || (@_mode == MODE_TIMESTAMP)
+      end
+
+      class_methods do
+        def timezone=(timezone)
+          error = 'Unknown timezone'
+          raise ExternalError, error unless valid_timezone?(timezone)
+          @@_timezone = timezone
+        end
+
+        def valid_timezone?(timezone)
+          timezone.nil? || ActiveSupport::TimeZone::MAPPING.value?(timezone)
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Style/ClassVars

data/lib/zenaton/traits/zenatonable.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'zenaton/engine'
+require 'zenaton/query/builder'
+
+module Zenaton
+  # Reusable modules from the Zenaton library
+  module Traits
+    # Module to be included in tasks and workflows
+    module Zenatonable
+      extend ActiveSupport::Concern
+      # Sends self as the single job to be executed to the engine and returns
+      # the result
+      def execute
+        Engine.instance.execute([self])[0]
+      end
+
+      # Sends self as the single job to be dispatched to the engine and returns
+      # the result
+      def dispatch
+        Engine.instance.dispatch([self])
+      end
+
+      class_methods do
+        # Search for workflows to interact with.
+        # For available methods, see {Zenaton::Query::Builder}
+        # @param id [String] (Optional) ID for a given worflow
+        # @return [Zenaton::Query::Builder] a query builder object
+        def where_id(id)
+          Query::Builder.new(self).where_id(id)
+        end
+      end
+    end
+  end
+end

data/lib/zenaton/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Zenaton
+  # This gem's current version
+  VERSION = '0.1.0'
+end

data/lib/zenaton/workflows/version.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'zenaton/exceptions'
+require 'zenaton/interfaces/workflow'
+require 'zenaton/traits/zenatonable'
+
+module Zenaton
+  # Module for the workflow manager and the versioned workflows
+  module Workflows
+    # @abstract Subclass and override {#versions} to create your own versionned
+    # workflows
+    class Version < Interfaces::Workflow
+      include Traits::Zenatonable
+
+      # @return [Array<Class>] an array containing the class name for each
+      # version, ordered from the oldest to the most recent version
+      def versions
+        raise NotImplemented,
+              "Please override the `versions' method in your subclass"
+      end
+
+      def initialize(*args)
+        @args = args
+      end
+
+      # Calls handle on the current implementation
+      def handle
+        current_implementation.handle
+      end
+
+      # Get the current implementation class
+      # @return [Class]
+      def current
+        _get_versions[-1]
+      end
+
+      # Get the first implementation class
+      # @return [Class]
+      def initial
+        _get_versions[0]
+      end
+
+      # Returns an instance of the current implementation
+      # @return [Zenaton::Interfaces::Workflow]
+      def current_implementation
+        current.new(*@args)
+      end
+
+      protected
+
+      def _get_versions
+        raise ExternalError unless versions.is_a? Array
+        raise ExternalError unless versions.any?
+        versions.each do |version|
+          raise ExternalError unless version < Interfaces::Workflow
+        end
+        versions
+      end
+    end
+  end
+end

data/zenaton.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zenaton/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zenaton'
+  spec.version       = Zenaton::VERSION
+  spec.authors       = ['Zenaton']
+  spec.email         = ['contact@zenaton.com']
+
+  spec.summary       = 'Zenaton ruby library'
+  spec.description   = 'Zenaton ruby library'
+  spec.homepage      = 'https://zenaton.com'
+  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_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'tzinfo-data'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,260 @@
+--- !ruby/object:Gem::Specification
+name: zenaton
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zenaton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Zenaton ruby library
+email:
+- contact@zenaton.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zenaton.rb
+- lib/zenaton/client.rb
+- lib/zenaton/engine.rb
+- lib/zenaton/exceptions.rb
+- lib/zenaton/interfaces/event.rb
+- lib/zenaton/interfaces/job.rb
+- lib/zenaton/interfaces/task.rb
+- lib/zenaton/interfaces/workflow.rb
+- lib/zenaton/parallel.rb
+- lib/zenaton/processor.rb
+- lib/zenaton/query/builder.rb
+- lib/zenaton/services/http.rb
+- lib/zenaton/services/properties.rb
+- lib/zenaton/services/serializer.rb
+- lib/zenaton/tasks/wait.rb
+- lib/zenaton/traits/with_duration.rb
+- lib/zenaton/traits/with_timestamp.rb
+- lib/zenaton/traits/zenatonable.rb
+- lib/zenaton/version.rb
+- lib/zenaton/workflows/version.rb
+- zenaton.gemspec
+homepage: https://zenaton.com
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Zenaton ruby library
+test_files: []