ruby_kpi 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_kpi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Fabio Viola
+
+MIT License
+
+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,31 @@
+# RubyKpi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_kpi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_kpi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ruby_kpi/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/DataStructures.rb

@@ -0,0 +1,90 @@
+module RubyKpi
+
+  ##################################################
+  #
+  # The URI class
+  #
+  ##################################################
+
+  class URI
+
+    # accessor
+    attr_reader :value
+
+    # constructor
+    def initialize(value)
+      if value
+        @value = value
+      else
+        @value = "http://www.nokia.com/NRC/M3/sib#any"
+      end
+    end
+
+    # to string
+    def to_str()
+      return "<" + @value + ">"
+    end
+
+  end
+
+
+  ##################################################
+  #
+  # The Literal class
+  #
+  ##################################################
+
+  class Literal
+
+    # accessor
+    attr_reader :value
+
+    # constructor
+    def initialize(value)
+      @value = value
+    end
+
+    # to string
+    def to_str()
+      return @value
+    end
+
+  end
+
+
+  ##################################################
+  #
+  # The Triple class
+  #
+  ##################################################
+
+  class Triple
+
+    # accessor
+    attr_reader :subject, :predicate, :object
+
+    # constructor
+    def initialize(subject, predicate, object)
+      
+      # subject
+      @subject = subject
+
+      # predicate
+      @predicate = predicate
+
+      # object
+      @object = object
+
+    end
+
+    # to string
+    def to_str()
+      
+      return "[" + @subject.to_str() + ", " + @predicate.to_str() + ", " + @object.to_str() + "]"
+
+    end
+ 
+  end
+
+
+end

data/lib/ReplyMessage.rb

@@ -0,0 +1,384 @@
+#!/usr/bin/ruby
+
+# requirements
+require "xml"
+
+module RubyKpi
+
+  class ReplyMessage
+
+    attr_reader :content, :message, :message_type, :transaction_type
+
+    # initialization
+    def initialize(message)
+
+      # attributes needed to parse the message
+      @message = message
+      @content = nil
+
+      # message attributes
+      @transaction_type = nil
+      @message_type = nil
+
+      # parse the message
+      @content = XML::Parser.string(@message).parse
+
+    end
+
+    # get_message_type
+    def get_message_type()
+      
+      # get the message type
+      @message_type = @content.find('//message_type').first.content()
+      return @message_type
+      
+    end
+
+    # get_transaction_type
+    def get_transaction_type()
+      
+      # get the transaction type
+      @transaction_type = @content.find('//transaction_type').first.content()
+      return @transaction_type
+
+    end
+
+    # get_subscription_id
+    def get_subscription_id()
+
+      # parse the parameters section
+      subscription_id = nil
+      pars = @content.root.find('./parameter')
+      pars.each do |p|
+        if p.attributes.get_attribute("name").value == "subscription_id"
+          subscription_id = p.content
+          break
+        end 
+      end
+      
+      # return the subscription_id
+      return  subscription_id
+
+    end
+
+    # get_status
+    def success?()
+
+      # find the new root
+      pars = @content.root.find('./parameter')
+      pars.each do |p|
+        
+        # get and return the status
+        if p.attributes.get_attribute("name").value == "status"
+          return p.content == "m3:Success" ? true : false
+          break
+        end 
+      end
+    end
+
+    # get_rdf_triples
+    def get_rdf_triples()
+
+      mt = get_transaction_type()
+
+      # It is a query?
+      if  mt == "QUERY" or mt == "SUBSCRIBE"
+
+        # Get the triple list
+        triple_list = []
+        pars = @content.root.find('./parameter')
+        pars.each do |p|
+
+          if p.attributes.get_attribute("name").value == "results"
+
+            # new root
+            nroot = p
+            t = p.find('./triple_list').first.find('./triple')
+            t.each do |tr|
+              
+              # get subject
+              s = tr.find('./subject').first
+              s_content = s.content.strip
+              s_type = s.attributes.get_attribute("type").value.strip
+              if s_type.downcase == "uri"
+                subject = URI.new(s_content)
+              else
+                subject = Literal.new(s_content)
+              end
+              
+              # get predicate
+              p = tr.find('./predicate').first
+              p_content = p.content.strip
+              predicate = URI.new(p_content)
+              
+              # get object
+              o = tr.find('./object').first
+              o_content = o.content.strip
+              o_type = o.attributes.get_attribute("type").value.strip
+              if o_type.downcase == "uri"
+                object = URI.new(o_content)
+              else
+                object = Literal.new(o_content)
+              end
+              
+              # triple
+              t = Triple.new(subject, predicate, object)
+              triple_list << t
+              
+            end
+          end 
+        end
+        
+        return triple_list
+
+      else
+        
+        # do nothing
+        # TODO: raise an exception
+
+      end
+    end
+
+    # get_sparql_results
+    def get_sparql_results()
+
+      mt = get_transaction_type()
+      if mt == "QUERY" or mt == "SUBSCRIBE"
+
+        # declare an empty list
+        results = []
+
+        # Get the triple list
+        pars = @content.root.find('./parameter')
+        pars.each do |p|
+          if p.attributes.get_attribute("name").value == "results"
+
+            # we're on the sparql node
+            p.each_element do |sparql|
+              
+              sparql.each_element do |hr|
+                
+                # head/results fields
+                hr.each_element do |field|
+                  
+                  # find the results
+                  if field.name == "result"
+                    
+                    # We found a result
+                    result = []
+                    
+                    field.each_element do |n|
+                      variable = []
+                      variable << n.attributes.first.value
+                      n.each_element do |v|
+                        variable << v.name
+                        variable << v.content
+                      end
+                      result << variable
+                      results << result
+                    end
+
+                  end
+                end        
+              end
+              break
+            end
+          end
+        end
+        
+        # return
+        return results
+
+      else
+        
+        # do nothing
+
+      end
+
+    end
+
+    # get_rdf_triples_from_indication
+    def get_rdf_triples_from_indication()
+
+      # Get NEW and OLD triple list
+      added = []
+      removed = []
+      pars = @content.root.find('./parameter')
+      pars.each do |p|
+        
+        # Extract added triples
+        if p.attributes.get_attribute("name").value == "new_results"
+          
+          # new root
+          nroot = p
+          t = p.find('./triple_list').first.find('./triple')
+          t.each do |tr|
+
+            # get subject
+            s = tr.find('./subject').first
+            s_content = s.content.strip
+            s_type = s.attributes.get_attribute("type").value.strip               
+            if s_type.downcase == "uri"
+              subject = URI.new(s_content)
+            else
+              subject = Literal.new(s_content)
+            end
+
+            # get predicate
+            p = tr.find('./predicate').first
+            p_content = p.content.strip
+            predicate = URI.new(p_content)
+            
+            # get object
+            o = tr.find('./object').first
+            o_content = o.content.strip
+            o_type = o.attributes.get_attribute("type").value.strip
+            if o_type.downcase == "uri"
+              object = URI.new(o_content)
+            else
+              object = Literal.new(o_content)
+            end
+            
+            # build the triple
+            added_triple = Triple.new(subject, predicate, object)
+            added << added_triple
+
+          end
+          
+          # Extract removed triples
+        elsif p.attributes.get_attribute("name").value == "obsolete_results"
+
+          # new root
+          nroot = p
+          t = p.find('./triple_list').first.find('./triple')
+          t.each do |tr|
+            
+            # get subject
+            s = tr.find('./subject').first
+            s_content = s.content.strip
+            s_type = s.attributes.get_attribute("type").value.strip               
+            if s_type.downcase == "uri"
+              subject = URI.new(s_content)
+            else
+              subject = Literal.new(s_content)
+            end
+            
+            # get predicate
+            p = tr.find('./predicate').first
+            p_content = p.content.strip
+            predicate = URI.new(p_content)
+            
+            # get object
+            o = tr.find('./object').first
+            o_content = o.content.strip
+            o_type = o.attributes.get_attribute("type").value.strip
+            if o_type.downcase == "uri"
+              object = URI.new(o_content)
+            else
+              object = Literal.new(o_content)
+            end
+            
+            # build the triple
+            removed_triple = Triple.new(subject, predicate, object)
+            removed << removed_triple
+            
+          end        
+        end     
+      end       
+      
+      # return added and removed triples
+      return added, removed
+
+    end
+
+    # get_sparql_results_from_indication
+    def get_sparql_results_from_indication()
+
+      puts "method started"
+
+      # declare an empty list
+      added = []
+      removed = []
+
+      # Get the triple list
+      pars = @content.root.find('./parameter')
+      pars.each do |p|
+        
+        puts p.attributes.get_attribute("name").value
+
+        if p.attributes.get_attribute("name").value == "new_results"
+          
+          # we're on the sparql node
+          p.each_element do |sparql|
+            
+            sparql.each_element do |hr|
+              
+              # head/results fields
+              hr.each_element do |field|
+                
+                # find the results
+                if field.name == "result"
+                  
+                  # We found a result
+                  result = []
+                  
+                  field.each_element do |n|
+                    variable = []
+                    variable << n.attributes.first.value
+                    n.each_element do |v|
+                      variable << v.name
+                      variable << v.content
+                    end
+                    result << variable
+                    added << result
+                  end
+                  
+                end
+              end        
+            end
+            break
+          end
+          
+        elsif p.attributes.get_attribute("name").value == "obsolete_results"
+
+          # we're on the sparql node
+          p.each_element do |sparql|
+            
+            sparql.each_element do |hr|
+              
+              # head/results fields
+              hr.each_element do |field|
+                
+                # find the results
+                if field.name == "result"
+                  
+                  # We found a result
+                  result = []
+                  
+                  field.each_element do |n|
+                    variable = []
+                    variable << n.attributes.first.value
+                    n.each_element do |v|
+                      variable << v.name
+                      variable << v.content
+                    end
+                    result << variable
+                    removed << result
+                  end
+                  
+                end
+              end        
+            end
+            break
+          end
+          
+        end
+      end
+
+      return added, removed
+
+    end
+
+  end
+
+end

data/lib/SSAP_templates.rb

@@ -0,0 +1,132 @@
+#!/usr/bin/ruby
+
+module RubyKpi
+
+  # JOIN
+  JOIN_REQUEST_TEMPLATE = %{<SSAP_message>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<transaction_type>JOIN</transaction_type>
+<message_type>REQUEST</message_type>
+<transaction_id>%s</transaction_id>
+<parameter name = "credentials">XXYYZZ</parameter>
+</SSAP_message>}
+
+
+  # LEAVE 
+  LEAVE_REQUEST_TEMPLATE = %{<SSAP_message>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<transaction_type>LEAVE</transaction_type>
+<message_type>REQUEST</message_type>
+<transaction_id>%s</transaction_id>
+</SSAP_message>}
+
+
+  # INSERT
+  INSERT_REQUEST_TEMPLATE = %{<SSAP_message>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<transaction_type>INSERT</transaction_type>
+<message_type>REQUEST</message_type>
+<transaction_id>%s</transaction_id>
+<parameter name = "insert_graph" encoding = "RDF-M3">
+<triple_list>%s</triple_list></parameter>
+<parameter name = "confirm">TRUE</parameter>
+</SSAP_message>}
+
+  # REMOVE
+  REMOVE_REQUEST_TEMPLATE = %{<SSAP_message>
+<message_type>REQUEST</message_type>
+<transaction_type>REMOVE</transaction_type>
+<transaction_id>%s</transaction_id>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<parameter name="confirm">TRUE</parameter>
+<parameter name="remove_graph"  encoding="RDF-M3">
+<triple_list>%s</triple_list></parameter>
+</SSAP_message>}
+
+  # UPDATE
+  UPDATE_REQUEST_TEMPLATE = %{<SSAP_message>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<transaction_type>UPDATE</transaction_type>
+<message_type>REQUEST</message_type>
+<transaction_id>%s</transaction_id>
+
+<parameter name = "insert_graph" encoding = "RDF-M3">
+<triple_list>%s</triple_list>
+</parameter>
+
+<parameter name = "remove_graph" encoding = "RDF-M3">
+<triple_list>%s</triple_list>
+</parameter>
+
+<parameter name = "confirm">TRUE</parameter>
+</SSAP_message>}
+
+  # RDF QUERY
+  RDF_QUERY_REQUEST_TEMPLATE = %{<SSAP_message>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<transaction_type>QUERY</transaction_type>
+<message_type>REQUEST</message_type>
+<transaction_id>%s</transaction_id>
+<parameter name = "type">RDF-M3</parameter>
+<parameter name = "query">
+<triple_list>%s</triple_list></parameter>
+</SSAP_message>}
+
+  # SPARQL QUERY
+  SPARQL_QUERY_REQUEST_TEMPLATE = %{<SSAP_message>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<transaction_type>QUERY</transaction_type>
+<message_type>REQUEST</message_type>
+<transaction_id>%s</transaction_id>
+<parameter name = "type">sparql</parameter>
+<parameter name = "query">%s</parameter>
+</SSAP_message>}
+
+  # RDF SUBSCRIBE
+  RDF_SUBSCRIBE_REQUEST_TEMPLATE = %{<SSAP_message>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<transaction_type>SUBSCRIBE</transaction_type>
+<message_type>REQUEST</message_type>
+<transaction_id>%s</transaction_id>
+<parameter name = "type">RDF-M3</parameter>
+<parameter name = "query">
+<triple_list>%s</triple_list></parameter>
+</SSAP_message>}
+
+  # SPARQL SUBSCRIBE
+  SPARQL_SUBSCRIBE_REQUEST_TEMPLATE = %{<SSAP_message>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<transaction_type>SUBSCRIBE</transaction_type>
+<message_type>REQUEST</message_type>
+<transaction_id>%s</transaction_id>
+<parameter name = "type">sparql</parameter>
+<parameter name = "query">%s</parameter>
+</SSAP_message>}
+
+  # UNSUBSCRIBE
+  UNSUBSCRIBE_REQUEST_TEMPLATE = %{<SSAP_message>
+<node_id>%s</node_id>
+<space_id>%s</space_id>
+<transaction_type>UNSUBSCRIBE</transaction_type>
+<message_type>REQUEST</message_type>
+<transaction_id>%s</transaction_id>
+<parameter name = "subscription_id">%s</parameter>
+</SSAP_message>}
+
+  # OTHER TEMPLATES
+  TRIPLE_TEMPLATE = %{<triple>
+<subject type = "%s">%s</subject>
+<predicate>%s</predicate>
+<object type = "%s">%s</object>
+</triple>}
+
+end