simple_segment 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a623a667db5890d88ca602d744725ce1a63ff6aee02ce8d6aa8439e714a8456
-  data.tar.gz: bfcb26a192fcc815ef7dfb875280fd4b3d12840177ecd39b6af691d50dc51539
+  metadata.gz: 4ecb763039e2fdacb85b464ebd96a7b46b4b18a92fb1a41069aff09af3c8fa92
+  data.tar.gz: e8bd47c02313e50940a2b3c042533b324ce4cba322572ade72562c6c39eec119
 SHA512:
-  metadata.gz: b47a7e817788640e8d05f88835c179aae1f6075eff460e4ad4677453f7bfe3882616caff2b06001c76bc22ded91fbf0d00eb32a2acd042647f7ae56d38bf3b42
-  data.tar.gz: 35086c2e4b6d1c0ab332663bf5241c61e2c4b977f7757b7d5827dda428fe873d6d923163f9ad72271bd0cd57f4c07b221f0e3ff4591c9057eeccdca3bd4447c1
+  metadata.gz: 5f0097b62f7bcfdcd6ca0f7caa16dc29505b1fd6a896dac9178d481201d6aaabd1aa456760baef7dbb95de34f956374df643351b0769626566cb6cb2ae89e6cc
+  data.tar.gz: 571840b8b57c64ac39d574b92e90db37290eb48e9f756c594c109f1948b27246503ceca31f00151f0802f4e67801dfcbb138f5311c6d105852e84636bd0710b1

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['3.1', '3.0', '2.7']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/.rubocop.yml

@@ -1,8 +1,11 @@
+AllCops:
+  NewCops: enable
+
 Metrics/BlockLength:
   Exclude:
     - '**/*_spec.rb'
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
   IgnoreCopDirectives: true
   Exclude:
@@ -10,3 +13,6 @@ Metrics/LineLength:
 
 Style/Documentation:
   Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/CHANGELOG.md

@@ -6,16 +6,31 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.4.0] - 2022-08-31
+
+### Added
+- Add host option to support regional segments https://github.com/whatthewhat/simple_segment/pull/37 by [@larsklevan](https://github.com/larsklevan)
+
+## [1.3.0] - 2021-11-27
+
+### Added
+- Add support for message_id override https://github.com/whatthewhat/simple_segment/pull/34 by [@theblang](https://github.com/theblang)
+
+## [1.2.0] - 2020-07-29
+
+### Changed
+- Use an empty hash if no properties were provided to `track` https://github.com/whatthewhat/simple_segment/pull/28
+
 ## [1.1.0] - 2020-04-11
 
 ### Added
-- Added supprt for http_proxy and https_proxy environment variables https://github.com/whatthewhat/simple_segment/pull/26 by @saks
+- Added support for http_proxy and https_proxy environment variables https://github.com/whatthewhat/simple_segment/pull/26 by [@saks](https://github.com/saks)
 - Added Ruby 2.7 to travis.yml
 
 ## [1.0.0] - 2019-12-12
 
 ### Added
-- Allow passing custom Net::HTTP options (e.g. timeout) https://github.com/whatthewhat/simple_segment/pull/23 by @barodeur
+- Allow passing custom Net::HTTP options (e.g. timeout) https://github.com/whatthewhat/simple_segment/pull/23 by [@barodeur](https://github.com/barodeur)
 
 ### Changed
 - The gem is no longer tested with Ruby versions below 2.4
@@ -25,7 +40,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Changed
 - Date properties are now automatically converted to ISO 8601 to be consistent with the official client https://github.com/whatthewhat/simple_segment/pull/19 by @juanramoncg
 
-[Unreleased]: https://github.com/whatthewhat/simple_segment/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/whatthewhat/simple_segment/compare/v1.4.0...HEAD
+[1.4.0]: https://github.com/whatthewhat/simple_segment/compare/v1.3.0...v1.4.0
+[1.3.0]: https://github.com/whatthewhat/simple_segment/compare/v1.2.0...v1.3.0
+[1.2.0]: https://github.com/whatthewhat/simple_segment/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/whatthewhat/simple_segment/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/whatthewhat/simple_segment/compare/v0.3.0...v1.0.0
 [0.3.0]: https://github.com/whatthewhat/simple_segment/compare/v0.2.1...v0.3.0

data/README.md

@@ -1,8 +1,8 @@
 # SimpleSegment
 
-[![Build Status](https://travis-ci.org/whatthewhat/simple_segment.svg?branch=master)](https://travis-ci.org/whatthewhat/simple_segment)
+![Build Status](https://github.com/whatthewhat/simple_segment/actions/workflows/ci.yml/badge.svg?branch=master)
 
-A simple synchronous Ruby API client for [segment.io](segment.io).
+A simple synchronous Ruby API client for [segment.io](https://segment.io).
 
 SimpleSegment allows for manual control of when and how the events are sent to Segment. This can be useful if you want to leverage an existing queueing system like Sidekiq or Resque for sending events or need to send events synchronously. If this is not the case you will be better off using the [official segment gem](https://github.com/segmentio/analytics-ruby) that handles queuing for you.
 
@@ -110,6 +110,17 @@ analytics = SimpleSegment::Client.new(
 )
 ```
 
+### Configurable Host
+
+You can use [regional segments](https://segment.com/docs/guides/regional-segment/) and send data to the desired region by setting the `host` parameter.
+
+```ruby
+analytics = SimpleSegment::Client.new(
+  write_key: 'YOUR_WRITE_KEY',
+  host: 'events.eu1.segmentapis.com'
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/simple_segment/client.rb

@@ -22,6 +22,7 @@ module SimpleSegment
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def identify(options)
       Operations::Identify.new(self, symbolize_keys(options)).call
     end
@@ -34,6 +35,7 @@ module SimpleSegment
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def track(options)
       Operations::Track.new(self, symbolize_keys(options)).call
     end
@@ -46,6 +48,7 @@ module SimpleSegment
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def page(options)
       Operations::Page.new(self, symbolize_keys(options)).call
     end
@@ -58,6 +61,7 @@ module SimpleSegment
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def group(options)
       Operations::Group.new(self, symbolize_keys(options)).call
     end
@@ -70,6 +74,7 @@ module SimpleSegment
     # @option :context [Hash]
     # @option :integrations [Hash]
     # @option :timestamp [#iso8601] (Time.now)
+    # @option :message_id
     def alias(options)
       Operations::Alias.new(self, symbolize_keys(options)).call
     end

data/lib/simple_segment/configuration.rb

@@ -7,7 +7,9 @@ module SimpleSegment
     include SimpleSegment::Utils
     include SimpleSegment::Logging
 
-    attr_reader :write_key, :on_error, :stub, :logger, :http_options
+    DEFAULT_HOST = 'api.segment.io'
+
+    attr_reader :write_key, :on_error, :stub, :logger, :http_options, :host
 
     def initialize(settings = {})
       symbolized_settings = symbolize_keys(settings)
@@ -17,6 +19,7 @@ module SimpleSegment
       @logger = default_logger(symbolized_settings[:logger])
       @http_options = { use_ssl: true }
                       .merge(symbolized_settings[:http_options] || {})
+      @host = symbolized_settings[:host] || DEFAULT_HOST
       raise ArgumentError, 'Missing required option :write_key' \
         unless @write_key
     end

data/lib/simple_segment/logging.rb

@@ -8,7 +8,7 @@ module SimpleSegment
     end
 
     def default_logger(logger_option)
-      logger_option || Logger.new(STDOUT)
+      logger_option || Logger.new($stdout)
     end
   end
 end

data/lib/simple_segment/operations/operation.rb

@@ -36,7 +36,8 @@ module SimpleSegment
           context: context,
           integrations: options[:integrations],
           timestamp: timestamp(options.fetch(:timestamp, current_time)),
-          sentAt: current_time.iso8601
+          sentAt: current_time.iso8601,
+          messageId: options[:message_id]
         }
       end
 

data/lib/simple_segment/operations/track.rb

@@ -8,14 +8,13 @@ module SimpleSegment
       end
 
       def build_payload
-        raise ArgumentError, 'event name must be present' \
-          unless options[:event]
+        raise ArgumentError, 'event name must be present' unless options[:event]
 
-        properties = options[:properties] && isoify_dates!(options[:properties])
+        properties = options[:properties] || {}
 
         base_payload.merge(
           event: options[:event],
-          properties: properties
+          properties: isoify_dates!(properties)
         )
       end
     end

data/lib/simple_segment/request.rb

@@ -2,13 +2,12 @@
 
 module SimpleSegment
   class Request
-    BASE_URL = 'https://api.segment.io'
     DEFAULT_HEADERS = {
       'Content-Type' => 'application/json',
       'accept' => 'application/json'
     }.freeze
 
-    attr_reader :write_key, :error_handler, :stub, :logger, :http_options
+    attr_reader :write_key, :error_handler, :stub, :logger, :http_options, :host
 
     def initialize(client)
       @write_key = client.config.write_key
@@ -16,6 +15,7 @@ module SimpleSegment
       @stub = client.config.stub
       @logger = client.config.logger
       @http_options = client.config.http_options
+      @host = client.config.host
     end
 
     def post(path, payload, headers: DEFAULT_HEADERS) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@@ -23,17 +23,17 @@ module SimpleSegment
       status_code = nil
       response_body = nil
 
-      uri = URI(BASE_URL)
+      uri = URI("https://#{host}#{path}")
       payload = JSON.generate(payload)
       if stub
         logger.debug "stubbed request to \
-        #{path}: write key = #{write_key}, \
+        #{uri.path}: write key = #{write_key}, \
         payload = #{payload}"
 
         { status: 200, error: nil }
       else
         Net::HTTP.start(uri.host, uri.port, :ENV, http_options) do |http|
-          request = Net::HTTP::Post.new(path, headers)
+          request = Net::HTTP::Post.new(uri.path, headers)
           request.basic_auth write_key, nil
           http.request(request, payload).tap do |res|
             status_code = res.code

data/lib/simple_segment/utils.rb

@@ -7,9 +7,7 @@ module SimpleSegment
     end
 
     def symbolize_keys(hash)
-      hash.each_with_object({}) do |(key, value), result|
-        result[key.to_sym] = value
-      end
+      hash.transform_keys(&:to_sym)
     end
 
     # public: Converts all the date values in the into iso8601 strings in place
@@ -22,8 +20,8 @@ module SimpleSegment
     #         strings
     #
     def isoify_dates(hash)
-      hash.each_with_object({}) do |(k, v), memo|
-        memo[k] = maybe_datetime_in_iso8601(v)
+      hash.transform_values do |v|
+        maybe_datetime_in_iso8601(v)
       end
     end
 

data/lib/simple_segment/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleSegment
-  VERSION = '1.1.0'
+  VERSION = '1.4.0'
 end

data/simple_segment.gemspec

@@ -24,7 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '0.75.0'
-  spec.add_development_dependency 'timecop', '~> 0.8.0'
+  spec.add_development_dependency 'rubocop', '1.23.0'
+  spec.add_development_dependency 'timecop', '~> 0.9.5'
   spec.add_development_dependency 'webmock', '~> 3.7'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_segment
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Mikhail Topolskiy
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-11 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.5
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -116,11 +116,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -147,8 +147,9 @@ files:
 homepage: https://github.com/whatthewhat/simple_segment
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,8 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A simple synchronous API client for segment.io.
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7