grumlin 1.0.0.rc7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf656a485be79f0ce06a1a091d3fb5421712ef05251150ff02ff5d12d867c777
-  data.tar.gz: 4ad9b95cfc61a9c41cdd0cb43ddd7ecc6686a1797a1162709b1c86cf512fb820
+  metadata.gz: 3d77c67f0dc99de145a48c9699f83c02c7f1689011c20a4fce35003ee0c3eb1a
+  data.tar.gz: beb9f37e27a057dad388ec74b5c0280ba1f560ddbf6d23251e5c8de997050692
 SHA512:
-  metadata.gz: '091041ce7819097c45dbf14c8ed50a3dc620f9a4be929d615934e0f131ed49f1684ecc3bdaf281f77a018c7c4db71e79e8fdb55039f447089e5700f6d5214edb'
-  data.tar.gz: 00067b1313025fb03bbbf336b5a7258a1ce7de33ab4756f697c916ee7610c54c8a8e28b804af2acf4c766a5de9e4e1188ecea13ba4af7a6b96cf34fcad1884f8
+  metadata.gz: 3143048e1834d41ee788f5782aa17f5c7f577de15c71ee82889b02401066632145fa96789a36f1937dcb590a06cbbac6e009fc1034c2d03abf6e93fcb730c685
+  data.tar.gz: 07add684f8f072c807c2b0db71ea9292655cabd40400fb4c2ee36089ea9626fcb7b041b2da44866e811e49b4b2495201c810dbaf067727687b0a5ea41e726171

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grumlin (1.0.0.rc7)
+    grumlin (1.0.0)
       async-pool (~> 0.3.0)
       async-websocket (~> 0.22.0)
       ibsciss-middleware (~> 0.4.0)
@@ -98,7 +98,7 @@ GEM
       protocol-http (~> 0.2)
       protocol-http1 (~> 0.2)
     racc (1.6.0)
-    rack (3.0.0)
+    rack (3.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.0)

data/README.md

@@ -1,6 +1,6 @@
 # Grumlin
 
-[![Ruby](https://github.com/zhulik/grumlin/actions/workflows/main.yml/badge.svg)](https://github.com/zhulik/grumlin/actions/workflows/main.yml)
+[![Ruby](https://github.com/babbel/grumlin/actions/workflows/main.yml/badge.svg)](https://github.com/babbel/grumlin/actions/workflows/main.yml)
 [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
 
@@ -286,6 +286,54 @@ end # commits automatically
 
 Please check out [bin/console](bin/console) for inspiration. A similar trick may be applied to PRY.
 
+Then you need to reference it in your application.rb:
+```ruby
+config.console = MyRailsConsole
+```
+
+#### Testing
+
+Grumlin provides a couple of helpers to simplify testing code written with it.
+
+##### RSpec
+
+Make sure you have [async-rspec](https://github.com/socketry/async-rspec) installed.
+
+`spec_helper.rb` or `rails_helper.rb`:
+```ruby
+require 'async/rspec'
+require require "grumlin/test/rspec"
+...
+config.include_context(Async::RSpec::Reactor) # Runs async reactor
+config.include_context(Grumlin::Test::RSpec::GremlinContext) # Injects `g`, `__` and expressions, makes sure client is closed after every test
+config.include_context(Grumlin::Test::RSpec::DBCleanerContext) # Cleans the database before every test
+...
+```
+
+It is highly recommended to use `Grumlin::Repository` and not trying to use lower level APIs as they are subject to 
+change.
+
+#### Using in a web app
+
+As previously mentioned, `Grumlin` is built on top of the [async stack](https://github.com/socketry/async).
+This basically means you'd either have to use [Falcon](https://github.com/socketry/falcon) as you application server,
+or you'd need to wrap every place where you use `Grumlin` into an `Async` block:
+
+```ruby
+Async do
+  MyGrumlinRepository.some_query
+ensure
+  Grumlin.close
+end
+```
+
+`Falcon` is preferred because it can keep connections to your Gremlin server open between requests. The only downside
+is that `ActiveRecord` currently does not play well with ruby's fiber scheduler so far, and it can block the event loop.
+When using `Falcon` you don't need explicit `Async` blocks.
+
+Currently it's not recommended to use `ActiveRecord` with `Falcon`. If you still need access to a SQL database from your app,
+consider using [socketry/db](https://github.com/socketry/db)
+
 #### Rails console
 
 In order to make it possible to execute gremlin queries from the rails console you need to define
@@ -325,32 +373,13 @@ class Async::RailsConsole
 end
 ```
 
-Then you need to reference it in your application.rb:
-```ruby
-config.console = MyRailsConsole
-```
+#### AWS Neptune
 
-#### Testing
+See [docs/neptune.md](./docs/neptune.md)
 
-Grumlin provides a couple of helpers to simplify testing code written with it.
+#### Sidekiq
 
-##### RSpec
-
-Make sure you have [async-rspec](https://github.com/socketry/async-rspec) installed.
-
-`spec_helper.rb` or `rails_helper.rb`:
-```ruby
-require 'async/rspec'
-require require "grumlin/test/rspec"
-...
-config.include_context(Async::RSpec::Reactor) # Runs async reactor
-config.include_context(Grumlin::Test::RSpec::GremlinContext) # Injects `g`, `__` and expressions, makes sure client is closed after every test
-config.include_context(Grumlin::Test::RSpec::DBCleanerContext) # Cleans the database before every test
-...
-```
-
-It is highly recommended to use `Grumlin::Repository` and not trying to use lower level APIs as they are subject to 
-change.
+See [docs/neptune.md](./docs/sidekiq.md)
 
 ## Development
 
@@ -372,9 +401,9 @@ and run `rake definitions:format`. You don't need to properly sort the lists man
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/zhulik/grumlin. This project is intended to 
+Bug reports and pull requests are welcome on GitHub at https://github.com/babbel/grumlin. This project is intended to 
 be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 
-[code of conduct](https://github.com/zhulik/grumlin/blob/master/CODE_OF_CONDUCT.md).
+[code of conduct](https://github.com/babbel/grumlin/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/docs/neptune.md

@@ -0,0 +1,65 @@
+# AWS Neptune
+
+Using AWS neptune with IAM authentication enabled requires some additional configuration. You'd need
+to provide `Grumlin` with a customized `Grumlin::Client` that is aware of authentication:
+```ruby
+# authenticated_client.rb
+
+class AuthenticatedClient < Grumlin::Client
+  SERVICE = "neptune-db"
+  METHOD = "GET"
+
+  def initialize(url, region:, parent: Async::Task.current)
+    @url = url
+    @region = region
+    super(@url, parent:)
+  end
+
+  def write(*, **)
+    connect unless connected?
+    super
+  end
+
+  private
+
+  def signer
+    @signer ||= Aws::Sigv4::Signer.new(service: SERVICE,
+                                       region: @region,
+                                       credentials_provider:,
+                                       apply_checksum_header: false)
+  end
+
+  def credentials_provider
+    @credentials_provider ||= Aws::CredentialProviderChain.new.resolve
+  end
+
+  def signed_headers
+    signer.sign_request(
+      http_method: METHOD,
+      url: @url
+    ).headers.except("host")
+  end
+
+  # Override
+  def build_transport
+    Grumlin::Transport.new(@url, parent: @parent, headers: signed_headers)
+  end
+end
+```
+
+
+```ruby
+# config/initializers/grumlin.rb
+
+Grumlin.configure do |config|
+  config.url = ENV.fetch("GREMLIN_URL")
+
+  if ENV.fetch("GREMLIN_USE_IAM")
+    config.provider = :neptune if ENV.fetch("NEPTUNE_REGION") != "local"
+
+    config.client_factory = lambda do |url, parent|
+      AuthenticatedClient.new(url, region: ENV.fetch("NEPTUNE_REGION"), parent:)
+    end
+  end
+end
+```

data/docs/sidekiq.md

@@ -0,0 +1,47 @@
+# Sidekiq
+
+Sidekiq does not use event loop, so you'd have to use explicit `Async` blocks:
+
+```ruby
+class MyWorker
+  include Sidekiq::Worker
+
+  def perform
+    Async do
+      MyGrumlinRepository.some_query
+    ensure
+      Grumlin.close
+    end
+  end
+end
+```
+
+As the other option you can use a server middleware:
+
+```ruby
+# async_server_middleware.rb
+
+class AsyncServerMiddleware
+  def call(_worker, _job, _queue)
+    Async do
+      yield
+    ensure
+      Grumlin.close
+    end
+  end
+end
+```
+
+```ruby
+# config/initializers/sidekiq.rb
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add AsyncServerMiddleware
+  end
+
+  config.on(:shutdown) do
+    Grumlin.close
+  end
+end
+```

data/grumlin.gemspec

@@ -14,12 +14,12 @@ Gem::Specification.new do |spec|
     Gremlin graph traversal language DSL and client for Ruby. Suitable and tested with gremlin-server and AWS Neptune.
   DESCRIPTION
 
-  spec.homepage      = "https://github.com/zhulik/grumlin"
+  spec.homepage      = "https://github.com/babbel/grumlin"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/zhulik/grumlin"
+  spec.metadata["source_code_uri"] = "https://github.com/babbel/grumlin"
   spec.metadata["changelog_uri"] = "https://github.com/babbel/grumlin/releases"
   spec.metadata["rubygems_mfa_required"] = "true"
 

data/lib/grumlin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Grumlin
-  VERSION = "1.0.0.rc7"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grumlin
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc7
+  version: 1.0.0
 platform: ruby
 authors:
 - Gleb Sinyavskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-pool
@@ -120,6 +120,8 @@ files:
 - bin/setup
 - doc/middlewares.md
 - docker-compose.yml
+- docs/neptune.md
+- docs/sidekiq.md
 - gremlin_server/Dockerfile
 - gremlin_server/tinkergraph-empty.properties
 - gremlin_server/tinkergraph-gremlin/lib/tinkergraph-gremlin-3.5.3.jar
@@ -196,12 +198,12 @@ files:
 - lib/grumlin/vertex_property.rb
 - lib/grumlin/with_extension.rb
 - lib/tasks/benchmark.rake
-homepage: https://github.com/zhulik/grumlin
+homepage: https://github.com/babbel/grumlin
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/zhulik/grumlin
-  source_code_uri: https://github.com/zhulik/grumlin
+  homepage_uri: https://github.com/babbel/grumlin
+  source_code_uri: https://github.com/babbel/grumlin
   changelog_uri: https://github.com/babbel/grumlin/releases
   rubygems_mfa_required: 'true'
 post_install_message: 
@@ -215,9 +217,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.33
 signing_key: