snowly 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: 8363b19687de0fa4f4812b7a6209a2caf414149e
-  data.tar.gz: e9b6a30be212eb0f42196f696dc10a6013cad6b0
+  metadata.gz: 0dd1955dfdfa77ea8fb0cadd08bbe0f0c3659cbe
+  data.tar.gz: de6db92338bf7b3837ad94bf32db4a0c51505522
 SHA512:
-  metadata.gz: 0e713e4e7f804f8cf715730a9c157cfb4bf6493f019f59658e83752af4fc0d029af70087d8368d59d1c34b6b72757fd1c57d00f6c898d3f54edca56489edbe37
-  data.tar.gz: 71423a4271c014abdecd4f4e146cf5a8aaa338a482fd417386dd5a1424e150aa512fee2b113544868d3b9fe582bf35d4380b206b427d7d12b4febc379efc95ed
+  metadata.gz: f4bbfaf664d3f1442f21cc90f4ce50fbaf6886b8dec6f7a782802ed07844395c8230e43536ee7e8f54c4442a1078b686d969cf03e6e8a09b7564ec4967b69883
+  data.tar.gz: bc163eaf001af257dec0693e140d599dd88013724165510f93e8609fa7c2e1fd27165f66ab9469275c6093cceea48db45c4d1ead5ffebd098f6d18a570a0f3cf

data/README.md

@@ -2,11 +2,11 @@
 
 Debug your Snowplow implementation locally, without resorting to Snowplow's ETL tasks. It's like Facebook's URL Linter, but for Snowplow.
 
-Snowly is a minimal [Collector](https://github.com/snowplow/snowplow/wiki/Setting-up-a-collector) implementation intended to run on your  development environment. It comes with a comprehensive validation engine, that will point out any schema requirement violations. You can easily validate your event requests before having to emmit them to a cloudfront, closure or scala collector.
+Snowly is a minimal [Collector](https://github.com/snowplow/snowplow/wiki/Setting-up-a-collector) implementation intended to run on your  development environment. It comes with a comprehensive validation engine, that will point out any schema requirement violations. You can easily validate your event requests before having to emit them to a cloudfront, closure or scala collector.
 
 ### Motivation
 
-Snowplow has an excellent toolset, but the first implementation stages can be hard. To run Snowplow properly you have to set up a lot of external dependencies like AWS permissions, Cloudfront distributions and EMR jobs. If you're tweaking the snowplow model to fit your needs or using trackers that don't enforce every requirement, you'll find yourself waiting for the ETL jobs to run in order to validate every implementation change. __[update] This has changed a quite a bit with Snowplow Mini's release. It's a lot easier to get started, but Snowly is still valuable as a first step and debug tool.__
+Snowplow has an excellent toolset, but the first implementation stages can be hard. To run Snowplow properly you have to set up a lot of external dependencies like AWS permissions, Cloudfront distributions and EMR jobs. If you're tweaking the snowplow model to fit your needs or using trackers that don't enforce every requirement, you'll find yourself waiting for the ETL jobs to run in order to validate every implementation change.
 
 ### Who will get the most from Snowly
 
@@ -22,7 +22,7 @@ Use cases:
 
 - Validate custom contexts or unstructured event types and required fields.
 - Restrict values for any field, like using a custom dictionary for the structured event action field.
-- Define requirements based on the content of another field: If __event action__ is 'viewed_product', __event property__ is required.
+- Define requirements based on the content of another field: If __event action__ is 'viewed_product', then __event property__ is required.
 
 ## Installation
 
@@ -63,32 +63,15 @@ touch ~/schemas/com.my_company/viewed_product/jsonschema/1-0-0
 
 ## Usage
 
-Just use `snowly` to start and `snowly -K` to stop. Where allowed, a browser window will open showing the collector's address.
-
-Other options:
-
-    -K, --kill               kill the running process and exit
-    -S, --status             display the current running PID and URL then quit
-    -s, --server SERVER      serve using SERVER (thin/mongrel/webrick)
-    -o, --host HOST          listen on HOST (default: 0.0.0.0)
-    -p, --port PORT          use PORT (default: 5678)
-    -x, --no-proxy           ignore env proxy settings (e.g. http_proxy)
-    -e, --env ENVIRONMENT    use ENVIRONMENT for defaults (default: development)
-    -F, --foreground         don't daemonize, run in the foreground
-    -L, --no-launch          don't launch the browser
-    -d, --debug              raise the log level to :debug (default: :info)
-        --app-dir APP_DIR    set the app dir where files are stored (default: ~/.vegas/collector)/)
-    -P, --pid-file PID_FILE  set the path to the pid file (default: app_dir/collector.pid)
-        --log-file LOG_FILE  set the path to the log file (default: app_dir/collector.log)
-        --url-file URL_FILE  set the path to the URL file (default: app_dir/collector.url)
+Just use `snowly` to start and `snowly -K` to stop. Where allowed, a browser window will open showing the collector's address. Use `snowly --help` for other options.
 
 ### Output
 
 When Snowly finds something wrong, it renders a parsed array of requests along with its errors.
 
-If everything is ok, Snowly delivers the default Snowplow pixel, unless you're using the debug mode. In debug mode it always renders the parsed contents of your requests.
+When everything is ok, Snowly delivers the default Snowplow pixel, unless you're using the debug mode.
 
-If you can't investigate the request's response, you can start Snowly in the foreground and in Debug Mode to output the response to STDOUT.
+If you can't investigate the request's response, you can start Snowly in the foreground and in __Debug Mode__ to output the response to __STDOUT__.
 `snowly -d -F`
 
 Example: 
@@ -116,6 +99,8 @@ Example:
 
 If you're using the closure collector and can't see your requests firing up right away, try [manually flushing](https://github.com/snowplow/snowplow/wiki/Ruby-Tracker#54-manual-flushing) or change your emitter's buffer_size(number of events before flusing) to a lower value.
 
+In debug mode Snowly always renders the parsed contents of your requests. If you're using the javascript tracker, use the __post__ option to be able to read the response in your browser inspector. The js tracker implementation for __get__ requests works by changing an image src, so the inspector hides the response.
+
 ## JSON Schemas
 
 JSON Schema is a powerful tool for validating the structure of JSON data. I recommend reading this excellent [Guide](http://spacetelescope.github.io/understanding-json-schema/) from Michael Droettboom to understand all of its capabilities, but you can start with the examples bellow.

data/lib/snowly/version.rb

@@ -1,3 +1,3 @@
 module Snowly
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/snowly.gemspec

@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'sinatra-contrib', '~> 1.4'
   spec.add_dependency 'vegas', '~> 0.1'
   spec.add_dependency 'thin', '~> 1.7'
+  spec.add_dependency 'pry-byebug', '~> 3.3'
 
   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 'pry-byebug', '~> 3.3'
   spec.add_development_dependency 'snowplow-tracker', '~> 0.5'
   spec.add_development_dependency 'webmock', '~> 2.0'
   spec.add_development_dependency "shotgun", '~> 0.9'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snowly
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Alexandre Angelim
@@ -109,61 +109,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
+        version: '3.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: snowplow-tracker
   requirement: !ruby/object:Gem::Requirement