orientdb_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b21ad9036b5e5873f1f51dc9508dd386bddd7b0
-  data.tar.gz: 503d006feb63fd5d7ff3ab7994af1e5d86839fed
+  metadata.gz: 34b02fe8fb6024627b8f8b7da8b29740018eef44
+  data.tar.gz: 293559a446780800aa63e846cad714eef7e24d31
 SHA512:
-  metadata.gz: 9eb18afed7dd6191124107a6919df244536c4468e11a599690134f43f150470c20a8d078f3aea3db7131b8c165608cda500fd1a8104182d5385ba6b962480e98
-  data.tar.gz: 252f573b2958cb4ffcbae1b7a71f0cb115d8e5f78e5748c563f5b9d1a41700c30f2629a7f1da8d51e7849b99c0df4bffd397cd37c453b53c15a9d2ab7737e509
+  metadata.gz: 8b2d8dcbdd22d90bd872b182694d410bba586205cb99216f0e89d50cdcd7925d6e963986b1f9d904fd023c894784c941b70ed3080faf2acadd3b759a801e21f1
+  data.tar.gz: 88e1a49b4dd43aef5caee889180f3cd8f1ab6ceec199ea47dfdac42e3fee82c887dbe7ba4ff5457316b011bc176cf5e2cc5f2c624266b950f5a8538beffba931

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.byebug_history

data/.travis.yml

@@ -1,4 +1,11 @@
 language: ruby
 rvm:
-  - 2.2.3
+  - 2.1
+  - 2.2
 script: bundle exec rspec --tag ~'type:integration'
+matrix:
+  include:
+    - rvm: 2.2
+      gemfile: Gemfiles/Gemfile.as3.2
+    - rvm: 2.2
+      gemfile: Gemfiles/Gemfile.as4.0

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## Master
+
+## 0.0.3
+
+* Added `CHANGELOG.md`
+* Breaking change: Swapped logging to use ActiveSupport::Notifications (#16). You will need to 
+update any code that assigns `MyClient::logger = `. Requests and response processing are
+both instrumented.
+
+## 0.0.2
+
+* Integrated Travic CI (#15).
+* Add handling more Orientdb errors (#14).
+
+## 0.0.1
+
+* Initial release.

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in orientdb_client.gemspec
 gemspec
 
+gem 'activesupport', '> 3.2', require: false
+
 group :test do
   gem 'curb', '~> 0.8'
 end

data/Gemfiles/Gemfile.as3.2

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 3.2', require: false
+
+group :test do
+  gem 'curb', '~> 0.8'
+end
+
+gemspec :path => "../"

data/Gemfiles/Gemfile.as4.0

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 4.0', require: false
+
+group :test do
+  gem 'curb', '~> 0.8'
+end
+
+gemspec :path => "../"

data/README.md

@@ -44,20 +44,39 @@ my_client.query('select * from V')
 # create database
 my_client.create_database('new_db', 'plocal', 'graph')
 
-# use a different logger
-class MyLogger
-  def info(message)
-    puts "my message: #{message}"
-  end
-end
-Orientdb::logger = MyLogger.new
-
 # use a different HttpAdapter
 require 'orientdb_client'
 require 'orientdb_client/http_adapters/curb_adapter'
 client = OrientdbClient.client(adapter: 'CurbAdapter')
 ```
 
+## Logging/instrumentation
+
+OrientdbClient does no logging by default, but will use ActiveSupport::Notifications
+if you `require 'orientdb_client/instrumentation/log_subscriber'`.
+
+If you are using Rails, this should *just work*.
+
+If you aren't, you'll need to manually specify the logger, like so:
+
+
+```ruby
+# activesupport version 3
+OrientdbClient::Instrumentation::LogSubscriber.logger = Logger.new(STDOUT)
+
+# activesupport version 4
+ActiveSupport::LogSubscriber.logger = Logger.new(STDOUT)
+```
+
+The right-hand side of the assignment here can be an instance of whatever
+logger class you want.
+
+The following events are instrumented:
+
+* `request.orientdb_client`: most of this is corresponds to time spent in HTTP
+* `process_response.orientdb_client`: most of this will correspond to JSON parsing
+and error response code/message handling.
+
 ## HTTP Adapters
 
 OrientdbClient currently supports Typhoeus and Curb HTTP adapters.

data/lib/orientdb_client/instrumentation/log_subscriber.rb

@@ -0,0 +1,22 @@
+require 'active_support/notifications'
+require 'active_support/log_subscriber'
+
+module OrientdbClient
+  module Instrumentation
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      def request(event)
+        return unless logger.debug?
+
+        method = event.payload[:method]
+        response_code = event.payload[:response_code]
+        url = event.payload[:url]
+        request = "#{method} #{url}: #{response_code}"
+
+        name = '%s (%.1fms)' % ["OrientdbClient request", event.duration]
+        debug "  #{color(name, YELLOW, true)}  [ #{request} ]"
+      end
+    end
+  end
+end
+
+OrientdbClient::Instrumentation::LogSubscriber.attach_to :orientdb_client

data/lib/orientdb_client/instrumenters/memory.rb

@@ -0,0 +1,26 @@
+module OrientdbClient
+  module Instrumenters
+    # Instrumentor that is useful for tests as it stores each of the events that
+    # are instrumented.
+    class Memory
+      Event = Struct.new(:name, :payload, :result)
+
+      attr_reader :events
+
+      def initialize
+        @events = []
+      end
+
+      def instrument(name, payload = {})
+        result = if block_given?
+          yield payload
+        else
+          nil
+        end
+
+        @events << Event.new(name, payload, result)
+        result
+      end
+    end
+  end
+end

data/lib/orientdb_client/instrumenters/noop.rb

@@ -0,0 +1,9 @@
+module OrientdbClient
+  module Instrumenters
+    class Noop
+      def self.instrument(name, payload = {})
+        yield payload if block_given?
+      end
+    end
+  end
+end

data/lib/orientdb_client/version.rb

@@ -1,3 +1,3 @@
 module OrientdbClient
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/orientdb_client.rb

@@ -1,13 +1,13 @@
+require 'forwardable'
 require "orientdb_client/version"
 require "orientdb_client/errors"
 require "orientdb_client/http_adapters"
 require "orientdb_client/http_adapters/typhoeus_adapter"
 require "orientdb_client/class_configurator"
+require "orientdb_client/instrumenters/noop"
 
 require 'oj'
 require 'cgi'
-require 'logger'
-require 'rainbow'
 
 module OrientdbClient
   class << self
@@ -20,7 +20,8 @@ module OrientdbClient
 
   class Client
     attr_reader :http_client
-    attr_accessor :logger
+    extend Forwardable
+    def_delegators :@instrumenter, :instrument
 
     def initialize(options)
       options = {
@@ -34,10 +35,10 @@ module OrientdbClient
                       else
                         HttpAdapters::TyphoeusAdapter
                       end
+      @instrumenter = options[:instrumenter] || Instrumenters::Noop
       @http_client = adapter_klass.new
       @node = Node.new(host: @host, port: @port, http_client: @http_client, client: self)
       @connected = false
-      @logger = Logger.new(STDOUT)
       self
     end
 
@@ -251,12 +252,17 @@ module OrientdbClient
 
     def request(method, path, options = {})
       url = build_url(path)
-      t1 = Time.now
-      response = @http_client.request(method, url, options)
-      time = Time.now - t1
-      r = handle_response(response)
-      info("request (#{time}), #{response.response_code}: #{method} #{url}")
-      r
+      request_instrumentation_hash = {method: method, url: url, options: options}
+      raw_response = safe_instrument('request.orientdb_client', request_instrumentation_hash) do |payload|
+        response = @http_client.request(method, url, options)
+        payload[:response_code] = response.response_code
+        response
+      end
+      response_instrumentation_hash = request_instrumentation_hash.merge(response_code: raw_response.response_code)
+      processed_response = safe_instrument('process_response.orientdb_client', response_instrumentation_hash) do |payload|
+        handle_response(raw_response)
+      end
+      processed_response
     end
 
     def build_url(path)
@@ -381,10 +387,19 @@ module OrientdbClient
       end
     end
 
-    def info(message)
-      wrapped_message = "#{Rainbow('OrientdbClient:').yellow} #{message}"
-      @client.logger.info(wrapped_message)
+    # Ensures instrumentation will complete even if exception is raised.
+    def safe_instrument(event_name, args)
+      err = nil
+      result = @client.instrument(event_name, args) do |payload|
+        begin
+          yield payload
+        rescue => e
+          payload[:error] = e.class.to_s
+          err = e
+        end
+      end
+      raise err if err
+      result
     end
-
   end
 end

data/orientdb_client.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "typhoeus", "~> 0.6"
   spec.add_dependency "oj", "~> 2.0"
-  spec.add_dependency "rainbow", "> 1.99"
 
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"

data/spec/integration/orientdb_client/instrumentation/log_subscriber_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'logger'
+require 'stringio'
+require 'orientdb_client/instrumentation/log_subscriber'
+
+# Only required for testing purposes, no difference in public API that impacts
+# actual libraryr code. Rails 4 changes `.logger=` from a `class_attribute` to a
+# `attr_writer` which affects inheritabiltiy.
+begin
+  require 'active_support/gem_version'
+  version = ActiveSupport::VERSION::MAJOR
+rescue LoadError
+  version = 3
+end
+
+RSpec.describe OrientdbClient::Instrumentation::LogSubscriber do
+  let(:client) { OrientdbClient.client instrumenter: ActiveSupport::Notifications }
+
+  before do
+    @io = StringIO.new
+    if version == 3
+      OrientdbClient::Instrumentation::LogSubscriber.logger = Logger.new(@io)
+    else
+      ActiveSupport::LogSubscriber.logger = Logger.new(@io)
+    end
+  end
+
+  after do
+    if version == 3
+      OrientdbClient::Instrumentation::LogSubscriber.logger = nil
+    else
+      ActiveSupport::LogSubscriber.logger = nil
+    end
+  end
+
+  let(:regex) { Regexp.new('get http://localhost:2480/listDatabases') }
+
+  it "works" do
+    begin
+      client.list_databases
+    rescue
+    end
+    log = @io.string
+    expect(log).to match(regex)
+  end
+
+  it "works through exceptions" do
+    allow_any_instance_of(OrientdbClient::HttpAdapters::TyphoeusAdapter).to receive(:request) { raise 'err' }
+    begin
+      client.list_databases
+    rescue
+    end
+    log = @io.string
+    expect(log).to match(regex)
+  end
+end

data/spec/orientdb_client_spec.rb

@@ -1,11 +1,8 @@
 require 'spec_helper'
+require 'orientdb_client/instrumenters/memory'
 
 RSpec.describe OrientdbClient do
-  let(:client) do
-    c = OrientdbClient.client
-    c.logger.level = Logger::ERROR
-    c
-  end
+  let(:client) { OrientdbClient.client }
   let(:username) { OrientdbClient::Test::Username }
   let(:valid_username) { OrientdbClient::Test::Username }
   let(:password) { OrientdbClient::Test::Password }
@@ -680,16 +677,69 @@ RSpec.describe OrientdbClient do
       end
     end
 
+    describe 'instrumentation' do
+      let(:memory_instrumenter) { OrientdbClient::Instrumenters::Memory.new }
+      let(:client) { OrientdbClient.client(instrumenter: memory_instrumenter) }
+
+      before do
+        client.connect(username: username, password: password, db: db)
+      end
+
+      it 'instruments requests' do
+        client.list_databases
+        request_events = memory_instrumenter.events.select {|e| e.name == 'request.orientdb_client' }
+        expect(request_events.size).to eq(2)
+
+        connect_request_event = request_events.first
+        expect(connect_request_event.payload[:url]).to match(/connect/)
+        expect(connect_request_event.payload[:response_code]).to eq(204)
+
+        list_event = request_events.last
+        expect(list_event.payload[:url]).to match(/listDatabases/)
+        expect(list_event.payload[:response_code]).to eq(200)
+      end
+
+      it 'works when the request fails' do
+        allow(client.http_client).to receive(:request).and_call_original
+        allow(client.http_client).to receive(:request).with(:get, "http://localhost:2480/class/orientdb_client_rb_test/OUser", anything) { raise 'err' }
+
+        begin
+          client.get_class('OUser')
+        rescue
+        ensure
+          expect(memory_instrumenter.events.last.payload[:error]).to eq('RuntimeError')
+        end
+      end
+
+      it 'instruments response handling' do
+        client.list_databases
+        response_events = memory_instrumenter.events.select {|e| e.name == 'process_response.orientdb_client' }
+        expect(response_events.size).to eq(2)
+
+        connect_response_event = response_events.first
+        expect(connect_response_event.payload[:url]).to match(/connect/)
+        expect(connect_response_event.payload[:response_code]).to eq(204)
+
+        list_response_event = response_events.last
+        expect(list_response_event.payload[:url]).to match(/listDatabases/)
+        expect(list_response_event.payload[:response_code]).to eq(200)
+      end
+
+      it 'works when the response handling fails' do
+        begin
+          client.command('insert into OUser CONTENT ' + Oj.dump({a:1}))
+        rescue
+        ensure
+          expect(memory_instrumenter.events.last.payload[:error]).to eq('OrientdbClient::SerializationException')
+        end
+      end
+    end
   end
 
   # These specs will sometimes fail, not too much we can do about that, depends
   # on timing/threading in ruby and odb
   describe 'mvcc handling', type: :integration do
-    let(:client) do
-      c = OrientdbClient.client
-      c.logger.level = Logger::ERROR
-      c
-    end
+    let(:client) { OrientdbClient.client }
     before do
       client.connect(username: username, password: password, db: db)
       if client.has_class?('Person')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orientdb_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Luke Rodgers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rainbow
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '1.99'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '1.99'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +133,10 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfiles/Gemfile.as3.2
+- Gemfiles/Gemfile.as4.0
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -157,10 +146,14 @@ files:
 - lib/orientdb_client/http_adapters.rb
 - lib/orientdb_client/http_adapters/curb_adapter.rb
 - lib/orientdb_client/http_adapters/typhoeus_adapter.rb
+- lib/orientdb_client/instrumentation/log_subscriber.rb
+- lib/orientdb_client/instrumenters/memory.rb
+- lib/orientdb_client/instrumenters/noop.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/spec_helper.rb
 - spec/support/shared_examples_for_http_adapter.rb
@@ -191,8 +184,8 @@ specification_version: 4
 summary: Orientdb ruby client
 test_files:
 - spec/curb_adapter_spec.rb
+- spec/integration/orientdb_client/instrumentation/log_subscriber_spec.rb
 - spec/orientdb_client_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples_for_http_adapter.rb
 - spec/typhoeus_adapter_spec.rb
-has_rdoc: