snowly 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: 9c992c7989523c3cb8ebd13f688bad98cd7aa97a
-  data.tar.gz: 0fe1d0225968f3bcdaff2e7798d33e24fc13d1d3
+  metadata.gz: 9254b6f1c821d30a0c34f25cf92c619935f30c8b
+  data.tar.gz: bbbcb42cc46d319243ea3fba626dbc1dafdcd313
 SHA512:
-  metadata.gz: 5aff20ddb95ef42774243adc84fdfda1d1696d8c4d625a78719bc71f21b4d9ccbccdd41cb31533743bd491e8b1c12904d1527a590d1d3223e490f890fe167595
-  data.tar.gz: dbcadb589c30777f767ed9bc16b200577d7338163e78ff6db3c94c34afc38416e6dd10e0c65399b501c875e6f977998afb047e3b58b89f709e13be46deebe6cd
+  metadata.gz: 3f6d0d38ce02be8812ec8ef1d45d039802debb0df4b1e0c0ae953586b90bf96383ed6a2e12722dbc8811bcc1ec3c9cbe7a9a381b6d07b456720171123cbd31ba
+  data.tar.gz: 9e63cebeec4c54f429ba8cee65403ad46e36900f7f8638857a11314a8bb14711fc366fa1dfbb6297a7e282fb5ec21d8882d6a8fe74707ebcd18bf12741ffcc48

data/README.md

@@ -16,7 +16,7 @@ Snowplow has an excellent toolset, but the first implementation stages can be ha
 
 ### Features
 
-With Snowly you can use [Json Schemas](http://spacetelescope.github.io/understanding-json-schema/) to define more expressive event requirements. Aside from assuring that you're fully compatible with the snowplow protocol, you can go even further and extend it with a set of more specific rules.
+With Snowly you can use [Json Schemas](http://spacetelescope.github.io/understanding-json-schema/) to define more expressive event requirements. Aside from assuring that you're fully compatible with the snowplow protocol, you can go even further and extend it with a set of more specific rules. Snowly emulates both cloudfront and closure collectors and will handle its differences automatically.
 
 Use cases:
 
@@ -84,7 +84,7 @@ Other options:
 
 ### Output
 
-When Snowly finds something wrong, it renders the parsed request along with its errors.
+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.
 
@@ -92,25 +92,30 @@ If you can't investigate the request's response, you can start Snowly in the for
 `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`
+`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&eid=ev-id-1`
 ```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"
+[
+  {
+    "event_id": "ev-id-1",
+    "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 '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",
+      "event_id": "ev-id-1"
+    }
   }
-}
+]
 ```
 
+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.
+
 ## 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/app/collector.rb

@@ -1,34 +1,34 @@
 require 'erb'
 require 'base64'
 require 'sinatra'
-require "sinatra/reloader" if development?
+require 'sinatra/reloader' if development?
 
 module Snowly
   module App
     class Collector < Sinatra::Base
-      GIF = Base64.decode64("R0lGODlhAQABAPAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==")
+      GIF = Base64.decode64('R0lGODlhAQABAPAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==')
       configure :development do
         register Sinatra::Reloader
       end
 
-      get '/' do
-        @url = request.url.gsub(/(http|https)\:\/\//,'')[0..-2]
-        @resolved_schemas = if resolver = Snowly.development_iglu_resolver_path
-          Dir[File.join(resolver,"/**/*")].select{ |e| File.file? e }
+      def extract_content(validator)
+        multi = validator.respond_to?(:validators)
+        @content ||= if multi
+          validator.validators.each_with_object([]) do |item, memo|
+            item_request = item.request.as_hash
+            memo << { event_id: item_request['event_id'], errors: item.errors, content: item_request }
+          end
         else
-          nil
-        end
-        erb :index
+          [{ event_id: validator.request.as_hash['event_id'], errors: validator.errors, content: validator.request.as_hash }]
+        end.to_json
       end
 
-      get '/i' do
-        content_type :json
-        validator = Snowly::Validator.new request.query_string
+      def handle_response(validator)
         if validator.validate
           status 200
-          content = { content: validator.request.as_hash }.to_json
-          Snowly.logger.info content
           if params[:debug] || Snowly.debug_mode
+            content = extract_content validator
+            Snowly.logger.info content
             body(content)
           else
             content_type 'image/gif'
@@ -36,11 +36,45 @@ module Snowly
           end
         else
           status 500
-          content = { errors: validator.errors, content: validator.request.as_hash }.to_json
+          content = extract_content validator
           Snowly.logger.error content
           body (content)
         end
       end
+
+      get '/' do
+        @url = request.url.gsub(/(http|https)\:\/\//,'')[0..-2]
+        @resolved_schemas = if resolver = Snowly.development_iglu_resolver_path
+          Dir[File.join(resolver,"/**/*")].select{ |e| File.file? e }
+        else
+          nil
+        end
+        erb :index
+      end
+
+      get '/i' do
+        content_type :json
+        validator = Snowly::Validator.new request.query_string
+        handle_response(validator)
+      end
+
+      post '/com.snowplowanalytics.snowplow/tp2' do
+        response.headers['Allow'] = 'HEAD,GET,PUT,POST,DELETE,OPTIONS'
+        response.headers['Access-Control-Allow-Headers'] = 'X-Requested-With, X-HTTP-Method-Override, Content-Type, Cache-Control, Accept'
+        response.headers['Access-Control-Allow-Credentials'] = 'true'
+        response.headers['Access-Control-Allow-Origin'] = env['HTTP_ORIGIN'] || '*'
+        payload = JSON.parse request.body.read
+        validator = Snowly::MultiValidator.new payload
+        handle_response(validator)
+      end
+
+      options '*' do
+        response.headers['Allow'] = 'HEAD,GET,PUT,POST,DELETE,OPTIONS'
+        response.headers['Access-Control-Allow-Headers'] = 'X-Requested-With, X-HTTP-Method-Override, Content-Type, Cache-Control, Accept'
+        response.headers['Access-Control-Allow-Credentials'] = 'true'
+        response.headers['Access-Control-Allow-Origin'] = env['HTTP_ORIGIN'] || '*'
+        200
+      end
     end
   end
 end

data/lib/snowly/app/views/index.erb

@@ -22,10 +22,10 @@
       <p><strong>Snowly</strong> is a minimal collector implementation intended to validate your event tracking requests before emitting them to cloudfront or a closure collector.</p>
       <p>When <strong>Snowly</strong> finds something wrong, it renders the parsed request along with its errors.</p>
       <p>If everything is ok, Snowly delivers the default Snowplow pixel, unless you're using the debug mode.</p>
-      <p>Point your collector URL to <code><%= url %>i</code> and have fun!</p>
+      <p>Point your collector URL to <code><%= url %></code> and have fun!</p>
       <p>
         <a class="btn btn-lg btn-success" href="/i?&e=pv&page=Root%20README&url=http%3A%2F%2Fgithub.com%2Fsnowplow%2Fsnowplow&aid=snowplow&p=web&tv=no-js-0.1.0&ua=firefox&&eid=u2i3&debug=true" role="button">See it working!</a>
-        <a class="btn btn-lg btn-warning" href="/i?&e=pv&page=Root%20README&url=http%3A%2F%2Fgithub.com%2Fsnowplow%2Fsnowplow&aid=snowplow&p=i&tv=no-js-0.1.0&debug=true" role="button">Event with errors!</a>
+        <a class="btn btn-lg btn-warning" href="/i?&e=pv&page=Root%20README&url=http%3A%2F%2Fgithub.com%2Fsnowplow%2Fsnowplow&aid=snowplow&p=i&tv=no-js-0.1.0&eid=u2i3&debug=true" role="button">Event with errors!</a>
       </p>
       <% unless Snowly.development_iglu_resolver_path %>
       <div class="alert alert-danger" role="alert">The Local Iglu Resolver Path is missing.</div>

data/lib/snowly/extensions/custom_dependencies.rb

@@ -32,7 +32,7 @@ class CustomDependenciesAttribute < JSON::Schema::Attribute
   def self.validate_dependency(schema, data, property, dependency_hash, fragments, processor, attribute, options)
     key, value = Array(dependency_hash).flatten
     return unless data[key.to_s] == value.to_s
-    return if data.has_key?(property.to_s)
+    return if data.has_key?(property.to_s) && not(data[property.to_s].blank?)
     message = "The property '#{build_fragment(fragments)}' did not contain a required property of '#{property}' when property '#{key}' is '#{value}'"
     validation_error(processor, message, fragments, schema, attribute, options[:record_errors])
   end

data/lib/snowly/multi_validator.rb

@@ -0,0 +1,21 @@
+require 'snowly/validator'
+module Snowly
+  class MultiValidator
+    attr_reader :validators
+    
+    def initialize(payload)
+      @validators = payload['data'].map do |req|
+        Validator.new(req)
+      end
+    end
+
+    def validate
+      validators.each(&:validate)
+      valid?
+    end
+
+    def valid?
+      validators.all? { |v| v.valid? }
+    end
+  end
+end

data/lib/snowly/protocol_schema_finder.rb

@@ -0,0 +1,34 @@
+module Snowly
+  class ProtocolSchemaFinder
+    PROTOCOL_FILE_NAME = 'snowplow_protocol.json'
+    attr_reader :schema
+
+    def initialize(custom_schema = nil)
+      @custom_schema = custom_schema
+      @schema = load_protocol_schema
+    end
+
+    def find_protocol_schema
+      return @custom_schema if @custom_schema
+      if resolver && alternative_protocol_schema
+        alternative_protocol_schema
+      else
+        File.expand_path("../../schemas/#{PROTOCOL_FILE_NAME}", __FILE__)
+      end
+    end
+
+    def resolver
+      Snowly.development_iglu_resolver_path
+    end
+
+    def alternative_protocol_schema
+      Dir[File.join(resolver,"/**/*")].select{ |f| File.basename(f) == PROTOCOL_FILE_NAME }[0]
+    end
+
+    # Loads the protocol schema created to describe snowplow events table attributes
+    # @return [Hash] parsed schema
+    def load_protocol_schema
+      JSON.parse File.read(find_protocol_schema)
+    end
+  end
+end

data/lib/snowly/request.rb

@@ -1,9 +1,11 @@
 require 'snowly/transformer'
 module Snowly
   class Request
-    attr_reader :query_string
-    def initialize(query_string)
-      @query_string = query_string
+
+    attr_reader :parsed_payload
+
+    def initialize(payload)
+      @parsed_payload = payload.is_a?(String) ? parse_query(payload) : payload
     end
 
     # Retuns request as json, after transforming parameters into column names
@@ -15,12 +17,12 @@ module Snowly
     # Retuns request as hash, after transforming parameters into column names
     # @return [Hash]
     def as_hash
-      @hash ||= Transformer.transform(parsed_query)
+      @hash ||= Transformer.transform(parsed_payload)
     end
 
     # Returns query parameters as hash
     # @return [Hash]
-    def parsed_query
+    def parse_query(query_string)
       @parsed_query ||= Rack::Utils.parse_nested_query(query_string)
     end
     

data/lib/snowly/validator.rb

@@ -1,17 +1,15 @@
 # Performs the validation for the root attributes and associated contexts and unstructured events.
 require 'snowly/request'
+require 'snowly/protocol_schema_finder'
 require 'snowly/extensions/custom_dependencies'
 
 module Snowly
   class Validator
-    PROTOCOL_FILE_NAME = 'snowplow_protocol.json'
+    attr_reader :request, :errors
 
-    attr_reader :request, :errors, :protocol_schema
-
-    def initialize(query_string)
-      @request = Request.new query_string
+    def initialize(payload)
+      @request = Request.new payload
       @errors = []
-      @protocol_schema = load_protocol_schema
     end
 
     # If request is valid
@@ -27,29 +25,11 @@ module Snowly
       valid?
     end
 
-    private
-
-    def find_protocol_schema
-      if resolver && alternative_protocol_schema
-        alternative_protocol_schema
-      else
-        File.expand_path("../../schemas/#{PROTOCOL_FILE_NAME}", __FILE__)
-      end
-    end
-
-    def resolver
-      Snowly.development_iglu_resolver_path
-    end
-
-    def alternative_protocol_schema
-      Dir[File.join(resolver,"/**/*")].select{ |f| File.basename(f) == PROTOCOL_FILE_NAME }[0]
+    def protocol_schema
+      @protocol_schema ||= ProtocolSchemaFinder.new.schema
     end
 
-    # Loads the protocol schema created to describe snowplow events table attributes
-    # @return [Hash] parsed schema
-    def load_protocol_schema
-      JSON.parse File.read(find_protocol_schema)
-    end
+    private
 
     # @return [Hash] all contexts content and schema definitions
     def associated_contexts

data/lib/snowly/version.rb

@@ -1,3 +1,3 @@
 module Snowly
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/snowly.rb

@@ -6,6 +6,7 @@ require 'json-schema'
 require 'snowly/validators/self_desc'
 require "snowly/version"
 require 'snowly/validator'
+require 'snowly/multi_validator'
 require 'snowly/schema_cache'
 
 module Snowly

data/snowly.gemspec

@@ -34,5 +34,4 @@ 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.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexandre Angelim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-15 00:00:00.000000000 Z
+date: 2016-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -192,20 +192,6 @@ 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:
@@ -230,6 +216,8 @@ files:
 - lib/snowly/app/collector.rb
 - lib/snowly/app/views/index.erb
 - lib/snowly/extensions/custom_dependencies.rb
+- lib/snowly/multi_validator.rb
+- lib/snowly/protocol_schema_finder.rb
 - lib/snowly/request.rb
 - lib/snowly/schema_cache.rb
 - lib/snowly/transformer.rb