cpee-dstore 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abfbfb8ae9eb6dcdee4a63e346a07adff179dd69a8f24f9a39cf05a91a3c1ef9
+  data.tar.gz: ff32c8d32760a160cfa4962123a6df4d6108f3b943dfd355a8912622f986c31e
+SHA512:
+  metadata.gz: 7b10646a092658cbe842c4153be747ff3a047fc656e8704f7dc0700d745d6d6afb708708bab4a955749634dac9bba475fb8542599b36d0b365564735a732c7d5
+  data.tar.gz: 1f997f2268a32b1150fd6411ecccd339907126817756972b4e5addbd5a1dd19c659aafd52e80682d2e394b23d81e8f9606ab1ce7c168f5a17998071a0d92f7d5

data/AUTHORS

@@ -0,0 +1 @@
+Jürgen "eTM" Mangler <juergen.mangler@gmail.com>

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,46 @@
+# CPEE-DSTORE
+
+A minimal generic file store for the cloud process execution engine
+(cpee.org), built with [riddl](https://github.com/etm/riddl).
+
+It exposes a single generic resource:
+
+```
+GET /<uuid>/<name>
+PUT /<uuid>/<name>
+```
+
+* `uuid` must be a valid UUID (`8-4-4-4-12` hex digits).
+* `name` must match `^[a-z_][a-zA-Z0-9_]*$`.
+
+`PUT` accepts a single body parameter of any mimetype and stores it on
+disk under the configured data directory as `data/<uuid>/<name>`
+(alongside a small sidecar file recording the uploaded mimetype).
+
+`GET` returns the stored content with the mimetype it was uploaded
+with. Requests for an unknown `uuid`/`name` pair return `404`;
+malformed `uuid`/`name` values return `400`.
+
+## Installation
+
+* gem install cpee-dstore
+
+## Scaffold a local install
+
+* cd ~/run
+* cpee-dstore new dstore
+
+## Configuration
+
+The data directory defaults to `data/` next to the server script and
+can be overridden either in `dstore.conf`:
+
+```yaml
+:data_dir: /home/user/run/store/data
+```
+
+or on the command line:
+
+```
+./dstore -o data_dir=/home/mangler/Projects/cpee-resources/data -v start
+```

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+require 'rubygems/package_task'
+
+spec = eval(File.read('cpee-dstore.gemspec'))
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+  FileUtils.mkdir 'pkg' rescue nil
+  FileUtils.rm_rf Dir.glob('pkg/*')
+  FileUtils.ln_sf "#{pkg.name}.gem", "pkg/#{spec.name}.gem"
+end
+
+task :default => [:gem]
+
+task :push => :gem do |r|
+  `gem push pkg/cpee-dstore.gem`
+end
+
+task :install => :gem do |r|
+  `gem install pkg/cpee-dstore.gem`
+end

data/cpee-dstore.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name             = "cpee-dstore"
+  s.version          = "1.0.0"
+  s.platform         = Gem::Platform::RUBY
+  s.license          = "LGPL-3.0-or-later"
+  s.summary          = "Generic document store for the cloud process execution engine (cpee.org)"
+
+  s.description      = "see http://cpee.org"
+
+  s.files            = Dir['{server/**/*,tools/**/*,lib/**/*}'] + %w(LICENSE Rakefile cpee-dstore.gemspec README.md AUTHORS)
+  s.require_path     = 'lib'
+  s.extra_rdoc_files = ['README.md']
+  s.bindir           = 'tools'
+  s.executables      = ['cpee-dstore']
+
+  s.required_ruby_version = '>=2.4.0'
+
+  s.authors          = ['Juergen eTM Mangler']
+
+  s.email            = 'juergen.mangler@gmail.com'
+  s.homepage         = 'http://cpee.org/'
+
+  s.add_runtime_dependency 'riddl', '~> 1.0'
+end

data/lib/cpee-dstore/implementation.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/ruby
+#
+# This file is part of CPEE-DSTORE.
+#
+# CPEE-DSTORE is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# CPEE-DSTORE is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CPEE-DSTORE (file LICENSE in the main directory). If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+require 'mimemagic'
+require 'riddl/server'
+require 'fileutils'
+
+module CPEE
+  module DStore
+    SERVER = File.expand_path(File.join(__dir__,'implementation.xml'))
+
+    class DoGet < Riddl::Implementation #{{{
+      def response
+        file = File.join(@a[0],@r[-2],@r[-1])
+        meta = file + '.mimetype'
+        if File.exist?(file) && File.exist?(meta)
+          Riddl::Parameter::Complex.new('file',File.read(meta).strip,File.open(file,'rb'))
+        else
+          @status = 404
+          nil
+        end
+      end
+    end #}}}
+
+    class DoPut < Riddl::Implementation #{{{
+      def response
+        name = @r[-1]
+        dir = File.join(@a[0],@r[-2])
+        FileUtils.mkdir_p(dir)
+
+        File.open(File.join(dir,name),'wb') do |f|
+          IO.copy_stream(@p[0].value,f)
+          mime = MimeMagic.by_magic(@p[0].value.read)
+          mt = if mime.nil?
+            'text/plain'
+          else
+            mime.type
+          end
+          File.write(File.join(dir,name + '.mimetype'), mt)
+        end
+
+        nil
+      end
+    end #}}}
+
+    def self::implementation(opts)
+      opts[:data_dir] ||= File.expand_path(File.join(__dir__,'data'))
+
+      Proc.new do
+        on resource do                                                                     # "/"
+          on resource '[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}' do      # uuid
+            on resource '[a-z_][a-zA-Z0-9_]*' do                                            # name
+              run DoGet, opts[:data_dir] if get
+              run DoPut, opts[:data_dir] if put 'file'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cpee-dstore/implementation.xml

@@ -0,0 +1,32 @@
+<!--
+  This file is part of CPEE-DSTORE.
+
+  CPEE-DSTORE is free software: you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by the
+  Free Software Foundation, either version 3 of the License, or (at your
+  option) any later version.
+
+  CPEE-DSTORE is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+  FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
+  more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with CPEE-DSTORE (file LICENSE in the main directory). If not, see
+  <http://www.gnu.org/licenses/>.
+-->
+
+<description xmlns="http://riddl.org/ns/description/1.0" xmlns:ann="http://riddl.org/ns/annotation/1.0" xmlns:xi="http://www.w3.org/2001/XInclude" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <message name="file">
+    <parameter name="file" mimetype="*"/>
+  </message>
+
+  <resource>
+    <resource relative="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}">
+      <resource relative='[a-z_][a-zA-Z0-9_]*'>
+        <get out="file"/>
+        <put in="file"/>
+      </resource>
+    </resource>
+  </resource>
+</description>

data/server/dstore

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby
+#
+# This file is part of CPEE-DSTORE.
+#
+# CPEE-DSTORE is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# CPEE-DSTORE is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CPEE-DSTORE (file LICENSE in the main directory).  If not, see
+# <http://www.gnu.org/licenses/>.
+
+if File.exist?(File.join(__dir__,'..','lib','cpee-dstore','implementation.rb'))
+  require_relative File.join(__dir__,'..','lib','cpee-dstore','implementation')
+elsif File.exist?(File.join(Dir.home,'Projects','cpee-dstore','lib','cpee-dstore','implementation.rb'))
+  require_relative File.join(Dir.home, 'Projects','cpee-dstore','lib','cpee-dstore','implementation')
+else
+  require 'cpee-dstore/implementation'
+end
+
+options = {
+  :host => 'localhost',
+  :port => 9304,
+  :secure => false
+}
+
+Riddl::Server.new(CPEE::DStore::SERVER, options) do
+  accessible_description true
+  cross_site_xhr true
+
+  @riddl_opts[:data_dir] ||= File.join(__dir__,'data')
+
+  use CPEE::DStore::implementation(@riddl_opts)
+end.loop!

data/tools/cpee-dstore

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby
+#
+# This file is part of CPEE-DSTORE.
+#
+# CPEE-DSTORE is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# CPEE-DSTORE is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CPEE-DSTORE (file LICENSE in the main directory).  If not, see
+# <http://www.gnu.org/licenses/>.
+
+curpath = __dir__
+require 'rubygems'
+require 'optparse'
+require 'fileutils'
+
+def wrap(s, width=78, indent=18)
+	lines = []
+	line, s = s[0..indent-2], s[indent..-1]
+  s.split(/\n/).each do |ss|
+    ss.split(/[ \t]+/).each do |word|
+      if line.size + word.size >= width
+        lines << line
+        line = (" " * (indent)) + word
+      else
+        line << " " << word
+      end
+    end
+    lines << line if line
+    line = (" " * (indent-1))
+  end
+	return lines.join "\n"
+end
+
+ARGV.options { |opt|
+  opt.summary_indent = ' ' * 2
+  opt.summary_width = 15
+  opt.banner = "Usage:\n#{opt.summary_indent}#{File.basename($0)} [options] new DIR\n"
+  opt.on("Options:")
+  opt.on("--help", "-h", "This text") { puts opt; exit }
+	opt.on("")
+  opt.on(wrap("[new DIR]         scaffolds a sample data store service."))
+  opt.parse!
+}
+if (ARGV.length <  2) ||
+   (ARGV.length == 2  && !(%w(new).include?(ARGV[0]))) ||
+   (ARGV.length >  2)
+  puts ARGV.options
+  exit
+end
+command = ARGV[0]
+p1      = ARGV[1]
+
+if command == 'new'
+  insta = "#{curpath}/../server/"
+  if !File.exist?(p1)
+    FileUtils.cp_r(insta,p1)
+    FileUtils.mkdir_p(File.join(p1,'data'))
+  else
+    FileUtils.cp_r(Dir.glob(File.join(insta,'*')).delete_if{|e| e =~ /\.conf/ },p1,remove_destination: true)
+    puts 'Directory already exists, updating ...'
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: cpee-dstore
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juergen eTM Mangler
+bindir: tools
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: riddl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: see http://cpee.org
+email: juergen.mangler@gmail.com
+executables:
+- cpee-dstore
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- AUTHORS
+- LICENSE
+- README.md
+- Rakefile
+- cpee-dstore.gemspec
+- lib/cpee-dstore/implementation.rb
+- lib/cpee-dstore/implementation.xml
+- server/dstore
+- tools/cpee-dstore
+homepage: http://cpee.org/
+licenses:
+- LGPL-3.0-or-later
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Generic document store for the cloud process execution engine (cpee.org)
+test_files: []