rudder_analytics_sync 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1992d97fc7c09e8c134890807c8c97363720bc4
-  data.tar.gz: 4f93faaa6fe432090f8c72f4752dca1c83b34406
+  metadata.gz: 3c6c66facc1d6ffdce7cf7f8e4e53988fb8ffa19
+  data.tar.gz: e6c5773b8adfa4a776baaa2022bb251ae22c1c7b
 SHA512:
-  metadata.gz: 8c14cef3115c7e2c4c003e1b283dd2860f1c707277d10cd4867b33b16dc114d46bb21ec8ea4f1b179c7ab6477ff45d9af713d11714cd441bf3191e7b9adf7883
-  data.tar.gz: b6cfa19c816fe004edc4a6d9877e7f560382b5ab09843cab65d363983805609d8749cb044d4ff3ea17d54caea62fad4952d7d999af9b1b070cf33c346855353f
+  metadata.gz: 071df6c5a1c30d11960bbfb05da4a58d1eb804349f7eecf61450caaea2ff4ca562e1eb88ecaa1a49f14c6a8e312349c16ef4d02e10de29c2a72bc0cb7802fd10
+  data.tar.gz: 40cdc7f1990658b6b601ebcdecf4e77ab238e1394cdaa525747f5847c115e7b871c553c77fe668ed71db89be1ed14f2e7c2fc88386d3fa751e08982f4fa19aa3

data/.gitignore

@@ -1,11 +1,9 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-*.gem
-.rbenv-gemsets
+Gemfile.lock

data/README.md

@@ -1,38 +1,25 @@
-# RudderAnalyticsSync
+# What is Rudder?
 
-[![Build Status](https://travis-ci.org/whatthewhat/simple_segment.svg?branch=master)](https://travis-ci.org/whatthewhat/simple_segment)
+**Short answer:** 
+Rudder is an open-source Segment alternative written in Go, built for the enterprise. .
 
-A simple synchronous Ruby API client for [segment.io](segment.io).
+**Long answer:** 
+Rudder is a platform for collecting, storing and routing customer event data to dozens of tools. Rudder is open-source, can run in your cloud environment (AWS, GCP, Azure or even your data-centre) and provides a powerful transformation framework to process your event data on the fly.
 
-RudderAnalyticsSync 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.
-
-## Status
-
-The gem supports all existing functionality of analytics-ruby:
-
-- `analytics.track(...)`
-- `analytics.identify(...)`
-- `analytics.group(...)`
-- `analytics.page(...)`
-- `analytics.alias(...)`
-- `analytics.flush` (no op for backwards compatibility with the official gem)
-
-In addition it offers the ability to manually batch events with [analytics.batch](#batching).
-
-The plan is to be an drop in replacement for the official gem, so if you find inconsistencies with `analytics-ruby` feel free to file an issue.
+Released under [MIT License 2.0](https://opensource.org/licenses/MIT)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'simple_segment'
+gem 'rudder_analytics_sync'
 ```
 
 Or install it yourself as:
 
 ```sh
-$ gem install simple_segment
+$ gem install rudder_analytics_sync
 ```
 
 ## Usage
@@ -41,7 +28,8 @@ Create a client instance:
 
 ```ruby
 analytics = RudderAnalyticsSync::Client.new(
-  write_key: 'YOUR_WRITE_KEY', # required
+  write_key: <YOUR_WRITE_KEY>, # required
+  data_plane_url: <DATA_PLANE_URL>
   on_error: proc { |error_code, error_body, exception, response|
     # defaults to an empty proc
   }
@@ -72,54 +60,5 @@ analytics.batch do |batch|
 end
 ```
 
-### Stub API calls
-
-You can stub your API calls avoiding unecessary requests in development and automated test environments (backwards compatible with the official gem):
-
-```ruby
-analytics = RudderAnalyticsSync::Client.new(
-  write_key: 'YOUR_WRITE_KEY',
-  stub: true
-)
-```
-
-### Configurable Logger
-
-When used in stubbed mode all calls are logged to STDOUT, this can be changed by providing a custom logger object:
-
-```ruby
-analytics = RudderAnalyticsSync::Client.new(
-  write_key: 'YOUR_WRITE_KEY',
-  logger: Rails.logger
-)
-```
-
-### 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 = RudderAnalyticsSync::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.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/whatthewhat/simple_segment.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+## Contact Us
+If you come across any issues while configuring or using RudderStack, please feel free to [contact us](https://rudderstack.com/contact/) or start a conversation on our [Discord](https://discordapp.com/invite/xNEdEGw) channel. We will be happy to help you.

data/example/example.rb

@@ -5,6 +5,7 @@ include RudderAnalyticsSync
 analytics = RudderAnalyticsSync::Client.new(
   write_key: '1aJDXU7xlQpUp6qW1ppTJTvkgSi', # required
   data_plane_url: 'https://86143ed0.ngrok.io',
+  stub: true,
   on_error: proc { |error_code, error_body, exception, response|
     # defaults to an empty proc
   }
@@ -16,29 +17,37 @@ analytics = RudderAnalyticsSync::Client.new(
 # )
 
 analytics.batch do |batch|
-  batch.track(
-    user_id: 'test_user_id',
-    event: 'Created Account'
-  )
-  batch.page(
-    user_id: 'test_user_id',
-    name: 'Created Account',
-    properties: {
-      k1: 'v1'
-    }
-  )
-  batch.track(
-    user_id: 'test_user_id',
-    event: 'Closed Account'
-  )
-  batch.identify(
-    user_id: 'test_user_id_1',
-    traits: {
-      name: 'test'
-    }
-  )
-  batch.group(
-    user_id: 'test_user_id',
-    group_id: 'group_id'
-  )
+  batch.context = { source: "test"}
+  batch.integrations = { All: false, S3: true }
+  batch.track({ event: "test" })
+  batch.identify({ user_id: "test" })
+  batch.screen({ user_id: "test", name: 'test'})
+  batch.page({ user_id: "test", name: 'test'})
+  batch.alias({ user_id: "test", previous_id: 'test'})
+  batch.group({ group_id: "test" })
+  # batch.track(
+  #   user_id: 'test_user_id',
+  #   event: 'Created Account'
+  # )
+  # batch.page(
+  #   user_id: 'test_user_id',
+  #   name: 'Created Account',
+  #   properties: {
+  #     k1: 'v1'
+  #   }
+  # )
+  # batch.track(
+  #   user_id: 'test_user_id',
+  #   event: 'Closed Account'
+  # )
+  # batch.identify(
+  #   user_id: 'test_user_id_1',
+  #   traits: {
+  #     name: 'test'
+  #   }
+  # )
+  # batch.group(
+  #   user_id: 'test_user_id',
+  #   group_id: 'group_id'
+  # )
 end

data/lib/rudder_analytics_sync/batch.rb

@@ -27,10 +27,18 @@ module RudderAnalyticsSync
       add(Operations::Page, options, __method__)
     end
 
+    def screen(options)
+      add(Operations::Screen, options, __method__)
+    end
+
     def group(options)
       add(Operations::Group, options, __method__)
     end
 
+    def alias(options)
+      add(Operations::Alias, options, __method__)
+    end
+
     def context=(context)
       payload[:context] = context
     end
@@ -56,6 +64,8 @@ module RudderAnalyticsSync
     def add(operation_class, options, action)
       operation = operation_class.new(client, symbolize_keys(options))
       operation_payload = operation.build_payload
+      operation_payload[:context] = operation_payload[:context].merge(payload[:context] || {})
+      operation_payload[:integrations] = payload[:integrations] || operation_payload[:integrations]
       operation_payload[:type] = action
       payload[:batch] << operation_payload
     end

data/lib/rudder_analytics_sync/operations/identify.rb

@@ -8,10 +8,13 @@ module RudderAnalyticsSync
       end
 
       def build_payload
+        raise ArgumentError, 'user_id must be present' \
+          unless options[:user_id]
+
         merged_payload = base_payload.merge(
           traits: options[:traits] && isoify_dates!(options[:traits])
         )
-        merged_payload[:context][:traits] = merged_payload[:context][:traits].merge(options[:traits])
+        merged_payload[:context][:traits] = merged_payload[:context][:traits].merge(options[:traits] || {})
         merged_payload
       end
     end

data/lib/rudder_analytics_sync/operations/operation.rb

@@ -32,31 +32,39 @@ module RudderAnalyticsSync
       attr_reader :options, :request, :context
 
       def base_payload
-        check_identity!
+        # check_identity!
         current_time = Time.now.utc
 
         anonymous_id = options[:anonymous_id] || uid()
+        user_id = options[:user_id]
         context[:traits] = (context[:traits] || {}) && {
           anonymousId: anonymous_id,
-          userId: options[:user_id] 
         }
 
-        {
-          userId: options[:user_id],
+        if (user_id) 
+          context[:traits] = context[:traits].merge({userId: user_id})
+        end
+
+        payload = {
           anonymousId: anonymous_id,
           context: context,
-          integrations: options[:integrations] || {All: true},
+          integrations: options[:integrations] || { All: true },
           timestamp: maybe_datetime_in_iso8601(options[:timestamp] || Time.now.utc),
           sentAt: maybe_datetime_in_iso8601(current_time),
           messageId: uid(),
           properties: options[:properties] || {}
         }
-      end
 
-      def check_identity!
-        raise ArgumentError, 'user_id or anonymous_id must be present' \
-          unless options[:user_id] || options[:anonymous_id]
+        if (user_id)
+          payload = payload.merge({userId: user_id})
+        end
+        payload
       end
+
+      # def check_identity!
+      #   raise ArgumentError, 'user_id or anonymous_id must be present' \
+      #     unless options[:user_id] || options[:anonymous_id]
+      # end
     end
   end
 end

data/lib/rudder_analytics_sync/operations/page.rb

@@ -8,11 +8,12 @@ module RudderAnalyticsSync
       end
 
       def build_payload
-        properties = options[:properties] && isoify_dates!(options[:properties])
+        properties = (options[:properties] && isoify_dates!(options[:properties])) || {}
 
         base_payload.merge(
           name: options[:name],
-          properties: properties || {}
+          event: options[:name],
+          properties: properties.merge({ name: options[:name] })
         )
       end
     end

data/lib/rudder_analytics_sync/operations/screen.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RudderAnalyticsSync
+  module Operations
+    class Screen < Operation
+      def call
+        request.post('/v1/screen', build_payload)
+      end
+
+      def build_payload
+        properties = (options[:properties] && isoify_dates!(options[:properties])) || {}
+
+        base_payload.merge(
+          name: options[:name],
+          event: options[:name],
+          properties: properties.merge({name: options[:name]})
+        )
+      end
+    end
+  end
+end

data/lib/rudder_analytics_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RudderAnalyticsSync
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rudder_analytics_sync
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - RudderStack
@@ -142,6 +142,7 @@ files:
 - lib/rudder_analytics_sync/operations/identify.rb
 - lib/rudder_analytics_sync/operations/operation.rb
 - lib/rudder_analytics_sync/operations/page.rb
+- lib/rudder_analytics_sync/operations/screen.rb
 - lib/rudder_analytics_sync/operations/track.rb
 - lib/rudder_analytics_sync/request.rb
 - lib/rudder_analytics_sync/utils.rb