pacer-titan 0.0.1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c3810e21df640978e98a39ccf84e9fc28be977c
+  data.tar.gz: 3399b781ddc7edb710deb1a8174c726719aa39b8
+SHA512:
+  metadata.gz: bb27e8b12b5b48b73ab5431b86e519ecda849dd56dc9147e5e5e26d74660836029af688240c3d6de62b517d5c5939f2037e4750487740adc650ae5a163f575c0
+  data.tar.gz: 8803d3e557170aea64e42dadf9092f3911cc0e8e3bb345ca349f153bdea0dde6c6209694809160b92f76f57f0b5d32c0c24410893f42a8206381e7ebb4adb8fc

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+target/*
+lib/*.jar

data/Gemfile

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

data/README.md

@@ -0,0 +1,51 @@
+# Titan Graph Database Adapter for Pacer
+
+[Pacer](https://github.com/pangloss/pacer) is a
+[JRuby](http://jruby.org) graph traversal framework built on the
+[Tinkerpop](http://www.tinkerpop.com) stack.
+
+This is an alpha-version pacer adapter with basic support for a [Titan](http://thinkaurelius.github.io/titan) graph in Pacer.
+Based on Derrick's pacer-dex and pacer-neo4j gems.
+
+## Installation
+
+You will need to install Maven first. 
+Clone this repository.
+Run 'rake install' in its directory to build Titan's jars.
+Include the gem in your project's gemfile, directing its path to your cloned copy.
+
+## Backends
+
+This gem includes Titan 0.4.2 and its dependencies.
+
+It seems embedded backends (embedded Cassandra, embedded ElasticSearch) do not launch without extra work specifying their class paths when launching your app. The stock gem can run a Cassandra graph via the Thrift connector but will balk at not being able to load log4j.
+
+The excellent [jBundler](https://github.com/mkristian/jbundler) does a great job of this for you, simply add any of the following to your Jarfile as needed:
+
+jar 'org.slf4j:slf4j-log4j12', '~> 1.7.5' # Logging output
+jar 'com.thinkaurelius.titan:titan-es', '~> 0.4.2' # ElasticSearch
+jar 'com.thinkaurelius.titan:titan-cassandra', '~> 0.4.2' # Embedded Cassandra
+jar 'com.thinkaurelius.titan:titan-berkeleyje', '~> 0.4.2' # BerkeleyDB
+
+You may find your JRuby JVM crashes under heavy load if you include too many jars; increase your -XX:MaxPermSize
+
+## Usage
+
+Opening a Titan graph in Pacer:
+
+  require 'pacer'
+  require 'pacer-titan'
+
+  g = Pacer.titan 'path/to/titan_config.properties'
+
+The graph settings are specified in an Apache Configuration .properties file.
+
+## Titan-specific routes
+
+You can use Titan's query() method in pacer routes.
+  g.query{ has('text', Java::ComThinkaureliusTitanCore::Text::CONTAINS, 'lorem') }.out(:author)
+
+You can also use Titan's indexQuery() method to send queries in Lucene syntax to external indices like Elastic:
+  g.index_query(:text, '(lorem ipsum*)', index_name: 'search').out(:author)
+  
+The index_query route can take an array of indices as the first parameter, you can also pass an options hash as the third parameter to specify the index name if it is something other than 'search' as used in most of the Titan configuration examples.

data/Rakefile

@@ -0,0 +1,36 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+file 'pom.xml' => 'lib/pacer-titan/version.rb' do
+  pom = File.read 'pom.xml'
+  when_writing('Update pom.xml version number') do
+    open 'pom.xml', 'w' do |f|
+      pom.each_line do |line|
+        line.sub!(%r{<gem.version>.*</gem.version>}, "<gem.version>#{ Pacer::Titan::VERSION }</gem.version>")
+        line.sub!(%r{<blueprints.version>.*</blueprints.version>}, "<blueprints.version>#{ Pacer::Titan::BLUEPRINTS_VERSION }</blueprints.version>")
+        line.sub!(%r{<pipes.version>.*</pipes.version>}, "<pipes.version>#{ Pacer::Titan::PIPES_VERSION }</pipes.version>")
+        line.sub!(%r{<titan.version>.*</titan.version>}, "<titan.version>#{ Pacer::Titan::TITAN_VERSION }</titan.version>")
+        f << line
+      end
+    end
+  end
+end
+
+file Pacer::Titan::JAR_PATH => 'pom.xml' do
+  when_writing("Execute 'mvn package' task") do
+    system('mvn clean package')
+  end
+end
+
+task :note do
+  puts "NOTE: touch lib/pacer-titan/version.rb (or rake touch) to force everything to rebuild"
+end
+
+task :build => [:note, Pacer::Titan::JAR_PATH]
+task :install => [:note, Pacer::Titan::JAR_PATH]
+
+desc 'Touch version.rb so that the jar rebuilds'
+task :touch do
+  system 'touch', 'lib/pacer-titan/version.rb'
+end
+

data/config/cassandra-es.properties

@@ -0,0 +1,14 @@
+storage.backend=cassandrathrift
+storage.hostname=127.0.0.1
+
+cache.db-cache = true
+cache.db-cache-clean-wait = 20
+cache.db-cache-time = 180000
+cache.db-cache-size = 0.25
+
+storage.index.search.backend=elasticsearch
+storage.index.search.directory=../../lib/titan_server/db/cassandra/es
+storage.index.search.client-only=false
+storage.index.search.local-mode=true
+
+storage.fast-property=true

data/config/inmemory.properties

@@ -0,0 +1,2 @@
+storage.backend=inmemory
+storage.fast-property=true

data/lib/pacer-titan.rb

@@ -0,0 +1,38 @@
+require 'pacer' unless defined? Pacer
+
+lib_path = File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+$:.unshift lib_path unless $:.any? { |path| path == lib_path }
+
+require 'pacer-titan/version'
+require Pacer::Titan::JAR
+require 'pacer-titan/graph'
+require 'pacer-titan/titan_query'
+require 'pacer-titan/external_index_query'
+
+module Pacer
+  class << self
+    def titan(path="config/inmemory.properties")      
+      open = proc do
+        graph = Pacer.open_graphs[path]
+        unless graph
+          args = [java.lang.String.java_class]
+          graph = com.thinkaurelius.titan.core.TitanFactory.java_send(:open, args, path)
+          Pacer.open_graphs[path] = graph
+        end
+        graph
+      end
+      
+      shutdown = proc do |graph|
+        graph.blueprints_graph.shutdown
+        Pacer.open_graphs.delete path
+      end
+
+      Titan::Graph.new(Pacer::YamlEncoder, open, shutdown)
+    end
+    
+    def executing_route(route)
+      Rails.logger.debug "Pacer Titan executing route: #{route.description}" if defined? Rails
+    end	
+  end
+end
+

data/lib/pacer-titan/external_index_query.rb

@@ -0,0 +1,67 @@
+module Pacer
+  module Titan
+    class Graph
+      # Use Titan's indexQuery to access external indexes using a custom lucene string
+      # eg. for grouped words search starting with lorem: g.index_query(:text, '(lorem*)')
+      # can also pass an array of properties to hit multiple elasticsearch indices at once
+      def index_query(properties, query, options = {})
+        options[:element_type] ||= :vertex
+        options[:index_name] ||= 'search' # name of the external index as configured in the .properties file
+        
+        chain_route options.merge(
+          query: query,
+          properties: properties,
+          filter: :external_index_query,
+          back: self
+        )
+      end
+    end
+  end
+
+  module Filter
+    module ExternalIndexQuery
+      attr_accessor :query, :properties, :top, :index_name
+      
+      def top_hits(n)
+        self.top = n
+        self
+      end
+      
+      def count
+        query_result.count
+      end
+        
+      protected
+      
+      def query_result
+        query_string = build_titan_lucene_query(query, properties)
+        path = graph.blueprints_graph.index_query(index_name, query_string)
+        path.limit(top) if top
+        path = path.vertices.collect{ |v| v.get_element }
+      end
+      
+      # expects query in the form of 'v.text:(lorem*)'
+      def build_titan_lucene_query(term, property)
+        if property.is_a? Array
+          queries = []
+          property.each do |prop|
+            prop = "\"#{prop}\"" if prop.to_s.include?("_") # need to surround in double quotes if indexed property has an underscore
+            queries.concat [ "v.#{prop}:#{term}" ] 
+          end
+          queries.join " OR "
+        else
+          property = "\"#{property}\"" if property.to_s.include?("_") 
+          "v.#{property}:#{term}"
+        end
+      end
+      
+      def source_iterator
+        query_result.to_route(element_type: :vertex, graph: graph)
+      end
+      
+      def inspect_string
+        "#{ inspect_class_name }"
+      end
+    end
+  end
+end

data/lib/pacer-titan/graph.rb

@@ -0,0 +1,28 @@
+module Pacer
+  module Titan
+    # hack to make indexing work:
+    class FeatureProxy
+      def initialize original_features 
+        @features = original_features 
+      end
+      
+      def supportsIndices
+        true
+      end
+      
+      def method_missing(name, *args, &block)
+        @features.public_send(name, *args, &block) 
+      end
+    end
+    
+    class Graph < PacerGraph
+      def features
+        FeatureProxy.new(blueprints_graph.features)
+      end 
+      
+      def indices
+        key_indices
+      end
+    end
+  end
+end

data/lib/pacer-titan/rspec.rb

@@ -0,0 +1,24 @@
+class RSpec::GraphRunner
+  module Titan
+    def all(usage_style = :read_write, indices = true, &block)
+      super
+      titan(usage_style, indices, &block)
+    end
+
+    def titan(usage_style = :read_write, indices = true, &block)
+      for_graph('titan', usage_style, indices, false, titan_graph, titan_graph_2, nil, block)
+    end
+
+    protected
+
+    def titan_graph
+      return @titan_graph if @titan_graph
+      @titan_graph = Pacer.titan('../pacer-titan/config/inmemory.properties')
+    end
+
+    def titan_graph_2
+      return @titan_graph_2 if @titan_graph_2
+      @dex_graph2 = Pacer.titan('../pacer-titan/config/inmemory.properties')
+    end
+  end
+end

data/lib/pacer-titan/titan_query.rb

@@ -0,0 +1,47 @@
+module Pacer
+  module Titan
+    class Graph
+      # Use Titan's QueryBuilder to access indexes (replaces g.v(key: value) style index querying
+      # eg: g.query{ has('login', 'ilya').has('description', Text::CONTAINS, 'abc') }.out(:messages)
+      # be sure to java_import com.thinkaurelius.titan.core.attribute.Text for the above example
+      def query(options = { element_type: :vertex }, &query)
+        chain_route options.merge(
+          query: query,
+          filter: :titan_query,
+          back: self
+        )
+      end
+    end
+  end
+
+  module Filter
+    module TitanQuery
+      attr_accessor :query, :top
+      
+      def top_hits(n)
+        self.top = n
+        self
+      end
+      
+      def count
+        query_result.count
+      end
+        
+      protected
+      
+      def query_result
+        path = graph.blueprints_graph.query.instance_exec(&query)
+        path.limit(top) if top
+        path = path.vertices
+      end
+      
+      def source_iterator
+        query_result.to_route(element_type: :vertex, graph: graph)
+      end
+      
+      def inspect_string
+        "#{ inspect_class_name }"
+      end
+    end
+  end
+end

data/lib/pacer-titan/version.rb

@@ -0,0 +1,11 @@
+module Pacer
+  module Titan
+    VERSION = "0.0.1"
+    JAR = "pacer-titan-#{ VERSION }-standalone.jar"
+    JAR_PATH = "lib/#{ JAR }"
+    BLUEPRINTS_VERSION = "2.4.0"
+    PIPES_VERSION = "2.4.0"
+    TITAN_VERSION = "0.4.2"
+    PACER_REQ = ">= 1.4.0"
+  end
+end

data/pacer-titan.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pacer-titan/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pacer-titan"
+  s.version     = Pacer::Titan::VERSION
+  s.platform    = 'java'
+  s.authors     = ["Ilya Kardailsky"]
+  s.email       = ["ilya.kardailsky@gmail.com"]
+  s.homepage    = "http://www.github.com"
+  s.summary     = %q{Titan jars and related code for Pacer}
+  s.description = s.summary
+
+  s.add_dependency 'pacer', Pacer::Titan::PACER_REQ
+
+  s.files         = `git ls-files`.split("\n") + [Pacer::Titan::JAR_PATH]
+  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"]
+end

data/pom.xml

@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>com.tinkerpop.pacer</groupId>
+    <artifactId>pacer-titan</artifactId>
+    <!-- NOTE: the following properties are automatically updated based on the values in lib/pacer-titan/version.rb -->
+    <properties>
+      <gem.version>0.0.1</gem.version>
+      <blueprints.version>2.4.0</blueprints.version>
+      <pipes.version>2.4.0</pipes.version>
+      <titan.version>0.4.2</titan.version>
+    </properties>
+    <!-- NOTE: the following properties are automatically updated based on the values in lib/pacer-titan/version.rb -->
+    <version>${gem.version}</version>
+    <packaging>pom</packaging>
+    <url>https://github.com/pangloss/pacer</url>
+    <name>Pacer Titan dependencies and related code.</name>
+    <description>
+    </description>
+    <inceptionYear>2014</inceptionYear>
+    <developers>
+        <developer>
+            <name>Ilya Kardailsky</name>
+            <email>ilya.kardailsky@gmail.com</email>
+            <url>http://github.com</url>
+        </developer>
+    </developers>
+    <dependencies>
+        <!-- PROPERTY GRAPH MODEL SUPPORT -->
+        <dependency>
+            <groupId>com.tinkerpop.blueprints</groupId>
+            <artifactId>blueprints-core</artifactId>
+            <version>${blueprints.version}</version>
+        </dependency>
+        <!-- GRAPH TRAVERSAL SUPPORT -->
+        <dependency>
+            <groupId>com.tinkerpop</groupId>
+            <artifactId>pipes</artifactId>
+            <version>${pipes.version}</version>
+        </dependency>
+        <!-- TITAN SUPPORT -->
+        <dependency>
+            <groupId>com.thinkaurelius.titan</groupId>
+            <artifactId>titan-core</artifactId>
+            <version>${titan.version}</version>
+        </dependency>
+    </dependencies>
+
+    <repositories>
+        <repository>
+            <id>tinkerpop-repository</id>
+            <name>TinkerPop Maven2 Repository</name>
+            <url>http://tinkerpop.com/maven2</url>
+            <snapshots>
+                <enabled>true</enabled>
+                <updatePolicy>always</updatePolicy>
+            </snapshots>
+        </repository>
+    </repositories>
+
+    <distributionManagement>
+        <repository>
+            <id>tinkerpop-repository</id>
+            <name>TinkerPop Maven2 Repository</name>
+            <url>ftp://ftp.tinkerpop.com:21/public/maven2/</url>
+        </repository>
+    </distributionManagement>
+
+    <build>
+        <directory>${basedir}/target</directory>
+        <finalName>${project.artifactId}-${project.version}</finalName>
+        <resources>
+            <resource>
+                <directory>${basedir}/src/main/resources
+                </directory>
+            </resource>
+        </resources>
+        <testResources>
+            <testResource>
+                <directory>${basedir}/src/test/resources
+                </directory>
+            </testResource>
+        </testResources>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>1.6</source>
+                    <target>1.6</target>
+                </configuration>
+            </plugin>
+            <plugin>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <version>2.2-beta-4</version>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>attached</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <descriptors>
+                        <descriptor>pom/standalone.xml</descriptor>
+                    </descriptors>
+                    <finalName>${project.artifactId}-${project.version}</finalName>
+                    <outputDirectory>lib</outputDirectory>
+                    <workDirectory>target/assembly/work</workDirectory>
+                    <tarLongFileMode>warn</tarLongFileMode>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>2.6.1</version>
+            </plugin>
+        </plugins>
+        <extensions>
+            <extension>
+                <groupId>org.apache.maven.wagon</groupId>
+                <artifactId>wagon-ftp</artifactId>
+                <version>1.0-alpha-6</version>
+            </extension>
+        </extensions>
+    </build>
+
+</project>

data/pom/standalone.xml

@@ -0,0 +1,22 @@
+<assembly>
+    <id>standalone</id>
+    <formats>
+        <format>jar</format>
+    </formats>
+    <includeBaseDirectory>false</includeBaseDirectory>
+
+    <fileSets>
+        <fileSet>
+            <directory>target/classes</directory>
+            <outputDirectory>/</outputDirectory>
+        </fileSet>
+    </fileSets>
+
+    <dependencySets>
+        <dependencySet>
+            <outputDirectory>/</outputDirectory>
+            <unpack>true</unpack>
+            <scope>runtime</scope>
+        </dependencySet>
+    </dependencySets>
+</assembly>

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: pacer-titan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: java
+authors:
+- Ilya Kardailsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pacer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: Titan jars and related code for Pacer
+email:
+- ilya.kardailsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- config/cassandra-es.properties
+- config/inmemory.properties
+- lib/pacer-titan.rb
+- lib/pacer-titan/external_index_query.rb
+- lib/pacer-titan/graph.rb
+- lib/pacer-titan/rspec.rb
+- lib/pacer-titan/titan_query.rb
+- lib/pacer-titan/version.rb
+- pacer-titan.gemspec
+- pom.xml
+- pom/standalone.xml
+- lib/pacer-titan-0.0.1-standalone.jar
+homepage: http://www.github.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Titan jars and related code for Pacer
+test_files: []