neuron-client 0.2.6 → 0.3.0

data/lib/neuron-client/schema/common.rb

@@ -0,0 +1,220 @@
+require 'map'
+require 'deep_merge/core'
+require 'tzinfo'
+
+module Neuron
+  module Schema
+    module Common
+      module ClassMethods
+        def schema
+          @schema ||= "#{self.name}::SCHEMA".constantize
+        end
+
+        def validate!(schema_name, data)
+          JSON::Validator.validate!(schema.send(schema_name), data)
+        rescue Exception => e
+          puts "Data: #{data}"
+          raise e
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def object_type(name, properties)
+        Map.new(
+          :type => "object",
+          :additionalProperties => false,
+          :required => true,
+          :properties => {
+            name => {
+              :type => "object",
+              :required => true,
+              :additionalProperties => false,
+              :properties => properties
+            }
+          }
+        )
+      end
+
+      def object_type_or_null(name, properties)
+        merged(object_type(name, properties), {:properties => {name => {:type => %w(object null)}}})
+      end
+
+      def merged(*hashes)
+        result = Map.new
+        hashes.each do |hash|
+          result = ::DeepMerge::deep_merge!(hash, result, {:preserve_unmergeables => false})
+        end
+        result
+      end
+
+      def choice_of(choices, overrides={})
+        merged({
+          :type => "string",
+          :enum => choices,
+          :required => true
+        }, overrides)
+      end
+
+      def one_of(*schemas)
+        merged({:type => schemas}, {})
+      end
+
+      def set_of(schema, overrides={})
+        merged({
+            :type => "array",
+            :additionalItems => false,
+            :uniqueItems => true,
+            :required => true,
+            :items => schema
+        }, overrides)
+      end
+
+      def datetime(overrides={})
+        merged({
+          :type => "string",
+          :format => "date-time",
+          :pattern => "^\\d{4}-[01]?\\d-[0-3]?\\dT[012]?\\d:[0-5]?\\d:[0-5]?\\dZ$",
+          :required => true
+        }, overrides)
+      end
+
+      def errors
+        merged({
+          :type => "object",
+          :required => true,
+          :additionalProperties => {
+            :type => "array",
+            :minItems => 1,
+            :items => {
+              :type => "string",
+              :required => true
+            }
+          }
+        }, {})
+      end
+
+      def id(overrides={})
+        merged({
+          :type => %w(integer string),
+          :required => true,
+          :pattern => "^\\d+$"
+        }, overrides)
+      end
+
+      def integer(overrides={})
+        merged({
+          :type => %w(integer string),
+          :required => true,
+          :pattern => "^\\-?\\d+$"
+        }, overrides)
+      end
+
+      def missing_or_null
+        merged({
+          :type => "null",
+          :required => false
+        }, {})
+      end
+
+      def missing_or_null_or_empty_hash
+        merged({
+          :type => %w(object null),
+          :additionalProperties => false,
+          :required => false
+        }, {})
+      end
+
+      def nonnull_string(overrides={})
+        merged({
+          :type => "string",
+          :maxLength => 255,
+          :required => "true"
+        }, overrides)
+      end
+
+      def null
+        merged({
+          :type => "null",
+          :required => true
+        }, {})
+      end
+      
+      def nullable_string(overrides={})
+        merged({
+          :type => %w(string null),
+          :maxLength => 255,
+          :required => true
+        }, overrides)
+      end
+
+      def parameters(parameters, overrides={})
+        merged({
+          :type => "object",
+          :required => true,
+          :additionalProperties => false,
+          :properties => parameters
+        }, overrides)
+      end
+
+      def priority(overrides={})
+        merged({
+          :type => %w(integer string),
+          :required => true,
+          :minimum => 1,
+          :maximum => 10,
+          :enum => (1..10).to_a + (1..10).map(&:to_s)
+        }, overrides)
+      end
+
+      def slug(overrides={})
+        merged({
+          :type => "string",
+          :required => true,
+          :pattern => "^\\w+$",
+          :maxLength => 255,
+          :minLength => 1
+        }, overrides)
+      end
+
+      def timezone(overrides={})
+        choice_of(Neuron::Client::Ad::TIME_ZONES, overrides)
+      end
+
+      def url(overrides={})
+        merged({
+          :type => "string",
+          :format => "uri",
+          :pattern => "^https?:\/\/",
+          :maxLength => 2000,
+          :required => true
+        }, overrides)
+      end
+
+      def uuid(overrides={})
+        merged({
+          :type => "string",
+          :pattern => "^[a-z0-9]+$",
+          :maxlength => 25,
+          :required => true
+        }, overrides)
+      end
+
+      def weight(overrides={})
+        merged({
+          :type => %w(number string),
+          :required => true,
+          :minimum => -1000,
+          :maximum => 1000,
+          :pattern => "^\\-?\\d+(\\.\\d+)?$"
+        }, overrides)
+      end
+
+      def yes_no(overrides={})
+        choice_of(%w(Yes No), overrides)
+      end
+    end
+  end
+end

data/lib/neuron-client/schema/event.rb

@@ -0,0 +1,17 @@
+module Neuron
+  module Schema
+    class Event
+      include Common
+
+      SCHEMA = self.new
+      
+      def create
+        {} #TODO
+      end
+
+      def multi_create
+        {} #TODO
+      end
+    end
+  end
+end

data/lib/neuron-client/schema/geo_target.rb

@@ -0,0 +1,33 @@
+module Neuron
+  module Schema
+    class GeoTarget
+      include Common
+
+      SCHEMA = self.new
+
+      def index
+        @@index ||=
+        set_of(object_type("geo_target",
+          :id => id,
+          :abbreviation => nonnull_string,
+          :full_name => nonnull_string,
+          :geo_type => choice_of(Neuron::Client::GeoTarget::TYPES),
+          :name => nonnull_string,
+          :netacuity_id => integer
+        ))
+      end
+
+      def show
+        @@show ||=
+        object_type("geo_target",
+          :id => id,
+          :abbreviation => nonnull_string,
+          :full_name => nonnull_string,
+          :geo_type => choice_of(Neuron::Client::GeoTarget::TYPES),
+          :name => nonnull_string,
+          :netacuity_id => integer
+        )
+      end
+    end
+  end
+end

data/lib/neuron-client/schema/pixel.rb

@@ -0,0 +1,39 @@
+module Neuron
+  module Schema
+    class Pixel
+      include Common
+
+      SCHEMA = self.new
+      
+      def index
+        @@index ||=
+        set_of(object_type("pixel",
+          :id => id
+        ))
+      end
+
+      def create
+        @@create ||=
+        object_type_or_null("pixel",
+          :ad_ids => set_of(id, :required => false)
+        )
+      end
+
+      def show
+        @@show ||=
+        object_type("pixel",
+          :id => id,
+          :ad_ids => set_of(id)
+        )
+      end
+
+      def update
+        @@update ||=
+        object_type("pixel",
+          :id => id,
+          :ad_ids => set_of(id)
+        )
+      end
+    end
+  end
+end

data/lib/neuron-client/schema/report.rb

@@ -0,0 +1,59 @@
+module Neuron
+  module Schema
+    class Report
+      include Common
+
+      SCHEMA = self.new
+
+      def index
+        @@index ||=
+        set_of(object_type("report",
+          :id => id,
+          :template => choice_of(Neuron::Client::Report::TEMPLATES),
+          :state => choice_of(Neuron::Client::Report::STATES)
+        ))
+      end
+
+      def create
+        @@create ||=
+        object_type("report",
+          :template => choice_of(Neuron::Client::Report::TEMPLATES),
+          :parameters => report_parameters
+        )
+      end
+
+      def show
+        @@show ||=
+        object_type("report",
+          :id => id,
+          :template => choice_of(Neuron::Client::Report::TEMPLATES),
+          :state => choice_of(Neuron::Client::Report::STATES),
+          :parameters => report_parameters,
+          :started_at =>  datetime(:type => %w(string null)),
+          :finished_at => datetime(:type => %w(string null)),
+          :accessed_at => datetime(:type => %w(string null)),
+          :created_at =>  datetime,
+          :updated_at =>  datetime
+        )
+      end
+
+      private
+
+      def report_parameters
+        parameters({
+          :start => datetime,
+          :end => datetime
+        }, {
+          :patternProperties => {
+            '^\\w{1,255}$' => {
+              :type => "string",
+              :required => true,
+              :minLength => 1,
+              :maxLength => 255
+            }
+          }
+        })
+      end
+    end
+  end
+end

data/lib/neuron-client/schema/s3_file.rb

@@ -0,0 +1,87 @@
+module Neuron
+  module Schema
+    class S3File
+      include Common
+
+      SCHEMA = self.new
+
+      def index
+        @@index ||=
+        set_of(object_type("s3_file", merged(CORE_PROPERTIES, SHOW_PROPERTIES)))
+      end
+
+      def create
+        @@create ||=
+        object_type("s3_file", CORE_PROPERTIES)
+      end
+
+      def show
+        @@show ||=
+        object_type("s3_file", merged(CORE_PROPERTIES, SHOW_PROPERTIES))
+      end
+
+      def update
+        @@update ||=
+        object_type("s3_file", {
+          :id => id,
+          :bucket => SCHEMA.bucket(:required => false),
+          :filename => SCHEMA.filename(:required => false),
+          :filesize => SCHEMA.filesize(:required => false),
+          :purpose => SCHEMA.choice_of(Neuron::Client::S3File::PURPOSE_CHOICES, :required => false)
+        })
+      end
+
+      # --------------------
+
+      def bucket(overrides={})
+        merged({
+          :description => "The name of the Amazon S3 bucket",
+          :type => "string",
+          :pattern => "^[a-z\\d]([a-z\\d\\-]*[a-z\\d])?(\\.[a-z\\d]([a-z\\d\\-]*[a-z\\d])?)*$",
+          :minLength => 3,
+          :maxLength => 63,
+          :required => true
+        }, overrides)
+      end
+
+      def filename(overrides={})
+        merged({
+          :description => "The full name of the file within the Amazon S3 bucket",
+          :type => "string",
+          :minLength => 3,
+          :maxLength => 255,
+          :required => true
+        }, overrides)
+      end
+
+      def filesize(overrides={})
+        merged({
+          :type => %w(integer string null),
+          :required => true,
+          :minimum => 1,
+          :exclusiveMinimum => false,
+          :pattern => "^[1-9]\\d*$"
+        }, overrides)
+      end
+
+      # --------------------
+
+      private
+
+      CORE_PROPERTIES =
+        {
+          :bucket => SCHEMA.bucket,
+          :filename => SCHEMA.filename,
+          :filesize => SCHEMA.filesize,
+          :purpose => SCHEMA.choice_of(Neuron::Client::S3File::PURPOSE_CHOICES)
+        }
+
+      SHOW_PROPERTIES =
+        {
+          :id => SCHEMA.id,
+          :created_at => SCHEMA.datetime,
+          :updated_at => SCHEMA.datetime
+        }
+    end
+  end
+end

data/lib/neuron-client/schema/zone.rb

@@ -0,0 +1,214 @@
+module Neuron
+  module Schema
+    class Zone
+      include Common
+
+      SCHEMA = self.new
+
+      def index
+        @@index ||=
+        set_of(object_type("zone",
+          :id => uuid,
+          :name => nullable_string
+        ))
+      end
+
+      def create
+        @@create ||=
+        one_of(
+          create_redirect,
+          create_iris,
+          create_vast
+        )
+      end
+
+      def show
+        @@show ||=
+        one_of(
+          show_redirect,
+          show_iris,
+          show_vast
+        )
+      end
+
+      def update
+        @@update ||=
+        one_of(
+          update_redirect,
+          update_iris,
+          update_vast
+        )
+      end
+
+      # --------------------
+
+      def create_redirect
+        @@create_redirect ||=
+        object_type("zone", merged(CREATE_PROPERTIES,{
+          :response_type => SCHEMA.choice_of([Neuron::Client::Zone::REDIRECT]),
+        }))
+      end
+
+      def create_iris
+        @@create_iris ||=
+        object_type("zone", merged(CREATE_PROPERTIES,{
+          :response_type => SCHEMA.choice_of([Neuron::Client::Zone::IRIS]),
+          :template_slug => SCHEMA.choice_of(Neuron::Client::Zone::TEMPLATE_SLUGS),
+          :mute          => SCHEMA.yes_no,
+          :autoplay      => SCHEMA.yes_no,
+          :channel       => SCHEMA.channel,
+          :expand        => SCHEMA.yes_no,
+          :text_overlay  => SCHEMA.yes_no,
+          :nami_feed_url => SCHEMA.url(:type => %w(string null), :required => false)
+        }))
+      end
+
+      def create_vast
+        @@create_vast ||=
+        object_type("zone", merged(CREATE_PROPERTIES,{
+          :response_type => SCHEMA.choice_of([Neuron::Client::Zone::VAST]),
+        }))
+      end
+
+      def show_redirect
+        @@show_redirect ||=
+        object_type("zone", merged(SHOW_PROPERTIES,{
+          :response_type => SCHEMA.choice_of([Neuron::Client::Zone::REDIRECT]),
+        }))
+      end
+
+      def show_iris
+        @@show_iris ||=
+        object_type("zone", merged(SHOW_PROPERTIES,{
+          :response_type => SCHEMA.choice_of([Neuron::Client::Zone::IRIS]),
+          :template_slug => SCHEMA.choice_of(Neuron::Client::Zone::TEMPLATE_SLUGS),
+          :mute          => SCHEMA.yes_no,
+          :autoplay      => SCHEMA.yes_no,
+          :channel       => SCHEMA.channel,
+          :expand        => SCHEMA.yes_no,
+          :text_overlay  => SCHEMA.yes_no,
+          :nami_feed_url => SCHEMA.url(:type => %w(string null))
+        }))
+      end
+
+      def show_vast
+        @@show_vast ||=
+        object_type("zone", merged(SHOW_PROPERTIES,{
+          :response_type => SCHEMA.choice_of([Neuron::Client::Zone::VAST]),
+        }))
+      end
+
+      def update_redirect
+        @@update_redirect ||=
+        object_type("zone", merged(UPDATE_PROPERTIES,{
+          :response_type => SCHEMA.choice_of([Neuron::Client::Zone::REDIRECT], :required => false),
+        }))
+      end
+
+      def update_iris
+        @@update_iris ||=
+        object_type("zone", merged(UPDATE_PROPERTIES,{
+          :response_type => SCHEMA.choice_of([Neuron::Client::Zone::IRIS], :required => false),
+          :template_slug => SCHEMA.choice_of(Neuron::Client::Zone::TEMPLATE_SLUGS, :required => false),
+          :mute          => SCHEMA.yes_no(:required => false),
+          :autoplay      => SCHEMA.yes_no(:required => false),
+          :channel       => SCHEMA.channel(:required => false),
+          :expand        => SCHEMA.yes_no(:required => false),
+          :text_overlay  => SCHEMA.yes_no(:required => false),
+          :nami_feed_url => SCHEMA.url(:type => %w(string null), :required => false)
+        }))
+      end
+
+      def update_vast
+        @@update_vast ||=
+        object_type("zone", merged(UPDATE_PROPERTIES,{
+          :response_type => SCHEMA.choice_of([Neuron::Client::Zone::VAST], :required => false),
+        }))
+      end
+
+      # --------------------
+
+      def ad_links(overrides={})
+        merged({
+          :type => "object",
+          :required => true,
+          :additionalProperties => false,
+          :patternProperties => {
+            "^[0-9]+$" => {
+              :description => "property name is an ad id",
+              :type => "object",
+              :required => true,
+              :additionalProperties => false,
+              :properties => {
+                :priority => priority,
+                :weight => weight
+              }
+            }
+          }
+        }, overrides)
+      end
+
+      def channel(overrides={})
+        merged({
+          :type => "string",
+          :pattern => "^\\w+$",
+          :minLength => 1,
+          :maxLength => 255
+        }, overrides)
+      end
+
+      # --------------------
+
+      private
+
+
+      CREATE_PROPERTIES =
+        {
+          :name          => SCHEMA.nullable_string(:required => false),
+          :ad_links      => SCHEMA.ad_links(:required => false),
+          :response_type => SCHEMA.choice_of([], :required => true),
+          :template_slug => SCHEMA.missing_or_null,
+          :mute          => SCHEMA.missing_or_null,
+          :autoplay      => SCHEMA.missing_or_null,
+          :channel       => SCHEMA.missing_or_null,
+          :expand        => SCHEMA.missing_or_null,
+          :text_overlay  => SCHEMA.missing_or_null,
+          :nami_feed_url => SCHEMA.missing_or_null,
+        }
+
+      SHOW_PROPERTIES =
+        {
+          :id         => SCHEMA.uuid(:required => true),
+          :created_at => SCHEMA.datetime(:required => true),
+          :updated_at => SCHEMA.datetime(:required => true),
+
+          :name          => SCHEMA.nullable_string(:required => true),
+          :ad_links      => SCHEMA.ad_links(:required => true),
+          :response_type => SCHEMA.choice_of([], :required => true),
+          :template_slug => SCHEMA.missing_or_null,
+          :mute          => SCHEMA.missing_or_null,
+          :autoplay      => SCHEMA.missing_or_null,
+          :channel       => SCHEMA.missing_or_null,
+          :expand        => SCHEMA.missing_or_null,
+          :text_overlay  => SCHEMA.missing_or_null,
+          :nami_feed_url => SCHEMA.missing_or_null,
+        }
+
+      UPDATE_PROPERTIES =
+        {
+          :id         => SCHEMA.uuid(:required => true),
+
+          :name          => SCHEMA.nullable_string(:required => false),
+          :ad_links      => SCHEMA.ad_links(:required => false),
+          :response_type => SCHEMA.choice_of([], :required => false),
+          :template_slug => SCHEMA.missing_or_null,
+          :mute          => SCHEMA.missing_or_null,
+          :autoplay      => SCHEMA.missing_or_null,
+          :channel       => SCHEMA.missing_or_null,
+          :expand        => SCHEMA.missing_or_null,
+          :text_overlay  => SCHEMA.missing_or_null,
+          :nami_feed_url => SCHEMA.missing_or_null,
+        }
+    end
+  end
+end

data/lib/neuron-client/version.rb

@@ -1,5 +1,5 @@
 module Neuron
   module Client
-    VERSION = "0.2.6"
+    VERSION = "0.3.0"
   end
 end