wewoo 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9405068406bfb2b2a289835503acf38b8c41a13
+  data.tar.gz: caddd5fad7db02dd7711fff21615bec5ae0ceb29
+SHA512:
+  metadata.gz: 60c3603e885d9bab087e80053136bc37896b7a018a664da10e15b8f697f366e39e555f30e2da84e83a61606596504e14b88e65733b136fb67dbdc414c2de3703
+  data.tar.gz: b8f56a6f2ef9892eaefe802cd3ad81cdd6dcbc9b603c3c4b4bc5479173817bc5c632706f37244e9dcdb6aa8f42505c1fdbbc67d5f13d05f7b4e0aa22a3d5ade1

data/.gitignore

@@ -0,0 +1,21 @@
+curls.txt
+todo.txt
+*.gem
+*.rbc
+*.swo
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in titanup.gemspec
+gemspec
+
+gem 'main', '~> 5.2.0'

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', cli: "--color --format Fuubar --fail-fast --drb", all_after_pass: false, all_on_start: false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^spec/support/.+\.rb$}) { "spec"} 
+  watch(%r{^lib/wewoo/(.+)\.rb$})  { |m| "spec/wewoo/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')     { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 derailed
+
+MIT License
+
+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.md

@@ -0,0 +1,176 @@
+# WeWoo
+
+Wewoo is a small wrapper library that provides for graph database
+management using Ruby. Any graph databases that supports the Rexster graph
+server REST API can be integrated with Wewoo.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'wewoo'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install wewoo
+```
+
+## Usage
+
+Wewoo comes bundled with a REPL console to make for experimentation with the
+graph database using Ruby a joy.
+
+```
+$ wewoo
+```
+
+### Connecting to a graph
+
+Dependending on your Rexster configuration, you will need to specify the
+host and port to tell Wewoo how to connect. The default url is localhost:8182.
+You may optionaly choose to set the configuration in a shell environment variable
+WEWOO_URL ie WEWOO_URL='http://localhost:8185'
+
+```ruby
+# List out all available graphs
+Wewoo::Graph.available_graphs #=> ["test_graph", "my_awesome_graph"]
+
+# Connect to an existing graph on localhost:8182
+g = Wewoo::Graph.new( :my_awesome_graph )
+# or...
+g = Wewoo::Graph.new( :my_awesome_graph, 'localhost', 9000 )
+
+# List out all vertices
+g.V # => [v(95084), v(95072), v(95076), v(95088), v(95080)]
+
+# List out all edges
+g.E # => [e(1lIN-oJG-4K) [95088-created-95076], e(1lIJ-oJy-4K) [95080-created-95084]]
+```
+
+### Adding a vertex
+
+Most graph database don't allow setting an id on a graph element. Wewoo errs on
+letting the graph implementation assign an internal id. It is usually considered
+good practice to keep vertex properties to a minimum. Wewoo provides a special
+property :gid to integrate the graph element with another data source.
+You can leverage :gid to represent a foreign key to another store. Hence :gid must
+be unique. If not set the gid will refer to the underlying graph
+implementation id.
+
+```ruby
+v = g.add_vertex( name: 'Fred', age: 20, active: true, gid: 'user_900' )
+v.id        #=> 1234
+v.gid       #=> 'user_900'
+v.props     #=> {name: 'Fred', age: 20, active: true}
+v.props.age #=> 20
+```
+
+### Adding an edge
+
+```ruby
+v1 = g.add_vertex( name: 'Fred' )
+v2 = g.add_vertex( name: 'Blee' )
+e  = g.add_edge( v1, v2, :friend, timestamp: Time.now )
+e.id    #=> 1234
+e.gid   #=> 1234
+e.props #=> {"timestamp"=>"2014-03-01 13:55:26 -0700"}
+```
+
+### Deleting elements
+
+Wewoo provides two way to delete a graph element. If you have a handle on the
+instance, you can call destroy on it directly. If not you can remove an element
+by calling the associated remove method on a graph instance using the graph
+element id.
+NOTE: By virtue of a graph database, when deleting a vertex, all associated
+edges will be deleted.
+
+```ruby
+# Delete edge with id 1234
+g.e( 1234 ).destroy
+# or ...
+g.remove_edge( 1234 )
+
+# Delete a vertex with id 5678
+g.v( 5678 ).destroy
+# or...
+g.remove_vertex( 5678 )
+
+# Clear out the graph
+g.clear
+```
+
+### Traversing
+
+The power of graph database is in traversal. Traversal in Wewoo is made available
+using the [Gremlin](http://gremlindocs.com/) graph api.
+
+```ruby
+# Find all vertices outbound from vertex 1234
+g.v( 1234 ).out #=> [v(4567)]
+
+# Find all vertices inbound to vertex 1234
+g.v( 1234 ).in  #=> [v(7890), v(7891)]
+
+# Find all vertices directly connected to vertex 1234
+g.v( 1234 ).both #=> [v(7890), v(7891), v(4567)]
+
+# Find all edges connected to vertex 1234 with labels fred or created
+g.v(1234).bothE( :fred, :created) #=> [e(1lIJ-oJy-4K) [95080-created-95084]]
+
+# Find all vertices with name property blee
+g.find_vertices( :name, 'blee' ) #=> [v(1234)]
+
+# Find vertex with gid 1234
+g.find_first_vertex( :gid, 1234 ) #=> [v(567)]
+
+# Find vertex with id 456
+g.find_vertex( 456 ) #=> [v(456)]
+# or...
+g.v( 456 )           #=> [v(456)]
+
+# Paging support...
+g.find_vertices( 'enabled', true, 1, 2 ) #=> [v(7890), v(7891)]
+```
+
+You can access the full gremlin query api using the Wewoo::Graph#query
+method. Wewoo does its best to construct graph elements objects with the returning
+results.
+
+```ruby
+# Find all vertices who's name is fred
+g.query( "g.V.out.groupCount.cap") #=> {v(113420)=>2, v(113416)=>2, v(113412)=>1}
+
+# Find all edge with weight < 0.5
+g.q( "g.E.has( 'weight', T.lt, 0.5f)" ) #=> [e(1xSj-tve-2W) [113412-friend-113416]]
+```
+
+## Releases
+
+* 0.1.0 Initial drop
+* 0.1.1 Disable user defined IDs as most graphs disallow
+* 0.1.2 Bug fixes and spec updates
+* 0.1.3 Spec'ed out Gremlin API
+* 0.1.4 Refactor graph elements
+* 0.1.5 Beef up specs + README
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+ Wewoo is released under the [MIT](http://opensource.org/licenses/MIT) license.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/wewoo

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+require 'bundler'
+Bundler.require
+require 'wewoo'
+require 'pry'
+
+Main {
+  def run
+    puts "WeWoo Console"
+    Pry.config.prompt_name = "WeWoo"
+    Pry.start
+  end
+}

data/lib/wewoo.rb

@@ -0,0 +1,19 @@
+require "wewoo/version"
+
+module Wewoo
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH    = ::File.dirname(LIBPATH) + ::File::SEPARATOR  
+  
+  def self.configure(&block)
+    Configuration.module_eval( &block )
+  end
+
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+    Dir.glob(search_me).sort.each { |rb| require rb }
+  end  
+end
+
+Wewoo.require_all_libs_relative_to File.expand_path( "wewoo", Wewoo::LIBPATH )

data/lib/wewoo/adapter.rb

@@ -0,0 +1,58 @@
+require 'typhoeus'
+require 'json'
+require 'map'
+
+module Wewoo
+  module Adapter
+    module_function
+
+    class NoDataError           < RuntimeError; end
+    class InvalidRequestError   < RuntimeError; end
+
+    def get( url, opts={} )
+      handle_response( Typhoeus.get( url, opts ) )
+    end
+
+    def post( url, opts={} )
+      handle_response( Typhoeus.post( url, opts ) )
+    end
+
+    def put( url, opts={} )
+      handle_response( Typhoeus.put( url, opts ) )
+    end
+
+    def delete( url, opts={} )
+      handle_response( Typhoeus.delete( url, opts ) )
+    end
+
+    def log( title, message )
+      return unless Configuration.debug
+
+      msg = "[Wewoo] #{title} -- #{message}"
+      if Object.const_defined? :Rails
+        Rails.logger.info msg
+      else
+        puts msg
+      end
+    end
+
+    def handle_response( resp )
+      log "URL", resp.effective_url
+
+      unless resp.success?
+        error = "-- " + JSON.parse( resp.response_body )['message'] rescue ""
+        raise InvalidRequestError, "<#{resp.response_code}> " +
+              "Failed request:#{resp.effective_url} #{error}"
+      end
+
+      if resp.body.empty? or resp.body == "null"
+        raise NoDataError, "No data found at location #{url}"
+      end
+
+      body = JSON.parse( resp.body )
+      log "RESP", body
+      results = body['results'] || body
+      results.is_a?(Hash) ? Map[results] : results
+    end
+  end
+end

data/lib/wewoo/configuration.rb

@@ -0,0 +1,24 @@
+module Wewoo
+  class Configuration
+    def self.debug(value=false)
+      @debug ||= value
+    end
+
+    def self.url(host=nil, port=nil)
+      @url = nil if host
+      @url ||= begin
+        url = compute_url( host, port) || ENV['WEWOO_URL'] || default_url
+        url.to_s.gsub( %r(/*$), '' )
+      end
+    end
+
+    private
+
+    def self.compute_url( host, port )
+      return nil unless host and port
+      "http://#{host}:#{port}"
+    end
+
+    def self.default_url; compute_url( :localhost, 8182 ); end
+  end
+end

data/lib/wewoo/edge.rb

@@ -0,0 +1,54 @@
+require 'wewoo/element'
+
+module Wewoo
+  class Edge < Element
+    include Adapter
+
+    attr_accessor :label, :from_id, :to_id
+
+    def ==( other )
+      self.class   == other.class and
+      self.id      == other.id and
+      self.from_id == other.from_id and
+      self.to_id   == other.to_id and
+      self.label   == other.label and
+      self.props   == other.props
+    end
+    alias :eql? :==
+    def hash; id; end
+
+    def get_vertex( direction )
+      id = (direction == :in ? to_id : from_id)
+      graph.find_vertex( id )
+    end
+    def in;  @in  || get_vertex(:in); end
+    def out; @out || get_vertex(:out); end
+
+    def to_s
+      "e(#{self.id}) [#{from_id}-#{label}-#{to_id}]"
+    end
+    alias :inspect :to_s
+
+    def destroy
+      graph.remove_edge( id )
+    end
+
+    private
+
+    def self.from_hash( graph, hash )
+      new( graph,
+           hash.delete( '_id' ),
+           hash.delete( '_outV' ),
+           hash.delete( '_inV' ),
+           hash.delete('_label'), hash )
+    end
+
+    def initialize( graph, id, from_id, to_id, label, properties )
+      super( graph, id, properties )
+
+      @from_id = from_id
+      @to_id   = to_id
+      @label   = label
+    end
+  end
+end

data/lib/wewoo/element.rb

@@ -0,0 +1,28 @@
+module Wewoo
+  class Element
+    attr_reader   :id, :graph
+    attr_accessor :properties
+
+    alias :props :properties
+
+    def gid
+      props.gid
+    end
+
+    private
+
+    def initialize( graph, id, properties )
+      @graph            = graph
+      @id               = id
+      @properties       = to_props( properties )
+      @properties[:gid] = id unless props[:gid]
+    end
+
+    def to_props( properties )
+      properties.delete( '_type' )
+      Map[Hash[properties.map { |k,v|
+        [k, ((v.is_a? Hash and v.has_key? 'type') ? v['value'] : v)]
+      }]]
+    end
+  end
+end