simple_segment 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17b61bb188d391c3349423f42c56444313a7ed154945149ecda2d1317d070a15
-  data.tar.gz: 499d33dbd054da57d6bf33bf277638a93d238dee88d7d1989626ce96f35dcbef
+  metadata.gz: 6e5090db1c874309f4cd0c4fef0cef16fc261eb9f41cc25e05bc653195199b1b
+  data.tar.gz: a36a26d72fd87df85236fb5b306e6c66dd9e64f1b65acb1f4b25ced8d7b655fd
 SHA512:
-  metadata.gz: 209c042c0b36bbe411cbb76e57ae072c6cde1de5906dff3bdcff597dd83148f92154d052acec4225b23e1c40c64f5be3129d4a21db62aff1709520725e45edc6
-  data.tar.gz: 120b864ff8d2ba8a68082a6b8d4bcc68f75cd490ae083f463ef2e8bc0c02efc52f4f926642a1cf5cc0067db7ba885220ab7e7a66c578daff5a9499385fa81826
+  metadata.gz: 4d9930d8f661b02fbdba7c513c0a5f424eeea901597059a8570518d1f719cc026cc24f1bd6c3a88508526198557929f8f7f3185f9f9408683c1b571cfc58e195
+  data.tar.gz: 1b34511c0bdd1960627e797c4a41802863cbaa15f67f53b8a3e583c3b3f95dd75b4b63d137e0e967c04cabee65853d5d96f6612f2a9a30c517af88cec782a499

data/.github/workflows/ci.yml

@@ -10,13 +10,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [2.6, 2.7, 3.0]
+        ruby: ['3.1', '3.0', '2.7']
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby ${{ matrix.ruby-version }}
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby-version }}
+          ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - name: Run tests
         run: bundle exec rake

data/CHANGELOG.md

@@ -6,10 +6,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.5.0] - 2022-12-06
+
+### Changed
+- Use the /v1/batch endpoint for batching events (this should be backward compatible according to Segment) https://github.com/whatthewhat/simple_segment/pull/40 by [@sgallag-insta](https://github.com/sgallag-insta)
+
+## [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][]
+- 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
 
@@ -19,13 +29,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [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 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
@@ -35,7 +45,9 @@ 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.3.0...HEAD
+[Unreleased]: https://github.com/whatthewhat/simple_segment/compare/v1.5.0...HEAD
+[1.5.0]: https://github.com/whatthewhat/simple_segment/compare/v1.4.0...v1.5.0
+[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

data/README.md

@@ -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/batch.rb

@@ -48,7 +48,7 @@ module SimpleSegment
         raise ArgumentError, 'A batch must contain at least one action'
       end
 
-      Request.new(client).post('/v1/import', payload)
+      Request.new(client).post('/v1/batch', payload)
     end
 
     private
@@ -56,7 +56,7 @@ module SimpleSegment
     def add(operation_class, options, action)
       operation = operation_class.new(client, symbolize_keys(options))
       operation_payload = operation.build_payload
-      operation_payload[:action] = action
+      operation_payload[:type] = action
       payload[:batch] << operation_payload
     end
   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/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/version.rb

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

data/simple_segment.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_segment
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Mikhail Topolskiy
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-26 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     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
@@ -149,7 +149,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -165,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A simple synchronous API client for segment.io.
 test_files: []