etre-client 0.8.0 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d7ee88bbc4eaef62c80b7fe886975cc09f6fe3fa
-  data.tar.gz: 474060e882a53a6274772f2b21854651295d43f5
+SHA256:
+  metadata.gz: 7bb4311536146ce0c48e5a7c29ebdaac1b5280774c9b82b7f93e7be0bde54802
+  data.tar.gz: a991b597c0a26848422e358dd7ac1d949d61b4edd4e8b0b2d0590db66115d63c
 SHA512:
-  metadata.gz: 5e3ec873dbc34c866833116196fce1b87a463a9f45360786bb48e6afb5c306bc1d7911a3c1d944736e81dee8dba6679793bf31afbeb63a2ad406b91930ea49d9
-  data.tar.gz: b993c6f228ac3bc21f941d4a2cbd2b86eb0f43058a8e3e9a27da4082555507668312bcf446a257ce7eb0b9d1b19bb8cdbbd2fa3fee9fadbd19c38fef80e0413d
+  metadata.gz: 901d1d3f2e8692c6ccea5dea15a2f3e60fbcc86105c25124725369a14b68f57192e18a211b254d913afd6e9973f5286a7413be3dd50f40541e5074a8689336c7
+  data.tar.gz: 3cd429236b2b6dc3d79ef504cc3e637ba18681f7ff1966513f1ee25a970bd492b37adbc55cbead4d569d551d06a48f71d523c58bb3870f691b1ac877c2f32497

data/.gitignore

@@ -1,2 +1 @@
-# ignore gems
 *.gem

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+Change Log
+==========
+
+Version 0.8.0 *(2017-10-31)*
+----------------------------
+
+Initial alpha release of etre-client.

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+Contributing
+============
+
+If you would like to contribute code to this project you can do so through GitHub by
+forking the repository and sending a pull request.
+
+When submitting code, please make every effort to follow existing conventions
+and style in order to keep the code as readable as possible. Please also make
+sure your code compiles by running `mvn clean verify`. Checkstyle failures
+during compilation indicate errors in your style and can be viewed in the
+`checkstyle-result.xml` file.
+
+Before your code can be accepted into the project you must also sign the
+[Individual Contributor License Agreement (CLA)][1].
+
+
+ [1]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2017 Square, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,27 +1,53 @@
+![Build Status](https://travis-ci.org/square/etre-client-ruby.svg?branch=master)
+
 Description
 ------
-etre-client is a gem that can be used to interact with an [Etre](https://github.com/square/etre) instance.
+etre-client is a client gem for [Etre](https://github.com/square/etre).
 
 Installation
 ------
 etre-client is hosted on rubygems.org. To install it
 1. Add "etre-client" to your Gemfile
-2. Run "bunndle install"
+2. Run "bundle install"
 
 Alternatively, you can just "gem install etre-client".
 
 Usage
 ------
+Require the gem
+```
+require 'etre-client'
+```
+
 Create a new client
 ```
+# 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
 ```
-entities = [{"foo" => "bar"}, {"foo" => "abc"}]
+entities = [{"foo" => "bar"}, {"foo" => "abc"}, {"l1" => "a", "l2" => "b"}]
 e.insert(entities)
-=> [{"id"=>"59f90caadd1b176f02eddcd8", "uri"=>"127.0.0.1:8080/api/v1/entity/59f90caadd1b176f02eddcd8"}, {"id"=>"59f90caadd1b176f02eddcda", "uri"=>"127.0.0.1:8080/api/v1/entity/59f90caadd1b176f02eddcda"}]
+=> [{"id"=>"59f90caadd1b176f02eddcd8", "uri"=>"127.0.0.1:8080/api/v1/entity/59f90caadd1b176f02eddcd8"}, {"id"=>"59f90caadd1b176f02eddcda", "uri"=>"127.0.0.1:8080/api/v1/entity/59f90caadd1b176f02eddcda"}, {"id"=>"59f90e3fdd1b176f02eddce5", "uri"=>"127.0.0.1:8080/api/v1/entity/59f90e3fdd1b176f02eddce5"}]
+```
+
+Read entities
+```
+query = "foo=bar"
+e.query(query)
+=> [{"_id"=>"59f90caadd1b176f02eddcd8", "_rev"=>0, "_type"=>"node", "foo"=>"bar"}]
 ```
 
 Update entities
@@ -35,30 +61,38 @@ e.update(query, patch)
 Update a single entity
 ```
 id = "59f90caadd1b176f02eddcda"
-patch = {"foo" => "newbar"}
+patch = {"foo" => "slug"}
 e.update_one(id, patch)
-
 => {"id"=>"59f90caadd1b176f02eddcda", "uri"=>"127.0.0.1:8080/api/v1/entity/59f90caadd1b176f02eddcda", "diff"=>{"_id"=>"59f90caadd1b176f02eddcda", "_rev"=>0, "_type"=>"node", "foo"=>"abc"}}
 ```
 
 Delete entities
 ```
-query = "foo=bar"
+query = "foo=slug"
 e.delete(query)
+=> [{"id"=>"59f90caadd1b176f02eddcda", "uri"=>"127.0.0.1:8080/api/v1/entity/59f90caadd1b176f02eddcda", "diff"=>{"_id"=>"59f90caadd1b176f02eddcda", "_rev"=>1, "_type"=>"node", "foo"=>"slug"}}]
 ```
 
 Delete a single entity
 ```
-id = "abc"
+id = "59f90caadd1b176f02eddcd8"
 e.delete_one(id)
-=> {"_id" => "abc", "foo" => "bar"}
+=> {"id"=>"59f90caadd1b176f02eddcd8", "uri"=>"127.0.0.1:8080/api/v1/entity/59f90caadd1b176f02eddcd8", "diff"=>{"_id"=>"59f90caadd1b176f02eddcd8", "_rev"=>1, "_type"=>"node", "foo"=>"newbar"}}
 ```
 
 List the labels for an entity
 ```
-id = "abc"
+id = "59f90e3fdd1b176f02eddce5"
 e.labels(id)
-=> ["foo"]
+=> ["f1", "f2"]
+```
+
+Delete the label on an entity
+```
+id = "59f90e3fdd1b176f02eddce5"
+label = "l1"
+e.delete_label(id)
+=> {"id"=>"59f90e3fdd1b176f02eddce5", "uri"=>"127.0.0.1:8080/api/v1/entity/59f90e3fdd1b176f02eddce5", "diff"=>{"_id"=>"59f90e3fdd1b176f02eddce5", "_rev"=>0, "_type"=>"node", "l1"=>"a", "l2"=>"b"}}
 ```
 
 Development
@@ -68,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/etre-client.gemspec

@@ -6,7 +6,6 @@ require 'etre-client/version'
 Gem::Specification.new do |spec|
   spec.name          = 'etre-client'
   spec.version       = Etre::Client::VERSION
-  spec.version       = '0.8.0'
   spec.license       = 'Apache-2.0'
   spec.authors       = ['Michael Finch']
   spec.email         = ['mfinch@squareup.com']

data/lib/etre-client.rb

@@ -1,264 +1,2 @@
+require 'etre-client/client'
 require 'etre-client/errors'
-require 'rest-client'
-require 'json'
-
-module Etre
-  class Client
-    attr_reader :entity_type, :url
-
-    API_ROOT = "/api/v1"
-    META_LABEL_ID = "_id"
-    META_LABEL_TYPE = "_type"
-
-    def initialize(entity_type:, url:, ssl_cert: nil, ssl_key: nil, ssl_ca: nil, insecure: true)
-      @entity_type = entity_type
-      @url = url
-
-      @ssl_cert = ssl_cert
-      @ssl_key = ssl_key
-      @ssl_ca = ssl_ca
-      @insecure = insecure
-    end
-
-    # query returns an array of entities that satisfy a query.
-    def query(query, filter = nil)
-      if query.nil? || query.empty?
-        raise QueryNotProvided
-      end
-
-      # @todo: translate filter to query params
-
-      # Do the normal GET /entities?query unless the query is ~2k characters
-      # becuase that brings the entire URL length close to the max supported
-      # limit across most HTTP servers. In that case, switch to alternate
-      # endpoint to POST the long query.
-      if query.length < 2000
-        # Always escape the query.
-        query = CGI::escape(query)
-
-        resp = etre_get("/entities/#{@entity_type}?query=#{query}")
-      else
-        # DO NOT ESCAPE THE QUERY! It's not sent via URL, so no escaping needed.
-        resp = etre_post("/query/#{@entity_type}", query)
-      end
-
-      if resp.code != 200
-        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
-      end
-
-      return JSON.parse(resp.body)
-    end
-
-    # insert inserts an array of entities.
-    def insert(entities)
-      if entities.nil? || !entities.any?
-        raise EntityNotProvided
-      end
-
-      entities.each do |e|
-        if e.key?(META_LABEL_ID)
-          raise EntityIdSet, "entity: #{e}"
-        end
-
-        if e.key?(META_LABEL_TYPE) && e[META_LABEL_TYPE] != @entity_type
-          raise EntityTypeMismatch, "only valid type is '#{@entity_type}', but " +
-            "entity has type '#{e[META_LABEL_TYPE]}'"
-        end
-      end
-
-      resp = etre_post("/entities/#{@entity_type}", entities)
-      if ![200, 201].include?(resp.code)
-        raise UnexpectedResponseCode, "expected 200 or 201, got #{resp.code}"
-      end
-
-      return JSON.parse(resp.body)
-    end
-
-    # update updates entities with the given patch that satisfy the given query.
-    def update(query, patch)
-      if query.nil? || query.empty?
-        raise QueryNotProvided
-      end
-
-      # Always escape the query.
-      query = CGI::escape(query)
-
-      if patch.nil? || !patch.any?
-        raise PatchNotProvided
-      end
-
-      if patch.key?(META_LABEL_ID)
-        raise PatchIdSet, "patch: #{patch}"
-      end
-
-      if patch.key?(META_LABEL_TYPE) && patch[META_LABEL_TYPE] != @entity_type
-        raise EntityTypeMismatch, "only valid type is '#{@entity_type}', but " +
-          "patch has type '#{patch[META_LABEL_TYPE]}'"
-      end
-
-      resp = etre_put("/entities/#{@entity_type}?query=#{query}", patch)
-      if ![200, 201].include?(resp.code)
-        raise UnexpectedResponseCode, "expected 200 or 201, got #{resp.code}"
-      end
-
-      return JSON.parse(resp.body)
-    end
-
-    # update_one updates the given entity id with the provided patch.
-    def update_one(id, patch)
-      if id.nil? || id.empty?
-        raise IdNotProvided
-      end
-
-      if patch.nil? || !patch.any?
-        raise PatchNotProvided
-      end
-
-      if patch.key?(META_LABEL_ID)
-        raise PatchIdSet, "patch: #{patch}"
-      end
-
-      if patch.key?(META_LABEL_TYPE) && patch[META_LABEL_TYPE] != @entity_type
-        raise EntityTypeMismatch, "only valid type is '#{@entity_type}', but " +
-          "patch has type '#{patch[META_LABEL_TYPE]}'"
-      end
-
-      resp = etre_put("/entity/#{@entity_type}/#{id}", patch)
-      if ![200, 201].include?(resp.code)
-        raise UnexpectedResponseCode, "expected 200 or 201, got #{resp.code}"
-      end
-
-      return JSON.parse(resp.body)
-    end
-
-    # delete deletes the entities that satisfy the given query.
-    def delete(query)
-      if query.nil? || query.empty?
-        raise QueryNotProvided
-      end
-
-      # Always escape the query.
-      query = CGI::escape(query)
-
-      resp = etre_delete("/entities/#{@entity_type}?query=#{query}")
-      if resp.code != 200
-        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
-      end
-
-      return JSON.parse(resp.body)
-    end
-
-    # delete_one deletes the entity with the given id.
-    def delete_one(id)
-      if id.nil? || id.empty?
-        raise IdNotProvided
-      end
-
-      resp = etre_delete("/entity/#{@entity_type}/#{id}")
-      if resp.code != 200
-        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
-      end
-
-      return JSON.parse(resp.body)
-    end
-
-    # labels returns an array of labels for the given entity id.
-    def labels(id)
-      if id.nil? || id.empty?
-        raise IdNotProvided
-      end
-
-      resp = etre_get("/entity/#{@entity_type}/#{id}/labels")
-
-      if resp.code != 200
-        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
-      end
-
-      return JSON.parse(resp.body)
-    end
-
-    # delete_label deletes the given label on the provided entity id.
-    def delete_label(id, label)
-      if id.nil? || id.empty?
-        raise IdNotProvided
-      end
-
-      if label.nil? || label.empty?
-        raise LabelNotSet
-      end
-
-      resp = etre_delete("/entity/#{@entity_type}/#{id}/labels/#{label}")
-      if resp.code != 200
-        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
-      end
-
-      return JSON.parse(resp.body)
-    end
-
-    private
-
-    def etre_get(route)
-      resource_for_route(route).get(
-        get_headers,
-      )
-    end
-
-    def etre_post(route, params = nil)
-      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,
-      )
-    end
-
-    def etre_delete(route)
-      resource_for_route(route).delete(
-        delete_headers,
-      )
-    end
-
-    def get_headers
-      {:accept => 'application/json'}
-    end
-
-    def post_headers
-      get_headers.merge!(:content_type => 'application/json')
-    end
-
-    def put_headers
-      post_headers
-    end
-
-    def delete_headers
-      get_headers
-    end
-
-    def resource_for_route(route)
-      opts = {}
-      opts.merge!(ssl_options) unless @insecure
-      RestClient::Resource.new(
-        @url + API_ROOT + route,
-        opts
-      )
-    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
-  end
-end

data/lib/etre-client/client.rb

@@ -0,0 +1,324 @@
+require 'etre-client/errors'
+require 'logger'
+require 'rest-client'
+require 'json'
+
+module Etre
+  class Client
+    attr_reader :entity_type, :url
+
+    API_ROOT = "/api/v1"
+    META_LABEL_ID = "_id"
+    META_LABEL_TYPE = "_type"
+
+    def initialize(entity_type:, url:, query_timeout: 5, 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
+
+      @logger = Logger.new(STDOUT)
+    end
+
+    # query returns an array of entities that satisfy a query.
+    def query(query, filter = nil)
+      if query.nil? || query.empty?
+        raise QueryNotProvided
+      end
+
+      # @todo: translate filter to query params
+
+      # Do the normal GET /entities?query unless the query is ~2k characters
+      # becuase that brings the entire URL length close to the max supported
+      # limit across most HTTP servers. In that case, switch to alternate
+      # endpoint to POST the long query.
+      if query.length < 2000
+        # Always escape the query.
+        query = CGI::escape(query)
+
+        begin
+          resp = etre_get("/entities/#{@entity_type}?query=#{query}")
+        rescue RestClient::ExceptionWithResponse => e
+          raise RequestFailed, e.response
+        end
+      else
+        # DO NOT ESCAPE THE QUERY! It's not sent via URL, so no escaping needed.
+        begin
+          resp = etre_post("/query/#{@entity_type}", query)
+        rescue RestClient::ExceptionWithResponse => e
+          raise RequestFailed, e.response
+        end
+      end
+
+      if resp.code != 200
+        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
+      end
+
+      return JSON.parse(resp.body)
+    end
+
+    # insert inserts an array of entities.
+    def insert(entities)
+      if entities.nil? || !entities.any?
+        raise EntityNotProvided
+      end
+
+      entities.each do |e|
+        if e.key?(META_LABEL_ID)
+          raise EntityIdSet, "entity: #{e}"
+        end
+
+        if e.key?(META_LABEL_TYPE) && e[META_LABEL_TYPE] != @entity_type
+          raise EntityTypeMismatch, "only valid type is '#{@entity_type}', but " +
+            "entity has type '#{e[META_LABEL_TYPE]}'"
+        end
+      end
+
+      begin
+        resp = etre_post("/entities/#{@entity_type}", entities)
+      rescue RestClient::ExceptionWithResponse => e
+        raise RequestFailed, e.response
+      end
+
+      if ![200, 201].include?(resp.code)
+        raise UnexpectedResponseCode, "expected 200 or 201, got #{resp.code}"
+      end
+
+      return JSON.parse(resp.body)
+    end
+
+    # update updates entities with the given patch that satisfy the given query.
+    def update(query, patch)
+      if query.nil? || query.empty?
+        raise QueryNotProvided
+      end
+
+      # Always escape the query.
+      query = CGI::escape(query)
+
+      if patch.nil? || !patch.any?
+        raise PatchNotProvided
+      end
+
+      if patch.key?(META_LABEL_ID)
+        raise PatchIdSet, "patch: #{patch}"
+      end
+
+      if patch.key?(META_LABEL_TYPE) && patch[META_LABEL_TYPE] != @entity_type
+        raise EntityTypeMismatch, "only valid type is '#{@entity_type}', but " +
+          "patch has type '#{patch[META_LABEL_TYPE]}'"
+      end
+
+      begin
+        resp = etre_put("/entities/#{@entity_type}?query=#{query}", patch)
+      rescue RestClient::ExceptionWithResponse => e
+        raise RequestFailed, e.response
+      end
+
+      if ![200, 201].include?(resp.code)
+        raise UnexpectedResponseCode, "expected 200 or 201, got #{resp.code}"
+      end
+
+      return JSON.parse(resp.body)
+    end
+
+    # update_one updates the given entity id with the provided patch.
+    def update_one(id, patch)
+      if id.nil? || id.empty?
+        raise IdNotProvided
+      end
+
+      if patch.nil? || !patch.any?
+        raise PatchNotProvided
+      end
+
+      if patch.key?(META_LABEL_ID)
+        raise PatchIdSet, "patch: #{patch}"
+      end
+
+      if patch.key?(META_LABEL_TYPE) && patch[META_LABEL_TYPE] != @entity_type
+        raise EntityTypeMismatch, "only valid type is '#{@entity_type}', but " +
+          "patch has type '#{patch[META_LABEL_TYPE]}'"
+      end
+
+      begin
+        resp = etre_put("/entity/#{@entity_type}/#{id}", patch)
+      rescue RestClient::ExceptionWithResponse => e
+        raise RequestFailed, e.response
+      end
+
+      if ![200, 201].include?(resp.code)
+        raise UnexpectedResponseCode, "expected 200 or 201, got #{resp.code}"
+      end
+
+      return JSON.parse(resp.body)
+    end
+
+    # delete deletes the entities that satisfy the given query.
+    def delete(query)
+      if query.nil? || query.empty?
+        raise QueryNotProvided
+      end
+
+      # Always escape the query.
+      query = CGI::escape(query)
+
+      begin
+        resp = etre_delete("/entities/#{@entity_type}?query=#{query}")
+      rescue RestClient::ExceptionWithResponse => e
+        raise RequestFailed, e.response
+      end
+
+      if resp.code != 200
+        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
+      end
+
+      return JSON.parse(resp.body)
+    end
+
+    # delete_one deletes the entity with the given id.
+    def delete_one(id)
+      if id.nil? || id.empty?
+        raise IdNotProvided
+      end
+
+      begin
+        resp = etre_delete("/entity/#{@entity_type}/#{id}")
+      rescue RestClient::ExceptionWithResponse => e
+        raise RequestFailed, e.response
+      end
+
+      if resp.code != 200
+        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
+      end
+
+      return JSON.parse(resp.body)
+    end
+
+    # labels returns an array of labels for the given entity id.
+    def labels(id)
+      if id.nil? || id.empty?
+        raise IdNotProvided
+      end
+
+      begin
+        resp = etre_get("/entity/#{@entity_type}/#{id}/labels")
+      rescue RestClient::ExceptionWithResponse => e
+        raise RequestFailed, e.response
+      end
+
+      if resp.code != 200
+        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
+      end
+
+      return JSON.parse(resp.body)
+    end
+
+    # delete_label deletes the given label on the provided entity id.
+    def delete_label(id, label)
+      if id.nil? || id.empty?
+        raise IdNotProvided
+      end
+
+      if label.nil? || label.empty?
+        raise LabelNotSet
+      end
+
+      begin
+        resp = etre_delete("/entity/#{@entity_type}/#{id}/labels/#{label}")
+      rescue RestClient::ExceptionWithResponse => e
+        raise RequestFailed, e.response
+      end
+
+      if resp.code != 200
+        raise UnexpectedResponseCode, "expected 200, got #{resp.code}"
+      end
+
+      return JSON.parse(resp.body)
+    end
+
+    private
+
+    def etre_get(route)
+      rest_retry {
+        resource_for_route(route).get(
+          get_headers,
+        )
+      }
+    end
+
+    def etre_post(route, params = nil)
+      rest_retry {
+        resource_for_route(route).post(
+          params.to_json,
+          post_headers,
+        )
+      }
+    end
+
+    def etre_put(route, params = nil)
+      rest_retry {
+        resource_for_route(route).put(
+          params.to_json,
+          put_headers,
+        )
+      }
+    end
+
+    def etre_delete(route)
+      rest_retry {
+        resource_for_route(route).delete(
+          delete_headers,
+        )
+      }
+    end
+
+    def get_headers
+      {
+          :accept => 'application/json',
+          :x_etre_query_timeout => @query_timeout
+      }
+    end
+
+    def post_headers
+      get_headers.merge!(:content_type => 'application/json')
+    end
+
+    def put_headers
+      post_headers
+    end
+
+    def delete_headers
+      get_headers
+    end
+
+    def resource_for_route(route)
+      RestClient::Resource.new(
+        @url + API_ROOT + route,
+        @options
+      )
+    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/errors.rb

@@ -8,6 +8,7 @@ module Etre
     class PatchIdSet < StandardError; end
     class PatchNotProvided < StandardError; end
     class QueryNotProvided < StandardError; end
+    class RequestFailed < StandardError; end
     class UnexpectedResponseCode < StandardError; end
   end
 end

data/lib/etre-client/version.rb

@@ -1,5 +1,5 @@
 module Etre
   class Client
-    VERSION = "0.8.0"
+    VERSION = "0.8.5"
   end
 end

data/spec/client_spec.rb

@@ -2,13 +2,11 @@ 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 => 5} }
   let(:post_headers) { get_headers.merge({:content_type => "application/json"}) }
   let(:put_headers) { post_headers }
   let(:delete_headers) { get_headers }
-  let(:migration_id) { 3 }
-  let(:cluster) { "cluster-001" }
   let(:entity1) { {"_id" => "abc", "foo" => "bar"} }
   let(:entity2) { {"oof" => "rab"} }
   let(:entity3) { {"blah" => "slug"} }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etre-client
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.5
 platform: ruby
 authors:
 - Michael Finch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2020-11-23 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: []
@@ -80,12 +80,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - etre-client.gemspec
 - lib/etre-client.rb
+- lib/etre-client/client.rb
 - lib/etre-client/errors.rb
 - lib/etre-client/version.rb
 - spec/client_spec.rb
@@ -94,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
@@ -109,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.3
+signing_key:
 specification_version: 4
 summary: Client gem for interacting with Etre
 test_files:

data/Gemfile.lock

@@ -1,97 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (5.1.4)
-      actionview (= 5.1.4)
-      activesupport (= 5.1.4)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.4)
-      activesupport (= 5.1.4)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.1.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    crass (1.0.2)
-    diff-lcs (1.3)
-    domain_name (0.5.20170404)
-      unf (>= 0.0.5, < 1.0.0)
-    erubi (1.7.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    i18n (0.9.0)
-      concurrent-ruby (~> 1.0)
-    loofah (2.1.1)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (0.9.0)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    mini_portile2 (2.3.0)
-    minitest (5.10.3)
-    netrc (0.11.0)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
-    rack (2.0.3)
-    rack-test (0.7.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    railties (5.1.4)
-      actionpack (= 5.1.4)
-      activesupport (= 5.1.4)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (12.2.1)
-    rest-client (2.0.2)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-rails (3.7.1)
-      actionpack (>= 3.0)
-      activesupport (>= 3.0)
-      railties (>= 3.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.4)
-      thread_safe (~> 0.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rest-client
-  rspec-rails
-
-BUNDLED WITH
-   1.15.4