flack 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2db9db527f885215d426f53353b9cc428d35bb54e6b11205a31c04ef234410f6
-  data.tar.gz: 5b2242b4137b08e65064682b7aa37f3f92267e58c7acca773580168b290b1cf5
+  metadata.gz: 83938d22a1da3371d405bc6f6f9ad5458d2e44ac21616b99df1d3f1058ffbc40
+  data.tar.gz: 5c844ae9c4eeca795a70cbcacfd616e40217b120ca75ae6d8368e343bb87746c
 SHA512:
-  metadata.gz: 11f46755eaa4d5aac73d8478bfa2de24dc3c6c3c7f29673eeec75a2932149452726c6c77c71b6eec5a53bf3401ca61851b9dbd04ddeca26f931128e460d711b8
-  data.tar.gz: 3fbb4eb5155ae97de8ab8cee7c4b99e4634c18fad5e5263e288e411f63f08286821021b6b05372bfeafccf845e4cdaee8b04a559b8b737e23728ee96c25641ca
+  metadata.gz: 43ca7e422779cc153db5c11db80a7048a9f526de6f2382e88b67a1b3fb12418f9a4a3e87e72b948bb685bd22e18ae8bb3d5d549dd24d00d840ce6b3f16ac5a17
+  data.tar.gz: fdca36864febf3ac369363de3fbe1b1687efbeb850f84b5ba3131d7af66d710d4e61d163a33c18c3b4923314c8eb3f7ddad3992e169de085aec80b476ac3d2c2

data/CHANGELOG.md

@@ -2,7 +2,15 @@
 # flack CHANGELOG.md
 
 
-## flack 0.17.0  not yet released
+## 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
 

data/Makefile

@@ -70,3 +70,9 @@ stop:
 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,7 +1,7 @@
 
 # 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.
@@ -20,7 +20,7 @@ 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

@@ -32,7 +32,7 @@ A web front-end to the flor workflow engine
   s.add_runtime_dependency 'flor'
 
   s.add_runtime_dependency 'rack', '>= 1.6', '< 3.0'
-  s.add_runtime_dependency 'httpclient', '~> 2.8'
+  #s.add_runtime_dependency 'httpclient', '~> 2.8'
 
   s.add_development_dependency 'rspec', '~> 3'
 

data/lib/flack.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 
+require 'cgi'
 require 'rack'
 
 require 'flor/unit'
@@ -6,7 +8,7 @@ require 'flor/unit'
 
 module Flack
 
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end
 
 require 'flack/app'

data/lib/flack/app.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'flack/app/helpers'
   #
@@ -6,6 +7,7 @@ require 'flack/app/static'
 require 'flack/app/message'
 require 'flack/app/executions'
 require 'flack/app/messages'
+require 'flack/app/pointers'
 
 
 class Flack::App
@@ -99,6 +101,7 @@ class Flack::App
     .collect(&:to_s)
     .select { |m| m.match(/\A(get|head|put|post|delete)_.+\z/) }
     .select { |m| instance_method(m).arity == 1 }
+    .sort
     .collect { |m|
       s = m.split('_')
       if s.length == 3 && s[2] == 'suffix'

data/lib/flack/app/executions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # /executions/*
 #
@@ -10,7 +11,14 @@ class Flack::App
 # TODO implement paging
     env['flack.rel'] = 'flack:executions'
 
-    respond(env, @unit.executions.all)
+    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>
@@ -42,6 +50,39 @@ class Flack::App
     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)
@@ -57,6 +98,10 @@ class Flack::App
 
   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/)
@@ -74,6 +119,8 @@ class Flack::App
       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,3 +1,4 @@
+# frozen_string_literal: true
 
 # helpers
 #
@@ -108,6 +109,7 @@ class Flack::App
     l[:templated] = true if type.index('{')
 
     rel_right_part = type
+      .gsub(/\{\?[^}]*\}/, '')
       .gsub(/[{}]/, '')
       .gsub(/\./, '-dot')
       .gsub(/\*/, '-star')
@@ -115,6 +117,11 @@ class Flack::App
     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 = {}
@@ -124,15 +131,12 @@ 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')
-    link(env, h, 'executions/{domain}')
-    link(env, h, 'executions/{domain}*')
-    link(env, h, 'executions/{domain}.*')
+    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}')
 
@@ -142,6 +146,12 @@ 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}')
+
     h
   end
 
@@ -149,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
 

data/lib/flack/app/index.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # /
 #

data/lib/flack/app/message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # /message
 #

data/lib/flack/app/messages.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # /messages/*
 #

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,3 +1,4 @@
+# frozen_string_literal: true
 
 # /*.html
 # /*.css

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flack
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-22 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flor
@@ -44,20 +44,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: httpclient
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +77,7 @@ files:
 - 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
 homepage: https://github.com/floraison/flack
 licenses: