flack 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36dd9d587c7d003cc296db2fc3ac9f7dac0916e267a43904f5ca8be1e25b780e
-  data.tar.gz: 1bc04ec7696966e9d197b80c25af1a76309463eabc88222d4777d769f866f9c6
+  metadata.gz: f3568a0f9f164613704ec78d2db777847180a5e6871dc77078aac09469506eed
+  data.tar.gz: f52a6ed6b32a249a98c5ac43d4d4178ea01a727995d6238efa458822502f9a81
 SHA512:
-  metadata.gz: f8f69c70110ed67738d5c0ef95b97d4d0d0612520bbe8bab4c0353018f9bd0476bc48f29644514d3628cd2edb446abacdb38bf5392e2fbf95044a6401c7a3d37
-  data.tar.gz: 59784ead309c9df695c416af89087d1fdf5e16d7900c758027da2f771b48337774252ee792e47fac32ba43fce0a86d2600798e155e420aecb357c1a235843bea
+  metadata.gz: 001a5dbaaebef7d8265b7a717da42972b1417eb1fc503e7ecc180c0320145038275a0ae7f6d51aa3fa6941757995147e96399844fbee04e648326d0008927fd3
+  data.tar.gz: cd6cd3d2952b87e8bd009b1bd6212889221a99a7e422a9865cab27398e567c290e7730f45a424e7c12c9c1d6ad30c08a9008a63337c0872e34f8d1d838189a4e

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 # CHANGELOG.md
 
 
+## flack 1.3.0  released 2023-03-29
+
+- GET /pointers?count=true
+- GET /executions?count=true
+- GET /pointers?exid=net.ntt.finance-
+- GET /pointers?dexid=20230310
+- GET /executions?exid=net.ntt.finance-
+- GET /executions?dexid=20230310
+- Add Flack.on_unit_created(unit) callback
+
+
+## flack 1.2.2  released 2021-04-08
+
+- let #rel fall back on PATH_INFO if no REQUEST_PATH
+
+
 ## flack 1.2.1  released 2021-04-08
 
 - Respond with a proper 500 error when necessary (and dump to $stderr)

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2016-2017, John Mettraux, jmettraux+flor@gmail.com
+Copyright (c) 2016-2023, 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

data/Makefile

@@ -1,10 +1,10 @@
 
 ## gem tasks ##
 
-NAME = \
-  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name")
-VERSION = \
-  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version")
+NAME != \
+  ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name"
+VERSION != \
+  ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version"
 
 PORT = 7007
 PID_FILE = tmp/$(NAME).pid

data/README.md

@@ -23,6 +23,17 @@ Warning: this serves an API, not some fancy web interface.
 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/).
 
 
+## in a rack app
+
+```ruby
+map '/flack' do
+
+  run Flack::App.new('flor/')
+    # starts a flack app whose flor unit uses the tree at flor/
+end
+```
+
+
 ## license
 
 MIT, see [LICENSE.txt](LICENSE.txt)

data/lib/flack/app/executions.rb

@@ -5,20 +5,31 @@
 class Flack::App
 
   # GET /executions
+  # GET /executions?exid=<exid_prefix>
+  # GET /executions?dexid=<date_exid_prefix>
   #
   def get_executions(env)
 
 # TODO implement paging
     env['flack.rel'] = 'flack:executions'
 
-    qs = CGI.parse(env['QUERY_STRING'] || '')
-    statuses = qs['status']
-    statuses = nil if statuses == []
+    statuses = query_values(env, 'statuses', 'status')
+    exid = query_value(env, 'exid')
+    dexid = query_value(env, 'dexid')
 
     q = @unit.executions
+      #
     q = q.where(status: statuses) if statuses
+    q = q.where(Sequel.like(:exid, "#{exid}%")) if exid
+    q = q.where(Sequel.like(:exid, "%-#{dexid}%")) if dexid
+      #
+    q = q.order(:exid)
 
-    respond(env, q.all)
+    if query_value(env, 'count')
+      respond(env, { count: q.count })
+    else
+      respond(env, q.all)
+    end
   end
 
   # GET /executions/<id>
@@ -98,9 +109,7 @@ class Flack::App
 
   def get_executions_by_domain(env, dom)
 
-    qs = CGI.parse(env['QUERY_STRING'] || '')
-    statuses = qs['status']
-    statuses = nil if statuses == []
+    statuses = query_values(env, 'statuses', 'status')
 
     q = @unit.executions
 

data/lib/flack/app/helpers.rb

@@ -126,14 +126,14 @@ class Flack::App
 
     h = {}
 
-    h['self'] = {
-      href: rel(env, env['REQUEST_PATH']) }
+    h['self'] = { href: rel(env, env['REQUEST_PATH'] || env['PATH_INFO']) }
+
     m = env['REQUEST_METHOD']
     h['self'][:method] = m unless %w[ GET HEAD ].include?(m)
 
     h['curies'] = CURIES
 
-    link(env, h, 'executions{?status}')
+    link(env, h, 'executions{?status,exid,dexid,count}')
     link(env, h, 'executions/{domain}{?status}')
     link(env, h, 'executions/{domain}*{?status}')
     link(env, h, 'executions/{domain}.*{?status}')
@@ -146,11 +146,11 @@ class Flack::App
     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}')
+    link(env, h, 'pointers{?types,exid,dexid,count}')
+    link(env, h, 'pointers/{exid}{?types}')
+    link(env, h, 'pointers/{domain}{?types}')
+    link(env, h, 'pointers/{domain}*{?types}')
+    link(env, h, 'pointers/{domain}.*{?types}')
 
     h
   end
@@ -189,5 +189,29 @@ class Flack::App
 
     respond(env, {}, code: 500, error: error)
   end
+
+  def query_value(env, *keys)
+
+    query = (env['__query'] ||= CGI.parse(env['QUERY_STRING'] || ''))
+
+    r = keys.collect { |k| query[k] }.compact.first
+    r ? r.first : r
+  end
+
+  def query_values(env, *keys)
+
+    query = (env['__query'] ||= CGI.parse(env['QUERY_STRING'] || ''))
+
+    r = keys
+      .collect { |k| query[k] }
+      .select { |v| v != [] }
+      .first
+    return nil unless r
+
+    r = r.first.split(',').select { |e| e.length > 0 }
+    return nil if r == []
+
+    r
+  end
 end
 

data/lib/flack/app/message.rb

@@ -64,7 +64,8 @@ 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 }) # FIXME change me
+    ret['queued'] = @unit.queue({
+      'point' => 'cancel', 'exid' => exid, 'nid' => nid })
 
     ret['_status'] = 202
     ret['_location'] = rel(env, '/executions/' + exid)
@@ -92,7 +93,8 @@ class Flack::App
     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['queued'] = @unit.queue({
+      'point' => 'return', 'exid' => exid, 'nid' => nid, 'payload' => payload})
 
     ret['_status'] = 202
     ret['_location'] = rel(env, '/executions/' + exid)

data/lib/flack/app/messages.rb

@@ -10,6 +10,8 @@ class Flack::App
 # TODO implement paging
     env['flack.rel'] = 'flack:messages'
 
+# TODO {?exid,dexid,count} like for /executions and /pointers
+
     respond(env, @unit.messages.all)
   end
 

data/lib/flack/app/pointers.rb

@@ -5,20 +5,32 @@
 class Flack::App
 
   # GET /pointers
+  # GET /pointers?exid=<exid_prefix>
+  # GET /pointers?dexid=<date_exid_prefix>
   #
   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 == []
+    types = query_values(env, 'types', 'type')
+
+    exid = query_value(env, 'exid')
+    dexid = query_value(env, 'dexid')
 
     q = @unit.pointers
+      #
     q = q.where(type: types) if types
+    q = q.where(Sequel.like(:exid, "#{exid}%")) if exid
+    q = q.where(Sequel.like(:exid, "%-#{dexid}%")) if dexid
+      #
+    q = q.order(:exid)
 
-    respond(env, q.all)
+    if query_value(env, 'count')
+      respond(env, { count: q.count })
+    else
+      respond(env, q.all)
+    end
   end
 
   # GET /pointers/<exid>
@@ -30,10 +42,7 @@ class Flack::App
 
     arg = env['flack.args'][0]
 
-    qs = CGI.parse(env['QUERY_STRING'] || '')
-
-    types = qs['types'].collect { |e| e.split(',') }.flatten
-    types = nil if types == []
+    types = query_values(env, 'types', 'type')
 
     if arg.count('-') == 0
       get_pointers_by_domain(env, arg, types)

data/lib/flack/app.rb

@@ -29,6 +29,8 @@ class Flack::App
 
     self.class.unit = @unit
 
+    Flack.on_unit_created(@unit) if Flack.respond_to?(:on_unit_created)
+
     @unit
   end
 
@@ -97,8 +99,11 @@ class Flack::App
 
     $stderr.puts '=' * 80
     $stderr.puts Time.now.to_s
+    $stderr.puts '-' * 80
     $stderr.puts err.inspect
     $stderr.puts err.backtrace
+    $stderr.puts '-' * 80
+    PP.pp(env, $stderr)
     $stderr.puts ('=' * 79) + '.'
 
     respond_internal_server_error(env, err)

data/lib/flack.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'pp'
 require 'cgi'
 require 'rack'
 
@@ -8,7 +9,7 @@ require 'flor/unit'
 
 module Flack
 
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end
 
 require 'flack/app'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flack
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - John Mettraux
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flor
@@ -83,7 +83,7 @@ homepage: https://github.com/floraison/flack
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,8 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: a web front-end to the flor workflow engine
 test_files: []