samsara_sdk 0.5.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c262c3b124bd4903dac56a5418ae0a1c99fab824
+  data.tar.gz: 090ef013b88e2e169729c6891ba7d8f4752a6ecb
+SHA512:
+  metadata.gz: 2a40ee0f8dc8e6095e36f33d6d8d268eb5270cc1b7a55bad63aa3830a5b3419516d7206b1b4e4a4ae3a0d31080d9e300739fd03171a34597f35bed14d2f6a53a
+  data.tar.gz: 8cce55a07e5355be151f2ac4d260b8fab985e869e345dd2d00dfd7b796624234a43a942cd8729d19140fc6d8c28ff08aaf21bfb7bc392443486bd598e22203e3

data/LICENSE.txt

@@ -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 {yyyy} {name of copyright owner}
+
+   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

@@ -0,0 +1,43 @@
+# samara_sdk
+
+Ruby client SDK for Samsara.
+
+Works with Ruby >= 1.9.3
+
+## Usage
+
+To see how to use this client please [read the documentation](/docs/clients/ruby-client.md)
+
+## Contributing
+
+Follow the [Quick-Start guide](/docs/quick-start.md) to get Samsara & friends set up.
+
+To hack client locally:
+
+```bash
+$ gem install bundler # (if not installed)
+$ gem install rake # (if not installed)
+$ git clone https://github.com/samsara/samsara.git
+$ cd samsara/clients/ruby
+$ rake rubocop # to check code-standards
+$ rake test # to run tests
+$ rake coverage # to generate code coverage report
+```
+
+To install client locally:
+
+```bash
+$ cd samsara/clients/ruby
+$ rake build
+$ rake install
+```
+
+### TODO
+
+- [ ] support `"send_client_stats"` option
+
+## License
+
+Copyright © 2016 Samsara's authors.
+
+Distributed under the Apache License v 2.0 (http://www.apache.org/licenses/LICENSE-2.0)

data/lib/samsara_sdk.rb

@@ -0,0 +1,6 @@
+require 'samsara_sdk/client'
+require 'samsara_sdk/config'
+require 'samsara_sdk/errors'
+require 'samsara_sdk/event'
+require 'samsara_sdk/publisher'
+require 'samsara_sdk/ring_buffer'

data/lib/samsara_sdk/client.rb

@@ -0,0 +1,57 @@
+require 'samsara_sdk/config'
+require 'samsara_sdk/publisher'
+require 'samsara_sdk/ring_buffer'
+require 'samsara_sdk/event'
+
+# Samsara SDK
+module SamsaraSDK
+  # A client for ingesting events into Samsara.
+  # It is the main interface to communicate with Samsara API.
+  class Client
+    # initialize
+    #
+    # @param config [Hash] Configuration overrides.
+    # @raise [SamsaraSDK::ConfigValidationError] if any config option is incorrect.
+    def initialize(config)
+      Config.setup! config
+      @publisher = Publisher.new
+      @queue = RingBuffer.new(Config.get[:max_buffer_size])
+      @activity = Thread.new { publishing_activity } if Config.get[:start_publishing_thread]
+    end
+
+    # Publishes given events list to Ingestion API immediately.
+    #
+    # @param events [Array<Hash>] List of events.
+    # @return [Boolean] The result of publish operation.
+    # @raise [SamsaraSDK::EventValidationError] if any option of the given event is invalid.
+    # @see http://samsara-analytics.io/docs/design/events-spec Event specification
+    def publish_events(events)
+      events = events.map { |event| Event.validate(Event.enrich(event)) }
+      @publisher.post events
+    end
+
+    # Pushes event to internal events' queue.
+    #
+    # @param event [Hash] Event data.
+    # @option data [String] :eventName Name of the event.
+    # @option data [String] :sourceId Source ID of the event.
+    # @option data [Integer] :timestamp Timestamp in milliseconds.
+    # @see http://samsara-analytics.io/docs/design/events-spec Event specification
+    def record_event(event)
+      event = Event.validate(Event.enrich(event))
+      @queue << event
+    end
+
+    private
+
+    # Publishing activity.
+    # Represents an infinite loop that periodically posts queued events to Ingestion API.
+    # Used in a background thread.
+    def publishing_activity
+      loop do
+        @queue.flush { |data| @publisher.post data } if @queue.count >= Config.get[:min_buffer_size]
+        sleep Config.get[:publish_interval_ms] / 1000
+      end
+    end
+  end
+end

data/lib/samsara_sdk/config.rb

@@ -0,0 +1,114 @@
+require 'samsara_sdk/errors'
+
+# Samsara SDK
+module SamsaraSDK
+  # Samsara SDK default configuration and request constants.
+  class Config
+    # Samsara specific HTTP Header
+    PUBLISHED_TIMESTAMP_HEADER = 'X-Samsara-publishedTimestamp'.freeze
+
+    # Samsara Ingestion API endpoint
+    API_PATH = '/v1/events'.freeze
+
+    # Default configuration values.
+    @defaults = {
+      # Samsara ingestion api endpoint "http://samsara-ingestion.local/"
+      url: '',
+
+      # Identifier of the source of these events
+      # OPTIONAL used only for record-event
+      sourceId: '',
+
+      # Start the publishing thread?
+      start_publishing_thread: TRUE,
+
+      # How often should the events being sent to Samsara
+      # in milliseconds.
+      # default = 30s
+      publish_interval_ms: 30_000,
+
+      # Max size of the buffer.
+      # When buffer is full older events are dropped.
+      max_buffer_size: 10_000,
+
+      # Minimum number of events that must be in the buffer
+      # before attempting to publish them.
+      min_buffer_size: 100,
+
+      # Network timeout for send operations
+      # in milliseconds.
+      # default 30s
+      send_timeout_ms: 30_000,
+
+      # Should the payload be compressed?
+      # allowed values :gzip, :none
+      compression: :gzip,
+
+      # NOT CURRENTLY SUPPORTED
+      # Add Samsara client statistics events
+      # this helps you to understand whether the
+      # buffer size and publish-intervals are
+      # adequately configured.
+      # send_client_stats: TRUE
+    }
+
+    # Actual configuration values.
+    @values = {}
+
+    class << self
+      # Set up configuration.
+      # Merges given config with defaults and validates the result.
+      #
+      # @param input_config [Hash] Input configuration options.
+      # @raise [SamsaraSDK::ConfigValidationError] if any config option is incorrect.
+      def setup!(input_config)
+        @values = @defaults.merge input_config
+        validate @values
+      end
+
+      # Get configuration values.
+      #
+      # @return [Hash] Configuration values.
+      def get
+        @values
+      end
+
+      # Generates current timestamp.
+      #
+      # @return [Integer] timestamp in milliseconds.
+      def timestamp
+        (Time.now.to_f.round(3) * 1000).to_i
+      end
+
+      private
+
+      # Validates given configuration values.
+      #
+      # @param config [Hash] Configuration values.
+      # @raise [SamsaraSDK::ConfigValidationError] if any config option is incorrect.
+      def validate(config)
+        config.each do |k, v|
+          raise ConfigValidationError, "#{k} should be of #{@defaults[k].class}" unless valid_type?(k, v)
+        end
+
+        raise ConfigValidationError, 'URL for Ingestion API should be specified.' if config[:url] == ''
+        raise ConfigValidationError, 'Incorrect compression option.' unless [:gzip, :none].include? config[:compression]
+        raise ConfigValidationError, 'Invalid interval time for Samsara client.' if config[:publish_interval_ms] <= 0
+        raise ConfigValidationError, 'max_buffer_size can not be less than min_buffer_size.' if
+            config[:max_buffer_size] < config[:min_buffer_size]
+      end
+
+      # Check value type corresponds to allowed type for particular config key.
+      #
+      # @param key [Symbol] Configuration key.
+      # @param value [Object] Configuration value.
+      # @return [Boolean]
+      def valid_type?(key, value)
+        if [TrueClass, FalseClass].include? @defaults[key].class
+          return [TrueClass, FalseClass].include? value.class
+        end
+        value.is_a? @defaults[key].class
+      end
+    end
+  end
+end

data/lib/samsara_sdk/errors.rb

@@ -0,0 +1,8 @@
+# Samsara SDK
+module SamsaraSDK
+  # Configuration validation error exception.
+  class ConfigValidationError < StandardError; end
+
+  # Event validation error exception.
+  class EventValidationError < StandardError; end
+end

data/lib/samsara_sdk/event.rb

@@ -0,0 +1,55 @@
+require 'samsara_sdk/config'
+require 'samsara_sdk/errors'
+
+# Samsara SDK
+module SamsaraSDK
+  # Contains methods for event manipulation.
+  class Event
+    # Validation schema for Ingestion API event.
+    @schema = {
+      sourceId:  { required: TRUE, not_blank: TRUE, type: String },
+      timestamp: { required: TRUE, type: Integer, min: 0 },
+      eventName: { required: TRUE, not_blank: TRUE, type: String }
+    }
+
+    # Validation rules for Ingestion API event.
+    @rules = {
+      required: lambda do |key, value, required|
+        raise EventValidationError, "Event.#{key}: Argument is required" if required && value.nil?
+      end,
+      not_blank: lambda do |key, value, on|
+        value.strip! if value.respond_to?(:strip!)
+        raise EventValidationError, "Event.#{key}: can't be blank" if
+            on && value.respond_to?(:empty?) ? value.empty? : !value
+      end,
+      type: ->(key, value, type) { raise EventValidationError, "Event.#{key}: Wrong type" unless value.is_a? type },
+      min: ->(key, value, min) { raise EventValidationError, "Event.#{key}: Can't be less than #{min}" if value < min }
+    }
+
+    class << self
+      # Enriches missing event properties with ones from config.
+      #
+      # @param event [Hash] Event for Ingestion API.
+      # @return [Hash] Event for Ingestion API filled with missing properties.
+      def enrich(event)
+        event[:sourceId] = event.fetch(:sourceId, Config.get[:sourceId])
+        event[:timestamp] = event.fetch(:timestamp, Config.timestamp)
+        event
+      end
+
+      # Validates event to conform Ingestion API requirements.
+      #
+      # @param event [Hash] Event.
+      # @return [Hash] Passed back event.
+      # @raise [SamsaraSDK::EventValidationError] if any option of the given event is invalid.
+      def validate(event)
+        @schema.each do |schema_param, schema_value|
+          schema_value.each do |rule_key, rule_value|
+            @rules[rule_key].call(schema_param, event[schema_param], rule_value)
+          end
+        end
+        event
+      end
+    end
+  end
+end

data/lib/samsara_sdk/publisher.rb

@@ -0,0 +1,70 @@
+require 'json'
+require 'zlib'
+require 'stringio'
+require 'net/http'
+require 'samsara_sdk/config'
+
+# Samsara SDK
+module SamsaraSDK
+  # Physical connector that Publishes messages to Samsara Ingestion API.
+  class Publisher
+    # Sends message to Ingestion API.
+    #
+    # @param data [Array<Hash>] List of events.
+    # @return [Boolean] Success or failure of HTTP POST call.
+    def post(data)
+      url = URI.parse(Config.get[:url].chomp('/') + Config::API_PATH)
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = url.scheme == 'https'
+      http.read_timeout = Config.get[:send_timeout_ms] / 1000
+      request = Net::HTTP::Post.new(url, headers)
+      request.body = prepare data
+      http.request(request).instance_of? Net::HTTPAccepted
+    rescue RuntimeError
+      FALSE
+    end
+
+    private
+
+    # Wraps data in JSON and optionally compresses it.
+    #
+    # @param data [Array<Hash>] Data to prepare.
+    # @return [String] Prepared data.
+    def prepare(data)
+      data = JSON.generate data
+      send(Config.get[:compression], data)
+    end
+
+    # Gzip wrapper for data.
+    #
+    # @param data [String] Data to wrap.
+    # @return [String] Gzipped data.
+    def gzip(data)
+      wio = StringIO.new('w')
+      w_gz = Zlib::GzipWriter.new(wio)
+      w_gz.write(data)
+      w_gz.close
+      wio.string
+    end
+
+    # None wrapper for data.
+    #
+    # @param data [String] Data to wrap.
+    # @return [String] Original data.
+    def none(data)
+      data
+    end
+
+    # Helper method to generate HTTP request headers for Ingestion API.
+    #
+    # @return [Hash] headers
+    def headers
+      {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json',
+        'Content-Encoding' => Config.get[:compression] == :gzip ? 'gzip' : 'identity',
+        Config::PUBLISHED_TIMESTAMP_HEADER => Config.timestamp.to_s
+      }
+    end
+  end
+end

data/lib/samsara_sdk/ring_buffer.rb

@@ -0,0 +1,129 @@
+# Samsara SDK
+module SamsaraSDK
+  # Thread-safe ring-buffer data queue tailored for Samsara Client.
+  class RingBuffer
+    # initialize.
+    #
+    # @param size [Integer] Storage size.
+    def initialize(size)
+      @size = size
+      @low = -1
+      @high = -1
+      @buffer = Array.new(size)
+      @mutex = Mutex.new
+    end
+
+    # Get current number of items in buffer.
+    #
+    # @return [Integer] number of pushed elements.
+    def count
+      @high - @low
+    end
+
+    # Is buffer full?
+    #
+    # @return [Boolean] Full or not.
+    def full?
+      count == @size
+    end
+
+    # Is buffer empty?
+    #
+    # @return [Boolean] Empty or not.
+    def empty?
+      count.zero?
+    end
+
+    # Puts element into buffer.
+    #
+    # @return [Object] Element that has been put into buffer.
+    def push(value)
+      @mutex.synchronize do
+        return if @size.zero?
+        @high += 1
+        @low += 1 if count > @size
+        @buffer[high_position] = value
+        value
+      end
+    end
+    alias << :push
+
+    # Extract all existing elements out of buffer.
+    #
+    # @yield [data] Block that processes data and returns success of the processing.
+    # @yieldparam [Array<Object>] data Buffer data.
+    # @yieldreturn [Boolean] Result of data processing. True if success, false otherwise.
+    #
+    # @return [Array<Object>] All buffer's elements in FIFO order.
+    def flush
+      data, at_mark = take_snapshot
+      success = block_given? ? yield(data) : TRUE
+      delete at_mark if success
+      data
+    end
+
+    private
+
+    # Helper-method for calculating position in a circle.
+    #
+    # @return [Integer] position of a given pointer.
+    def calculate_position(pointer)
+      @size.nonzero? ? pointer.remainder(@size) : -1
+    end
+
+    # Get array-position of the element that was last added.
+    # Must be used within a synced mutex.
+    #
+    # @return [Integer] position.
+    def high_position
+      calculate_position @high
+    end
+
+    # Get array-position of the element that was last consumed.
+    # Must be used within a synced mutex.
+    #
+    # @return [Integer] position.
+    def low_position
+      calculate_position @low
+    end
+
+    # Make a snapshot of the current buffer at a given moment in FIFO order.
+    # Notes:
+    # It could be implemented just by iterating through @buffer and taking
+    # elements between @low and @high;
+    # but it's not as efficient as Ruby native array manipulations.
+    # So we stick to manipulating indices and handling different cases to get FIFO.
+    #
+    # @return [Array<Object>] actual elements in FIFO order,
+    # @return [Integer] High-water-mark that snapshot was taken at.
+    def take_snapshot
+      @mutex.synchronize do
+        i = high_position
+        j = low_position + 1
+
+        data = if empty?
+                 []
+               elsif @low == -1
+                 @buffer.compact
+               elsif @high < @size # array is not filled completely
+                 @buffer[j..i]
+               else
+                 @buffer[j..-1] + @buffer[0..i]
+               end
+
+        return data, @high
+      end
+    end
+
+    # Removes chunk of elements that present in a snapshot out of buffer.
+    # Detects if the last consumed element has been overridden by new pushes.
+    #
+    # @param mark [Integer] high attribute that represents high-water-mark of a snapshot.
+    def delete(mark)
+      @mutex.synchronize do
+        @low = [@low, mark].max
+        @high = [@high, mark].max
+      end
+    end
+  end
+end

data/samsara_sdk.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.authors = ['Egor Kolotaev']
+  spec.summary = 'Ruby client library for Samsara Analytics platform.'
+  spec.email = %w(samsara.systems+info@gmail.com)
+  spec.homepage = 'https://github.com/samsara/samsara/tree/master/clients/ruby'
+  spec.license = 'Apache License 2.0'
+  spec.name = 'samsara_sdk'
+  spec.require_paths = %w(lib)
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.description = spec.summary
+  spec.files = %w(LICENSE.txt README.md samsara_sdk.gemspec) + Dir['lib/**/*.rb']
+  spec.version = File.read('../../samsara.version').strip.sub(/[A-za-z-]*$/, '')
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: samsara_sdk
+version: !ruby/object:Gem::Version
+  version: 0.5.5.0
+platform: ruby
+authors:
+- Egor Kolotaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client library for Samsara Analytics platform.
+email:
+- samsara.systems+info@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- samsara_sdk.gemspec
+- lib/samsara_sdk/client.rb
+- lib/samsara_sdk/config.rb
+- lib/samsara_sdk/errors.rb
+- lib/samsara_sdk/event.rb
+- lib/samsara_sdk/publisher.rb
+- lib/samsara_sdk/ring_buffer.rb
+- lib/samsara_sdk.rb
+homepage: https://github.com/samsara/samsara/tree/master/clients/ruby
+licenses:
+- Apache License 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Ruby client library for Samsara Analytics platform.
+test_files: []