flack 0.9.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 53ad40ea2e437d87d34f32ddd9239af062bb03aa
-  data.tar.gz: 262ba6b52d7891724ff81912b0accd9c00e0b4d7
+SHA256:
+  metadata.gz: 36dd9d587c7d003cc296db2fc3ac9f7dac0916e267a43904f5ca8be1e25b780e
+  data.tar.gz: 1bc04ec7696966e9d197b80c25af1a76309463eabc88222d4777d769f866f9c6
 SHA512:
-  metadata.gz: df483e90b692c55a35dcc885f5bb53e258f5a017d97ada4a29bb012dd00fd0acee83075cad989adc25c2aa2459bb2f834b87d6711ed680387b7e3325f7b81eae
-  data.tar.gz: 8c395360bc1edef076943e04d49576a7447d41596d8d278f6672a63e6347748939bba10c528c2464352ff17a2f34e3e536e7fb44aeb9a1baec07b116b9669186
+  metadata.gz: f8f69c70110ed67738d5c0ef95b97d4d0d0612520bbe8bab4c0353018f9bd0476bc48f29644514d3628cd2edb446abacdb38bf5392e2fbf95044a6401c7a3d37
+  data.tar.gz: 59784ead309c9df695c416af89087d1fdf5e16d7900c758027da2f771b48337774252ee792e47fac32ba43fce0a86d2600798e155e420aecb357c1a235843bea

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 
-# flack CHANGELOG.md
+# CHANGELOG.md
+
+
+## flack 1.2.1  released 2021-04-08
+
+- Respond with a proper 500 error when necessary (and dump to $stderr)
+
+
+## flack 1.2.0  released 2021-03-29
+
+- Simplify links
+- Remove dependency on HttpClient gem
+- Introduce DELETE /executions/:exid
+- Ensure METHS order, stabilize across Ruby versions
+
+
+## flack 1.0.0  released 2020-11-22
+
+- Leave Sequel dependency to flor
+
+
+## flack 0.16.1  released 2019-02-05
+
+- Depend on Sequel 5 (Sequel 4 and 5 seem OK)
+- GET /executions/:domain
+- GET /executions/:domain*
+- GET /executions/:domain.*
+- GET /messages/:point
+- GET /messages/:exid/:point
+- GET /messages/:exid
+- GET /messages/:id
+- GET /executions/:exid
+- GET /executions/:id
+
+
+## flack 0.10.0  released 2017-03-03
+
+## flack 0.10.0  released 2017-03-03
+
+- Flack::App#shutdown (@unit.shutdown)
 
 
 ## flack 0.9.1.1  released 2017-01-31

data/Makefile

@@ -6,6 +6,9 @@ NAME = \
 VERSION = \
   $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version")
 
+PORT = 7007
+PID_FILE = tmp/$(NAME).pid
+
 count_lines:
 	find lib -name "*.rb" | xargs cat | ruby -e "p STDIN.readlines.count { |l| l = l.strip; l[0, 1] != '#' && l != '' }"
 cl: count_lines
@@ -24,7 +27,7 @@ build: gemspec_validate
 	mv $(NAME)-$(VERSION).gem pkg/
 
 push: build
-	gem push pkg/$(NAME)-$(VERSION).gem
+	gem push --otp "$(OTP)" pkg/$(NAME)-$(VERSION).gem
 
 
 ## flor tasks
@@ -41,11 +44,35 @@ migrate:
 ## flack tasks
 
 serve:
-	bundle exec rackup -p 7007
+	bundle exec rackup -p $(PORT)
 s: serve
 
 curl:
-	curl -s http://127.0.0.1:7007/ | \
+	curl -s http://127.0.0.1:$(PORT)/ | \
       $(RUBY) -e "require 'json'; puts JSON.pretty_generate(JSON.load(STDIN.read))"
 c: curl
 
+start:
+	@if [ ! -f $(PID_FILE) ]; then \
+      bundle exec rackup -p $(PORT) -P $(PID_FILE) -D; \
+      sleep 1; \
+      echo "listening on $(PORT), pid `cat $(PID_FILE)`"; \
+    else \
+      echo "already running at `cat $(PID_FILE)`"; \
+    fi
+
+stop:
+	@if [ -f $(PID_FILE) ]; then \
+      echo "stopping flack pid `cat $(PID_FILE)`"; \
+      kill `cat $(PID_FILE)`; \
+    fi
+
+restart:
+	@if [ -f $(PID_FILE) ]; then make -s stop; fi; make -s start
+
+# Calls / and lists the links available
+#
+links:
+	bundle exec ruby -Ilib -r 'flack' \
+      -e "app = Flack::App.new('envs/test/', start: false); pp JSON.parse(app.call('REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/', 'REQUEST_PATH' => '/', 'SCRIPT_NAME' => '')[2].first)"
+

data/README.md

@@ -1,14 +1,27 @@
 
 # flack
 
-[![Build Status](https://secure.travis-ci.org/floraison/flack.svg)](http://travis-ci.org/floraison/flack)
+[![tests](https://github.com/floraison/flack/workflows/test/badge.svg)](https://github.com/floraison/flack/actions)
 [![Gem Version](https://badge.fury.io/rb/flack.svg)](http://badge.fury.io/rb/flack)
 
 Flack is a Rack app for the [flor](https://github.com/floraison/flor) workflow engine.
 
+
+## test ride
+
+```sh
+make migrate
+make start
+open http://localhost:7007/
+```
+
+Warning: this serves an API, not some fancy web interface.
+
+
 ## api
 
-Based on HAL ([spec](http://stateless.co/hal_specification.html) and [draft](https://tools.ietf.org/html/draft-kelly-json-hal-08)).
+Based on HAL ([spec](http://stateless.co/hal_specification.html) and [draft](https://tools.ietf.org/html/draft-kelly-json-hal-08)), [URI Template](https://tools.ietf.org/html/rfc6570), and [CURIE](https://www.w3.org/TR/curie/).
+
 
 ## license
 

data/flack.gemspec

@@ -10,8 +10,7 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.authors = [ 'John Mettraux' ]
   s.email = [ 'jmettraux@gmail.com' ]
-  s.homepage = 'http://github.com/floraison'
-  #s.rubyforge_project = 'flor'
+  s.homepage = 'https://github.com/floraison/flack'
   s.license = 'MIT'
   s.summary = 'a web front-end to the flor workflow engine'
 
@@ -21,16 +20,19 @@ A web front-end to the flor workflow engine
 
   #s.files = `git ls-files`.split("\n")
   s.files = Dir[
+    'README.{md,txt}',
+    'CHANGELOG.{md,txt}', 'CREDITS.{md,txt}', 'LICENSE.{md,txt}',
     'Makefile',
     'lib/**/*.rb', #'spec/**/*.rb', 'test/**/*.rb',
-    '*.gemspec', '*.txt', '*.rdoc', '*.md'
+    "#{s.name}.gemspec",
   ]
 
-  flor_version = s.version.to_s.split('.').take(2).join('.')
-  s.add_runtime_dependency 'flor', "~> #{flor_version}"
+  #flor_version = s.version.to_s.split('.').take(2).join('.')
+  #s.add_runtime_dependency 'flor', "~> #{flor_version}"
+  s.add_runtime_dependency 'flor'
 
-  s.add_runtime_dependency 'rack', '~> 1.6'
-  s.add_runtime_dependency 'sequel', '~> 4'
+  s.add_runtime_dependency 'rack', '>= 1.6', '< 3.0'
+  #s.add_runtime_dependency 'httpclient', '~> 2.8'
 
   s.add_development_dependency 'rspec', '~> 3'
 

data/lib/flack.rb

@@ -1,27 +1,6 @@
-#--
-# Copyright (c) 2016-2017, John Mettraux, jmettraux+flor@gmail.com
-#
-# 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.
-#
-# Made in Japan.
-#++
+# frozen_string_literal: true
 
+require 'cgi'
 require 'rack'
 
 require 'flor/unit'
@@ -29,7 +8,7 @@ require 'flor/unit'
 
 module Flack
 
-  VERSION = '0.9.1.1'
+  VERSION = '1.2.1'
 end
 
 require 'flack/app'

data/lib/flack/app.rb

@@ -1,26 +1,4 @@
-#--
-# Copyright (c) 2016-2017, John Mettraux, jmettraux+flor@gmail.com
-#
-# 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.
-#
-# Made in Japan.
-#++
+# frozen_string_literal: true
 
 require 'flack/app/helpers'
   #
@@ -28,6 +6,8 @@ require 'flack/app/index'
 require 'flack/app/static'
 require 'flack/app/message'
 require 'flack/app/executions'
+require 'flack/app/messages'
+require 'flack/app/pointers'
 
 
 class Flack::App
@@ -52,6 +32,11 @@ class Flack::App
     @unit
   end
 
+  def shutdown
+
+    @unit.shutdown
+  end
+
   def self.unit
     @unit
   end
@@ -76,7 +61,7 @@ class Flack::App
       match = true
       args = []
 
-      for i in 0..flack_path_info.length - 1
+      for i in 0..(flack_path_info.length - 1)
 
         break unless match
 
@@ -90,8 +75,10 @@ class Flack::App
           args << pi.to_i
         elsif mi == 's'
           args << pi
+        elsif mi.is_a?(Regexp)
+          match = pi.match(mi)
         else
-          match = pi == mi
+          match = (pi == mi)
         end
       end
 
@@ -105,6 +92,16 @@ class Flack::App
     end
 
     respond_not_found(env)
+
+  rescue => err
+
+    $stderr.puts '=' * 80
+    $stderr.puts Time.now.to_s
+    $stderr.puts err.inspect
+    $stderr.puts err.backtrace
+    $stderr.puts ('=' * 79) + '.'
+
+    respond_internal_server_error(env, err)
   end
 
   def get_debug(env); debug_respond(env); end
@@ -114,7 +111,14 @@ class Flack::App
     .collect(&:to_s)
     .select { |m| m.match(/\A(get|head|put|post|delete)_.+\z/) }
     .select { |m| instance_method(m).arity == 1 }
-    .collect { |m| s = m.split('_'); [ m, s.shift.upcase, s ] }
+    .sort
+    .collect { |m|
+      s = m.split('_')
+      if s.length == 3 && s[2] == 'suffix'
+        [ m, s.shift.upcase, [ /\.#{s[0]}\z/ ] ]
+      else
+        [ m, s.shift.upcase, s ]
+      end }
     .collect(&:freeze).freeze
 end
 

data/lib/flack/app/executions.rb

@@ -1,42 +1,127 @@
-#--
-# Copyright (c) 2016-2017, John Mettraux, jmettraux+flor@gmail.com
-#
-# 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.
-#
-# Made in Japan.
-#++
-
+# frozen_string_literal: true
 
 # /executions/*
 #
 class Flack::App
 
+  # GET /executions
+  #
   def get_executions(env)
 
 # TODO implement paging
-    respond(env, @unit.executions.all)
+    env['flack.rel'] = 'flack:executions'
+
+    qs = CGI.parse(env['QUERY_STRING'] || '')
+    statuses = qs['status']
+    statuses = nil if statuses == []
+
+    q = @unit.executions
+    q = q.where(status: statuses) if statuses
+
+    respond(env, q.all)
   end
 
+  # GET /executions/<id>
+  #
   def get_executions_i(env)
 
-# TODO
-    debug_respond(env)
+    env['flack.rel'] = 'flack:executions/id'
+
+    if exe = @unit.executions[env['flack.args'][0]]
+      respond(env, exe)
+    else
+      respond_not_found(env)
+    end
+  end
+
+  # GET /executions/<exid>
+  # GET /executions/<domain>
+  # GET /executions/<domain>*
+  # GET /executions/<domain>.*
+  #
+  def get_executions_s(env)
+
+    arg = env['flack.args'][0]
+
+    if arg.count('-') == 0
+      get_executions_by_domain(env, arg)
+    else
+      get_executions_by_exid(env, arg)
+    end
+  end
+
+  # DELETE /executions/<exid>
+  #
+  def delete_executions_s(env)
+
+    exid = env['flack.args'][0]
+
+    return respond_not_found(env) \
+      unless @unit.executions.where(exid: exid).count > 0
+
+    r = { exid: exid, counts: {} }
+    cs = r[:counts]
+
+    @unit.storage.db.transaction do
+
+      cs[:messages] = @unit.messages.where(exid: exid).count
+      cs[:executions] = @unit.executions.where(exid: exid).count
+      cs[:pointers] = @unit.pointers.where(exid: exid).count
+      cs[:timers] = @unit.timers.where(exid: exid).count
+      cs[:traps] = @unit.traps.where(exid: exid).count
+        #
+        # not sure if the DB adapter returns the DELETE count,
+        # so counting first
+
+      @unit.messages.where(exid: exid).delete
+      @unit.executions.where(exid: exid).delete
+      @unit.pointers.where(exid: exid).delete
+      @unit.timers.where(exid: exid).delete
+      @unit.traps.where(exid: exid).delete
+    end
+
+    respond(env, r)
+  end
+
+  protected
+
+  def get_executions_by_exid(env, exid)
+
+    env['flack.rel'] = 'flack:executions/exid'
+
+    if exe = @unit.executions[exid: exid]
+      respond(env, exe)
+    else
+      respond_not_found(env)
+    end
+  end
+
+  def get_executions_by_domain(env, dom)
+
+    qs = CGI.parse(env['QUERY_STRING'] || '')
+    statuses = qs['status']
+    statuses = nil if statuses == []
+
+    q = @unit.executions
+
+    if m = dom.match(/\A([^*]+)\*+\z/)
+      if m[1][-1, 1] == '.'
+        env['flack.rel'] = 'flack:executions/domain-dot-star'
+        q = q.where(Sequel.like(:domain, "#{m[1]}%"))
+      else
+        env['flack.rel'] = 'flack:executions/domain-star'
+        q = q.where(
+          Sequel[{ domain: m[1] }] |
+          Sequel.like(:domain, "#{m[1]}.%"))
+      end
+    else
+      env['flack.rel'] = 'flack:executions/domain'
+      q = q.where(domain: dom)
+    end
+
+    q = q.where(status: statuses) if statuses
+
+    respond(env, q.all)
   end
 end
 

data/lib/flack/app/helpers.rb

@@ -1,27 +1,4 @@
-#--
-# Copyright (c) 2016-2017, John Mettraux, jmettraux+flor@gmail.com
-#
-# 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.
-#
-# Made in Japan.
-#++
-
+# frozen_string_literal: true
 
 # helpers
 #
@@ -38,7 +15,7 @@ class Flack::App
 
     o.is_a?(Array) &&
     o.length == 3 &&
-    o[0].is_a?(Fixnum) &&
+    o[0].is_a?(Integer) &&
     o[1].is_a?(Hash) &&
     o[2].is_a?(Array)
   end
@@ -98,7 +75,13 @@ class Flack::App
   def serialize_array(env, data, opts)
 
     { '_links' => links(env),
-      '_embedded' => data.collect { |e| serialize(env, e, opts) } }
+      '_embedded' => {
+        key(env) => data.collect { |e| serialize(env, e, opts) } } }
+  end
+
+  def key(env)
+
+    env['flack.rel'] || 'flack:unspecified-rel'
   end
 
   def determine_root_uri(env)
@@ -122,9 +105,23 @@ class Flack::App
 
   def link(env, h, type)
 
-    h["flack:#{type}"] = { href: rel(env, "/#{type}") }
+    l = { href: rel(env, "/#{type}") }
+    l[:templated] = true if type.index('{')
+
+    rel_right_part = type
+      .gsub(/\{\?[^}]*\}/, '')
+      .gsub(/[{}]/, '')
+      .gsub(/\./, '-dot')
+      .gsub(/\*/, '-star')
+
+    h["flack:#{rel_right_part}"] = l
   end
 
+  CURIES = [ {
+    name: 'flack',
+    href: 'https://github.com/floraison/flack/blob/master/doc/rels.md#{rel}',
+    templated: true } ].freeze
+
   def links(env)
 
     h = {}
@@ -134,12 +131,26 @@ class Flack::App
     m = env['REQUEST_METHOD']
     h['self'][:method] = m unless %w[ GET HEAD ].include?(m)
 
-    h['curies'] = [{
-      name: 'flack',
-      href: 'https://github.com/floraison/flack/blob/master/doc/rels.md#{rel}',
-      templated: true }]
+    h['curies'] = CURIES
+
+    link(env, h, 'executions{?status}')
+    link(env, h, 'executions/{domain}{?status}')
+    link(env, h, 'executions/{domain}*{?status}')
+    link(env, h, 'executions/{domain}.*{?status}')
+    link(env, h, 'executions/{exid}')
+    link(env, h, 'executions/{id}')
 
-    link(env, h, :executions)
+    link(env, h, 'messages')
+    link(env, h, 'messages/{point}')
+    link(env, h, 'messages/{exid}/{point}')
+    link(env, h, 'messages/{exid}')
+    link(env, h, 'messages/{id}')
+
+    link(env, h, 'pointers{?type}')
+    link(env, h, 'pointers/{exid}{?type}')
+    link(env, h, 'pointers/{domain}{?type}')
+    link(env, h, 'pointers/{domain}*{?type}')
+    link(env, h, 'pointers/{domain}.*{?type}')
 
     h
   end
@@ -148,11 +159,19 @@ class Flack::App
 
     h = {}
 
+    h['curies'] = CURIES
+
     h['flack:forms/message'] = {
       action: rel(env, '/message'),
       method: 'POST',
       _inputs: { 'flack:forms/message-content' => { type: 'json' } } }
 
+    h['flack:forms/execution-deletion'] = {
+      action: rel(env, '/executions/{exid}'),
+      method: 'DELETE',
+      _inputs: {},
+      templated: true }
+
     h
   end
 
@@ -165,5 +184,10 @@ class Flack::App
 
     respond(env, {}, code: 404, error: error)
   end
+
+  def respond_internal_server_error(env, error=nil)
+
+    respond(env, {}, code: 500, error: error)
+  end
 end
 

data/lib/flack/app/index.rb

@@ -1,27 +1,4 @@
-#--
-# Copyright (c) 2016-2017, John Mettraux, jmettraux+flor@gmail.com
-#
-# 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.
-#
-# Made in Japan.
-#++
-
+# frozen_string_literal: true
 
 # /
 #

data/lib/flack/app/message.rb

@@ -1,27 +1,4 @@
-#--
-# Copyright (c) 2016-2017, John Mettraux, jmettraux+flor@gmail.com
-#
-# 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.
-#
-# Made in Japan.
-#++
-
+# frozen_string_literal: true
 
 # /message
 #
@@ -30,14 +7,13 @@ class Flack::App
   def post_message(env)
 
     msg = JSON.load(env['rack.input'].read)
-#pp msg
 
     pt = msg['point']
 
     return respond_bad_request(env, 'missing msg point') \
       unless pt
     return respond_bad_request(env, "bad msg point #{pt.inspect}") \
-      unless %w[ launch cancel ].include?(pt)
+      unless %w[ launch cancel reply ].include?(pt)
 
     r = self.send("queue_#{pt}", env, msg, { point: pt })
 
@@ -48,16 +24,18 @@ class Flack::App
 
   def queue_launch(env, msg, ret)
 
-    dom = msg['domain']
+    dom = msg['domain'] || 'domain0'
     src = msg['tree'] || msg['name']
+    vars = msg['vars'] || {}
+    fields = msg['fields'] || {}
 
-    return respond_bad_request(env, 'missing domain') \
-      unless dom
     return respond_bad_request(env, 'missing "tree" or "name" in launch msg') \
       unless src
 
     opts = {}
     opts[:domain] = dom
+    opts[:vars] = vars
+    opts[:fields] = fields
 
     r = @unit.launch(src, opts)
 
@@ -86,7 +64,35 @@ class Flack::App
     return respond_not_found(env, 'missing execution node') \
       unless exe.nodes[nid]
 
-    ret['xxx'] = @unit.queue({ 'point' => 'cancel', 'exid' => exid, 'nid' => nid })
+    ret['xxx'] = @unit.queue({ 'point' => 'cancel', 'exid' => exid, 'nid' => nid }) # FIXME change me
+
+    ret['_status'] = 202
+    ret['_location'] = rel(env, '/executions/' + exid)
+    ret['_links'] = { 'flack:execution' => { 'href' => ret['_location'] } }
+
+    ret
+  end
+
+  def queue_reply(env, msg, ret)
+
+    exid = msg['exid']
+    nid = msg['nid']
+    payload = msg['payload'] || {}
+
+    return respond_bad_request(env, 'missing exid') \
+      unless exid
+
+    return respond_bad_request(env, 'missing nid') \
+      unless nid
+
+    exe = @unit.executions[exid: exid]
+
+    return respond_not_found(env, 'missing execution') \
+      unless exe
+    return respond_not_found(env, 'missing execution node') \
+      unless exe.nodes[nid]
+
+    ret['xxx'] = @unit.queue({ 'point' => 'return', 'exid' => exid, 'nid' => nid, 'payload' => payload}) # FIXME change me
 
     ret['_status'] = 202
     ret['_location'] = rel(env, '/executions/' + exid)

data/lib/flack/app/messages.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# /messages/*
+#
+class Flack::App
+
+  # GET /messages
+  def get_messages(env)
+
+# TODO implement paging
+    env['flack.rel'] = 'flack:messages'
+
+    respond(env, @unit.messages.all)
+  end
+
+  # GET /messages/<id>
+  def get_messages_i(env)
+
+    env['flack.rel'] = 'flack:messages'
+
+    if exe = @unit.messages[env['flack.args'][0]]
+      respond(env, exe)
+    else
+      respond_not_found(env)
+    end
+  end
+
+  # GET /messages/<exid>
+  def get_messages_s(env)
+
+# TODO implement paging
+    arg = env['flack.args'][0]
+
+    if Flor.point?(arg)
+      get_messages_by_point(env, arg)
+    else
+      get_messages_by_exid(env, arg)
+    end
+  end
+
+  # GET /messages/<exid>/<point>
+  def get_messages_s_s(env)
+
+    env['flack.rel'] = 'flack:messages/exid/point'
+
+    exid, point = env['flack.args']
+
+    respond(
+      env,
+      @unit.messages.where(exid: exid, point: point).all)
+  end
+
+  protected
+
+  def get_messages_by_exid(env, exid)
+
+    env['flack.rel'] = 'flack:messages/exid'
+
+    respond(env, @unit.messages.where(exid: exid).all)
+  end
+
+  def get_messages_by_point(env, point)
+
+    env['flack.rel'] = 'flack:messages/point'
+
+    respond(env, @unit.messages.where(point: point).all)
+  end
+end
+

data/lib/flack/app/pointers.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# /pointers/*
+#
+class Flack::App
+
+  # GET /pointers
+  #
+  def get_pointers(env)
+
+# TODO implement paging
+    env['flack.rel'] = 'flack:pointers'
+
+    qs = CGI.parse(env['QUERY_STRING'] || '')
+    types = qs['types'].collect { |e| e.split(',') }.flatten
+    types = nil if types == []
+
+    q = @unit.pointers
+    q = q.where(type: types) if types
+
+    respond(env, q.all)
+  end
+
+  # GET /pointers/<exid>
+  # GET /pointers/<domain>
+  # GET /pointers/<domain>*
+  # GET /pointers/<domain>.*
+  #
+  def get_pointers_s(env)
+
+    arg = env['flack.args'][0]
+
+    qs = CGI.parse(env['QUERY_STRING'] || '')
+
+    types = qs['types'].collect { |e| e.split(',') }.flatten
+    types = nil if types == []
+
+    if arg.count('-') == 0
+      get_pointers_by_domain(env, arg, types)
+    else
+      get_pointers_by_exid(env, arg, types)
+    end
+  end
+
+  protected
+
+  def get_pointers_by_exid(env, exid, types)
+
+    env['flack.rel'] = 'flack:pointers/exid'
+
+    q = @unit.pointers.where(exid: exid)
+    q = q.where(type: types) if types
+
+    respond(env, q.all)
+  end
+
+  def get_pointers_by_domain(env, dom, types)
+
+    q = @unit.pointers
+    q = q.where(type: types) if types
+
+    if m = dom.match(/\A([^*]+)\*+\z/)
+      if m[1][-1, 1] == '.'
+        env['flack.rel'] = 'flack:pointers/domain-dot-star'
+        q = q.where(Sequel.like(:domain, "#{m[1]}%"))
+      else
+        env['flack.rel'] = 'flack:pointers/domain-star'
+        q = q.where(
+          Sequel[{ domain: m[1] }] |
+          Sequel.like(:domain, "#{m[1]}.%"))
+      end
+    else
+      env['flack.rel'] = 'flack:pointers/domain'
+      q = q.where(domain: dom)
+    end
+
+    respond(env, q.all)
+  end
+end
+

data/lib/flack/app/static.rb

@@ -1,40 +1,23 @@
-#--
-# Copyright (c) 2016-2017, John Mettraux, jmettraux+flor@gmail.com
-#
-# 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.
-#
-# Made in Japan.
-#++
-
+# frozen_string_literal: true
 
-# /static/+
+# /*.html
+# /*.css
+# /*.js
 #
 class Flack::App
 
-  RACK_FILE = Rack::File.new(
+  STATIC_FILE = Rack::File.new(
     File.absolute_path(
       File.join(
-        File.dirname(__FILE__), '..')))
+        File.dirname(__FILE__), '..', 'static')))
 
-  def get_static_plus(env)
+  def serve_file(env)
 
-    RACK_FILE.call(env)
+    STATIC_FILE.call(env)
   end
+
+  alias get_html_suffix serve_file
+  alias get_css_suffix serve_file
+  alias get_js_suffix serve_file
 end
 

metadata

@@ -1,66 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: flack
 version: !ruby/object:Gem::Version
-  version: 0.9.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - John Mettraux
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2021-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: flor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-  name: flor
-  prerelease: false
+        version: '0'
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
-  name: rack
-  prerelease: false
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
-  name: sequel
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -77,8 +69,6 @@ files:
 - LICENSE.txt
 - Makefile
 - README.md
-- env.txt
-- env2.txt
 - flack.gemspec
 - lib/flack.rb
 - lib/flack/app.rb
@@ -86,13 +76,14 @@ files:
 - lib/flack/app/helpers.rb
 - lib/flack/app/index.rb
 - lib/flack/app/message.rb
+- lib/flack/app/messages.rb
+- lib/flack/app/pointers.rb
 - lib/flack/app/static.rb
-- t.txt
-homepage: http://github.com/floraison
+homepage: https://github.com/floraison/flack
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -107,9 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.4.8
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: a web front-end to the flor workflow engine
 test_files: []

data/env.txt

@@ -1,38 +0,0 @@
-
-GATEWAY_INTERFACE: "CGI/1.1"
-PATH_INFO: "/debug/77"
-QUERY_STRING: "a=b&c=d"
-REMOTE_ADDR: "::1"
-REMOTE_HOST: "localhost"
-REQUEST_METHOD: "GET"
-REQUEST_URI: "http://localhost:7007/debug/77?a=b&c=d"
-SCRIPT_NAME: ""
-SERVER_NAME: "localhost"
-SERVER_PORT: "7007"
-SERVER_PROTOCOL: "HTTP/1.1"
-SERVER_SOFTWARE: "WEBrick/1.3.1 (Ruby/1.9.3/2014-05-14)"
-HTTP_HOST: "localhost:7007"
-HTTP_CONNECTION: "keep-alive"
-HTTP_UPGRADE_INSECURE_REQUESTS: "1"
-HTTP_USER_AGENT: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Safari/537.36"
-HTTP_ACCEPT: "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8"
-HTTP_ACCEPT_ENCODING: "gzip, deflate, sdch"
-HTTP_ACCEPT_LANGUAGE: "ja,en-US;q=0.8,en;q=0.6,fr;q=0.4,de;q=0.2,it;q=0.2,zh-TW;q=0.2,zh;q=0.2"
-HTTP_COOKIE: "sg_dev=2ebdd63d694602c96834d5a261fc471732a2a44c37f40d6446c5cab1b724a263"
-rack.version: [1, 3]
-rack.input: #<Rack::Lint::InputWrapper:0x007fb27b230048 @input=#<StringIO:0x007fb27b238b30>>
-rack.errors: #<Rack::Lint::ErrorWrapper:0x007fb27b22fee0 @error=#<IO:<STDERR>>>
-rack.multithread: true
-rack.multiprocess: false
-rack.run_once: false
-rack.url_scheme: "http"
-rack.hijack?: true
-rack.hijack: #<Proc:0x007fb27b230ae8@/Users/jmettraux/.gem/ruby/1.9.3/gems/rack-1.6.4/lib/rack/lint.rb:525>
-rack.hijack_io: nil
-HTTP_VERSION: "HTTP/1.1"
-REQUEST_PATH: "/debug/77"
-rack.tempfiles: []
-flack.path_info: ["debug", "77"]
-flack.args: [77]
-flack.query_string: {"a"=>"b", "c"=>"d"}
-

data/env2.txt

@@ -1,33 +0,0 @@
-GATEWAY_INTERFACE:CGI/1.1
-PATH_INFO:/debug
-QUERY_STRING:
-REMOTE_ADDR:127.0.0.1
-REMOTE_HOST:localhost
-REQUEST_METHOD:GET
-REQUEST_URI:http://127.0.0.1:7007/flack/debug
-SCRIPT_NAME:/flack
-SERVER_NAME:127.0.0.1
-SERVER_PORT:7007
-SERVER_PROTOCOL:HTTP/1.1
-SERVER_SOFTWARE:WEBrick/1.3.1 (Ruby/1.9.3/2014-05-14)
-HTTP_HOST:127.0.0.1:7007
-HTTP_USER_AGENT:curl/7.43.0
-HTTP_ACCEPT:*/*
-rack.version:[1
-3]
-rack.input:#<Rack::Lint::InputWrapper:0x007ff6baa373a8>
-rack.errors:#<Rack::Lint::ErrorWrapper:0x007ff6baa37290>
-rack.multithread:true
-rack.multiprocess:false
-rack.run_once:false
-rack.url_scheme:http
-rack.hijack?:true
-rack.hijack:#<Proc:0x007ff6baa38208@/Users/jmettraux/.gem/ruby/1.9.3/gems/rack-1.6.4/lib/rack/lint.rb:525>
-rack.hijack_io:null
-HTTP_VERSION:HTTP/1.1
-REQUEST_PATH:/flack/debug
-rack.tempfiles:[]
-flack.path_info:[debug]
-flack.args:[]
-flack.query_string:{}
-flack.root_uri:http://127.0.0.1:7007

data/t.txt

@@ -1,7 +0,0 @@
-
-https://git.io/viDSd
-https://goo.gl/xuOZcu
-http://tiny.cc/flack
-
-http://lambda.io/flack
-