simple_segment 0.1.0.pre → 0.1.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 894ef7cd8308bd97baa1ca0e58112a2977f9bef6
-  data.tar.gz: d1c3fd40058bf4dacf28e28db2489f791d85ae3d
+  metadata.gz: e5979b1b25f12af923da26348d23edba401da59d
+  data.tar.gz: 5e5fb48ad7401d4f940074d82f6588f4efea2b84
 SHA512:
-  metadata.gz: 40be6532c6e71cbc81adeae4bfd943b059b027310e4f7458cf9b8b4723a03f5317cb5c2ab0b74f187fadfe344536b066935ea0c8dded88e5210b1eb68e124aba
-  data.tar.gz: 3d13dd7218a30366db53054cffae79ff5895e93ff9e8c34ad5570abf1d0b51337b9d259beac4619d2744032f2f30b6a1cc841fbb77facd92a0e7672d30085a62
+  metadata.gz: 528412610b190fa09d3db9ddfb7401b69752e475d699229315d260538b774dc2a0449f52870fc0a5ed1dc75d232684c44076c406e2ca50e16c1207cbe49c6501
+  data.tar.gz: 0b7c89ab4123685489cf5dbd79bf3650ddb58c70b63c36fa754a762047172f8dd39def607f3e68a0417b7276d0015adf0c7b2214bd1b93cf4ecb5ea996db746b

data/README.md

@@ -1,7 +1,5 @@
 # SimpleSegment
 
-**Warning** The project is in development and is not ready for production use yet!
-
 [![Build Status](https://travis-ci.org/whatthewhat/simple_segment.svg?branch=master)](https://travis-ci.org/whatthewhat/simple_segment)
 
 A simple synchronous Ruby API client for [segment.io](segment.io).
@@ -18,15 +16,13 @@ SimpleSegment allows for manual control of when and how the events are sent to S
 - `analytics.page(...)`
 - `analytics.alias(...)`
 - `analytics.flush` (no op for backwards compatibility with the official gem)
+- Ability to manually batch events with `analytics.batch`
 
-### Planned
-
-- Ability to manually batch events, https://segment.com/docs/libraries/http/#import
-- Configurable network error handling
-- Configurable logging
+[List of planned features](https://github.com/whatthewhat/simple_segment/issues?q=is%3Aissue+is%3Aopen+label%3Afeature)
 
 The plan is to be an drop in replacement for the official gem, so all the APIs will stay the same whenever possible.
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -49,7 +45,10 @@ Create a client instance:
 
 ```ruby
 analytics = SimpleSegment::Client.new({
-  write_key: 'YOUR_WRITE_KEY'
+  write_key: 'YOUR_WRITE_KEY', # required
+  on_error: proc { |error_code, error_body, response, exception|
+    # defaults to an empty proc
+  }
 })
 ```
 
@@ -66,6 +65,21 @@ analytics.track(
 
 If you find inconsistencies with `analytics-ruby` feel free to file an issue.
 
+### Batching
+
+You can manually batch events with `analytics.batch`:
+
+```ruby
+analytics.batch do |batch|
+  batch.context = {...}       # shared context for all events
+  batch.integrations = {...}  # shared integrations hash for all events
+  batch.identify(...)
+  batch.track(...)
+  batch.track(...)
+  ...
+end
+```
+
 ## 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/bin/console

@@ -6,9 +6,5 @@ require "simple_segment"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/lib/simple_segment/batch.rb

@@ -0,0 +1,50 @@
+module SimpleSegment
+  class Batch
+    include SimpleSegment::Utils
+
+    attr_reader :config, :payload
+    attr_accessor :context, :integrations
+
+    def initialize(config)
+      @config = config
+      @payload = { batch: [] }
+      @context = {}
+      @integrations = {}
+    end
+
+    def identify(options)
+      add(Operations::Identify, options, __method__)
+    end
+
+    def track(options)
+      add(Operations::Track, options, __method__)
+    end
+
+    def page(options)
+      add(Operations::Page, options, __method__)
+    end
+
+    def group(options)
+      add(Operations::Group, options, __method__)
+    end
+
+    def commit
+      if payload[:batch].length == 0
+        raise ArgumentError, 'A batch must contain at least one action'
+      end
+      payload[:context] = context
+      payload[:integrations] = integrations
+
+      Request.new('/v1/import', config).post(payload)
+    end
+
+    private
+
+    def add(operation_class, options, action)
+      operation = operation_class.new(symbolize_keys(options), config)
+      operation_payload = operation.build_payload
+      operation_payload[:action] = action
+      payload[:batch] << operation_payload
+    end
+  end
+end

data/lib/simple_segment/client.rb

@@ -1,6 +1,7 @@
 require 'simple_segment/utils'
 require 'simple_segment/configuration'
 require 'simple_segment/operations'
+require 'simple_segment/batch'
 
 module SimpleSegment
   class Client
@@ -71,6 +72,12 @@ module SimpleSegment
       Operations::Alias.new(symbolize_keys(options), config).call
     end
 
+    def batch
+      batch = Batch.new(config)
+      yield(batch)
+      batch.commit
+    end
+
     # A no op, added for backwards compatibility with `analytics-ruby`
     def flush
     end

data/lib/simple_segment/configuration.rb

@@ -2,11 +2,12 @@ module SimpleSegment
   class Configuration
     include SimpleSegment::Utils
 
-    attr_reader :write_key
+    attr_reader :write_key, :on_error
 
     def initialize(settings = {})
       symbolized_settings = symbolize_keys(settings)
       @write_key = symbolized_settings[:write_key]
+      @on_error = symbolized_settings[:on_error] || proc {}
       raise ArgumentError, 'Missing required option :write_key' unless @write_key
     end
   end

data/lib/simple_segment/operations/alias.rb

@@ -5,8 +5,6 @@ module SimpleSegment
         Request.new('/v1/alias', config).post(build_payload)
       end
 
-      private
-
       def build_payload
         raise ArgumentError, 'previous_id must be present' unless options[:previous_id]
 

data/lib/simple_segment/operations/group.rb

@@ -5,8 +5,6 @@ module SimpleSegment
         Request.new('/v1/group', config).post(build_payload)
       end
 
-      private
-
       def build_payload
         raise ArgumentError, 'group_id must be present' unless options[:group_id]
 

data/lib/simple_segment/operations/identify.rb

@@ -5,8 +5,6 @@ module SimpleSegment
         Request.new('/v1/identify', config).post(build_payload)
       end
 
-      private
-
       def build_payload
         base_payload.merge({
           traits: options[:traits]

data/lib/simple_segment/operations/page.rb

@@ -5,8 +5,6 @@ module SimpleSegment
         Request.new('/v1/page', config).post(build_payload)
       end
 
-      private
-
       def build_payload
         base_payload.merge({
           name: options[:name],

data/lib/simple_segment/operations/track.rb

@@ -5,9 +5,7 @@ module SimpleSegment
         Request.new('/v1/track', config).post(build_payload)
       end
 
-      private
-
-      def build_payload(current_time = Time.now)
+      def build_payload
         raise ArgumentError, 'event name must be present' unless options[:event]
 
         base_payload.merge({

data/lib/simple_segment/request.rb

@@ -6,22 +6,31 @@ module SimpleSegment
       'accept' => 'application/json'
     }.freeze
 
-    attr_reader :path, :write_key
+    attr_reader :path, :write_key, :error_handler
 
     def initialize(path, config)
       @path = path
       @write_key = config.write_key
+      @error_handler = config.on_error
     end
 
     def post(payload, headers: DEFAULT_HEADERS)
+      response, status_code, response_body = nil, nil, nil
       uri = URI(BASE_URL)
+      payload = JSON.generate(payload)
+
       Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        payload = JSON.generate(payload)
         request = Net::HTTP::Post.new(path, headers)
         request.basic_auth write_key, nil
-
-        http.request(request, payload)
+        http.request(request, payload).tap { |res|
+          status_code = res.code
+          response_body = res.body
+          response = res
+          response.value
+        }
       end
+    rescue StandardError => e
+      error_handler.call(status_code, response_body, e, response)
     end
   end
 end

data/lib/simple_segment/version.rb

@@ -1,3 +1,3 @@
 module SimpleSegment
-  VERSION = '0.1.0.pre'
+  VERSION = '0.1.0.pre2'
 end

data/simple_segment.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 1.24"
   spec.add_development_dependency "timecop", "~> 0.8.0"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_segment
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0.pre2
 platform: ruby
 authors:
 - Mikhail Topolskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.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'
 description: SimpleSegment allows for manual control of when and how the events are
   sent to Segment.
 email:
@@ -98,6 +112,7 @@ files:
 - bin/console
 - bin/setup
 - lib/simple_segment.rb
+- lib/simple_segment/batch.rb
 - lib/simple_segment/client.rb
 - lib/simple_segment/configuration.rb
 - lib/simple_segment/operations.rb