neuron-client 0.2.6 → 0.3.0

data/spec/lib/schema/report_spec.rb

@@ -0,0 +1,129 @@
+require 'json-schema'
+
+module Neuron
+  module Schema
+    describe Report do
+      before(:each) do
+        @datetime = "2011-11-11T11:11:11Z"
+        @monkey_wrench = {"monkey_wrench" => {"id" => 42, "name" => "a"}}
+        @monkey_wrenches = [
+          {"monkey_wrench" => {"id" => 1, "name" => "a"}},
+          {"monkey_wrench" => {"id" => 2, "name" => "b"}},
+          {"monkey_wrench" => {"id" => 3, "name" => "c"}}
+        ]
+      end
+
+      def validate(data, opts={})
+        schema = opts[:against] || raise("You forgot to specify the schema!")
+        JSON::Validator.validate!(schema, data)
+      end
+
+      def invalidate(data, opts={})
+        schema = opts[:against] || raise("You forgot to specify the schema!")
+        JSON::Validator.validate(schema, data).should be_false
+      end
+
+      describe "index" do
+        it "should approve an example list of reports" do
+          validate(
+            [{"report" => {"id" => 42,  "state" => "RUNNING", "template" => "delivery_metrics"}},
+             {"report" => {"id" => 82,  "state" => "FAILED",  "template" => "post_activities"}},
+             {"report" => {"id" => 246, "state" => "READY",   "template" => "ad_events"}}
+            ],
+            :against => Report::SCHEMA.index)
+        end
+
+        it "should approve an empty list" do
+          validate([], :against => Report::SCHEMA.index)
+        end
+
+        it "should not approve an example report outside of a list" do
+          invalidate(
+            {"report" => {"id" => 246, "state" => "READY", "template" => "ad_events"}},
+            :against => Report::SCHEMA.index)
+        end
+
+        it "should not approve an example list of monkey wrenches" do
+          invalidate(@monkey_wrenches, :against => Report::SCHEMA.index)
+        end
+      end
+
+      describe "create" do
+        it "should approve an example report" do
+          validate({"report" => {
+            "template" => "ad_events",
+            "parameters" => {"start" => @datetime, "end" => @datetime}
+          }}, :against => Report::SCHEMA.create)
+        end
+
+        it "should not approve a report with missing information" do
+          invalidate({"report" => {
+            "template" => "ad_events",
+            "parameters" => {"start" => @datetime}
+          }}, :against => Report::SCHEMA.create)
+        end
+
+        it "should not approve a report with extra information" do
+          invalidate({"report" => {
+            "template" => "ad_events",
+            "parameters" => {"start" => @datetime, "end" => @datetime},
+            "state" => "WAITING" #extra
+          }}, :against => Report::SCHEMA.create)
+        end
+
+        it "should not approve a monkey wrench" do
+          invalidate(@monkey_wrench, :against => Report::SCHEMA.create)
+        end
+      end
+
+      describe "show" do
+        it "should approve an example report" do
+          validate({"report" => {
+            "template" => "ad_events",
+            "parameters" => {"start" => @datetime, "end" => @datetime},
+            "state" => "RUNNING",
+            "started_at" => @datetime,
+            "finished_at" => nil,
+            "accessed_at" => nil,
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => 1
+          }}, :against => Report::SCHEMA.show)
+        end
+
+        it "should not approve a report with missing information" do
+          invalidate({"report" => {
+            "template" => "ad_events",
+            "parameters" => {"start" => @datetime, "end" => @datetime},
+            "state" => "RUNNING",
+            "started_at" => @datetime,
+            "finished_at" => nil,
+            "accessed_at" => nil,
+            # "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => 1
+          }}, :against => Report::SCHEMA.show)
+        end
+
+        it "should not approve a report with extra information" do
+          invalidate({"report" => {
+            "template" => "ad_events",
+            "parameters" => {"start" => @datetime, "end" => @datetime},
+            "state" => "RUNNING",
+            "started_at" => @datetime,
+            "finished_at" => nil,
+            "accessed_at" => nil,
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => 1,
+            "name" => "extra"
+          }}, :against => Report::SCHEMA.show)
+        end
+
+        it "should not approve a monkey wrench" do
+          invalidate(@monkey_wrench, :against => Report::SCHEMA.show)
+        end
+      end
+    end
+  end
+end

data/spec/lib/schema/s3_file_spec.rb

@@ -0,0 +1,164 @@
+require 'json-schema'
+
+module Neuron
+  module Schema
+    describe S3File do
+      before(:each) do
+        @datetime = "2011-11-11T11:11:11Z"
+        @monkey_wrench = {"monkey_wrench" => {"id" => 42, "name" => "a"}}
+        @monkey_wrenches = [
+          {"monkey_wrench" => {"id" => 1, "name" => "a"}},
+          {"monkey_wrench" => {"id" => 2, "name" => "b"}},
+          {"monkey_wrench" => {"id" => 3, "name" => "c"}}
+        ]
+      end
+
+      def validate(data, opts={})
+        schema = opts[:against] || raise("You forgot to specify the schema!")
+        JSON::Validator.validate!(schema, data)
+      end
+
+      def invalidate(data, opts={})
+        schema = opts[:against] || raise("You forgot to specify the schema!")
+        JSON::Validator.validate(schema, data).should be_false
+      end
+
+      describe "index" do
+        it "should approve an example list of S3 files" do
+          validate(
+            [{"s3_file" => {"id" => 42,  "bucket" => "abc", "filename" => "1.log", "filesize" => 123, "purpose" => "RAW_EVENT_LOG", "created_at" => @datetime, "updated_at" => @datetime}},
+             {"s3_file" => {"id" => 82,  "bucket" => "abc", "filename" => "2.log", "filesize" => 123, "purpose" => "RAW_EVENT_LOG", "created_at" => @datetime, "updated_at" => @datetime}},
+             {"s3_file" => {"id" => 246, "bucket" => "abc", "filename" => "3.log", "filesize" => 123, "purpose" => "RAW_EVENT_LOG", "created_at" => @datetime, "updated_at" => @datetime}},
+            ],
+            :against => S3File::SCHEMA.index)
+        end
+
+        it "should approve an empty list" do
+          validate([], :against => S3File::SCHEMA.index)
+        end
+
+        it "should not approve an example S3 file outside of a list" do
+          invalidate(
+            {"s3_file" => {"id" => 42,  "bucket" => "abc", "filename" => "1.log", "filesize" => 123, "purpose" => "RAW_EVENT_LOG", "created_at" => @datetime, "updated_at" => @datetime}},
+            :against => S3File::SCHEMA.index)
+        end
+
+        it "should not approve an example list of monkey wrenches" do
+          invalidate(@monkey_wrenches, :against => S3File::SCHEMA.index)
+        end
+      end
+
+      describe "create" do
+        it "should approve an example S3 file" do
+          validate({"s3_file" => {
+            "bucket" => "abc",
+            "filename" => "1.log",
+            "filesize" => nil,
+            "purpose" => "RAW_EVENT_LOG",
+          }}, :against => S3File::SCHEMA.create)
+        end
+
+        it "should not approve a S3 file with missing information" do
+          invalidate({"s3_file" => {
+            "bucket" => "abc",
+            "filename" => "1.log",
+            "purpose" => "RAW_EVENT_LOG",
+          }}, :against => S3File::SCHEMA.create)
+        end
+
+        it "should not approve a S3 file with extra information" do
+          invalidate({"s3_file" => {
+            "bucket" => "abc",
+            "filename" => "1.log",
+            "filesize" => nil,
+            "purpose" => "RAW_EVENT_LOG",
+            "name" => "extra"
+          }}, :against => S3File::SCHEMA.create)
+        end
+
+        it "should not approve a monkey wrench" do
+          invalidate(@monkey_wrench, :against => S3File::SCHEMA.create)
+        end
+      end
+
+      describe "show" do
+        it "should approve an example S3 file" do
+          validate({"s3_file" => {
+            "bucket" => "abc",
+            "filename" => "1.log",
+            "filesize" => nil,
+            "purpose" => "RAW_EVENT_LOG",
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => 1
+          }}, :against => S3File::SCHEMA.show)
+        end
+
+        it "should not approve a S3 file with missing information" do
+          invalidate({"s3_file" => {
+            "bucket" => "abc",
+            "filename" => "1.log",
+            "purpose" => "RAW_EVENT_LOG",
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => 1
+          }}, :against => S3File::SCHEMA.show)
+        end
+
+        it "should not approve a S3 file with extra information" do
+          invalidate({"s3_file" => {
+            "bucket" => "abc",
+            "filename" => "1.log",
+            "filesize" => nil,
+            "purpose" => "RAW_EVENT_LOG",
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => 1,
+            "name" => "extra"
+          }}, :against => S3File::SCHEMA.show)
+        end
+
+        it "should not approve a monkey wrench" do
+          invalidate(@monkey_wrench, :against => S3File::SCHEMA.show)
+        end
+      end
+
+      describe "update" do
+        it "should approve an example S3 file" do
+          validate({"s3_file" => {
+            "bucket" => "abc",
+            "filename" => "1.log",
+            "filesize" => 1234,
+            "purpose" => "RAW_EVENT_LOG",
+            "id" => 1
+          }}, :against => S3File::SCHEMA.update)
+        end
+
+        it "should not approve a S3 file with missing id" do
+          invalidate({"s3_file" => {
+            "bucket" => "abc",
+            "filename" => "1.log",
+            "filesize" => 1234,
+            "purpose" => "RAW_EVENT_LOG",
+            #"id" => 1
+          }}, :against => S3File::SCHEMA.update)
+        end
+
+        it "should not approve a S3 file with extra information" do
+          invalidate({"s3_file" => {
+            "bucket" => "abc",
+            "filename" => "1.log",
+            "filesize" => nil,
+            "purpose" => "RAW_EVENT_LOG",
+            "id" => 1,
+            "name" => "extra"
+          }}, :against => S3File::SCHEMA.update)
+        end
+
+        it "should not approve a monkey wrench" do
+          invalidate(@monkey_wrench, :against => S3File::SCHEMA.update)
+        end
+      end
+    end
+  end
+end

data/spec/lib/schema/zone_spec.rb

@@ -0,0 +1,243 @@
+require 'json-schema'
+
+module Neuron
+  module Schema
+    describe Zone do
+      before(:each) do
+        @datetime = "2011-11-11T11:11:11Z"
+        @monkey_wrench = {"monkey_wrench" => {"id" => 42, "name" => "a"}}
+        @monkey_wrenches = [
+          {"monkey_wrench" => {"id" => 1, "name" => "a"}},
+          {"monkey_wrench" => {"id" => 2, "name" => "b"}},
+          {"monkey_wrench" => {"id" => 3, "name" => "c"}}
+        ]
+      end
+
+      def validate(data, opts={})
+        schema = opts[:against] || raise("You forgot to specify the schema!")
+        JSON::Validator.validate!(schema, data)
+      end
+
+      def invalidate(data, opts={})
+        schema = opts[:against] || raise("You forgot to specify the schema!")
+        JSON::Validator.validate(schema, data).should be_false
+      end
+
+      describe "index" do
+        it "should approve an example list of zones" do
+          validate(
+            [{"zone" => {"id" => "abc123", "name" => nil}},
+             {"zone" => {"id" => "efg456", "name" => nil}},
+             {"zone" => {"id" => "hij789", "name" => nil}}
+            ],
+            :against => Zone::SCHEMA.index)
+        end
+
+        it "should approve an empty list" do
+          validate([], :against => Zone::SCHEMA.index)
+        end
+
+        it "should not approve an example zone outside of a list" do
+          invalidate(
+            {"zone" => {"id" => "abc123", "name" => "fred"}},
+            :against => Zone::SCHEMA.index)
+        end
+
+        it "should not approve an example list of monkey wrenches" do
+          invalidate(@monkey_wrenches, :against => Zone::SCHEMA.index)
+        end
+      end
+
+      describe "create" do
+        it "should approve an example redirect zone" do
+          validate({"zone" => {
+            "name" => "example_redirect_zone",
+            "response_type" => "Redirect",
+            "ad_links" => {"1" => {"weight" => 1.5, "priority" => 1},
+                           "2" => {"weight" => 2.5, "priority" => 2}}
+          }}, :against => Zone::SCHEMA.create)
+        end
+
+        it "should approve an example iris zone" do
+          validate({"zone" => {
+            "name" => "example_iris_zone",
+            "response_type" => "Iris",
+            "ad_links" => {},
+            "expand" => "Yes",
+            "mute" => "No",
+            "autoplay" => "Yes",
+            "channel" => "drivel",
+            "template_slug" => "300x250",
+            "text_overlay" => "Yes",
+            "nami_feed_url" => "http://example.com/"
+          }}, :against => Zone::SCHEMA.create)
+        end
+
+        it "should approve an example vast zone" do
+          validate({"zone" => {
+            "name" => "example_vast_zone",
+            "response_type" => "Vast",
+            "ad_links" => {}
+          }}, :against => Zone::SCHEMA.create)
+        end
+
+        it "should not approve a zone with missing information" do
+          invalidate({"zone" => {
+            "name" => "example_redirect_zone",
+            #"response_type" => "Redirect",
+            "ad_links" => {"1" => {"weight" => 1.5, "priority" => 1},
+                           "2" => {"weight" => 2.5, "priority" => 2}}
+          }}, :against => Zone::SCHEMA.create)
+        end
+
+        it "should not approve a zone with extra information" do
+          invalidate({"zone" => {
+            "name" => "example_redirect_zone",
+            "response_type" => "Redirect",
+            "ad_links" => {"1" => {"weight" => 1.5, "priority" => 1},
+                           "2" => {"weight" => 2.5, "priority" => 2}},
+            "channel" => "extra"
+          }}, :against => Zone::SCHEMA.create)
+        end
+
+        it "should not approve a monkey wrench" do
+          invalidate(@monkey_wrench, :against => Zone::SCHEMA.create)
+        end
+      end
+
+      describe "show" do
+        it "should approve an example redirect zone" do
+          validate({"zone" => {
+            "name" => "example_redirect_zone",
+            "response_type" => "Redirect",
+            "ad_links" => {"1" => {"weight" => 1.5, "priority" => 1},
+                           "2" => {"weight" => 2.5, "priority" => 2}},
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => "abc123"
+          }}, :against => Zone::SCHEMA.show)
+        end
+
+        it "should approve an example iris zone" do
+          validate({"zone" => {
+            "name" => "example_iris_zone",
+            "response_type" => "Iris",
+            "ad_links" => {},
+            "expand" => "Yes",
+            "mute" => "No",
+            "autoplay" => "Yes",
+            "channel" => "drivel",
+            "template_slug" => "300x250",
+            "text_overlay" => "No",
+            "nami_feed_url" => nil,
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => "abc123"
+          }}, :against => Zone::SCHEMA.show)
+        end
+
+        it "should approve an example vast zone" do
+          validate({"zone" => {
+            "name" => "example_vast_zone",
+            "response_type" => "Vast",
+            "ad_links" => {},
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => "abc123"
+          }}, :against => Zone::SCHEMA.show)
+        end
+
+        it "should not approve a zone with missing information" do
+          invalidate({"zone" => {
+            #"name" => "example_redirect_zone",
+            "response_type" => "Redirect",
+            "ad_links" => {"1" => {"weight" => 1.5, "priority" => 1},
+                           "2" => {"weight" => 2.5, "priority" => 2}},
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => "abc123"
+          }}, :against => Zone::SCHEMA.show)
+        end
+
+        it "should not approve a zone with extra information" do
+          invalidate({"zone" => {
+            "name" => "example_redirect_zone",
+            "response_type" => "Redirect",
+            "ad_links" => {"1" => {"weight" => 1.5, "priority" => 1},
+                           "2" => {"weight" => 2.5, "priority" => 2}},
+            "created_at" => @datetime,
+            "updated_at" => @datetime,
+            "id" => "abc123",
+            "channel" => "extra"
+          }}, :against => Zone::SCHEMA.show)
+        end
+
+        it "should not approve a monkey wrench" do
+          invalidate(@monkey_wrench, :against => Zone::SCHEMA.show)
+        end
+      end
+
+      describe "update" do
+        it "should approve an example redirect zone" do
+          validate({"zone" => {
+            "name" => "example_redirect_zone",
+            "response_type" => "Redirect",
+            "ad_links" => {"1" => {"weight" => 1.5, "priority" => 1},
+                           "2" => {"weight" => 2.5, "priority" => 2}},
+            "id" => "abc123"
+          }}, :against => Zone::SCHEMA.update)
+        end
+
+        it "should approve an example iris zone" do
+          validate({"zone" => {
+            "name" => "example_iris_zone",
+            "response_type" => "Iris",
+            "ad_links" => {},
+            "expand" => "Yes",
+            "mute" => "No",
+            "autoplay" => "Yes",
+            "channel" => "drivel",
+            "text_overlay" => "No",
+            "nami_feed_url" => nil,
+            "template_slug" => "300x250",
+            "id" => "abc123"
+          }}, :against => Zone::SCHEMA.update)
+        end
+
+        it "should approve an example vast zone" do
+          validate({"zone" => {
+            "name" => "example vast zone",
+            "response_type" => "Vast",
+            "ad_links" => {},
+            "id" => "abc123"
+          }}, :against => Zone::SCHEMA.update)
+        end
+
+        it "should not approve a zone with missing id" do
+          invalidate({"zone" => {
+            "name" => "example_redirect_zone",
+            "response_type" => "Redirect",
+            "ad_links" => {"1" => {"weight" => 1.5, "priority" => 1},
+                           "2" => {"weight" => 2.5, "priority" => 2}},
+            #"id" => "abc123"
+          }}, :against => Zone::SCHEMA.update)
+        end
+
+        it "should not approve a zone with extra information" do
+          invalidate({"zone" => {
+            "name" => "example_redirect_zone",
+            "response_type" => "Redirect",
+            "ad_links" => {"1" => {"weight" => 1.5, "priority" => 1},
+                           "2" => {"weight" => 2.5, "priority" => 2}},
+            "id" => "abc123",
+            "channel" => "drivel"
+          }}, :against => Zone::SCHEMA.update)
+        end
+
+        it "should not approve a monkey wrench" do
+          invalidate(@monkey_wrench, :against => Zone::SCHEMA.update)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,8 @@
 require 'simplecov'
 SimpleCov.start do
   add_filter "/spec/"
-  add_group "Models", "lib"
+  add_group "Schema", "schema"
+  add_group "Models", "model"
 end
 
 require 'rubygems'