majortom_connector 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.project
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Sven Windisch
+
+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.rdoc

@@ -0,0 +1,43 @@
+= MaJorToM-Connector
+
+This gem provides easy access to any MaJorToM-Server.
+
+== Requirements
+
+* HTTParty http://github.com/jnunemaker/httparty/ - For the HTTP requests.
+
+== Install
+
+* sudo gem install majortom_connector
+* Copy the majortom-server.yml from the examples folder into the config folder of your Rails app and configure it to your needs.
+
+== Usage
+
+1. Before executing any request, you must connect to the server with
+     MajortomConnector.connect "base_iri_or_map_id"
+2. Start the topic map madness.
+   * Get the _id_ of the map you are connected with
+       MajortomConnector.topic_map_id
+   * Get all maps that are on the server
+       MajortomConnector.list_maps
+   * Find the id of a map with given base locator
+       MajortomConnector.find_topic_map_id_by_base_iri(base_iri)
+   * Get all topics of the connected map*
+       MajortomConnector.topics
+   * Fire a TMQL query against the server*
+       MajortomConnector.tmql(query)
+   * Fire a SPARQL query against the server
+       MajortomConnector.sparql(query)
+   * Do a search in the fulltext index of the map that was created while loading
+       MajortomConnector.search(query)
+3. Have fun!
+
+Note: All methods (except those that just return ids) return a +Result+ object, that carries several values:
+* +code+ says, whether all went fine (if it's 0) or not
+* +message+ has a message from the server for you ('OK' or any error message)
+* +data+ contains the actual data that was returned from the server if no error occured
+* +jtmqr+ contains the JTMQR that comes with all methods marked with * above
+
+== Documentation
+
+* You can find the JTMQR result format there: https://code.google.com/p/tmql/wiki/JTMQR

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/examples/majortom-server.yml

@@ -0,0 +1,7 @@
+server:
+  host: http://your.majortom-server.com
+  port: 8080
+  context: majortom-server
+  
+user:
+  api_key: 1a2b3c4d5e6f7g8h9i0j

data/lib/majortom_connector/request.rb

@@ -0,0 +1,76 @@
+require 'httparty'
+
+module MajortomConnector
+  class Request
+
+    AvailableCommands = [
+      "topics",
+      "topicmaps",
+      "resolvetm",
+      "xtm",
+      "ctm",
+      "tmql",
+      "sparql",
+      "beru"
+    ]
+
+    attr_reader :result
+
+    def self.call(config, command, query)
+      new(config).run(command, query)
+    end
+
+    def self.available_commands
+      const_get(:AvailableCommands)
+    end
+
+    def self.command_available?(command)
+      available_commands.include?(command)
+    end
+
+    def initialize(config)
+      @mts_config = config
+    end
+
+    def run(command, query = "")
+      raise ArgumentError, "Command #{command} not available. Try one of the following: #{const_get(:AvailableCommands).join(',')}" unless self.class.command_available?(command)
+      @mts_result = Result.new
+      post(command, query) if %w[tmql sparql beru].include?(command)
+      get(command, query) if %w[topics topicmaps resolvetm clearcache xtm ctm].include?(command)
+      return @mts_result
+    end
+
+    def successful?
+      @mts_result.successful?
+    end
+
+    protected
+
+    def get(command, query = "")
+      @mts_result.parse(HTTParty.get("#{server_uri}/tm/#{command}#{parameter_builder(command, query)}"))
+    end
+
+    def post(command, query)
+      post_options = {:body => {:query => query, :apikey => @mts_config['user']['api_key']}}
+      @mts_result.parse(HTTParty.post("#{server_uri}/tm/#{command}/#{@mts_config['map']['id']}/", post_options))
+    end
+
+    def xtm
+    end
+
+    def ctm
+    end
+
+    def server_uri
+      "#{@mts_config['server']['host']}:#{@mts_config['server']['port']}/#{@mts_config['server']['context']}"
+    end
+
+    def parameter_builder(command, query = "")
+      parameter = case command
+      when 'topics' then "/#{@mts_config['map']['id']}?"
+      when 'resolvetm' then "?bl=#{query}&"
+      else "?"
+      end << "apikey=#{@mts_config['user']['api_key']}"
+    end
+  end
+end

data/lib/majortom_connector/result.rb

@@ -0,0 +1,43 @@
+module MajortomConnector
+  class Result
+
+    attr_reader :code
+
+    attr_reader :message
+
+    attr_reader :data
+    
+    attr_reader :jtmqr
+    
+    def successful?
+      @code == "0" ? true : false
+    end
+    
+    def parse (result)
+      @code = result['code']
+      @message = result['msg']
+      @data = result['data']
+      
+      if @data.kind_of?(Hash) && @data.has_key?('version')
+        send("handle_jtmqr_v#{@data['version'].to_i}")
+      end
+    end
+
+    protected
+    
+    def handle_jtmqr_v1
+      @jtmqr = Array.new
+      @data['seq'].each do |tupel|
+        cells = Array.new
+        tupel['t'].each do |c|
+          cells << c[c.keys.first]
+        end
+        @jtmqr << cells
+      end
+    end
+    
+    def handle_jtmqr_v2
+      # JTMQR v2 is currently not supported by MaJorToM-Server
+    end
+  end
+end

data/lib/majortom_connector/version.rb

@@ -0,0 +1,3 @@
+module MajortomConnector
+  VERSION = "0.0.1"
+end

data/lib/majortom_connector.rb

@@ -0,0 +1,64 @@
+require 'pathname'
+
+dir = Pathname(__FILE__).dirname.expand_path
+
+require dir + 'majortom_connector/result'
+require dir + 'majortom_connector/request'
+
+module MajortomConnector
+  def self.connect(id_or_base_iri = "")
+    raise ArgumentError, 'Parameter must not be blank' if id_or_base_iri.blank?
+    id = id_or_base_iri.match(/^http/) ? find_topic_map_id_by_base_iri(id_or_base_iri) : id_or_base_iri
+    config.merge!({'map' => {'id' => id}})
+  end
+
+  def self.topic_map_id
+    config['map']['id'] ||= ""
+  end
+
+  def self.list_maps
+    request.run('topicmaps')
+  end
+
+  def self.find_topic_map_id_by_base_iri(base_iri)
+    request.run('resolvetm', base_iri).data
+  end
+
+  def self.topics
+    request.run('topics')
+  end
+
+  def self.tmql(query)
+    request.run('tmql', query)
+  end
+
+  def self.sparql(query)
+    request.run('sparql', query)
+  end
+
+  def self.search(query = "")
+    request.run('beru', query)
+  end
+
+  def self.to_xtm
+    request.run('xtm')
+  end
+
+  def self.to_ctm
+    request.run('ctm')
+  end
+
+  protected
+  
+  def self.request
+    @mts_request ||= Request.new(config)
+  end
+
+  def self.config
+    @mts_config ||= load_server_config
+  end
+
+  def self.load_server_config
+    YAML.load_file(File.join(::Rails.root, 'config', 'majortom-server.yml'))
+  end
+end

data/majortom_connector.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "majortom_connector/version"
+
+Gem::Specification.new do |s|
+  s.name        = "majortom_connector"
+  s.version     = MajortomConnector::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Sven Windisch"]
+  s.email       = ["sven.windisch@googlemail.com"]
+  s.homepage    = "https://github.com/semantosoph/majortom_connector"
+  s.summary     = %q{Connector gem for any MaJorToM-Server}
+  s.description = %q{Provides easy and configurable access to MaJorToM-Server data stores.}
+
+  s.rubyforge_project = "majortom_connector"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency('httparty', '>= 0.7.4')
+  s.post_install_message = %q{You have successfully installed the majortom_connector gem. Don't forget to put the majortom-server.yml into rails' config folder.}
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: majortom_connector
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sven Windisch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 7
+        - 4
+        version: 0.7.4
+  type: :runtime
+  version_requirements: *id001
+description: Provides easy and configurable access to MaJorToM-Server data stores.
+email: 
+- sven.windisch@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- examples/majortom-server.yml
+- lib/majortom_connector.rb
+- lib/majortom_connector/request.rb
+- lib/majortom_connector/result.rb
+- lib/majortom_connector/version.rb
+- majortom_connector.gemspec
+has_rdoc: true
+homepage: https://github.com/semantosoph/majortom_connector
+licenses: []
+
+post_install_message: You have successfully installed the majortom_connector gem. Don't forget to put the majortom-server.yml into rails' config folder.
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: majortom_connector
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Connector gem for any MaJorToM-Server
+test_files: []
+