semcon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3980361cb218919f5d7b87ffbbe03ee325c5d4e807f5da14ec474e65f120faf
+  data.tar.gz: 987a4b6112b196eb4409ea67c7589aef6d24efb12002ba8050105d3181bb62da
+SHA512:
+  metadata.gz: dcf9ab7da19da4f1e7ca478f39c145b2cc95ca1ce9c84f3263c9b011da0e900df1c9852a5fd7fd7c977eddb4aefb04b65ac86488ac269618def615264ba5e949
+  data.tar.gz: 416a13437f6f51d3385bb15b9a2cad25c97845b55070b5239c408fe4dbccd8e5f3a73bf22fe741316aba1af7a5f59cddd6457bae98c995bbc8945743dd5aa3ef

data/AUTHORS

@@ -0,0 +1 @@
+* Christoph Fabianek <christoph@ownyourdata.eu>

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 OwnYourData
+
+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.

data/README.md

@@ -0,0 +1,5 @@
+# SemCon Gem
+
+[![Gem Version](https://badge.fury.io/rb/semcon.png)](http://badge.fury.io/rb/semcon)
+[![Build Status](https://github.com/ownyourdata/semcon/workflows/CI/badge.svg)](https://github.com/ownyourdata/semcon/actions?query=workflow%3ACI)
+[![Coverage Status](https://coveralls.io/repos/github/OwnYourData/semcon/badge.svg?branch=main)](https://coveralls.io/github/OwnYourData/semcon?branch=main)

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/semcon/basic.rb

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+class Semcon
+
+    # basic functions ---------------------------
+    def self.host_from_did(did, filter, options)
+        result, err_msg = Oydid.read(did, options)
+        if result.nil? || err_msg != ""
+            return [nil, err_msg]
+        end
+        result_url = ""
+        w3c_did = Oydid.w3c(result, options)
+        service_array = w3c_did["service"]
+        service_array.each do |service|
+            if service["type"] == filter
+                case filter
+                when "DecentralizedWebNode"
+                    nodes = service["serviceEndpoint"]["nodes"] rescue nil
+                    if nodes.nil?
+                        next
+                    end
+                    result_url = service["serviceEndpoint"]["nodes"].first rescue nil
+                    if nodes.nil?
+                        next
+                    end
+                    break
+                else
+                    result_url = service["serviceEndpoint"].to_s
+                    break
+                end
+            end
+        end unless service_array.nil?
+        if result_url.to_s == ""
+            return [nil, "Service Endpoint URL not found in " + did.to_s]
+        else
+            return [result_url, ""]
+        end
+    end
+end

data/lib/semcon.rb

@@ -0,0 +1,65 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'httparty'
+require 'oydid'
+require 'semcon/basic'
+
+class Semcon
+    def self.write(payload, target, options)
+        record_dri = Oydid.hash(Oydid.canonical({"content": payload, "meta": {}}))
+        # puts "Record DRI: " + record_dri.to_s
+        target_url, err_msg = host_from_did(target, "DecentralizedWebNode", options)
+        if target_url.nil? || err_msg != ""
+            return [nil, err_msg]
+        end
+        # puts "Target URL: " + target_url.to_s
+
+        content = [
+            {
+                "id": "#data", 
+                "type": "data", 
+                "serviceEndpoint": target + "?dri="+record_dri
+            }
+        ]
+        options[:location] = target_url
+        options[:doc_location] = target_url
+        options[:log_location] = target_url
+        did, didDocument, revoc_log, l1, l2, r1, privateKey, revocationKey, did_old, log_old, msg = Oydid.generate_base(content, "", "create", options)
+        semcon_object = {}
+        semcon_object["data"] = {"content": payload, "meta": {}}
+        semcon_object["did-document"] = didDocument
+        semcon_object["did-log"] = [l1, l2]
+        # puts "Write Object"
+        # puts JSON.pretty_generate(semcon_object)
+
+        retVal = HTTParty.post(target_url + "/api/data",
+            headers: { 'Content-Type' => 'application/json' },
+            body: semcon_object.to_json )
+
+        # puts "Response from dc-base:"
+        # puts JSON.pretty_generate(retVal.parsed_response)
+
+        err_msg = ""
+        did = retVal.parsed_response["did"].to_s rescue nil
+        if did.nil?
+            err_msg = retVal.parsed_response["error"] rescue nil
+        end
+        return [did, err_msg]
+    end
+
+    def self.read(target, options)
+        target_url, err_msg = host_from_did(target, "data", options)
+        if target_url.nil? || err_msg != ""
+            return [nil, err_msg]
+        end
+        dc_did = target_url.dup.split("?").first
+        host_url, err_msg = host_from_did(dc_did, "DecentralizedWebNode", options)
+        target_url = host_url.to_s + "/api/data?" + target_url.dup.split("?").last
+        retVal = HTTParty.get(target_url)
+        result = retVal.parsed_response
+
+        return [result, err_msg]
+    end
+end
+

data/spec/semcon_spec.rb

@@ -0,0 +1,14 @@
+require_relative 'spec_helper'
+
+describe "Semcon handling" do
+
+  # writing data
+  Dir.glob(File.expand_path("../input/*.doc", __FILE__)).each do |input|
+    it "writes #{input.split('/').last}" do
+      expected = File.read(input.sub('input', 'output'))
+      data = File.read(input)
+      expect(Semcon.write(data, {})).to eq expected
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+$:.unshift(File.join("../lib", __FILE__))
+
+require "bundler/setup"
+require 'rspec'
+
+begin
+  require 'simplecov'
+  require 'simplecov-lcov'
+
+  SimpleCov::Formatter::LcovFormatter.config do |config|
+    #Coveralls is coverage by default/lcov. Send info results
+    config.report_with_single_file = true
+    config.single_report_path = 'coverage/lcov.info'
+  end
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::LcovFormatter
+  ])
+  
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+rescue LoadError
+end
+
+require 'oydid'
+
+::RSpec.configure do |c|
+  c.filter_run focus: true
+  c.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: semcon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christoph Fabianek
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: oydid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: This gem provides the basic methods for managing Semantic Containers.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- LICENSE
+- README.md
+- VERSION
+- lib/semcon.rb
+- lib/semcon/basic.rb
+- spec/semcon_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ownyourdata/semcon
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://ownyourdata.github.io/semcon
+  bug_tracker_uri: https://github.com/ownyourdata/semcon/issues
+  homepage_uri: http://github.com/ownyourdata/semcon
+  source_code_uri: http://github.com/ownyourdata/semcon/tree/main/ruby-gem
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Semantic Container handling in Ruby.
+test_files:
+- spec/spec_helper.rb
+- spec/semcon_spec.rb