simple_segment 1.0.0.pre → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27c373f624b3e1192b8ebb92fbd5ead37924a4578e5179dd831c9226e4f57583
-  data.tar.gz: b2537161f1f05a92ed3c39c47d65c62cb535217ebedc3d1201ed75a8aa928e56
+  metadata.gz: 17b61bb188d391c3349423f42c56444313a7ed154945149ecda2d1317d070a15
+  data.tar.gz: 499d33dbd054da57d6bf33bf277638a93d238dee88d7d1989626ce96f35dcbef
 SHA512:
-  metadata.gz: b53313b90d9db6a87799b57f4cfee2fba4fb645e9b2b1aea3db19e996795266d6a558f14802c9bf86a6f13fa2655f0b9760267bab4189736746bd2684e93ed10
-  data.tar.gz: e2b9c0b2d5bde7ff41de7e78af42b9c50621f0c095c9d8563cabfba3f0d5bf703c80e46b6fae3101cb4f686ebaa58c82ab77149792c3f87408df5b3d267c88db
+  metadata.gz: 209c042c0b36bbe411cbb76e57ae072c6cde1de5906dff3bdcff597dd83148f92154d052acec4225b23e1c40c64f5be3129d4a21db62aff1709520725e45edc6
+  data.tar.gz: 120b864ff8d2ba8a68082a6b8d4bcc68f75cd490ae083f463ef2e8bc0c02efc52f4f926642a1cf5cc0067db7ba885220ab7e7a66c578daff5a9499385fa81826

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-version: [2.6, 2.7, 3.0]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          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,13 +6,40 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.3.0] - 2021-11-27
+
+### Added
+- Add support for message_id override https://github.com/whatthewhat/simple_segment/pull/34 by [@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 support for http_proxy and https_proxy environment variables https://github.com/whatthewhat/simple_segment/pull/26 by [@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][]
+
+### Changed
+- The gem is no longer tested with Ruby versions below 2.4
 
 ## [0.3.0] - 2018-03-15
 
 ### 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/v0.3.0...HEAD
+[Unreleased]: https://github.com/whatthewhat/simple_segment/compare/v1.3.0...HEAD
+[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
 [0.2.1]: https://github.com/whatthewhat/simple_segment/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/whatthewhat/simple_segment/compare/v0.1.1...v0.2.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.
 
@@ -29,34 +29,32 @@ Add this line to your application's Gemfile:
 gem 'simple_segment'
 ```
 
-And then execute:
-
-    $ bundle
-
 Or install it yourself as:
 
-    $ gem install simple_segment
+```sh
+$ gem install simple_segment
+```
 
 ## Usage
 
 Create a client instance:
 
 ```ruby
-analytics = SimpleSegment::Client.new({
+analytics = SimpleSegment::Client.new(
   write_key: 'YOUR_WRITE_KEY', # required
   on_error: proc { |error_code, error_body, exception, response|
     # defaults to an empty proc
   }
-})
+)
 ```
 
 Use it as you would use `analytics-ruby`:
 
 ```ruby
-analytics.track({
+analytics.track(
   user_id: user.id,
   event: 'Created Account'
-})
+)
 ```
 
 ### Batching
@@ -86,6 +84,7 @@ analytics = SimpleSegment::Client.new(
 ```
 
 ### Configurable Logger
+
 When used in stubbed mode all calls are logged to STDOUT, this can be changed by providing a custom logger object:
 
 ```ruby
@@ -97,7 +96,7 @@ analytics = SimpleSegment::Client.new(
 
 ### Set HTTP Options
 
-You can set options that are passed to `Net::HTTP.start`.
+You can set [options](https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html#method-c-start) that are passed to `Net::HTTP.start`.
 
 ```ruby
 analytics = SimpleSegment::Client.new(

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/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

@@ -32,7 +32,7 @@ module SimpleSegment
 
         { status: 200, error: nil }
       else
-        Net::HTTP.start(uri.host, uri.port, http_options) do |http|
+        Net::HTTP.start(uri.host, uri.port, :ENV, http_options) do |http|
           request = Net::HTTP::Post.new(path, headers)
           request.basic_auth write_key, nil
           http.request(request, payload).tap do |res|

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.0.0.pre'
+  VERSION = '1.3.0'
 end

data/simple_segment.gemspec

@@ -20,11 +20,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'bundler', '>= 1.11'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  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 'rubocop', '1.23.0'
   spec.add_development_dependency 'timecop', '~> 0.8.0'
   spec.add_development_dependency 'webmock', '~> 3.7'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: simple_segment
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.3.0
 platform: ruby
 authors:
 - Mikhail Topolskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.11'
 - !ruby/object:Gem::Dependency
@@ -42,14 +42,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -72,14 +72,14 @@ 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
@@ -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,7 +147,8 @@ files:
 homepage: https://github.com/whatthewhat/simple_segment
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -159,11 +160,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A simple synchronous API client for segment.io.

data/.travis.yml

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