simple_segment 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00dfcaba81c53815a6cc8f837b9fe8e8a832abb7
-  data.tar.gz: 7c2f9c23df74413679b4dce401d7f0f8d1cfb2a6
+  metadata.gz: fcf149ce05352ac16b248268daee8b2ec22256b9
+  data.tar.gz: 3ca99ff617ebe0e2d88afb594ba6036d8ef7f813
 SHA512:
-  metadata.gz: 46211a605c9107ff3b960278c3d10227e0cf1388c25a4ad10551709cc7e88a3ab04bd559c4c9a04e840cde5e943c8d1423511bbc557cdd41469b3467b0892243
-  data.tar.gz: 5015cffb0a7100bba692ae9023bc083c49dcd7993c4b41ee1cbdccdba7a515f32d9eb4b6ec88530535eeca71ba29f6eb29fdfef69886c5f1cd51cbf061b6c7db
+  metadata.gz: 757e1a05e10fa4698041b2dd0ac2ca704e3cb65838350378116cd88b1831ada96c23864d51d502149b44b71873f80b1caba5b4b116220f95fce71251a116b308
+  data.tar.gz: 7a657b9e44f601081cfc372b52e5721508fcc15afb1b063f944122caa5e9f7732b35b5074cdb88697e9f710e9cf63ab75097dfce4730124498ae4813e81f1817

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.gem
+.rbenv-gemsets

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Metrics/BlockLength:
+  Exclude:
+    - '**/*_spec.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'simple_segment.gemspec'
+
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -8,7 +8,7 @@ SimpleSegment allows for manual control of when and how the events are sent to S
 
 ## Status
 
-### Implemented
+The gem supports all existing functionality of analytics-ruby:
 
 - `analytics.track(...)`
 - `analytics.identify(...)`
@@ -16,12 +16,10 @@ 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`
 
-[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.
+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.
 
 ## Installation
 
@@ -55,16 +53,12 @@ analytics = SimpleSegment::Client.new({
 Use it as you would use `analytics-ruby`:
 
 ```ruby
-analytics.track(
-  {
-    user_id: user.id,
-    event: 'Created Account'
-  }
-)
+analytics.track({
+  user_id: user.id,
+  event: 'Created Account'
+})
 ```
 
-If you find inconsistencies with `analytics-ruby` feel free to file an issue.
-
 ### Batching
 
 You can manually batch events with `analytics.batch`:
@@ -80,6 +74,27 @@ 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 = SimpleSegment::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 = SimpleSegment::Client.new(
+  write_key: 'YOUR_WRITE_KEY',
+  logger: Rails.logger
+)
+```
+
 ## 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,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "simple_segment"
+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.
 
-require "pry"
+require 'pry'
 Pry.start

data/lib/simple_segment/batch.rb

@@ -42,7 +42,7 @@ module SimpleSegment
     end
 
     def commit
-      if payload[:batch].length == 0
+      if payload[:batch].length.zero?
         raise ArgumentError, 'A batch must contain at least one action'
       end
 

data/lib/simple_segment/client.rb

@@ -88,7 +88,6 @@ module SimpleSegment
     end
 
     # A no op, added for backwards compatibility with `analytics-ruby`
-    def flush
-    end
+    def flush; end
   end
 end

data/lib/simple_segment/configuration.rb

@@ -1,14 +1,20 @@
+require 'simple_segment/logging'
+
 module SimpleSegment
   class Configuration
     include SimpleSegment::Utils
+    include SimpleSegment::Logging
 
-    attr_reader :write_key, :on_error
+    attr_reader :write_key, :on_error, :stub, :logger
 
     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
+      @stub = symbolized_settings[:stub]
+      @logger = default_logger(symbolized_settings[:logger])
+      raise ArgumentError, 'Missing required option :write_key' \
+        unless @write_key
     end
   end
 end

data/lib/simple_segment/logging.rb

@@ -0,0 +1,16 @@
+require 'logger'
+module SimpleSegment
+  module Logging
+    def self.included(klass)
+      klass.extend(self)
+    end
+
+    def default_logger(logger_option)
+      if logger_option
+        logger_option
+      else
+        Logger.new STDOUT
+      end
+    end
+  end
+end

data/lib/simple_segment/operations/alias.rb

@@ -6,11 +6,12 @@ module SimpleSegment
       end
 
       def build_payload
-        raise ArgumentError, 'previous_id must be present' unless options[:previous_id]
+        raise ArgumentError, 'previous_id must be present' \
+          unless options[:previous_id]
 
-        base_payload.merge({
+        base_payload.merge(
           previousId: options[:previous_id]
-        })
+        )
       end
     end
   end

data/lib/simple_segment/operations/group.rb

@@ -6,12 +6,13 @@ module SimpleSegment
       end
 
       def build_payload
-        raise ArgumentError, 'group_id must be present' unless options[:group_id]
+        raise ArgumentError, 'group_id must be present' \
+          unless options[:group_id]
 
-        base_payload.merge({
+        base_payload.merge(
           traits: options[:traits],
           groupId: options[:group_id]
-        })
+        )
       end
     end
   end

data/lib/simple_segment/operations/identify.rb

@@ -6,9 +6,9 @@ module SimpleSegment
       end
 
       def build_payload
-        base_payload.merge({
+        base_payload.merge(
           traits: options[:traits]
-        })
+        )
       end
     end
   end

data/lib/simple_segment/operations/operation.rb

@@ -36,9 +36,8 @@ module SimpleSegment
       end
 
       def check_identity!
-        unless options[:user_id] || options[:anonymous_id]
-          raise ArgumentError, 'user_id or anonymous_id must be present'
-        end
+        raise ArgumentError, 'user_id or anonymous_id must be present' \
+          unless options[:user_id] || options[:anonymous_id]
       end
 
       def timestamp(timestamp)

data/lib/simple_segment/operations/page.rb

@@ -6,10 +6,10 @@ module SimpleSegment
       end
 
       def build_payload
-        base_payload.merge({
+        base_payload.merge(
           name: options[:name],
           properties: options[:properties]
-        })
+        )
       end
     end
   end

data/lib/simple_segment/operations/track.rb

@@ -6,12 +6,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]
 
-        base_payload.merge({
+        base_payload.merge(
           event: options[:event],
           properties: options[:properties]
-        })
+        )
       end
     end
   end

data/lib/simple_segment/request.rb

@@ -6,27 +6,39 @@ module SimpleSegment
       'accept' => 'application/json'
     }.freeze
 
-    attr_reader :write_key, :error_handler
+    attr_reader :write_key, :error_handler, :stub, :logger
 
     def initialize(client)
       @write_key = client.config.write_key
       @error_handler = client.config.on_error
+      @stub = client.config.stub
+      @logger = client.config.logger
     end
 
     def post(path, payload, headers: DEFAULT_HEADERS)
-      response, status_code, response_body = nil, nil, nil
+      response = nil
+      status_code = nil
+      response_body = nil
+
       uri = URI(BASE_URL)
       payload = JSON.generate(payload)
+      if stub
+        logger.debug "stubbed request to \
+        #{path}: write key = #{write_key}, \
+        payload = #{payload}"
 
-      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        request = Net::HTTP::Post.new(path, headers)
-        request.basic_auth write_key, nil
-        http.request(request, payload).tap { |res|
-          status_code = res.code
-          response_body = res.body
-          response = res
-          response.value
-        }
+        { status: 200, error: nil }
+      else
+        Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+          request = Net::HTTP::Post.new(path, headers)
+          request.basic_auth write_key, nil
+          http.request(request, payload).tap do |res|
+            status_code = res.code
+            response_body = res.body
+            response = res
+            response.value
+          end
+        end
       end
     rescue StandardError => e
       error_handler.call(status_code, response_body, e, response)

data/lib/simple_segment/utils.rb

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

data/lib/simple_segment/version.rb

@@ -1,3 +1,3 @@
 module SimpleSegment
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'.freeze
 end

data/simple_segment.gemspec

@@ -4,25 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'simple_segment/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "simple_segment"
+  spec.name          = 'simple_segment'
   spec.version       = SimpleSegment::VERSION
-  spec.authors       = ["Mikhail Topolskiy"]
-  spec.email         = ["mikhail.topolskiy@gmail.com"]
+  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.summary       = 'A simple synchronous API client for segment.io.'
+  spec.description   = '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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  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"
-  spec.add_development_dependency "pry"
+  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'
+  spec.add_development_dependency 'rubocop', '~> 0.47.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.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Mikhail Topolskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-10 00:00:00.000000000 Z
+date: 2017-03-07 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.0
+  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
@@ -103,7 +117,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -115,6 +131,7 @@ files:
 - lib/simple_segment/batch.rb
 - lib/simple_segment/client.rb
 - lib/simple_segment/configuration.rb
+- lib/simple_segment/logging.rb
 - lib/simple_segment/operations.rb
 - lib/simple_segment/operations/alias.rb
 - lib/simple_segment/operations/group.rb
@@ -146,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A simple synchronous API client for segment.io.