simple_segment 0.2.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 51451276d36995db980573591e7703e32e7ba5c2
-  data.tar.gz: e34ae21510134d077de91a191bd9d29fd613ff28
+SHA256:
+  metadata.gz: 6fb16e2b7875babb8be42dcd1bd734c150a9965be347d59ce8c977597fd07679
+  data.tar.gz: 291ec1529c2db59b7b047af54e2dad386c83f885422e4ecdd59f2aff448444d8
 SHA512:
-  metadata.gz: 9060d055127519c59e9033b2a42a222321265c90f20f164e77a84a9cf7f144955a02490776fb79a57beb1cff9e7fb5d5b5f27f7f6a0c821636850c829859b7fa
-  data.tar.gz: 156154cbb0ca38e288727142fc5d80fc9d264503259f40477b4dce8739621ef8a402467225863dff16816f0f34a4d6e50e2834cfe80dfa073f24b3dbc1a6f8d1
+  metadata.gz: d931d49bc337899519bf9731b0f0262b0b88eb7f36256e9255730fae574d328af1a98a27d82f947f1e03e49e4f629ffc7a1eb08ba4732a8aeda9e22e841d0d1b
+  data.tar.gz: 2f574ae47e801ab3d1fb2d079c288142590f8a8e8d7916ab386e53b69858d0fb9175779509301cd9bea1e790b7926cbf54bb9213820cb1aabebd0062e02bfd4f

data/.hound.yml

@@ -1,2 +1,3 @@
-ruby:
+rubocop:
   config_file: .rubocop.yml
+  version: 0.75.0

data/.rubocop.yml

@@ -3,6 +3,8 @@ Metrics/BlockLength:
     - '**/*_spec.rb'
 
 Metrics/LineLength:
+  Max: 100
+  IgnoreCopDirectives: true
   Exclude:
     - 'simple_segment.gemspec'
 

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [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/v1.2.0...HEAD
+[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
+[0.1.1]: https://github.com/whatthewhat/simple_segment/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/whatthewhat/simple_segment/compare/2d62f07a1df8388000b0b5a20331409132d05ad3...v0.1.0

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in simple_segment.gemspec

data/README.md

@@ -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, response, exception|
+  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
@@ -95,6 +94,22 @@ analytics = SimpleSegment::Client.new(
 )
 ```
 
+### Set HTTP Options
+
+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(
+  write_key: 'YOUR_WRITE_KEY',
+  http_options: {
+    open_timeout: 42,
+    read_timeout: 42,
+    close_on_empty_response: true,
+    # ...
+  }
+)
+```
+
 ## 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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'simple_segment'

data/lib/simple_segment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'json'
 require 'time'

data/lib/simple_segment/batch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleSegment
   class Batch
     include SimpleSegment::Utils

data/lib/simple_segment/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simple_segment/utils'
 require 'simple_segment/configuration'
 require 'simple_segment/operations'

data/lib/simple_segment/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simple_segment/logging'
 
 module SimpleSegment
@@ -5,7 +7,7 @@ module SimpleSegment
     include SimpleSegment::Utils
     include SimpleSegment::Logging
 
-    attr_reader :write_key, :on_error, :stub, :logger
+    attr_reader :write_key, :on_error, :stub, :logger, :http_options
 
     def initialize(settings = {})
       symbolized_settings = symbolize_keys(settings)
@@ -13,6 +15,8 @@ module SimpleSegment
       @on_error = symbolized_settings[:on_error] || proc {}
       @stub = symbolized_settings[:stub]
       @logger = default_logger(symbolized_settings[:logger])
+      @http_options = { use_ssl: true }
+                      .merge(symbolized_settings[:http_options] || {})
       raise ArgumentError, 'Missing required option :write_key' \
         unless @write_key
     end

data/lib/simple_segment/logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 module SimpleSegment
   module Logging
@@ -6,11 +8,7 @@ module SimpleSegment
     end
 
     def default_logger(logger_option)
-      if logger_option
-        logger_option
-      else
-        Logger.new STDOUT
-      end
+      logger_option || Logger.new(STDOUT)
     end
   end
 end

data/lib/simple_segment/operations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simple_segment/request'
 require 'simple_segment/operations/operation'
 require 'simple_segment/operations/identify'

data/lib/simple_segment/operations/alias.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleSegment
   module Operations
     class Alias < Operation

data/lib/simple_segment/operations/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleSegment
   module Operations
     class Group < Operation
@@ -10,7 +12,7 @@ module SimpleSegment
           unless options[:group_id]
 
         base_payload.merge(
-          traits: options[:traits],
+          traits: options[:traits] && isoify_dates!(options[:traits]),
           groupId: options[:group_id]
         )
       end

data/lib/simple_segment/operations/identify.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleSegment
   module Operations
     class Identify < Operation
@@ -7,7 +9,7 @@ module SimpleSegment
 
       def build_payload
         base_payload.merge(
-          traits: options[:traits]
+          traits: options[:traits] && isoify_dates!(options[:traits])
         )
       end
     end

data/lib/simple_segment/operations/operation.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module SimpleSegment
   module Operations
     class Operation
+      include SimpleSegment::Utils
+
       DEFAULT_CONTEXT = {
         library: {
           name: 'simple_segment',
@@ -8,10 +12,9 @@ module SimpleSegment
         }
       }.freeze
 
-      attr_reader :options, :request
-
       def initialize(client, options = {})
         @options = options
+        @context = DEFAULT_CONTEXT.merge(options[:context].to_h)
         @request = Request.new(client)
       end
 
@@ -21,6 +24,8 @@ module SimpleSegment
 
       private
 
+      attr_reader :options, :request, :context
+
       def base_payload
         check_identity!
         current_time = Time.now
@@ -28,7 +33,7 @@ module SimpleSegment
         {
           userId: options[:user_id],
           anonymousId: options[:anonymous_id],
-          context: DEFAULT_CONTEXT.merge(options[:context].to_h),
+          context: context,
           integrations: options[:integrations],
           timestamp: timestamp(options.fetch(:timestamp, current_time)),
           sentAt: current_time.iso8601

data/lib/simple_segment/operations/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleSegment
   module Operations
     class Page < Operation
@@ -6,9 +8,11 @@ module SimpleSegment
       end
 
       def build_payload
+        properties = options[:properties] && isoify_dates!(options[:properties])
+
         base_payload.merge(
           name: options[:name],
-          properties: options[:properties]
+          properties: properties
         )
       end
     end

data/lib/simple_segment/operations/track.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleSegment
   module Operations
     class Track < Operation
@@ -6,12 +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] || {}
 
         base_payload.merge(
           event: options[:event],
-          properties: options[:properties]
+          properties: isoify_dates!(properties)
         )
       end
     end

data/lib/simple_segment/request.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 module SimpleSegment
   class Request
-    BASE_URL = 'https://api.segment.io'.freeze
+    BASE_URL = 'https://api.segment.io'
     DEFAULT_HEADERS = {
       'Content-Type' => 'application/json',
       'accept' => 'application/json'
     }.freeze
 
-    attr_reader :write_key, :error_handler, :stub, :logger
+    attr_reader :write_key, :error_handler, :stub, :logger, :http_options
 
     def initialize(client)
       @write_key = client.config.write_key
       @error_handler = client.config.on_error
       @stub = client.config.stub
       @logger = client.config.logger
+      @http_options = client.config.http_options
     end
 
-    def post(path, payload, headers: DEFAULT_HEADERS)
+    def post(path, payload, headers: DEFAULT_HEADERS) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       response = nil
       status_code = nil
       response_body = nil
@@ -29,7 +32,7 @@ module SimpleSegment
 
         { status: 200, error: nil }
       else
-        Net::HTTP.start(uri.host, uri.port, use_ssl: true) 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleSegment
   module Utils
     def self.included(klass)
@@ -9,5 +11,33 @@ module SimpleSegment
         result[key.to_sym] = value
       end
     end
+
+    # public: Converts all the date values in the into iso8601 strings in place
+    #
+    def isoify_dates!(hash)
+      hash.replace isoify_dates hash
+    end
+
+    # public: Returns a new hash with all the date values in the into iso8601
+    #         strings
+    #
+    def isoify_dates(hash)
+      hash.each_with_object({}) do |(k, v), memo|
+        memo[k] = maybe_datetime_in_iso8601(v)
+      end
+    end
+
+    def maybe_datetime_in_iso8601(prop)
+      case prop
+      when Time
+        prop.iso8601(3)
+      when DateTime
+        prop.to_time.iso8601(3)
+      when Date
+        prop.strftime('%F')
+      else
+        prop
+      end
+    end
   end
 end

data/lib/simple_segment/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleSegment
-  VERSION = '0.2.1'.freeze
+  VERSION = '1.2.0'
 end

data/simple_segment.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'simple_segment/version'
 
@@ -19,11 +20,11 @@ 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 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '>= 1.11'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 1.24'
+  spec.add_development_dependency 'rubocop', '0.75.0'
   spec.add_development_dependency 'timecop', '~> 0.8.0'
-  spec.add_development_dependency 'rubocop', '~> 0.47.0'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'webmock', '~> 3.7'
 end

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: simple_segment
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Mikhail Topolskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2020-07-29 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
+  name: pry
+  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: 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
@@ -53,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: 0.75.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: 0.75.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -81,33 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.0
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.0
-- !ruby/object:Gem::Dependency
-  name: pry
-  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'
+        version: '3.7'
 description: SimpleSegment allows for manual control of when and how the events are
   sent to Segment.
 email:
@@ -121,6 +121,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -162,8 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple synchronous API client for segment.io.