abrupt 0.0.1

data/lib/abrupt/service/complexity.rb

@@ -0,0 +1,27 @@
+# @author Manuel Dudda
+module Abrupt
+  module Service
+    # Complexity service
+    # documentation see 'http://wba.cs.hs-rm.de/AbRUPt/service/complexity/public/index.php/api/v1/complexity'
+    class Complexity < Base
+      # TODO: outsource service uri to module Service
+      SERVICE_URI = 'http://wba.cs.hs-rm.de/AbRUPt/service/complexity/public/index.php/api/v1/complexity'
+
+      def self.available_options
+        %w(adblock vicram vizweb color contrast ratio)
+      end
+
+      def service_uri
+        SERVICE_URI
+      end
+
+      def execute
+        super
+        @response['differenceMatrix']['matrix'].flatten!
+        @response['differenceMatrix']['palette'].flatten!
+        @response['contrast']['_1'] = @response['contrast'].delete '1'
+        @response
+      end
+    end
+  end
+end

data/lib/abrupt/service/input.rb

@@ -0,0 +1,15 @@
+# @author Manuel Dudda
+module Abrupt
+  module Service
+    # Readability service
+    # documentation see 'http://wba.cs.hs-rm.de/AbRUPt/service/readability/'
+    class Input < Base
+      # TODO: outsource service uri to module Service
+      SERVICE_URI = 'http://wba.cs.hs-rm.de/AbRUPt/service/input/'
+
+      def service_uri
+        SERVICE_URI
+      end
+    end
+  end
+end

data/lib/abrupt/service/link.rb

@@ -0,0 +1,15 @@
+# @author Manuel Dudda
+module Abrupt
+  module Service
+    # Readability service
+    # documentation see 'http://wba.cs.hs-rm.de/AbRUPt/service/readability/'
+    class Link < Base
+      # TODO: outsource service uri to module Service
+      SERVICE_URI = 'http://wba.cs.hs-rm.de/AbRUPt/service/link/'
+
+      def service_uri
+        SERVICE_URI
+      end
+    end
+  end
+end

data/lib/abrupt/service/picture.rb

@@ -0,0 +1,19 @@
+# @author Manuel Dudda
+module Abrupt
+  module Service
+    # Readability service
+    # documentation see 'http://wba.cs.hs-rm.de/AbRUPt/service/readability/'
+    class Picture < Base
+      # TODO: outsource service uri to module Service
+      SERVICE_URI = 'http://wba.cs.hs-rm.de/AbRUPt/service/picture/'
+
+      def self.available_options
+        ['url']
+      end
+
+      def service_uri
+        SERVICE_URI
+      end
+    end
+  end
+end

data/lib/abrupt/service/readability.rb

@@ -0,0 +1,26 @@
+# @author Manuel Dudda
+module Abrupt
+  module Service
+    # Readability service
+    # documentation see 'http://wba.cs.hs-rm.de/AbRUPt/service/readability/'
+    class Readability < Base
+      # TODO: outsource service uri to module Service
+      SERVICE_URI = 'http://wba.cs.hs-rm.de/AbRUPt/service/readability/'
+
+      def self.available_options
+        ['lang']
+      end
+
+      def service_uri
+        SERVICE_URI
+      end
+
+      def execute
+        super
+        superfluous_keys = %w(originalText hyphenText)
+        @response.delete_if { |key, _value| superfluous_keys.include?(key) }
+        @response
+      end
+    end
+  end
+end

data/lib/abrupt/service/subject.rb

@@ -0,0 +1,19 @@
+# @author Manuel Dudda
+module Abrupt
+  module Service
+    # Readability service
+    # documentation see 'http://wba.cs.hs-rm.de/AbRUPt/service/readability/'
+    class Subject < Base
+      # TODO: outsource service uri to module Service
+      SERVICE_URI = 'http://wba.cs.hs-rm.de/AbRUPt/service/subject/'
+
+      def self.available_options
+        %w(lang word_limit depth)
+      end
+
+      def service_uri
+        SERVICE_URI
+      end
+    end
+  end
+end

data/lib/abrupt/transformation/base.rb

@@ -0,0 +1,145 @@
+# @author Manuel Dudda
+module Abrupt
+  module Transformation
+    # base class
+    class Base
+      include RDF
+      attr_accessor :parent_uri, :uri, :values, :result, :md5
+
+      SCHEMA_MAPPING = {
+          integer: :to_i,
+          number: :to_f,
+          string: :to_s,
+          boolean: [:kind_of?, Object]
+      }
+
+      # Initializes Transformer for Individual Statement for parent_uri & uri.
+      # @param parent_uri [Array] the parent uri in array structure of paths
+      # @param uri [Array] the uri as array structure of path and id
+      # @example
+      # Readability.new([
+      #     'Website',
+      #     'http://www.rikscha-mainz.de',
+      #     'Page',
+      #     'http://www.rikscha-mainz.de/Angebote'
+      #   ], [
+      #     'State',
+      #     'state54'
+      #   ])
+      def initialize(parent_uri, uri, values = {})
+        @parent_uri = parent_uri.to_a.map(&:remove_last_slashes)
+        @uri = uri.to_a.map(&:remove_last_slashes)
+        @values = values
+        @result = []
+      end
+
+      # rubocop:disable all
+      def self.customize_to_schema(values)
+        @values = values
+        keyname = name.split('::').last.downcase.to_sym
+        schema_file = File.join Abrupt.root, 'assets', 'schema', 'v1', "#{keyname}.json"
+        return values unless File.exist?(schema_file)
+        schema = ::JSON.load(File.read(schema_file)).deep_symbolize_keys
+        # :button => ..., :text => {:type => "array", :items => {...}}
+        schema[:properties][keyname][:properties].each do |state_key, state_schema|
+          set_value(state_key, state_schema, [':state', ":#{keyname}"])
+        end
+        @values
+      end
+
+      def self.set_value(key, schema, ref)
+        ref << ":#{key}"
+        key_string = '[' + ref.join('][') + ']'
+        value = eval "@values#{key_string}" rescue nil
+        return unless value
+        case schema[:type]
+        when 'array'
+          case schema[:items][:type]
+          when 'object'
+            # :name => { :type => :string }
+            schema[:items][:properties].each do |arr_key, arr_val|
+              eval "@values#{key_string} = [value].flatten.compact" unless value.is_a? Array
+              value.each_with_index do |_obj, i|
+                set_value arr_key, arr_val, ref.dup + [i]
+              end
+            end
+          end
+        when 'object'
+          schema[:properties].each do |schema_key, schema_value|
+            set_value(schema_key, schema_value, ref.dup)
+          end
+        else
+          if value.is_a? Array
+            value.each_with_index do |val, i|
+              eval "@values#{key_string}[i] = val.send(*SCHEMA_MAPPING[schema[:type].to_sym])"
+            end
+          else
+            eval "@values#{key_string} = value.send(*SCHEMA_MAPPING[schema[:type].to_sym])"
+          end
+        end
+      end
+
+      # rubocop:enable all
+
+      def add_individuals
+        add_individual
+        return @result unless @values[keyname]
+        @values[keyname].each do |k, v|
+          s = k.to_s.eql?('language') ? "#{keyname}Language" : k
+          add_data_property s, v
+        end
+        @result
+      end
+
+      # Returns the class name
+      def class_name
+        self.class.name.split('::').last
+      end
+
+      # Returns the keyname
+      # @example:
+      # Readability.new(parent_uri, uri).keyname
+      #   => :readability
+      def keyname
+        class_name.downcase.to_sym
+      end
+
+      def resolve_parent_uri_part
+        "#{VOC}#{@parent_uri.join('/')}"
+      end
+
+      def resolve_parent_uri
+        RDF::URI(resolve_parent_uri_part)
+      end
+
+      def resolve_uri_part(name)
+        if @uri.empty?
+          "#{class_name}/#{name}"
+        else
+          "#{@uri.join('/')}"
+        end
+      end
+
+      def resolve_uri(name = nil)
+        name ||= @uri.last
+        RDF::URI(resolve_parent_uri_part + '/' + resolve_uri_part(name))
+      end
+
+      def add_individual(name = @values[:name], klass = nil)
+        klass ||= @uri.empty? ? class_name : @uri.first
+        uri = resolve_uri(name)
+        @result << Statement.new(uri, RDF.type, VOC[klass])
+        @result << Statement.new(resolve_parent_uri, VOC["has#{klass}"], uri)
+      end
+
+      def add_data_property(type, value, name = @values[:name])
+        @result << Statement.new(resolve_uri(name), VOC[type], value)
+      end
+
+      def add_object_property(parent_uri, type, child_uri)
+        parent_uri = RDF::URI(parent_uri) if parent_uri.is_a?(String)
+        @result << Statement.new(parent_uri, VOC["has#{type}"], child_uri)
+      end
+    end
+  end
+end

data/lib/abrupt/transformation/client/base.rb

@@ -0,0 +1,8 @@
+module Abrupt
+  module Transformation
+    module Client
+      class Base < Transformation::Base
+      end
+    end
+  end
+end

data/lib/abrupt/transformation/client/page_view.rb

@@ -0,0 +1,27 @@
+# @author Manuel Dudda
+module Abrupt
+  module Transformation
+    module Client
+      # Transformation clas for client visit data
+      class PageView < Transformation::Base
+        def add_individuals
+          datetime = @values['datetime']
+          return @result unless datetime
+          @values[:name] = ::Abrupt.format_time(datetime)
+          super
+          @values.each do |_i, attr|
+            next if attr.is_a?(String)
+            name = attr.name.eql?('name') ? 'inputname' : attr.name
+            value = if name.eql?('datetime')
+                      Abrupt.parse_time(attr.value)
+                    else
+                      CGI.escape(attr.value)
+                    end
+            add_data_property(name, value)
+          end
+          @result
+        end
+      end
+    end
+  end
+end

data/lib/abrupt/transformation/client/visit.rb

@@ -0,0 +1,56 @@
+# @author Manuel Dudda
+module Abrupt
+  module Transformation
+    module Client
+      # Transformation clas for client visit data
+      class Visit < Base
+        def add_individuals
+          @values[:name] = @uri.last
+          super
+          @values.each do |key, value|
+            add_property(key, value) if value
+          end
+          add_individuals_for_view
+          @result
+        end
+
+        def add_property(key, value)
+          enumerable = value.is_a?(Hash) || value.is_a?(Array)
+          return if enumerable # value.is_a?(Enumerable)
+          name = case key
+                 when 'uri'
+                   uri = [@parent_uri[1], value].map(&:remove_last_slashes)
+                   parent_uri_path = (@parent_uri[0..-3] + ['Page', uri.join])
+                   parent_uri = "#{VOC}#{parent_uri_path.join('/')}"
+                   # Page hasVisit visit
+                   add_object_property(parent_uri, 'PageVisit', resolve_uri)
+                   key
+                 when 'size' # TODO: transform via customize_to_schema
+                   'contentlength'
+                 else
+                   key
+                 end
+          add_data_property(name, CGI.escape(value))
+        end
+
+        def add_individuals_for_view
+          page_views = @values[:view]
+          return unless page_views
+          page_views.each do |type, view|
+            [view].flatten.each do |attributes|
+              add_page_view(type.to_s.capitalize, attributes)
+            end
+          end
+        end
+
+        def add_page_view(type, attributes)
+          time = ::Abrupt.format_time(attributes[:datetime])
+          page_view = PageView.new(@parent_uri + @uri,
+                                   [type, time],
+                                   attributes)
+          @result += page_view.add_individuals
+        end
+      end
+    end
+  end
+end

data/lib/abrupt/transformation/client/visitor.rb

@@ -0,0 +1,19 @@
+# @author Manuel Dudda
+module Abrupt
+  module Transformation
+    module Client
+      # Transformation class for client visit data
+      class Visitor < Transformation::Base
+        def add_individuals
+          return @result unless @values
+          @values[:name] = @values[:ip]
+          super
+          @values.each do |key, value|
+            add_data_property(key, value) if value.is_a?(String)
+          end
+          @result
+        end
+      end
+    end
+  end
+end

data/lib/abrupt/transformation/website/base.rb

@@ -0,0 +1,8 @@
+module Abrupt
+  module Transformation
+    module Website
+      class Base < Transformation::Base
+      end
+    end
+  end
+end

data/lib/abrupt/transformation/website/complexity.rb

@@ -0,0 +1,20 @@
+# @author Manuel Dudda
+module Abrupt
+  module Transformation
+    module Website
+      # Complexity service
+      # documentation see 'http://wba.cs.hs-rm.de/AbRUPt/service/complexity/public/index.php/api/v1/complexity'
+      class Complexity < Base
+        def add_individuals
+          @uri = @parent_uri.slice!(-2, 2)
+          return @result unless @values[keyname]
+          # flatten vicram complexity
+          @values[keyname][:vicramComplexity] =
+              @values[keyname][:vicram].delete(:complexity)
+          @values[keyname].delete :vicram
+          super
+        end
+      end
+    end
+  end
+end

data/lib/abrupt/transformation/website/input.rb

@@ -0,0 +1,42 @@
+# @author Manuel Dudda
+module Abrupt
+  module Transformation
+    module Website
+      # Input service
+      # documentation see 'http://wba.cs.hs-rm.de/AbRUPt/service/input/'
+      # schema located in {PROJECT_ROOT}/assets/schema/v1/input.json
+      class Input < Base
+        attr_accessor :form_uri
+
+        def add_individuals
+          return @result unless @values[keyname]
+          form_id = Digest::MD5.hexdigest(@values[keyname].to_s)
+          @uri = ['Form', form_id]
+          add_individual
+          @parent_uri += @uri
+          @values[keyname].each do |input_type, inputs|
+            add_individuals_for_inputs(inputs, input_type)
+          end
+          @result
+        end
+
+        def add_individuals_for_inputs(inputs, input_type)
+          [inputs].flatten.compact.each do |input|
+            form_element_id = input[:id] || Digest::MD5.hexdigest(input.to_s)
+            @uri = [input_type.to_s.camelcase, form_element_id]
+            add_individual
+            add_data_properties input
+          end
+        end
+
+        def add_data_properties(input)
+          input.each do |type, value|
+            next unless type && value
+            v = value.is_a?(String) ? CGI.escapeHTML(value) : value
+            add_data_property type, v
+          end
+        end
+      end
+    end
+  end
+end