simple_segment 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 894ef7cd8308bd97baa1ca0e58112a2977f9bef6
+  data.tar.gz: d1c3fd40058bf4dacf28e28db2489f791d85ae3d
+SHA512:
+  metadata.gz: 40be6532c6e71cbc81adeae4bfd943b059b027310e4f7458cf9b8b4723a03f5317cb5c2ab0b74f187fadfe344536b066935ea0c8dded88e5210b1eb68e124aba
+  data.tar.gz: 3d13dd7218a30366db53054cffae79ff5895e93ff9e8c34ad5570abf1d0b51337b9d259beac4619d2744032f2f30b6a1cc841fbb77facd92a0e7672d30085a62

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_segment.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mikhail Topolskiy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# 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).
+
+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.
+
+## Status
+
+### Implemented
+
+- `analytics.track(...)`
+- `analytics.identify(...)`
+- `analytics.group(...)`
+- `analytics.page(...)`
+- `analytics.alias(...)`
+- `analytics.flush` (no op for backwards compatibility with the official gem)
+
+### Planned
+
+- Ability to manually batch events, https://segment.com/docs/libraries/http/#import
+- Configurable network error handling
+- Configurable logging
+
+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:
+
+```ruby
+gem 'simple_segment'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_segment
+
+## Usage
+
+Create a client instance:
+
+```ruby
+analytics = SimpleSegment::Client.new({
+  write_key: 'YOUR_WRITE_KEY'
+})
+```
+
+Use it as you would use `analytics-ruby`:
+
+```ruby
+analytics.track(
+  {
+    user_id: user.id,
+    event: 'Created Account'
+  }
+)
+```
+
+If you find inconsistencies with `analytics-ruby` feel free to file an issue.
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_segment/client.rb

@@ -0,0 +1,78 @@
+require 'simple_segment/utils'
+require 'simple_segment/configuration'
+require 'simple_segment/operations'
+
+module SimpleSegment
+  class Client
+    include SimpleSegment::Utils
+
+    attr_reader :config
+
+    def initialize(options = {})
+      @config = Configuration.new(options)
+    end
+
+    # @param [Hash] options
+    # @option :user_id
+    # @option :anonymous_id
+    # @option :traits [Hash]
+    # @option :context [Hash]
+    # @option :integrations [Hash]
+    # @option :timestamp [#iso8601] (Time.now)
+    def identify(options)
+      Operations::Identify.new(symbolize_keys(options), config).call
+    end
+
+    # @param [Hash] options
+    # @option :event [String] required
+    # @option :user_id
+    # @option :anonymous_id
+    # @option :properties [Hash]
+    # @option :context [Hash]
+    # @option :integrations [Hash]
+    # @option :timestamp [#iso8601] (Time.now)
+    def track(options)
+      Operations::Track.new(symbolize_keys(options), config).call
+    end
+
+    # @param [Hash] options
+    # @option :user_id
+    # @option :anonymous_id
+    # @option :name [String]
+    # @option :properties [Hash]
+    # @option :context [Hash]
+    # @option :integrations [Hash]
+    # @option :timestamp [#iso8601] (Time.now)
+    def page(options)
+      Operations::Page.new(symbolize_keys(options), config).call
+    end
+
+    # @param [Hash] options
+    # @option :user_id
+    # @option :anonymous_id
+    # @option :group_id required
+    # @option :traits [Hash]
+    # @option :context [Hash]
+    # @option :integrations [Hash]
+    # @option :timestamp [#iso8601] (Time.now)
+    def group(options)
+      Operations::Group.new(symbolize_keys(options), config).call
+    end
+
+    # @param [Hash] options
+    # @option :user_id
+    # @option :anonymous_id
+    # @option :previous_id required
+    # @option :traits [Hash]
+    # @option :context [Hash]
+    # @option :integrations [Hash]
+    # @option :timestamp [#iso8601] (Time.now)
+    def alias(options)
+      Operations::Alias.new(symbolize_keys(options), config).call
+    end
+
+    # A no op, added for backwards compatibility with `analytics-ruby`
+    def flush
+    end
+  end
+end

data/lib/simple_segment/configuration.rb

@@ -0,0 +1,13 @@
+module SimpleSegment
+  class Configuration
+    include SimpleSegment::Utils
+
+    attr_reader :write_key
+
+    def initialize(settings = {})
+      symbolized_settings = symbolize_keys(settings)
+      @write_key = symbolized_settings[:write_key]
+      raise ArgumentError, 'Missing required option :write_key' unless @write_key
+    end
+  end
+end

data/lib/simple_segment/operations/alias.rb

@@ -0,0 +1,19 @@
+module SimpleSegment
+  module Operations
+    class Alias < Operation
+      def call
+        Request.new('/v1/alias', config).post(build_payload)
+      end
+
+      private
+
+      def build_payload
+        raise ArgumentError, 'previous_id must be present' unless options[:previous_id]
+
+        base_payload.merge({
+          previousId: options[:previous_id]
+        })
+      end
+    end
+  end
+end

data/lib/simple_segment/operations/group.rb

@@ -0,0 +1,20 @@
+module SimpleSegment
+  module Operations
+    class Group < Operation
+      def call
+        Request.new('/v1/group', config).post(build_payload)
+      end
+
+      private
+
+      def build_payload
+        raise ArgumentError, 'group_id must be present' unless options[:group_id]
+
+        base_payload.merge({
+          traits: options[:traits],
+          groupId: options[:group_id]
+        })
+      end
+    end
+  end
+end

data/lib/simple_segment/operations/identify.rb

@@ -0,0 +1,17 @@
+module SimpleSegment
+  module Operations
+    class Identify < Operation
+      def call
+        Request.new('/v1/identify', config).post(build_payload)
+      end
+
+      private
+
+      def build_payload
+        base_payload.merge({
+          traits: options[:traits]
+        })
+      end
+    end
+  end
+end

data/lib/simple_segment/operations/operation.rb

@@ -0,0 +1,45 @@
+module SimpleSegment
+  module Operations
+    class Operation
+      DEFAULT_CONTEXT = {
+        library: {
+          name: 'simple_segment',
+          version: SimpleSegment::VERSION
+        }
+      }.freeze
+
+      attr_reader :options, :config
+
+      def initialize(options = {}, config)
+        @options = options
+        @config = config
+      end
+
+      def call
+        raise 'Must be implemented in a subclass'
+      end
+
+      private
+
+      def base_payload
+        check_identity!
+        current_time = Time.now
+
+        {
+          userId: options[:user_id],
+          anonymousId: options[:anonymous_id],
+          context: DEFAULT_CONTEXT.merge(options[:context].to_h),
+          integrations: options[:integrations],
+          timestamp: options.fetch(:timestamp, current_time).iso8601,
+          sentAt: current_time.iso8601
+        }
+      end
+
+      def check_identity!
+        unless options[:user_id] || options[:anonymous_id]
+          raise ArgumentError, 'user_id or anonymous_id must be present'
+        end
+      end
+    end
+  end
+end

data/lib/simple_segment/operations/page.rb

@@ -0,0 +1,18 @@
+module SimpleSegment
+  module Operations
+    class Page < Operation
+      def call
+        Request.new('/v1/page', config).post(build_payload)
+      end
+
+      private
+
+      def build_payload
+        base_payload.merge({
+          name: options[:name],
+          properties: options[:properties]
+        })
+      end
+    end
+  end
+end

data/lib/simple_segment/operations/track.rb

@@ -0,0 +1,20 @@
+module SimpleSegment
+  module Operations
+    class Track < Operation
+      def call
+        Request.new('/v1/track', config).post(build_payload)
+      end
+
+      private
+
+      def build_payload(current_time = Time.now)
+        raise ArgumentError, 'event name must be present' unless options[:event]
+
+        base_payload.merge({
+          event: options[:event],
+          properties: options[:properties]
+        })
+      end
+    end
+  end
+end

data/lib/simple_segment/operations.rb

@@ -0,0 +1,12 @@
+require 'simple_segment/request'
+require 'simple_segment/operations/operation'
+require 'simple_segment/operations/identify'
+require 'simple_segment/operations/track'
+require 'simple_segment/operations/page'
+require 'simple_segment/operations/group'
+require 'simple_segment/operations/alias'
+
+module SimpleSegment
+  module Operations
+  end
+end

data/lib/simple_segment/request.rb

@@ -0,0 +1,27 @@
+module SimpleSegment
+  class Request
+    BASE_URL = 'https://api.segment.io'.freeze
+    DEFAULT_HEADERS = {
+      'Content-Type' => 'application/json',
+      'accept' => 'application/json'
+    }.freeze
+
+    attr_reader :path, :write_key
+
+    def initialize(path, config)
+      @path = path
+      @write_key = config.write_key
+    end
+
+    def post(payload, headers: DEFAULT_HEADERS)
+      uri = URI(BASE_URL)
+      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)
+      end
+    end
+  end
+end

data/lib/simple_segment/utils.rb

@@ -0,0 +1,9 @@
+module SimpleSegment
+  module Utils
+    def symbolize_keys(hash)
+      hash.each_with_object({}) { |(key, value), result|
+        result[key.to_sym] = value
+      }
+    end
+  end
+end

data/lib/simple_segment/version.rb

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

data/lib/simple_segment.rb

@@ -0,0 +1,7 @@
+require 'net/http'
+require 'json'
+require 'simple_segment/version'
+require 'simple_segment/client'
+
+module SimpleSegment
+end

data/simple_segment.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_segment/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_segment"
+  spec.version       = SimpleSegment::VERSION
+  spec.authors       = ["Mikhail Topolskiy"]
+  spec.email         = ["mikhail.topolskiy@gmail.com"]
+
+  spec.summary       = %q{A simple synchronous API client for segment.io.}
+  spec.description   = %q{SimpleSegment allows for manual control of when and how the events are sent to Segment.}
+  spec.homepage      = "https://github.com/whatthewhat/simple_segment"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.24"
+  spec.add_development_dependency "timecop", "~> 0.8.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: simple_segment
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Mikhail Topolskiy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-24 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: 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
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: SimpleSegment allows for manual control of when and how the events are
+  sent to Segment.
+email:
+- mikhail.topolskiy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_segment.rb
+- lib/simple_segment/client.rb
+- lib/simple_segment/configuration.rb
+- lib/simple_segment/operations.rb
+- lib/simple_segment/operations/alias.rb
+- lib/simple_segment/operations/group.rb
+- lib/simple_segment/operations/identify.rb
+- lib/simple_segment/operations/operation.rb
+- lib/simple_segment/operations/page.rb
+- lib/simple_segment/operations/track.rb
+- lib/simple_segment/request.rb
+- lib/simple_segment/utils.rb
+- lib/simple_segment/version.rb
+- simple_segment.gemspec
+homepage: https://github.com/whatthewhat/simple_segment
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+signing_key: 
+specification_version: 4
+summary: A simple synchronous API client for segment.io.
+test_files: []