sdl-ng 0.0.1

data/Rakefile

@@ -0,0 +1,16 @@
+gem 'yard'
+gem 'redcarpet'
+gem 'yard-redcarpet-ext'
+
+require 'bundler/gem_tasks'
+
+require 'yard'
+require 'redcarpet'
+require 'yard-redcarpet-ext'
+
+YARD::Rake::YardocTask.new do |yardoc|
+  yardoc.files = ['lib/**/*.rb', '-', 'README.md']
+  yardoc.options << '--title' << 'Service Description Language Framework Documentation'
+  yardoc.options << '--plugin' << 'redcarpet-ext'
+  yardoc.options << '-M' << 'redcarpet'
+end

data/bin/process_service_descriptions

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+gem 'sdl-ng'
+
+require 'sdl'
+require 'active_support'
+require 'i18n'
+
+# Make the translations for fact classes, instances, etc. known to the I18n framework
+I18n.load_path << File.join(Dir.pwd, 'translations', 'en.yml')
+
+# Create an empty service compendium
+compendium = SDL::Base::ServiceCompendium.new
+
+# Load SDL
+Dir.glob(File.join(Dir.pwd, '**', '*.sdl.rb')) do |filename|
+  compendium.facts_definition do
+    eval(File.read(filename), binding, filename)
+  end
+end
+
+compendium.register_classes_globally
+
+# Load Service Definitions
+Dir.glob(File.join(Dir.pwd, '**', '*.service.rb')) do |filename|
+  service = compendium.service filename.match(%r[.+/(.+).service.rb])[1] do
+    eval(File.read(filename), binding, filename)
+  end
+end
+
+puts "Loaded Service Compendium with #{compendium.services.count} services. Generating output"
+
+%w[xml rdf markdown].each do |directory| FileUtils.mkdir_p File.join(Dir.pwd, 'output', directory) end
+
+schema_exporter = SDL::Exporters::XSDSchemaExporter.new(compendium)
+service_exporter = SDL::Exporters::XMLServiceExporter.new(compendium)
+markdown_exporter = SDL::Exporters::MarkdownServiceExporter.new(compendium)
+rdf_exporter = SDL::Exporters::RDFExporter.new(compendium)
+
+schema_dir = Dir.pwd + '/output/xml/schema.xsd'
+File.open(schema_dir, 'w') {|f|
+  f.write(schema_exporter.export_schema)
+  puts "Written Service Compendium XSD schema into #{schema_dir}"
+}
+
+# Load XSD
+xsd = Nokogiri::XML::Schema(File.read(Dir.pwd + '/output/xml/schema.xsd'))
+
+compendium.services.each do |name, service|
+  xml_output_file = Dir.pwd + "/output/xml/#{name}.xml"
+  service_exporter.export_service_to_file service, xml_output_file
+  puts "Wrote XML export of service '#{name}' to #{xml_output_file}"
+
+  puts "Validating XML export against schema"
+  xsd.validate(Nokogiri::XML(File.read(Dir.pwd + "/output/xml/#{name}.xml"))).each do |error|
+    puts error.message
+  end
+
+  rdf_output_file = Dir.pwd + "/output/rdf/#{name}.rdf"
+  rdf_exporter.export_service_to_file service, rdf_output_file
+  puts "Wrote RDF export of service '#{name}' to #{rdf_output_file}"
+
+  markdown_output_file = Dir.pwd + "/output/markdown/#{name}.md"
+  markdown_exporter.export_service_to_file service, markdown_output_file
+  puts "Wrote Markdown export of service '#{name}' to #{markdown_output_file}"
+end
+
+all_needed_translations = {
+    'en' => {
+        'sdl' => I18n.backend.instance_eval{translations}[:en][:sdl]
+    }
+}
+
+def returning(value)
+  yield(value)
+  value
+end
+
+def convert_hash_to_ordered_hash_and_sort(object, deep = false)
+# from http://seb.box.re/2010/1/15/deep-hash-ordering-with-ruby-1-8/
+  if object.is_a?(Hash)
+    # Hash is ordered in Ruby 1.9!
+    res = returning(RUBY_VERSION >= '1.9' ? Hash.new : ActiveSupport::OrderedHash.new) do |map|
+      object.each {|k, v| map[k] = deep ? convert_hash_to_ordered_hash_and_sort(v, deep) : v }
+    end
+    return res.class[res.sort {|a, b| a[0].to_s <=> b[0].to_s } ]
+  elsif deep && object.is_a?(Array)
+    array = Array.new
+    object.each_with_index {|v, i| array[i] = convert_hash_to_ordered_hash_and_sort(v, deep) }
+    return array
+  else
+    return object
+  end
+end
+
+translations_output_file = Dir.pwd + "/translations/en.out.yml"
+File.open(translations_output_file, 'w') do |f|
+  f.write(convert_hash_to_ordered_hash_and_sort(all_needed_translations.deep_stringify_keys!, true).to_yaml)
+  puts "Wrote resulting translations file to #{translations_output_file}."
+end
+
+puts 'Finished'

data/examples/services/google_drive_for_business.service.rb

@@ -0,0 +1,50 @@
+name 'Google Drive for Business'
+
+has_documentation 'http://www.google.com/enterprise/apps/business/products.html#drive'
+
+has_add_on_repository 'https://www.google.com/enterprise/marketplace/home', 1000
+
+has_cloud_service_model saas
+
+has_communication_protection https
+
+has_status_page 'http://www.google.com/appsstatus'
+
+has_public_service_level_agreement 'http://www.google.com/apps/intl/en/terms/sla.html'
+
+maintenance_free
+
+has_past_release_notes 'https://plus.google.com/+GoogleDrive/posts'
+has_feedback_page 'https://plus.google.com/+GoogleDrive/posts'
+
+has_establishing_year 2006
+
+has_rest_interface annotation: 'https://developers.google.com/drive/'
+
+has_offline_capability annotation: 'https://support.google.com/drive/answer/2375012'
+
+is_billed monthly, in_advance
+
+has_payment_option credit_card
+
+has_browser_interface do
+  compatible_browser firefox, 'recent'
+  compatible_browser chrome, 'recent'
+  compatible_browser safari, '5', annotation: 'on Mac'
+  compatible_browser internet_explorer, '9'
+end
+
+{ "For documents" => [:html, :rtf, :word, :open_office, :pdf, :text],
+  "For spreadsheets" => [:csv, :html, :odf, :pdf, :xls, :text],
+  "For presentations" => [:pdf, :pptx, :text],
+  "For drawings" => [:png, :jpeg, :svg, :pdf]
+}.each do |annotation, formats_list|
+  formats_list.each do |f|
+    has_data_capability export, f, annotation: annotation
+  end
+end
+
+headers = fetch_from_url 'http://www.google.com/enterprise/apps/business/products.html', 'div.apps-content-set:nth-child(3) div.maia-col-4 h3'
+headers.each do |header|
+  has_feature header.content.strip, header.search('~p')[0]
+end

data/examples/services/salesforce_sales_cloud.service.rb

@@ -0,0 +1,51 @@
+name "Salesforce Sales Cloud"
+
+has_documentation url: 'http://www.salesforce.com/sales-cloud/overview/'
+
+has_add_on_repository 'https://appexchange.salesforce.com/' do
+  number_of_add_ons 2000
+end
+
+has_communication_protection https
+
+has_status_page 'http://trust.salesforce.com/trust/status/'
+
+has_public_service_level_agreement 'http://www.salesforce.com/assets/pdf/misc/salesforce_MSA.pdf'
+
+has_establishing_year 1999
+
+has_offline_capability annotation: 'http://help.salesforce.com/apex/HTViewHelpDoc?id=offline_def.htm'
+
+maintenance_free
+
+has_future_roadmap 'http://www.sfdcstatic.com/assets/pdf/misc/summer13_ReleasePreview.pdf'
+has_past_release_notes 'http://www.salesforce.com/newfeatures/'
+
+has_cloud_service_model saas
+
+has_rest_interface
+has_soap_interface
+has_xmlrpc_interface
+
+has_browser_interface do
+  compatible_browser internet_explorer, '7'
+  compatible_browser firefox, 'recent'
+  compatible_browser chrome, 'recent'
+  compatible_browser safari, '5', annotation: 'on Mac'
+end
+
+has_data_capability export, csv
+
+is_billed annually, in_advance
+
+has_payment_option credit_card
+has_payment_option cheque
+has_payment_option invoice
+
+features = fetch_from_url 'http://www.salesforce.com/sales-cloud/overview/', '.slide h3 + p'
+
+has_feature 'Mobile', features[0]
+has_feature 'Contact Management', features[1]
+has_feature 'Opportunity Management', features[2]
+has_feature 'Chatter', features[3]
+has_feature 'Email Integration', features[4]

data/examples/translations/en.yml

@@ -0,0 +1,184 @@
+---
+en:
+  sdl:
+    fact:
+      add_on_repository: The service has an add-on repository.
+      audit_option: The service has an audit option
+      bill: The service billing terms.
+      charge_unit: The unit of service charging, e.g. "per user".
+      cloud_service_model: The cloud service model
+      communication_protection: The communication with the service is protected
+      continuous_service_improvement: The service has continuous service improvement
+        means
+      continuous_service_improvement_feedback_page: The service has a feedback page
+      continuous_service_improvement_future_roadmap: The service has a future roadmap
+      continuous_service_improvement_past_release_notes: The service has past release
+        notes
+      data_capability: The service can carry out operations on a specific data format
+      data_deletion_policy: The service allows for complete deletion of user data
+        after termination of contract
+      data_encryption: The service applies encrpytion on user data
+      data_location: The service offers to locate service data at runtime
+      data_location_transparency: The provider makes the location of service data
+        transparent
+      documentation: Some service documentation
+      duration: Generic duration of something.
+      duration_provision_end_user_duration: The duration for provisioning an end user.
+      duration_set_up_consumption_duration: The duration for setting up the service.
+      establishing_year: The establishing year of the service is known
+      feature: A service feature
+      interface: An interface to service functionality
+      interface_browser_interface: A regular browser-based interface
+      interface_rest_interface: The service has a RESTful interface
+      interface_soap_interface: The service has a SOAP interface
+      interface_xmlrpc_interface: The service has an XMLRPC interface
+      maintenance: The service has maintenance information
+      maintenance_maintenance_free: The service is maintenance free
+      maintenance_maintenance_window: The service has a maintenance window
+      name: The service has a name.
+      offline_capability: Service functionality can be used offline
+      payment_option: The service can be payed by a payment option, e.g. credit card.
+      service_category: The service belongs to a category
+      service_level_agreement: The service has a kind of service level agreement
+      service_level_agreement_public_service_level_agreement: The service has a publicibly
+        accessible service level agreement
+      service_tag: The service is tagged
+      status_page: The service has a status page
+    instance:
+      type:
+        billing_term:
+          annually: Annually billing
+          monthly: Monthly billing
+        browser:
+          chrome: Google Chrome
+          firefox: Mozilla Firefox
+          internet_explorer: Internet Explorer
+          opera: Opera Browser
+          safari: Apple Safari
+        charge_unit:
+          floating_license: The number of floating licenses
+          user_account: The number of user accounts
+        cloud_service_model:
+          haas: Hardware as a Service (HaaS)
+          iaas: Infrastructure as a Service (IaaS)
+          paas: Platform as a Service (PaaS)
+          saas: Software as a Service (SaaS)
+        communication_protection:
+          https: HTTPS encryption
+          vpn: VPN connection
+        data_capability_operation:
+          export: Exporting data
+          import: Importing data
+        data_format:
+          csv: Comma-separated values (CSV)
+          html: HTML
+          jpeg: JPEG
+          odf: Open Document Format (ODF)
+          open_office: Open Office
+          pdf: Adobe PDF
+          png: Portable Network Graphics (PNG)
+          pptx: Microsoft PowerPoint
+          rtf: Rich text (RTF)
+          svg: Scalable Vector Graphics (SVG)
+          text: Plain text
+          word: Microsoft Word
+          xls: Microsoft Excel
+        key_control:
+          provider_only: Only the provider controls the encryption keys
+          shared: Both user and provider control the encryption keys
+          user_only: Only the service user controls the encryption keys
+        payment_option:
+          cheque: Cheque
+          credit_card: Credit card
+          invoice: Invoice
+        payment_term:
+          after_use: Payment is done after service consumption
+          in_advance: Payment is done in advance of service consumption
+    property:
+      fact:
+        add_on_repository:
+          number_of_add_ons: The number of available add-ons
+          url: The URL of the add-on repository
+        audit_option:
+          audit_option: The audit option
+        bill:
+          billing_term: The billing terms
+          payment_term: The payment terms
+        charge_unit:
+          charge_unit: The unit of charge
+        cloud_service_model:
+          cloud_service_model: The cloud service model
+        communication_protection:
+          communication_protection: The protection means
+        continuous_service_improvement:
+          url: A link to the continuous service improvement
+        data_capability:
+          format: The data format
+          operation: The operation, which can be carried out on the data format
+        data_encryption:
+          key_control: Who excercises control over the encryption keys
+        data_location:
+          location: The location of data
+        documentation:
+          url: The documentation URL
+        duration:
+          duration: The duration
+        establishing_year:
+          year: The year, the service was established
+        feature:
+          description: The feature description
+          feature: The feature name
+        interface_browser_interface:
+          compatible_browsers: The compatible browsers
+          required_plugins: The required browser plugins
+        maintenance_maintenance_window:
+          timespan: The timespan of the maintenance window
+        name:
+          name: The service name
+        payment_option:
+          payment_option: The payment option
+        service_category:
+          service_category: The category of the service
+        service_level_agreement_public_service_level_agreement:
+          url: The URL of the service level agreement
+        service_tag:
+          service_tag: The service tag
+        status_page:
+          url: The URL of the service status page
+      type:
+        browser:
+          browser_name: The name of the browser
+          url: The browser homepage URL
+        browser_plugin:
+          plugin_name: The name of the browser plugin
+          url: The browser plugin URL
+        compatible_browser:
+          compatible_browser: The compatible browser
+          min_version: The minimum version of the browser
+        data_format:
+          mime_type: The mime type of the data format
+        required_plugin:
+          min_version: The minimum version required of the browser plugin
+          required_plugin: The plugin
+        timespan:
+          end: The timespan end
+          start: The timespan start
+    type:
+      audit_option: An option to audit a service
+      billing_term: The billing term, e.g. "per month".
+      browser: A browser
+      browser_plugin: A browser plugin
+      charge_unit: The charge unit
+      cloud_service_model: A cloud service model
+      communication_protection: A communication protection means
+      compatible_browser: A compatible browser
+      data_capability_operation: The data capability operation
+      data_format: The data format
+      key_control: One possibility of key control
+      location: Location information
+      payment_option: The payment option
+      payment_term: The payment terms, i.e., in advance and after use.
+      required_plugin: The required plugins
+      service_category: The category of a service
+      service_tag: A Service tag
+      timespan: An arbitrary timespan

data/examples/vocabulary/base/base.sdl.rb

@@ -0,0 +1,8 @@
+type :timespan do
+  datetime :start
+  datetime :end
+end
+
+fact :name do
+  string :name
+end

data/examples/vocabulary/base/location.sdl.rb

@@ -0,0 +1,5 @@
+type :location do
+  subtype :address
+  subtype :country
+  subtype :jurisdiction
+end

data/examples/vocabulary/crf/characteristics.sdl.rb

@@ -0,0 +1,25 @@
+type :cloud_service_model
+type :service_category
+type :service_tag
+
+fact :cloud_service_model do
+  cloud_service_model
+end
+
+fact :service_category do
+  service_category
+end
+
+fact :service_tag do
+  service_tag
+end
+
+fact :add_on_repository do
+  url
+  integer :number_of_add_ons
+end
+
+cloud_service_model :saas
+cloud_service_model :paas
+cloud_service_model :iaas
+cloud_service_model :haas