snowly 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: d173fa98485fdac15319ceb8c82e13e217a71e01
-  data.tar.gz: 29b7b391be367f4cdc8ade831fc115aef27eed59
+  metadata.gz: ec039a35fbadcbad31e696a39fe787f180e840bf
+  data.tar.gz: 54ad9ca4c16d3f98bed4a165c9122d3acf086c14
 SHA512:
-  metadata.gz: baaa31a93be34a90f0ee857b8fe54c83d0f07e4bfbf07c205ed050d461a411dd99e35d455498ae620ad7077225731b9a01b1275ecf4a86fb955fa04b48524736
-  data.tar.gz: 7c76ad98a44bbe6da61bc4b3d9dd5eab1ecf38b36a557bdac76980990c24d6dd818e63f57b05652a40ecbc977b07e8da96541651142b1f135dc8dff317ee0477
+  metadata.gz: 4e38417f1b759774c5f842fb4c3747cc4377f2ac3ebed499c8799d532a29e37ff565b1093ce2497990256f75a5aac578561c7e9f8048d619a20d0cf2a37b7942
+  data.tar.gz: 9bd5e3d86e4d3214356c5a41bd8487a01ec2cd874fed89c732a42192342411bcaced52115d3a31adae432585c79b161e4f6c845b59c48e5eb7e7eab07d2085bc

data/README.md

@@ -6,7 +6,7 @@ Snowly is a minimal [Collector](https://github.com/snowplow/snowplow/wiki/Settin
 
 ### 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 changes.
+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.__
 
 ### Who will get the most from Snowly
 
@@ -82,6 +82,35 @@ Other options:
         --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)
 
+### Output
+
+When Snowly finds something wrong, it renders the parsed request 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.
+
+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: 
+`http://0.0.0.0:5678/i?&e=pv&page=Root%20README&url=http%3A%2F%2Fgithub.com%2Fsnowplow%2Fsnowplow&aid=snowplow&p=i&tv=no-js-0.1.0`
+```json
+{
+  "errors": [
+    "The property '#/platform' value \"i\" did not match one of the following values: web, mob, pc, srv, tv, cnsl, iot in schema snowplow_protocol.json",
+    "The property '#/' did not contain a required property of 'event_id' in schema snowplow_protocol.json",
+    "The property '#/' did not contain a required property of 'useragent' in schema snowplow_protocol.json"
+  ],
+  "content": {
+    "event": "pv",
+    "page_title": "Root README",
+    "page_url": "http://github.com/snowplow/snowplow",
+    "app_id": "snowplow",
+    "platform": "i",
+    "v_tracker": "no-js-0.1.0"
+  }
+}
+```
+
 ## 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.
@@ -153,7 +182,7 @@ __Note that this is not valid json because of the comments.__
 
 ### Extending Snowplow's Protocol
 
-Although the Snowplow's protocol isn't originally defined in a JSON schema, it doesn't hurt to do so and take advantage of all its perks. It's also here for the sake of consistency, right?
+Although the Snowplow's protocol isn't originally defined as a JSON schema, it doesn't hurt to do so and take advantage of all its perks. It's also here for the sake of consistency, right?
 
 By expressing the protocol in a JSON schema you can extend it to fit your particular needs and enforce domain rules that otherwise wouldn't be available. [Take a look](https://github.com/angelim/snowly/blob/master/lib/schemas/snowplow_protocol.json) at the default schema, derived from the rules specified on the [canonical model](https://github.com/snowplow/snowplow/wiki/canonical-event-model).
 

data/lib/snowly/transformer.rb

@@ -102,7 +102,7 @@ module Snowly
       begin
         case type
         when 'json' then JSON.parse(value)
-        when 'base64' then JSON.parse(Base64.urlsafe_decode64(value))
+        when 'base64' then JSON.parse(Base64.strict_decode64(value))
         when 'integer' then Integer(value)
         when 'number' then Float(value)
         else

data/lib/snowly/version.rb

@@ -1,3 +1,3 @@
 module Snowly
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/snowly.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'snowplow-tracker', '~> 0.5'
   spec.add_development_dependency 'webmock', '~> 2.0'
   spec.add_development_dependency "shotgun", '~> 0.9'
+  spec.add_development_dependency "yard", '~> 0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snowly
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Alexandre Angelim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -192,6 +192,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Snowly is a minimal collector implementation intended to validate your
   event tracking requests before emitting them to cloudfront or a closure collector.
 email: