orientdb_client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34b02fe8fb6024627b8f8b7da8b29740018eef44
-  data.tar.gz: 293559a446780800aa63e846cad714eef7e24d31
+  metadata.gz: 1f790f7d0f994bd626bff6f95c180024a2fbcd7c
+  data.tar.gz: 46f3386fef71ef7736be02b7b92e59254f1d62b2
 SHA512:
-  metadata.gz: 8b2d8dcbdd22d90bd872b182694d410bba586205cb99216f0e89d50cdcd7925d6e963986b1f9d904fd023c894784c941b70ed3080faf2acadd3b759a801e21f1
-  data.tar.gz: 88e1a49b4dd43aef5caee889180f3cd8f1ab6ceec199ea47dfdac42e3fee82c887dbe7ba4ff5457316b011bc176cf5e2cc5f2c624266b950f5a8538beffba931
+  metadata.gz: 7765f03411f6491a02751d05bf2bb0d3c5fa7c744a4c7290775e0fc376c709103d9c2bc4c4cc01a04cd45e766394d02cf3171ebcdff62d44f21ef82c09afa0fd
+  data.tar.gz: 9e42dc627c9e01792cbce92a16e9259efaac17f4ccae3d82220d48783eecf66b593f9bb0ed2f02e869f09fbbae244d7a3995d9c42c43f1af0d0fdfda404fe26c

data/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Master
 
+* Added support for timeouts.
+
 ## 0.0.3
 
 * Added `CHANGELOG.md`

data/README.md

@@ -48,6 +48,9 @@ my_client.create_database('new_db', 'plocal', 'graph')
 require 'orientdb_client'
 require 'orientdb_client/http_adapters/curb_adapter'
 client = OrientdbClient.client(adapter: 'CurbAdapter')
+
+# initialize client with an HTTP request timeout of 30s
+client = OrientdbClient.client(host: 'localhost', timeout: 30)
 ```
 
 ## Logging/instrumentation
@@ -55,7 +58,13 @@ client = OrientdbClient.client(adapter: 'CurbAdapter')
 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 are using Rails, this should *just work*. You will have to initialize your client instance
+with the option `instrumenter: ActiveSupport::Notifications`, e.g.:
+
+
+```ruby
+my_client = OrientdbClient.client(host: 'localhost', instrumenter: ActiveSupport::Notifications)
+```
 
 If you aren't, you'll need to manually specify the logger, like so:
 
@@ -105,10 +114,26 @@ curb       0.060000   0.010000   0.070000 (  0.331764)
 
 Launch pry session with the gem: `rake console`, in pry use `reload!` to reload all gem files.
 
-Run tests: `rake db:test:create` (consult `test.rb` for information on customizing auth credentials via env variables).
-
 Turn on/off rudimentary debug mode with `client.debug = true/false`.
 
+### Running the tests
+
+Currently, we don't run integration tests in CI due to the hackyness of setting running orientdb on Travis, and also because
+some of the integration tests fail non-deterministically (especially the ones involving multiple threads).
+
+To run all the tests:
+
+1. install orientdb locally
+2. if you used a different username or password than `root`, then you'll have to specify those values via environment variables, e.g.:
+
+    ```
+    export ORIENTDB_TEST_USERNAME=your_username
+    export ORIENTDB_TEST_PASSWORD=your_password
+    ```
+
+3. run `bundle exec rake db:test:create` to create the test database
+4. run `bundle exec rspec` to run the tests
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/orientdb_client/fork )

data/lib/orientdb_client.rb

@@ -36,7 +36,7 @@ module OrientdbClient
                         HttpAdapters::TyphoeusAdapter
                       end
       @instrumenter = options[:instrumenter] || Instrumenters::Noop
-      @http_client = adapter_klass.new
+      @http_client = adapter_klass.new(timeout: options[:timeout])
       @node = Node.new(host: @host, port: @port, http_client: @http_client, client: self)
       @connected = false
       self

data/lib/orientdb_client/errors.rb

@@ -20,6 +20,7 @@ module OrientdbClient
   class DistributedRecordLockedException < TransactionException; end
   # Generic DistributedException, generally a more specific error is preferable.
   class DistributedException < ServerError; end
+  class Timeout < ServerError; end
 
   # ClientError: you did something wrong
   class ClientError < OrientdbError; end

data/lib/orientdb_client/http_adapters.rb

@@ -5,10 +5,12 @@ module OrientdbClient
     class Base
       attr_accessor :username, :password
 
-      def initialize
+      def initialize(timeout: nil)
         @username = nil
         @password = nil
         @session_id = nil
+        @timeout = timeout
+        after_initialize
       end
 
       def reset_credentials
@@ -20,6 +22,16 @@ module OrientdbClient
       def request
         raise NotImplementedError
       end
+
+      private
+
+      def timed_out!(method, url)
+        raise OrientdbClient::Timeout, "#{method}: #{url}"
+      end
+
+      def after_initialize
+        # noop, override me as necessary
+      end
     end
   end
 end

data/lib/orientdb_client/http_adapters/curb_adapter.rb

@@ -4,18 +4,19 @@ module OrientdbClient
   module HttpAdapters
     class CurbAdapter < Base
 
-      def initialize
-        super
-        @curl = Curl::Easy.new
-      end
-
       def request(method, url, options = {})
         req = prepare_request(method, url, options)
         run_request(req, method)
         req
+      rescue Curl::Err::TimeoutError
+        timed_out!(method, url)
       end
 
       private
+
+      def after_initialize
+        @curl = Curl::Easy.new
+      end
       
       def prepare_request(method, url, options)
         username = options[:username] || @username
@@ -24,6 +25,9 @@ module OrientdbClient
         @curl.http_auth_types = :basic
         @curl.username = username
         @curl.password = password
+        if timeout = @timeout || options[:timeout]
+          @curl.timeout = timeout
+        end
         @curl
       end
 

data/lib/orientdb_client/http_adapters/typhoeus_adapter.rb

@@ -6,7 +6,12 @@ module OrientdbClient
 
       def request(method, url, options = {})
         req = prepare_request(method, url, options)
-        run_request(req)
+        response = run_request(req)
+        if response.timed_out?
+          timed_out!(method, url)
+        else
+          return response
+        end
       end
 
       private
@@ -16,6 +21,9 @@ module OrientdbClient
           userpwd: authentication_string(options),
           method: method
         }.merge(options)
+        if timeout = @timeout || options[:timeout]
+          options[:timeout] = timeout
+        end
         Typhoeus::Request.new(url, options)
       end
 

data/lib/orientdb_client/test.rb

@@ -1,8 +1,8 @@
 module OrientdbClient
   module Test
     OrientdbClient::Test::DatabaseName = ENV['ORIENTDB_TEST_DATABASENAME'] || 'orientdb_client_rb_test'
-    OrientdbClient::Test::Username = ENV['ORIENTDB_TEST_USERNAME'] || 'test'
-    OrientdbClient::Test::Password = ENV['ORIENTDB_TEST_PASSWORD'] || 'test'
+    OrientdbClient::Test::Username = ENV['ORIENTDB_TEST_USERNAME'] || 'root'
+    OrientdbClient::Test::Password = ENV['ORIENTDB_TEST_PASSWORD'] || 'root'
   end
 end
 

data/lib/orientdb_client/version.rb

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

data/spec/support/shared_examples_for_http_adapter.rb

@@ -20,6 +20,15 @@ RSpec.shared_examples 'http adapter' do
     end
   end
 
+  describe 'timeout handling' do
+    let(:url) { 'http://localhost:2480/listDatabases' }
+
+    it 'raises a Timeout exception' do
+      stub_request(:get, url).to_timeout
+      expect { adapter.request(:get, url) }.to raise_exception(OrientdbClient::Timeout)
+    end
+  end
+
   describe '#request' do
     describe 'GET' do
       let(:url) { 'http://localhost:2480/listDatabases' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orientdb_client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Luke Rodgers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-21 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus