neoon 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08ac0ff644d4961a328938854c086db4a7d35689
+  data.tar.gz: 54aa3709453cecc5d1533036418812868547affe
+SHA512:
+  metadata.gz: 84a8aaca5d0e2a78c120517f29aba0ad0a63d9b8c4e818a4e5a9fbb5239f02d0611ce2d5d92a544e1fc7b99e41fbc8d2f8c6e55378394b191f818f81a8621494
+  data.tar.gz: 50662379431fe64b80fbd9d64930060d1a582adb737a52bddb92f9135b2c9880d53d3f0cff493f80492fafdfe29e0d60bb479799f25193f7389c9e3362c6070e

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/.rspec

@@ -0,0 +1 @@
+--format documentation --color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby
+jdk:
+  - openjdk7
+services:
+  - neo4j

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'rake'
+
+group :test do
+  gem 'rspec'
+  gem 'sqlite3', :platform => [:ruby, :mswin, :mingw]
+  gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Amr Tamimi
+
+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,101 @@
+**The gem is not Production Ready™.**
+
+# Neoon [![Build Status](https://travis-ci.org/amrnt/neoon.png?branch=master)](https://travis-ci.org/amrnt/neoon)
+
+A simple Ruby wrapper for Neo4j with focus on Cypher and the features of Neo4j 2.0
+
+#### Inspired by [Neoid](https://github.com/elado/neoid)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'neoon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install neoon
+
+## Usage
+
+First you have to initialize  a client:
+
+```ruby
+ENV["NEO4J_URL"] ||= "http://localhost:7474"
+
+$neo = Neoon.client ENV["NEO4J_URL"]
+```
+
+Set configuration:
+
+```ruby
+Neoon.configure do |config|
+  config.preload_models = true # (default: false) This will load your models — so to update the indexes at the (Rails) boot
+end
+```
+
+To query using Cypher:
+
+```ruby
+$neo.q("START node=node(*) RETURN node")
+```
+
+To your ActiveRecord model, initialize Neoon like so (with example of using properties/index):
+
+```ruby
+class Topic < ActiveRecord::Base
+
+  include Neoon::Node
+
+  neoon do |c|
+    c.property :name
+    c.property :slug, :index => true do
+      "#{self.id}-#{self.name.underscore}"
+    end
+  end
+
+end
+```
+
+### Indexing
+
+This will be used internally to auto indexing the model depends on what described in the neoon model config.
+
+```ruby
+Neoon.db.list 'Topic' #=> ["slug"]
+
+Neoon.db.create 'Topic', [:name, ...]
+
+Neoon.db.drop 'Topic' [:name, ...]
+
+# Alternativly
+
+Topic.neo_index_list #=> ["slug"]
+
+Topic.neo_index_create [:name, ...]
+
+Topic.neo_index_drop [:name, ...]
+
+# Sync the indexes you described in model config. It returns the indexed fields.
+# Remember, this will be called on each model on the boot if preload_models set to true.
+Topic.neo_index_update #=> ["slug"]
+```
+
+**The gem is still at heavy development. More to come!**
+
+## TODO
+
+1. ADD TESTS
+2. ..
+
+## 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

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/neoon/client/connection.rb

@@ -0,0 +1,46 @@
+module Neoon
+  module Client
+    class Connection
+
+      attr_reader :connection
+
+      def initialize(url)
+        @uri = URI.parse(url)
+        end_point = "#{@uri.scheme}://#{@uri.host}:#{@uri.port}#{@uri.path}"
+        @connection ||= Faraday.new(end_point, connection_options.merge(:builder => middleware))
+        @connection.basic_auth(@uri.user, @uri.password) if @uri.user && @uri.password
+      end
+
+      include Request
+      include Indexing
+
+    private
+
+      def connection_options
+        @connection_options ||= {
+          :headers => {
+            :accept => 'application/json',
+            :content_type => 'application/json; charset=UTF-8',
+            :x_stream => 'true',
+            :user_agent => ['Neoon', Neoon::VERSION].join(' ')
+          },
+          :request => {
+            :open_timeout => 5,
+            :timeout => 10,
+          },
+        }
+      end
+
+      def middleware
+        @middleware ||= Faraday::Builder.new do |builder|
+          builder.use FaradayMiddleware::EncodeJson
+          builder.use FaradayMiddleware::Mashify
+          builder.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+
+          builder.adapter Faraday.default_adapter
+        end
+      end
+
+    end
+  end
+end

data/lib/neoon/client/indexing.rb

@@ -0,0 +1,25 @@
+module Neoon
+  module Client
+    module Indexing
+
+      def list(label)
+        Neoon.db.get("/schema/index/#{label}")
+          .map{|f| f.send("property-keys")}.flatten.map(&:to_s).sort
+      end
+
+      def create(label, keys = [])
+        keys.each do |key|
+          Neoon.db.cypher("CREATE INDEX ON :#{label}(#{key.to_s.downcase})")
+        end
+      end
+
+      def drop(label, keys = [])
+        keys.each do |key|
+          Neoon.db.cypher("DROP INDEX ON :#{label}(#{key.to_s.downcase})")
+        end
+        neo_index_list
+      end
+
+    end
+  end
+end

data/lib/neoon/client/request.rb

@@ -0,0 +1,46 @@
+require 'faraday_middleware'
+
+module Neoon
+  module Client
+    module Request
+
+      def cypher(query, parameters = {})
+        options = { :query => query, :params => parameters }
+        post('/cypher', options)
+      end
+      alias_method :q, :cypher
+
+      def get(path, options={})
+        make_request(:get, '/db/data' + path, options)
+      end
+
+      def post(path, options={})
+        make_request(:post, '/db/data' + path, options)
+      end
+
+      def put(path, options={})
+        make_request(:put, '/db/data' + path, options)
+      end
+
+      def delete(path, options={})
+        make_request(:delete, '/db/data' + path, options)
+      end
+
+    private
+
+      def make_request(method, path, options)
+        response = connection.send(method) do |request|
+          case method
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options unless options.empty?
+          end
+        end
+        response.body
+      end
+
+    end
+  end
+end

data/lib/neoon/config.rb

@@ -0,0 +1,9 @@
+module Neoon
+  class Config
+    attr_accessor :preload_models
+
+    def models
+      @models ||= []
+    end
+  end
+end

data/lib/neoon/model/config.rb

@@ -0,0 +1,19 @@
+module Neoon
+  module Model
+    class Config
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def properties
+        @properties ||= {}
+      end
+
+      def property(name, *opts, &block)
+        self.properties[name] = {:block => block}.merge(opts.first || {}).reject { |k, v| v.nil? }
+      end
+
+    end
+  end
+end

data/lib/neoon/model/schema.rb

@@ -0,0 +1,39 @@
+module Neoon
+  module Model
+    module Schema
+
+      def neo_index_list
+        Neoon.db.list self.name
+      end
+
+      def neo_index_create keys = []
+        Neoon.db.create self.name, keys
+      end
+
+      def neo_index_drop keys = []
+        Neoon.db.drop self.name, keys
+      end
+
+      def neo_index_update
+        cl = neo_index_list
+        ck = neo_node_keys_to_index
+        return cl if (cl) == (ck)
+
+        neo_index_create(ck - cl) unless (ck - cl).empty?
+        neo_index_drop(cl - ck) unless (cl - ck).empty?
+        neo_index_list
+      end
+
+    private
+
+      def neo_model_props
+        self.neo_model_config.properties
+      end
+
+      def neo_node_keys_to_index
+        neo_model_props.select{ |k, v| v[:index]==true }.keys.map(&:to_s).sort
+      end
+
+    end
+  end
+end

data/lib/neoon/model/service.rb

@@ -0,0 +1,69 @@
+module Neoon
+  module Model
+    module Service
+
+      module ClassMethods
+        attr_reader :neo_model_config
+
+        def neo_model_config
+          @neo_model_config ||= Neoon::Model::Config.new(self)
+        end
+
+        def neoon(opts = {})
+          yield(neo_model_config) if block_given?
+
+          opts.each do |key, value|
+            raise "No such option #{key} for #{self.name} model" unless neo_model_config.respond_to?("#{key}=")
+            neo_model_config.send("#{key}=", value)
+          end
+        end
+      end
+
+      module InstanceMethods
+        def neo_node_props
+          neo_node.merge({ :db_id => self.id })
+        end
+
+        def neo_save
+          cypher_query = <<-CYPHER
+            MERGE (node:#{self.class.name} { db_id: #{self.id} })
+            ON CREATE node SET node = {props}
+            ON MATCH node SET node = {props}
+            RETURN node
+          CYPHER
+          Neoon.db.q(cypher_query, { :props => neo_node_props })
+        end
+
+        def neo_destroy
+          cypher_query = <<-CYPHER
+          CYPHER
+          Neoon.db.q(cypher_query)
+        end
+
+      protected
+
+        def neo_node
+          return {} unless self.class.neo_model_props
+          hash = self.class.neo_model_props.inject({}) do |all, (field, block)|
+            all[field] = if block[:block]
+              instance_eval(&block[:block])
+            else
+              self.send(field) rescue (raise "No field #{field} for #{self.class.name}")
+            end
+            all
+          end
+          hash.reject { |k, v| v.nil? }
+        end
+      end
+
+      def self.included(receiver)
+        receiver.extend         ClassMethods
+        receiver.extend         Schema
+        receiver.send :include, InstanceMethods
+
+        receiver.after_save :neo_save
+      end
+
+    end
+  end
+end

data/lib/neoon/node.rb

@@ -0,0 +1,18 @@
+module Neoon
+  module Node
+
+    module ClassMethods
+    end
+
+    module InstanceMethods
+    end
+
+    def self.included(receiver)
+      receiver.send :include, Model::Service
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+      Neoon.config.models << receiver
+    end
+
+  end
+end

data/lib/neoon/railtie.rb

@@ -0,0 +1,26 @@
+require 'rails'
+require 'rails/neoon'
+
+module Rails
+  module Neoon
+    class Railtie < ::Rails::Railtie
+
+      rake_tasks do
+        load "neoon/railties/database.rake"
+      end
+
+      initializer "neoon.neo_index_update" do
+        config.after_initialize do
+          ::Neoon.config.models.each(&:neo_index_update)
+        end
+      end
+
+      initializer "neoon.preload_models" do |app|
+        config.to_prepare do
+          Rails::Neoon.preload_models(app)
+        end
+      end
+
+    end
+  end
+end

data/lib/neoon/railties/database.rake

@@ -0,0 +1,2 @@
+namespace :db do
+end

data/lib/neoon/version.rb

@@ -0,0 +1,3 @@
+module Neoon
+  VERSION = '0.0.3'
+end

data/lib/neoon.rb

@@ -0,0 +1,40 @@
+require 'multi_json'
+
+require 'neoon/version'
+require 'neoon/config'
+require 'neoon/client/request'
+require 'neoon/client/indexing'
+require 'neoon/client/connection'
+
+require 'neoon/model/config'
+require 'neoon/model/schema'
+require 'neoon/model/service'
+require 'neoon/node'
+
+if defined?(Rails)
+  require 'neoon/railtie'
+end
+
+module Neoon
+
+  class << self
+    attr_reader :db
+
+    def client(url)
+      @db ||= Client::Connection.new url
+    end
+
+    def config
+      @config ||= begin
+        config = Neoon::Config.new
+        config.preload_models = false
+        config
+      end
+    end
+
+    def configure
+      yield config
+    end
+  end
+
+end

data/lib/rails/neoon.rb

@@ -0,0 +1,30 @@
+module Rails
+  module Neoon
+    extend self
+
+    def load_models(models)
+      models.each do |path|
+        files = Dir.glob("#{path}/**/*.rb")
+        files.sort.each do |file|
+          load_model(file.gsub("#{path}/" , "").gsub(".rb", ""))
+        end
+      end
+    end
+
+    def preload_models(app)
+      models = app.config.paths["app/models"]
+      load_models(models) if ::Neoon.config.preload_models
+    end
+
+  private
+
+    def load_model(file)
+      begin
+        require_dependency(file)
+      rescue Exception => e
+        puts e.message
+      end
+    end
+
+  end
+end

data/neoon.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'neoon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'neoon'
+  spec.version       = Neoon::VERSION
+  spec.authors       = ['Amr Tamimi']
+  spec.email         = ['amrnt0@gmail.com']
+  spec.description   = 'A simple Ruby wrapper for Neo4j with focus on Cypher'
+  spec.summary       = 'A simple Ruby wrapper for Neo4j with focus on Cypher'
+  spec.homepage      = 'https://github.com/amrnt/neoon'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version     = ">= 1.9"
+
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+  spec.add_runtime_dependency 'multi_json'
+  spec.add_runtime_dependency 'hashie'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'rspec'
+end

data/spec/app/models/topic.rb

@@ -0,0 +1,11 @@
+class Topic < ActiveRecord::Base
+  include Neoon::Node
+
+  neoon do |c|
+    c.property :name
+    c.property :slug, :index => true do
+      "#{self.id}-#{self.name.underscore}"
+    end
+  end
+
+end

data/spec/neoon_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Neoon do
+
+  describe ".config" do
+
+    context "no block given" do
+      it "returns the config singleton" do
+        Neoon.config.should eq Neoon::config
+      end
+
+      it "returns config.preload_models false" do
+        Neoon.config.preload_models.should be_false
+      end
+
+      it "should have no model" do
+        Neoon.config.models.should be_empty
+      end
+    end
+
+    context "with block given" do
+      before do
+        Neoon.configure do |c|
+          c.preload_models = true
+        end
+        require 'app/models/topic' # fake loading a model
+      end
+
+      after do
+        Neoon.configure do |c|
+          c.preload_models = false
+        end
+      end
+
+      it "returns config.preload_models true" do
+        Neoon.config.preload_models.should be_true
+      end
+
+      it "should have models" do
+        Neoon.config.models.should_not be_empty
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'neoon'
+require 'active_record'
+
+ENV["NEO4J_URL"] ||= "http://localhost:7474"
+$neo = Neoon.client(ENV["NEO4J_URL"])
+
+ActiveRecord::Base.configurations = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'support/database.yml')))
+if defined?(JRUBY_VERSION)
+  ActiveRecord::Base.establish_connection('jruby')
+else
+  ActiveRecord::Base.establish_connection('ruby')
+end
+
+require 'support/schema'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/support/database.yml

@@ -0,0 +1,13 @@
+ruby:
+  adapter: sqlite3
+  database: ":memory:"
+  encoding: utf8
+  charset: utf8
+  timeout: 5000
+
+jruby:
+  adapter: jdbcsqlite3
+  database: ":memory:"
+  encoding: utf8
+  charset: utf8
+  timeout: 5000

data/spec/support/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define :version => 0 do
+  create_table :topics do |t|
+    t.string :name
+
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: neoon
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Amr Tamimi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple Ruby wrapper for Neo4j with focus on Cypher
+email:
+- amrnt0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/neoon.rb
+- lib/neoon/client/connection.rb
+- lib/neoon/client/indexing.rb
+- lib/neoon/client/request.rb
+- lib/neoon/config.rb
+- lib/neoon/model/config.rb
+- lib/neoon/model/schema.rb
+- lib/neoon/model/service.rb
+- lib/neoon/node.rb
+- lib/neoon/railtie.rb
+- lib/neoon/railties/database.rake
+- lib/neoon/version.rb
+- lib/rails/neoon.rb
+- neoon.gemspec
+- spec/app/models/topic.rb
+- spec/neoon_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.yml
+- spec/support/schema.rb
+homepage: https://github.com/amrnt/neoon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+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: A simple Ruby wrapper for Neo4j with focus on Cypher
+test_files:
+- spec/app/models/topic.rb
+- spec/neoon_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.yml
+- spec/support/schema.rb