orientdb_client 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c427444c46d0f4c5beecc6e0f6bfaf47e094dd6
-  data.tar.gz: d9573d4f5bca08e707fe550d0d5422e7c686b331
+  metadata.gz: f6ff9bea3763a8ec608f82345d72cf055701c520
+  data.tar.gz: f87c97ac3b85eee009e16c28694c5ddbcad9af49
 SHA512:
-  metadata.gz: 05f99c6bf186824a78c8c4817f3562fac61c362110cb93b8d296d20dbc3d7a9867c697aa3559202d3a8c3d03468d50c405bc300b4147c0b2c6d7a08da06d1e9e
-  data.tar.gz: eb0a3d64d9594d05559fcd836c7773573f1a061b05e114b3629fb1d231af979364cfbb481a29968360e1ee4a5c0110b329f91174d9998209ff417ff7b453df86
+  metadata.gz: 4be54bafd6bbab818aa34f4f29b73468e620bd07a5c93bd32dc3e6c92d8d9dcd75b03644dbe4a5649a04544fc494113c35def34dadff55a8f4a3327e5ae215fb
+  data.tar.gz: 4028fbaa72f17074eff9a2588cc9f44a9824e6f0f94eda236984abcc8f55b1ad67c6354f8d91803c6a6d88723e96924b5a5e2d3ab47e25619e86d48ddd760671

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Master
 
+## 0.0.8
+
+* Fix circular argument warning.
+* Add Skylight.io normalizer. b814880
+* Support for OrientDB 2.2. 1ba0c34
+
 ## 0.0.7
 
 * Test ActiveSupport 5 and ruby 2.3.1.

data/Gemfile

@@ -6,4 +6,5 @@ gemspec
 group :test do
   gem 'activesupport', '~> 4.0', require: false
   gem 'curb', '~> 0.8'
+  gem 'skylight', '~> 0.10'
 end

data/Gemfiles/Gemfile.as3.2

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 group :test do
   gem 'curb', '~> 0.8'
   gem 'activesupport', '~> 3.2', require: false
+  gem 'skylight', '~> 0.10'
 end
 
 gemspec :path => "../"

data/Gemfiles/Gemfile.as4.0

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 group :test do
   gem 'curb', '~> 0.8'
   gem 'activesupport', '~> 4.0', require: false
+  gem 'skylight', '~> 0.10'
 end
 
 gemspec :path => "../"

data/Gemfiles/Gemfile.as5.0

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 group :test do
   gem 'curb', '~> 0.8'
   gem 'activesupport', '~> 5.0', require: false
+  gem 'skylight', '~> 0.10'
 end
 
 gemspec :path => "../"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Luke Rodgers
+Copyright (c) 2015-2016 Luke Rodgers
 
 MIT License
 
@@ -20,3 +20,20 @@ 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.
+
+
+## Other Licenses
+
+### Ruby on Rails
+
+Copyright (c) 2005-2016 David Heinemeier Hansson
+
+Released under the MIT License.
+
+Original source at https://github.com/rails/rails.
+
+### Skylight
+
+Copyright (c) 2013-2016 Tilde, Inc.
+
+Original source at https://github.com/skylightio/skylight-ruby

data/README.md

@@ -12,6 +12,7 @@ Goals:
 * fine-grained handling of Orientdb errors, via rich set of ruby exceptions
 
 Tested on:
+* 2.2.10
 * 2.1.10
 * 2.1.9
 * 2.1.5
@@ -91,6 +92,20 @@ The following events are instrumented:
 * `process_response.orientdb_client`: most of this will correspond to JSON parsing
 and error response code/message handling.
 
+### Skylight.io integration
+
+If you use Skylight for application monitoring, you can include an OrientDB normalizer so that Skylight will group
+your OrientDB queries with other db (sql, redis) queries and visually separate them from the rest of your rails code.
+
+The best way I've found to do this is including this in your `config/application.rb`:
+
+```ruby
+config.before_initialize do
+  # This will run before initializers for all railties, which is where Skylight registers its normalizers.
+  require 'orientdb_client/integration/skylight_normalizer'
+end
+```
+
 ## HTTP Adapters
 
 OrientdbClient currently supports Typhoeus and Curb HTTP adapters.

data/lib/orientdb_client.rb

@@ -140,7 +140,7 @@ module OrientdbClient
     attr_reader :database
     attr_writer :debug
 
-    def initialize(host:, port:, http_client: http_client, client: client)
+    def initialize(host:, port:, http_client:, client:)
       @host = host
       @port = port
       @http_client = http_client
@@ -276,6 +276,8 @@ module OrientdbClient
         raise ConnectionError.new("No server at #{@host}:#{@port}", 0, nil)
       when 200, 201, 204
         return response
+      when 400
+        translate_error(response)
       when 401
         raise UnauthorizedError.new('Unauthorized', response.response_code, response.body)
       when 404
@@ -307,8 +309,8 @@ module OrientdbClient
       code = response.response_code
       body = response.body
       case odb_error_class
-      when /OCommandSQLParsingException/
-        raise ClientError.new("#{odb_error_class}: #{odb_error_message}", code, body)
+      when /OCommandSQLParsingException/, "Error parsing query", "Error on parsing command"
+        raise ParsingError.new("#{odb_error_class}: #{odb_error_message}", code, body)
       when /OQueryParsingException/
         raise ClientError.new("#{odb_error_class}: #{odb_error_message}", code, body)
       when /OCommandExecutorNotFoundException/

data/lib/orientdb_client/errors.rb

@@ -28,6 +28,7 @@ module OrientdbClient
   class IllegalArgumentException < ClientError; end
   class CommandExecutionException < ClientError; end
   class SerializationException < ClientError; end
+  class ParsingError < ClientError; end
 
   # ConflictError: you tried to create something that already exists
   class ConflictError < ClientError; end

data/lib/orientdb_client/integration/skylight_normalizer.rb

@@ -0,0 +1,34 @@
+require 'skylight'
+require 'uri'
+
+module Skylight
+  module Normalizers
+    module OrientdbClient
+      class Query < Normalizer
+        register "request.orientdb_client"
+
+        CAT = "db.orientdb.query".freeze
+        QUERY_REGEX = /\/([^\/]+)/
+        SUPPORTED_QUERY_TYPES = ["query".freeze, "command".freeze]
+
+        def normalize(trace, name, payload)
+          url = payload[:url]
+          query_type = nil
+          begin
+            uri = URI.parse(url)
+            match = uri.path.match(QUERY_REGEX)
+            if match
+              query_type = match[1]
+            end
+          rescue URI::Error
+            return :skip
+          end
+
+          return :skip unless SUPPORTED_QUERY_TYPES.include?(query_type)
+
+          [ CAT, "orientdb: #{query_type}", nil ]
+        end
+      end
+    end
+  end
+end

data/lib/orientdb_client/version.rb

@@ -1,3 +1,3 @@
 module OrientdbClient
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/orientdb_client_spec.rb

@@ -206,7 +206,7 @@ RSpec.describe OrientdbClient do
 
         context 'with invalid query' do
           it 'raises ClientError' do
-            expect { client.query('select * crumb') }.to raise_exception(OrientdbClient::ClientError, /OCommandSQLParsingException/)
+            expect { client.query('select * crumb') }.to raise_exception(OrientdbClient::ParsingError)
           end
         end
         
@@ -255,7 +255,7 @@ RSpec.describe OrientdbClient do
 
         context 'with invalid query' do
           it 'returns result' do
-            expect { client.command('select * crumb') }.to raise_exception(OrientdbClient::ClientError, /OCommandSQLParsingException/)
+            expect { client.command('select * crumb') }.to raise_exception(OrientdbClient::ParsingError)
           end
         end
       end
@@ -511,7 +511,7 @@ RSpec.describe OrientdbClient do
         it 'raises exception on creation of classes that extend nothing' do
           expect do
             client.create_class(class_name, extends: 'VJk')
-          end.to raise_exception(OrientdbClient::ClientError, /OCommandSQLParsingException/)
+          end.to raise_exception(OrientdbClient::ParsingError)
         end
 
         describe 'with block' do

data/spec/skylight_normalizer_spec.rb

@@ -0,0 +1,84 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'orientdb_client/integration/skylight_normalizer'
+
+RSpec.describe Skylight::Normalizers::OrientdbClient::Query do
+
+  let(:n) { Skylight::Normalizers::OrientdbClient::Query.new({}) }
+  let(:name) { 'odb_query' }
+
+  it 'normalizes a graph query' do
+    name, title, desc = n.normalize(trace, name, url: 'http://localhost:2480/query/graphdb/sql/select+%2A+from+Post+order+by+%40rid+desc+limit+1')
+    expect(name).to eql('db.orientdb.query')
+    expect(title).to eql('orientdb: query')
+    expect(desc).to be_nil
+  end
+
+  it 'normalizes a graph query without a title' do
+    name, title, desc = n.normalize(trace, nil, url: 'http://localhost:2480/query/graphdb/sql/select+%2A+from+Post+order+by+%40rid+desc+limit+1')
+    expect(name).to eql('db.orientdb.query')
+    expect(title).to eql('orientdb: query')
+    expect(desc).to be_nil
+  end
+
+  it 'normalizes a graph query with multibyte characaters' do
+    name, title, desc = n.normalize(trace, nil, url: 'http://localhost:2480/query/graphdb/sql/select+%2A+from+Post+where+name+%3D+%22%F0%9D%92%9C+FROM+z%C3%B8mg+%C3%A5%22')
+    expect(name).to eql('db.orientdb.query')
+    expect(title).to eql('orientdb: query')
+    expect(desc).to be_nil
+  end
+
+  it 'normalizes a graph update with JSON in URL' do
+    name, title, desc = n.normalize(trace, name, url: 'http://localhost:2480/command/graphdb/sql/update+%2311%3A2+set+category_list%3D%5B%22sports%22%2C+%22gaming%22%2C+%22music%22%5D')
+    expect(name).to eql('db.orientdb.query')
+    expect(title).to eql('orientdb: command')
+    expect(desc).to be_nil
+  end
+
+  it 'normalizes property creation commands' do
+    name, title, desc = n.normalize(trace, name, url: 'http://localhost:2480/command/graphdb/sql/CREATE+PROPERTY+Post.id+string')
+    expect(name).to eql('db.orientdb.query')
+    expect(title).to eql('orientdb: command')
+    expect(desc).to be_nil
+  end
+
+  it 'normalizes property alter commands' do
+    name, title, desc = n.normalize(trace, name, url: 'http://localhost:2480/command/graphdb/sql/ALTER+PROPERTY+Post.exists+type+integer')
+    expect(name).to eql('db.orientdb.query')
+    expect(title).to eql('orientdb: command')
+    expect(desc).to be_nil
+  end
+
+  it 'normalizes class creation commands' do
+    name, title, desc = n.normalize(trace, name, url: 'http://localhost:2480/command/graphdb/sql/CREATE+CLASS+Post')
+    expect(name).to eql('db.orientdb.query')
+    expect(title).to eql('orientdb: command')
+    expect(desc).to be_nil
+  end
+
+  it 'skips connect queries' do
+    name, * = n.normalize(trace, name, url: 'http://localhost:2480/connect/graphdb')
+    expect(name).to eql(:skip)
+  end
+
+  it 'skips disconnect queries' do
+    name, * = n.normalize(trace, name, url: 'http://localhost:2480/disconnect')
+    expect(name).to eql(:skip)
+  end
+
+  it 'skips listDatabase queries' do
+    name, * = n.normalize(trace, name, url: 'http://localhost:2480/listDatabases')
+    expect(name).to eql(:skip)
+  end
+
+  it 'skips database creation' do
+    name, * = n.normalize(trace, name, url: 'http://localhost:2480/database/foobaz/plocal/graph')
+    expect(name).to eql(:skip)
+  end
+
+  it 'skips unknown queries' do
+    name, * = n.normalize(trace, name, url: 'http://localhost:2480/cluster/unknownop?x=y')
+    expect(name).to eql(:skip)
+  end
+end

data/spec/spec_helper.rb

@@ -39,6 +39,11 @@ ensure
   end
 end
 
+# Require support files
+Dir[File.expand_path('../support/*.rb', __FILE__)].each do |f|
+  require "support/#{File.basename(f, ".rb")}"
+end
+
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
@@ -68,6 +73,8 @@ RSpec.configure do |config|
   config.order = :random
   Kernel.srand config.seed
 
+  config.include SpecHelper
+
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin

data/spec/support/skylight_tracing.rb

@@ -0,0 +1,15 @@
+# From Skylight spec/support/tracing.rb
+
+module SpecHelper
+  class MockTrace
+    attr_accessor :endpoint
+
+    def initialize
+      @endpoint = "Rack"
+    end
+  end
+
+  def trace
+    @trace ||= MockTrace.new
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orientdb_client
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Luke Rodgers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -150,14 +150,17 @@ files:
 - lib/orientdb_client/instrumentation/log_subscriber.rb
 - lib/orientdb_client/instrumenters/memory.rb
 - lib/orientdb_client/instrumenters/noop.rb
+- lib/orientdb_client/integration/skylight_normalizer.rb
 - lib/orientdb_client/test.rb
 - lib/orientdb_client/version.rb
 - orientdb_client.gemspec
 - spec/curb_adapter_spec.rb
 - spec/integration/orientdb_client/instrumentation/log_subscriber_spec.rb
 - spec/orientdb_client_spec.rb
+- spec/skylight_normalizer_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples_for_http_adapter.rb
+- spec/support/skylight_tracing.rb
 - spec/typhoeus_adapter_spec.rb
 homepage: https://github.com/lukeasrodgers/orientdb_client
 licenses:
@@ -187,6 +190,8 @@ test_files:
 - spec/curb_adapter_spec.rb
 - spec/integration/orientdb_client/instrumentation/log_subscriber_spec.rb
 - spec/orientdb_client_spec.rb
+- spec/skylight_normalizer_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples_for_http_adapter.rb
+- spec/support/skylight_tracing.rb
 - spec/typhoeus_adapter_spec.rb