neo4apis 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 263a1abd3e312305779129128e2d57f89f40f322
-  data.tar.gz: 581cde3d29596bc38e767cfbc681d5d16a49124c
+  metadata.gz: b354c2fcdc459dfee003519187e331dbbdf18b21
+  data.tar.gz: 582a44a502d76bc64787c91b6adc8fe5d701bf94
 SHA512:
-  metadata.gz: 3a6cea13605e886f0d60ad96ce4d2021823cb0b8c5990032d3a5da33547d96e3c50c46d802edb09a7aa2dd96119314934ef54ed9b40b30eab5acb550e11f06c5
-  data.tar.gz: f7a4e1b8c9fe255acc05d2f86bfe5eeca35235ef376f89154155e4d68d8308d5ca7507d80506d5a034abe946f2031312d99fae94dd34f903601b14bc79afae7f
+  metadata.gz: 906c3561511e1d9896d5c9f53f6bde9613091672a0808a20ad2a67393eb730c4901c8dec1b441a66aa98c02f2d772397f6fada42b887873e4d3d8772103d913f
+  data.tar.gz: 3447ff2185d46f9327c6c5ccaf9892620ed73946317b67879074ad754e311c51d0b869077e9985da3e86d3b0b656324d05427d0a295c36ea894a7663cf6f262f

data/README.md

@@ -1,13 +1,27 @@
 
-neo4apis is a ruby gem for building gems which import data into neo4j.  Takes care of batching of queries for better import performance
+==Introduction==
+
+neo4apis is a ruby gem for building objects which import data into neo4j.  It takes care of batching of queries for better import performance and creating indexes for better query performance.  It also uses MERGEs to make sure the same node/relationship isn't imported twice.  neo4apis is for anybody who want to build a gem or even just an adapter in their application which encapsulates the logic of data import from some source.  For examples see the drivers for [Twitter](https://github.com/neo4jrb/neo4apis-twitter) and [GitHub](https://github.com/neo4jrb/neo4apis-github)
 
 In the below example we assume that a variable `awesome_client` is passed in which allows us to make requests to the API.  This may be, for example, provided by another gem.
 
+==To install==
+
+`gem 'neo4apis'` in your Gemfile or `gem install neo4apis`
+
+==To use==
+
 ```ruby
   require 'neo4apis'
 
   module Neo4Apis
     class AwesomeSite < Base
+      # Adds a prefix to labels so that they become AwesomeSiteUser and AwesomeSiteWidget (optional)
+      prefix :AwesomeSite
+
+      # Number of queries which are built up until batch request to DB is made (optional, default = 500)
+      batch_size 2000
+
       uuid :User, :id
       uuid :Widget, :uuid
 

data/lib/neo4apis/base.rb

@@ -5,11 +5,12 @@ module Neo4Apis
     UUID_FIELDS = {}
     NODE_PROXIES = {}
     IMPORTERS = {}
+    DEFAULT_BATCH_SIZE = 500
 
     attr_reader :options
 
     def initialize(neo4j_session, options = {})
-      @buffer = QueryBuffer.new(neo4j_session, options[:flush_size] || self.class.default_flush_size)
+      @buffer = QueryBuffer.new(neo4j_session, options[:batch_size] || self.class.batch_size || DEFAULT_BATCH_SIZE)
       @options = options
 
       UUID_FIELDS.each do |label, uuid_field|
@@ -100,8 +101,14 @@ module Neo4Apis
       end
     end
 
-    def self.default_flush_size
-      500
+    def self.batch_size(batch_size = nil)
+      if batch_size.is_a?(Integer)
+        @batch_size = batch_size
+      elsif batch_size.nil?
+        @batch_size
+      else
+        raise ArgumentError, "Invalid value for batch_size: #{batch_size.inspect}"
+      end
     end
 
     private

data/neo4apis.gemspec

@@ -3,7 +3,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name     = "neo4apis"
-  s.version  = '0.1.0'
+  s.version  = '0.2.0'
   s.required_ruby_version = ">= 1.9.1"
 
   s.authors  = "Brian Underwood"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4apis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brian Underwood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday