cayley 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 505f350b550e3d42002f260e544ad84402c9a7be
-  data.tar.gz: ab6b45e217d3e6e07c8575d82241f2a3d7c2648a
+  metadata.gz: 793eed313948db158c0686987ee9309a9f9b94db
+  data.tar.gz: f3f73cf8f68ec5b912e0c4f44cc731ee3b740e2a
 SHA512:
-  metadata.gz: e0d54d7b09841f5d3626d66c0af382918713904a9a27fcd240dfa393d39c96d2bed94785bd5dbcd531e19cbcb8a59131913884e144eb65f64ecbd220e54735b8
-  data.tar.gz: 4f9a4398e5c833b6cd20ba65f51af284f7e2160e368213e6deb366fe70b597e3965c94019da1b8524a1bb88548976f6228601f7d5c49206e6bc378d55a5b5406
+  metadata.gz: d923514bf7c0923317505b37f72d2cc55f193b2da5bdea3e4d169a429d0636553d6002e206f3585b47f0d07519518d5de7e8b5408476827288695d1aaea271f0
+  data.tar.gz: a30a1142bb6ca416ba802f38ba01a5f11c8020e53236bce64ad61626f6d8773af1b0bdb71250aa50fdc065ad6739629d58cea6a01f3a8bfe5ed436f3ca755c00

data/README.md

@@ -0,0 +1,102 @@
+# cayley-ruby
+
+A ruby library for working with
+[Google's Cayley](https://github.com/google/cayley)
+graph database.
+
+## Installation
+
+You can install it via gem
+
+```bash
+gem install cayley
+```
+
+## Usage
+
+Start your Cayley
+
+```bash
+# example using 30kmoviedata from cayley's repository
+./cayley http --dbpath=30kmoviedata.nt
+```
+
+You can use methods from
+[Gremlin API documentation](https://github.com/google/cayley/blob/master/docs/GremlinAPI.md), just translate method names to snake style equivalent.
+
+As a first step you need to create your client
+
+```ruby
+require 'cayley'
+
+graph = Cayley::Graph.new
+
+# or
+
+graph = Cayley::Graph.new(host: 'localhost', port: 64210)
+```
+
+Then using **30kmovies.nt** db from cayley's repository you can do this
+
+```ruby
+graph.vertex.get_limit(5)
+
+graph.vertex('Humphrey Bogart').lll
+
+graph.v('Humphrey Bogart').all
+
+graph.v('Humphrey Bogart').in('name').all
+
+graph.v('Casablanca').in('name').all
+
+graph.v().has('name', 'Casablanca').all
+```
+
+You can also use morphism
+
+```
+film_to_actor = graph.morphism
+                     .out('/film/film/starring')
+                     .out('/film/performance/actor')
+graph.v
+     .has('name', 'Casablanca')
+     .follow(film_to_actor)
+     .out('name').all
+```
+
+For more info take a look at
+[Cayley's repository](https://github.com/google/cayley)
+
+## Advanced
+
+By default result of your queries are wrapped in Hashie::Mash so you can
+do things like these
+
+```ruby
+graph.v.all.each do |result|
+  puts result.id # instead of result['id']
+end
+```
+
+If you want to use plain ruby hashes you can disable wrapping by
+
+```ruby
+graph = Cayley::Graph.new(result_wrapper: nil)
+```
+
+Or you can use some custom wrapper if you put class instead of nil.
+
+## Debugging
+
+If you are not sure why you are getting nil as a result of your query
+and you are not able to find out the solution you can turn on debug mode
+where used Gremlin query is printed out.
+
+```ruby
+graph = Cayley::Graph.new(debug: true)
+```
+
+## TODO
+
+* logger
+* tests

data/lib/cayley.rb

@@ -0,0 +1,8 @@
+
+require 'json'
+require 'curb'
+require 'hashie'
+require 'active_support/core_ext/string/inflections'
+
+require 'cayley/path'
+require 'cayley/graph'

data/lib/cayley/graph.rb

@@ -0,0 +1,55 @@
+module Cayley
+
+  class Graph
+    API_PATH = '/api/v1/query/gremlin'
+
+
+    def initialize params
+      @host = params[:host] || 'localhost'
+      @port = params[:port] || 64210
+      @debug = params[:debug] || false
+      @result_wrapper = params[:result_wrapper] || Hashie::Mash
+    end
+
+    def query
+      Query.new(self)
+    end
+
+    def vertex *args
+      Path.vertex(self, *args)
+    end
+
+    alias_method :v, :vertex
+
+    def morphism
+      Path.morphism(self)
+    end
+
+    alias_method :m, :morphism
+
+    def perform query
+      constructed = query.construct
+      puts "DEBUG - Query: #{constructed}" if @debug
+      results = request(constructed)
+
+      if results && @result_wrapper
+        results.map{ |r| @result_wrapper.new(r) }
+      else
+        results
+      end
+    end
+
+    protected
+
+    def request data
+      url = "http://#{@host}:#{@port}#{API_PATH}"
+      r = Curl::Easy.new(url) do |curl|
+        curl.headers["User-Agent"] = "curb-#{Curl::VERSION}"
+        #curl.verbose = true
+      end
+      r.http_post(data)
+      JSON.load(r.body_str)['result']
+    end
+  end
+
+end

data/lib/cayley/path.rb

@@ -0,0 +1,66 @@
+module Cayley
+
+  class Path
+    attr_accessor :calls
+
+    METHODS = [
+      :out, :in, :both, :is, :has, # basic
+      :tag, :back, :save, # tags
+      :intersect, :union, # joining
+    ]
+
+    def self.vertex graph, *args
+      path = Path.new(graph)
+      path.calls = [{ method: :vertex, args: args }]
+      path
+    end
+
+    def self.morphism graph
+      Path.new(graph)
+    end
+
+    def initialize graph=nil
+      @graph = graph
+      @calls = []
+    end
+
+    def method_missing name, *args
+      return super unless METHODS.include?(name)
+      add(name, *args)
+    end
+
+    def add name, *args
+      @calls << { method: name, args: args }
+      self
+    end
+
+    def follow path
+      path.calls.each { |c| @calls << c }
+      self
+    end
+
+    def + path
+      clone.follow(path)
+    end
+
+    def all
+      add(:all)
+      @graph.perform(self)
+    end
+
+    def get_limit limit
+      add(:get_limit, limit)
+      @graph.perform(self)
+    end
+
+    def construct
+      calls = @calls.map do |call|
+        m = call[:method].to_s.camelize
+        as = (call[:args] || []).map{ |a| "\"#{a}\"" }.join(", ")
+        "#{m}(#{as})"
+      end
+      'graph.' + calls.join('.')
+    end
+  end
+
+end

data/lib/cayley/version.rb

@@ -1,3 +1,3 @@
 module Cayley
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: cayley
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Rene Klacan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -38,14 +94,17 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-description: ''
+description: Ruby library for working with Google's Cayley graph database
 email: rene@klacan.sk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/cayley.rb
+- lib/cayley/path.rb
 - lib/cayley/version.rb
+- lib/cayley/graph.rb
+- README.md
 homepage: https://github.com/reneklacan/cayley-ruby
 licenses:
 - Beerware
@@ -69,6 +128,6 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Ruby library for working with Google's Cayley graph database
 test_files: []
 has_rdoc: