etre-client 0.8.1 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9a9a7c0360d700dabbe48fc8572a362ec8f2eae8
-  data.tar.gz: 73f22ebd75fd9621c33e72fa4fe10be856b368a5
+SHA256:
+  metadata.gz: 4a00b1a3963aabc7289f9c3bc6b5a26ae0c1184aaa068ce44f999fb238b41366
+  data.tar.gz: 0344444b0a5bea0596a3b8ccbcd9031c0b67d0f589508c1633d196785f82f0a7
 SHA512:
-  metadata.gz: f66a61bb2b27da32951328b2bbe2da2f29d7579fee33d780223f7af2a4dfc3ba0de7d38c6bbf7411625086ac4c684e60c72371652f4c8567d59a4da2857b464e
-  data.tar.gz: 7f9e30e3707341914aaad1a1adcaac4290c5a9f7b5572db162831f239ea1d3880dedfd727797481ea048167ed5eb1e0f10589b30567c672d505265397a06c853
+  metadata.gz: 4b19650c25db22a5d501753900441eddca53f0a3322b51a60450e75c173fd9c605cb27b3e31e57841e6f2ea2f50d4c54764ed1950bd5283cf1d58e40f5d4a67f
+  data.tar.gz: 8457352ca44a551d2e2fb62f63ff9d8946d02d8c510aac905a11c23bb6a0d6a605a1512767b68b3fff9481755ee8432a33ec700bea9bdd64f4791d9232ffe7b8

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
   - 2.3
+  - 2.4
+  - 2.5
 script: bundle exec rake spec

data/README.md

@@ -21,7 +21,19 @@ require 'etre-client'
 
 Create a new client
 ```
-e = Etre::Client.new(entity_type: "node", url: "http://127.0.0.1:8080", ssl_cert: nil, ssl_key: nil, ssl_ca: nil, insecure: true)
+# Create a standard client.
+e = Etre::Client.new(entity_type: "node", url: "http://127.0.0.1:8080")
+
+# Create a client with advanced HTTP options. These are passed down to the rest-client within the Etre Client.
+# See https://github.com/rest-client/rest-client#passing-advanced-options for more details.
+options = {
+  :ssl_client_cert => OpenSSL::X509::Certificate.new(File.read("path_to_ssl_cert")),
+  :ssl_client_key  => OpenSSL::PKey::RSA.new(File.read("path_to_ssl_key")),
+  :ssl_ca_file     => "path_to_ssl_ca",
+  :verify_ssl      => OpenSSL::SSL::VERIFY_PEER,
+  :cookies         => {:foo => "bar"},
+}
+e = Etre::Client.new(entity_type: "node", url: "http://127.0.0.1:8080", options: options)
 ```
 
 Insert entities
@@ -90,6 +102,11 @@ Run the tests
 bundle exec rake spec
 ```
 
+Publish a new version of the gem:
+1. Bump the version in lib/etre-client/version.rb
+2. Build the gem with `gem build etre-client.gemspec`
+3. Publish the new gem with `gem push etre-client-#{GEM_VERSION}.gem`
+
 ## License
 
 Copyright (c) 2017 Square Inc. Distributed under the Apache 2.0 License.

data/lib/etre-client/client.rb

@@ -1,4 +1,5 @@
 require 'etre-client/errors'
+require 'logger'
 require 'rest-client'
 require 'json'
 
@@ -10,14 +11,15 @@ module Etre
     META_LABEL_ID = "_id"
     META_LABEL_TYPE = "_type"
 
-    def initialize(entity_type:, url:, ssl_cert: nil, ssl_key: nil, ssl_ca: nil, insecure: true)
+    def initialize(entity_type:, url:, query_timeout: '5s', retry_count: 0, retry_wait: 1, options: {})
       @entity_type = entity_type
       @url = url
+      @query_timeout = query_timeout # http request timeout in seconds
+      @retry_count = retry_count # retry count on network or API error
+      @retry_wait = retry_wait # wait time between retries in seconds
+      @options = options
 
-      @ssl_cert = ssl_cert
-      @ssl_key = ssl_key
-      @ssl_ca = ssl_ca
-      @insecure = insecure
+      @logger = Logger.new(STDOUT)
     end
 
     # query returns an array of entities that satisfy a query.
@@ -240,33 +242,44 @@ module Etre
     private
 
     def etre_get(route)
-      resource_for_route(route).get(
-        get_headers,
-      )
+      rest_retry {
+        resource_for_route(route).get(
+          get_headers,
+        )
+      }
     end
 
     def etre_post(route, params = nil)
-      resource_for_route(route).post(
-        params.to_json,
-        post_headers,
-      )
+      rest_retry {
+        resource_for_route(route).post(
+          params.to_json,
+          post_headers,
+        )
+      }
     end
 
     def etre_put(route, params = nil)
-      resource_for_route(route).put(
-        params.to_json,
-        put_headers,
-      )
+      rest_retry {
+        resource_for_route(route).put(
+          params.to_json,
+          put_headers,
+        )
+      }
     end
 
     def etre_delete(route)
-      resource_for_route(route).delete(
-        delete_headers,
-      )
+      rest_retry {
+        resource_for_route(route).delete(
+          delete_headers,
+        )
+      }
     end
 
     def get_headers
-      {:accept => 'application/json'}
+      {
+          :accept => 'application/json',
+          :x_etre_query_timeout => @query_timeout
+      }
     end
 
     def post_headers
@@ -282,25 +295,30 @@ module Etre
     end
 
     def resource_for_route(route)
-      opts = {}
-      opts.merge!(ssl_options) unless @insecure
       RestClient::Resource.new(
         @url + API_ROOT + route,
-        opts
+        @options
       )
     end
 
-    def ssl_options
-      {
-        :ssl_client_cert => OpenSSL::X509::Certificate.new(File.read(@ssl_cert)),
-        :ssl_client_key  => OpenSSL::PKey::RSA.new(File.read(@ssl_key)),
-        :ssl_ca_file     => @ssl_ca,
-        :verify_ssl      => OpenSSL::SSL::VERIFY_PEER,
-      }
-    end
-
     def parse_response(response)
       JSON.parse(response)
     end
+
+    def rest_retry(&block)
+      retries = 0
+
+      begin
+        yield
+      rescue => e
+        if (retries += 1) <= @retry_count
+          @logger.warn("Error querying etre (#{e}). Sleeping for #{@retry_wait} seconds before trying again (attmept #{retries}/#{@retry_count}).")
+          sleep(@retry_wait)
+          retry
+        else
+          raise
+        end
+      end
+    end
   end
 end

data/lib/etre-client/version.rb

@@ -1,5 +1,5 @@
 module Etre
   class Client
-    VERSION = "0.8.1"
+    VERSION = "0.8.6"
   end
 end

data/spec/client_spec.rb

@@ -2,8 +2,8 @@ require 'etre-client'
 require 'ostruct'
 
 describe Etre::Client do
-  let(:etre_client) { Etre::Client.new(entity_type: "node", url: "http://localhost:3000", insecure: true) }
-  let(:get_headers) { {:accept => "application/json"} }
+  let(:etre_client) { Etre::Client.new(entity_type: "node", url: "http://localhost:3000") }
+  let(:get_headers) { {:accept => "application/json", :x_etre_query_timeout => '5s'} }
   let(:post_headers) { get_headers.merge({:content_type => "application/json"}) }
   let(:put_headers) { post_headers }
   let(:delete_headers) { get_headers }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etre-client
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.6
 platform: ruby
 authors:
 - Michael Finch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -42,22 +42,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - mfinch@squareup.com
 executables: []
@@ -98,7 +98,7 @@ homepage: https://github.com/square/etre-client-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,9 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Client gem for interacting with Etre
 test_files: