neo4apis 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30ba847cad3af0957ed3e603dd236b5037c80f20
+  data.tar.gz: eb86312649a77abe55ae3c668b178709cb5ac803
+SHA512:
+  metadata.gz: 1ac9fcb8bbe6b8f1f934df3f81ad6dbeb267fcc502bff457fe3b7a6698963d0de9dff9f51874f1f0125585c1ee62af9975384b3ad3231832ae882d4c5fbfdf7c
+  data.tar.gz: bd4597cad7cf2adf0a6c4dab7e2235e6ce3b7c86b45b30f1e07fa564179fbc0930eda0c6134b67ed30553c64bebce29fd9edc3c9b2d8eee78d1fb8a7b5aa6758

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'neo4j-core', '~> 3.0.0', path: '/Users/brian/github/neo4jrb/neo4j-core'
+
+gem 'twitter'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'rspec'
+end
+

data/README.md

@@ -0,0 +1,73 @@
+
+neo4apis is a ruby gem for building gems which import data into neo4j.  Takes care of batching of queries for better import performance
+
+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.
+
+```ruby
+  require 'neo4apis'
+
+  module Neo4Apis
+    class AwesomeSite < Base
+      PREFIX = 'awesome_site'
+
+      def initialize(neo4j_client, options = {})
+        @client = options[:awesome_client]
+
+        options[:uuids] = (options[:uuids] || {}).merge({
+          User: :id,
+          Widget: :uuid
+        })
+
+        super(neo4j_client, options)
+      end
+
+      def import_widget_search(*args)
+        @client.widget_search(*args).each do |widget|
+          add_widget(widget)
+        end
+      end
+
+      private
+      
+      def add_widget(widget)
+        user_node = add_user(widget.owner)
+
+        # add_node comes from From Neo4Apis::Base
+        node = add_node :Widget, {
+          uuid: widget.uuid,
+          text: widget.text,
+        }
+
+        # add_relationship comes from Neo4Apis::Base
+        add_relationship(:owns, user_node, node)
+
+        node
+      end
+
+      def add_user(user)
+        add_node :User, {
+          id: user.id,
+          username: user.username,
+          name: user.name,
+        }
+      end
+
+    end
+  end
+```
+
+Then somebody else could use your gem in the following manner:
+
+```ruby
+
+neo4j_session = Neo4j::Session.open # From the neo4j-core gem
+awesome_client = Awesome.open # From a theoretical API wrapping gem
+
+neo4apis_awesome = Neo4Apis::AwesomeSite.new(neo4j_session, awesome_client: awesome_client)
+
+neo4apis_awesome.batch do
+  neo4apis_awesome.import_widget_search('cool') # Does a search for 'cool' via the Awesome gem and imports to the neo4j database
+end
+
+```
+

data/lib/neo4apis/base.rb

@@ -0,0 +1,82 @@
+module Neo4Apis
+  class Base
+    DEFAULT_FLUSH_SIZE = 500
+
+    NODE_PROXIES = {}
+
+    def initialize(neo4j_session, options = {})
+      @buffer = QueryBuffer.new(neo4j_session)
+      @flush_size = DEFAULT_FLUSH_SIZE
+      (options[:uuids] || {}).each do |label, uuid_field|
+        NODE_PROXIES[label] = Struct.new(:label, :props) do
+          const_set(:UUID_FIELD, uuid_field)
+
+          def uuid_value
+            raise ArgumentError, "props does not have UUID field `#{uuid_field}` for #{self.inspect}" if not props.has_key?(uuid_field)
+
+            props[uuid_field]
+          end
+
+          def uuid_field
+            self.class::UUID_FIELD
+          end
+        end
+      end
+    end
+
+    def add_node(label, props = {})
+      require_batch
+
+      node_proxy = NODE_PROXIES[label]
+      raise ArgumentError, "No UUID specified for label `#{label}`" if not node_proxy
+
+      node_proxy.new(label, props).tap do |node_proxy|
+        @buffer << create_node_query(node_proxy)
+      end
+    end
+
+    def add_relationship(type, source, target, props = {})
+      raise ArgumentError, "No source specified" if not source
+      raise ArgumentError, "No target specified" if not target
+
+      require_batch
+
+      @buffer << create_relationship_query(type, source, target, props)
+    end
+
+    def batch
+      @in_batch = true
+
+      yield
+
+      @buffer.flush
+    ensure
+      @in_batch = false
+    end
+
+    private
+
+    def create_node_query(node_proxy)
+      Neo4j::Core::Query.new.
+        merge(node: {node_proxy.label => {node_proxy.uuid_field => node_proxy.uuid_value}}).
+        on_create_set(node: node_proxy.props)
+    end
+
+    def create_relationship_query(type, source, target, props)
+      Neo4j::Core::Query.new.
+        match(source: {source.label => {source.uuid_field => source.uuid_value}}).
+        match(target: {target.label => {target.uuid_field => target.uuid_value}}).
+        merge("source-[:#{type}]->target")
+    end
+
+    def add_to_buffer(*args)
+      flush_buffer if buffer.size >= FLUSH_SIZE
+
+      @buffer << args
+    end
+
+    def require_batch
+      raise "Must be in a batch" if not @in_batch
+    end
+  end
+end

data/lib/neo4apis/query_buffer.rb

@@ -0,0 +1,51 @@
+module Neo4Apis
+  class QueryBuffer < Array
+
+    def initialize(neo4j_session)
+      @neo4j_session = neo4j_session
+
+      uri = URI.parse(@neo4j_session.resource_url)
+
+      @faraday_connection = Faraday.new(:url => "#{uri.scheme}://#{uri.host}:#{uri.port}") do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+
+      super()
+    end
+
+    def flush
+      execute
+
+      clear
+    end
+
+
+    private
+
+    def execute
+      puts "request_body_data", request_body_data.inspect
+      @faraday_connection.post do |req|
+        req.url '/db/data/transaction/commit'
+        req.headers['Accept'] = 'application/json; charset=UTF-8'
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['X-Stream'] = 'true'
+        req.body = request_body_data.to_json
+      end
+    end
+
+    def request_body_data
+      {
+        statements: self.map do |query|
+          {
+            statement: query.to_cypher,
+            parameters: query.send(:merge_params)
+          }
+        end
+      }
+    end
+
+  end
+end
+

data/lib/neo4apis/version.rb

@@ -0,0 +1,3 @@
+module Neo4Apis
+  VERSION = '0.0.1'
+end

data/lib/neo4apis.rb

@@ -0,0 +1,6 @@
+require 'neo4j-core'
+
+require 'neo4apis/version'
+
+require 'neo4apis/query_buffer'
+require 'neo4apis/base'

data/neo4apis.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'neo4apis/version'
+
+Gem::Specification.new do |s|
+  s.name     = "neo4apis"
+  s.version  = Neo4Apis::VERSION
+  s.required_ruby_version = ">= 1.9.1"
+
+  s.authors  = "Brian Underwood"
+  s.email    = 'public@brian-underwood.codes'
+  s.homepage = "https://github.com/neo4jrb/neo4apis/"
+  s.summary = "An API to import web API data to neo4j"
+  s.license = 'MIT'
+  s.description = <<-EOF
+A core library for importing data from APIs into neo4j.  Designed to be used with an adapter
+  EOF
+
+  s.require_path = 'lib'
+  s.files = Dir.glob("{bin,lib,config}/**/*") + %w(README.md Gemfile neo4apis.gemspec)
+
+  s.add_dependency('faraday', "~> 0.9.0")
+  s.add_dependency("neo4j-core", "~> 3.0.3")
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: neo4apis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Underwood
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: neo4j-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+description: |
+  A core library for importing data from APIs into neo4j.  Designed to be used with an adapter
+email: public@brian-underwood.codes
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/neo4apis.rb
+- lib/neo4apis/base.rb
+- lib/neo4apis/query_buffer.rb
+- lib/neo4apis/version.rb
+- neo4apis.gemspec
+homepage: https://github.com/neo4jrb/neo4apis/
+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.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An API to import web API data to neo4j
+test_files: []