neuron-client 0.3.0 → 0.4.0

data/lib/neuron-client/model/ad.rb

@@ -68,17 +68,25 @@ module Neuron
 
       STATISTIC_TYPES = %w(selections undeliveries impressions redirects clicks)
 
-      def recent(statistic, by=nil)
+      def recent(statistic, parameters={})
         connected_to_admin!
+        by = (parameters[:by] || parameters['by']).to_s
+        minutes = parameters[:minutes] || parameters['minutes']
+        parameters = {}
+        parameters['by'] = by unless by.blank?
+        parameters['minutes'] = minutes.to_i if minutes.to_i > 0
         if validate?
           unless STATISTIC_TYPES.include?(statistic.to_s)
             raise "Unsupported statistic: #{statistic}"
           end
-          unless by.nil? || by.to_s == 'zone'
+          unless by.blank? || by == 'zone'
             raise "Unsupported by: #{by}"
           end
+          unless minutes.blank? || minutes.to_i > 0
+            raise "Unsupported minutes: #{minutes}"
+          end
         end
-        parameters = by.nil? ? {} : {'by' => by.to_s}
+
         connection.get("ads/#{id}/recent/#{statistic}", parameters)
       end
 

data/lib/neuron-client/model/base.rb

@@ -95,7 +95,12 @@ module Neuron
         # data : the serializable object that should match the given schema
         def validate_against_schema!(schema_name, data)
           if validate? && data.present?
-            JSON::Validator.validate!(schema.send(schema_name), data)
+            begin
+              JSON::Validator.validate!(schema.send(schema_name), data)
+            rescue Exception => e
+              e.message << "\nSchema: #{schema.class.name}::SCHEMA.#{schema_name}\nData: #{data.inspect}"
+              raise e
+            end
           end
         end
 

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

@@ -11,7 +11,14 @@ module Neuron
       VAST = "Vast"
       RESPONSE_TYPES = [REDIRECT, IRIS, VAST]
 
-      TEMPLATE_SLUGS = ["300x250", "300x600"]
+      IRIS_2_0 = '2_0'
+      IRIS_2_5 = '2_5'
+      IRIS_VERSIONS = [IRIS_2_0, IRIS_2_5]
+      TEMPLATE_SLUGS = ['300x250']
+      PLAYLIST_MODES = ['MAXI', 'MINI']
+      PLAYBACK_MODE_OPTIONS = [['Auto Play', 'AUTO'], ['Click To Play','CTP'], ['Rollover To Play', 'RTP']]
+      PLAYBACK_MODES = Hash[PLAYBACK_MODE_OPTIONS].values
+      OVERLAY_PROVIDERS = ['NAMI', 'PREDICTV']
 
       ATTRIBUTES = [
         :id,
@@ -19,12 +26,20 @@ module Neuron
         :name,
         :response_type, # string in RESPONSE_TYPES
         :template_slug, # nil, or string in TEMPLATE_SLUGS
-        :mute,          # nil, or "Yes" or "No"
-        :autoplay,      # nil, or "Yes" or "No"
         :channel,       # nil, or slug
         :expand,        # nil, or "Yes" or "No"
-        :text_overlay,  # nil, or "Yes" or "No"
-        :nami_feed_url, # nil, or string URL
+        :iris_version,  # nil, or string in IRIS_VERSIONS
+        # Iris 2.0
+        :mute,          # nil, or "Yes" or "No"
+        :autoplay,      # nil, or "Yes" or "No"
+        # Iris 2.5
+        :playlist_mode, # nil, or string in PLAYLIST_MODES
+        :volume,        # nil, or 1-100s
+        :color,         # nil, or string (hex color - '333333')
+        :playback_mode, # nil, or string in PLAYBACK_MODES
+        :overlay_provider, # nil, or string in OVERLAY_PROVIDERS
+        :overlay_feed_url, # nil, or string URL
+
         :created_at,    # string, datetime in UTC
         :updated_at,    # string, datetime in UTC
       ]

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

@@ -13,7 +13,7 @@ module Neuron
         def validate!(schema_name, data)
           JSON::Validator.validate!(schema.send(schema_name), data)
         rescue Exception => e
-          puts "Data: #{data}"
+          e.message << "\nSchema: #{schema.class.name}::SCHEMA.#{schema_name}\nData: #{data.inspect}"
           raise e
         end
       end

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

@@ -17,7 +17,8 @@ module Neuron
         @@create ||=
         one_of(
           create_redirect,
-          create_iris,
+          create_iris_2_0,
+          create_iris_2_5,
           create_vast
         )
       end
@@ -26,7 +27,8 @@ module Neuron
         @@show ||=
         one_of(
           show_redirect,
-          show_iris,
+          show_iris_2_0,
+          show_iris_2_5,
           show_vast
         )
       end
@@ -35,7 +37,8 @@ module Neuron
         @@update ||=
         one_of(
           update_redirect,
-          update_iris,
+          update_iris_2_0,
+          update_iris_2_5,
           update_vast
         )
       end
@@ -49,17 +52,33 @@ module Neuron
         }))
       end
 
-      def create_iris
-        @@create_iris ||=
+      def create_iris_2_0
+        @@create_iris_2_0 ||=
         object_type("zone", merged(CREATE_PROPERTIES,{
           :response_type => SCHEMA.choice_of([Neuron::Client::Zone::IRIS]),
+          :iris_version  => SCHEMA.choice_of([Neuron::Client::Zone::IRIS_2_0], :required => false),
           :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)
+          :mute          => SCHEMA.yes_no,
+          :autoplay      => SCHEMA.yes_no
+        }))
+      end
+
+      def create_iris_2_5
+        @@create_iris_2_5 ||=
+        object_type("zone", merged(CREATE_PROPERTIES,{
+          :response_type    => SCHEMA.choice_of([Neuron::Client::Zone::IRIS]),
+          :iris_version     => SCHEMA.choice_of([Neuron::Client::Zone::IRIS_2_5]),
+          :template_slug    => SCHEMA.choice_of(Neuron::Client::Zone::TEMPLATE_SLUGS),
+          :channel          => SCHEMA.channel,
+          :expand           => SCHEMA.yes_no,
+          :playlist_mode    => SCHEMA.playlist_mode,
+          :volume           => SCHEMA.volume,
+          :color            => SCHEMA.color(:required => false),
+          :playback_mode    => SCHEMA.playback_mode,
+          :overlay_provider => SCHEMA.overlay_provider(:required => false),
+          :overlay_feed_url => SCHEMA.url(:type => %w(null string), :required => false)
         }))
       end
 
@@ -77,17 +96,33 @@ module Neuron
         }))
       end
 
-      def show_iris
-        @@show_iris ||=
+      def show_iris_2_0
+        @@show_iris_2_0 ||=
         object_type("zone", merged(SHOW_PROPERTIES,{
           :response_type => SCHEMA.choice_of([Neuron::Client::Zone::IRIS]),
+          :iris_version  => SCHEMA.choice_of([Neuron::Client::Zone::IRIS_2_0], :required => false),
           :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))
+          :mute          => SCHEMA.yes_no,
+          :autoplay      => SCHEMA.yes_no
+        }))
+      end
+
+      def show_iris_2_5
+        @@show_iris_2_5 ||=
+        object_type("zone", merged(SHOW_PROPERTIES,{
+          :response_type    => SCHEMA.choice_of([Neuron::Client::Zone::IRIS]),
+          :iris_version     => SCHEMA.choice_of([Neuron::Client::Zone::IRIS_2_5]),
+          :template_slug    => SCHEMA.choice_of(Neuron::Client::Zone::TEMPLATE_SLUGS),
+          :channel          => SCHEMA.channel,
+          :expand           => SCHEMA.yes_no,
+          :playlist_mode    => SCHEMA.playlist_mode,
+          :volume           => SCHEMA.volume,
+          :color            => SCHEMA.color,
+          :playback_mode    => SCHEMA.playback_mode,
+          :overlay_provider => SCHEMA.overlay_provider,
+          :overlay_feed_url => SCHEMA.url(:type => %w(null string))
         }))
       end
 
@@ -105,17 +140,33 @@ module Neuron
         }))
       end
 
-      def update_iris
-        @@update_iris ||=
+      def update_iris_2_0
+        @@update_iris_2_0 ||=
         object_type("zone", merged(UPDATE_PROPERTIES,{
           :response_type => SCHEMA.choice_of([Neuron::Client::Zone::IRIS], :required => false),
+          :iris_version  => SCHEMA.choice_of([Neuron::Client::Zone::IRIS_2_0], :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)
+          :mute          => SCHEMA.yes_no(:required => false),
+          :autoplay      => SCHEMA.yes_no(:required => false)
+        }))
+      end
+
+      def update_iris_2_5
+        @@update_iris_2_5 ||=
+        object_type("zone", merged(UPDATE_PROPERTIES,{
+          :response_type    => SCHEMA.choice_of([Neuron::Client::Zone::IRIS], :required => false),
+          :iris_version     => SCHEMA.choice_of([Neuron::Client::Zone::IRIS_2_5], :required => false),
+          :template_slug    => SCHEMA.choice_of(Neuron::Client::Zone::TEMPLATE_SLUGS, :required => false),
+          :channel          => SCHEMA.channel(:required => false),
+          :expand           => SCHEMA.yes_no(:required => false),
+          :playlist_mode    => SCHEMA.playlist_mode(:required => false),
+          :volume           => SCHEMA.volume(:required => false),
+          :color            => SCHEMA.color(:required => false),
+          :playback_mode    => SCHEMA.playback_mode(:required => false),
+          :overlay_provider => SCHEMA.overlay_provider(:required => false),
+          :overlay_feed_url => SCHEMA.url(:type => %w(null string), :required => false)
         }))
       end
 
@@ -157,23 +208,63 @@ module Neuron
         }, overrides)
       end
 
+      def color(overrides={})
+        merged({
+          :type => %w(string null),
+          :format => "color",
+          :required => true
+        }, overrides)
+      end
+
+      def overlay_provider(overrides={})
+        choice_of(Neuron::Client::Zone::OVERLAY_PROVIDERS, overrides)
+      end
+
+      def playback_mode(overrides={})
+        choice_of(Neuron::Client::Zone::PLAYBACK_MODES, overrides)
+      end
+
+      def playlist_mode(overrides={})
+        choice_of(Neuron::Client::Zone::PLAYLIST_MODES, overrides)
+      end
+
+      def volume(overrides={})
+        merged({
+          :type => %w(integer string null),
+          :required => true,
+          :minimum => 0,
+          :exclusiveMinimum => false,
+          :maximum => 100,
+          :exclusiveMaximum => false,
+          :pattern => "^[0-9]\\d+$",
+          :maxLength => 3
+        }, 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),
+          :iris_version  => SCHEMA.missing_or_null,
           :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,
+          # Iris 2.0
+          :mute             => SCHEMA.missing_or_null,
+          :autoplay         => SCHEMA.missing_or_null,
+          # Iris 2.5
+          :playlist_mode    => SCHEMA.missing_or_null,
+          :volume           => SCHEMA.missing_or_null,
+          :color            => SCHEMA.missing_or_null,
+          :playback_mode    => SCHEMA.missing_or_null,
+          :overlay_provider => SCHEMA.missing_or_null,
+          :overlay_feed_url => SCHEMA.missing_or_null,
+
         }
 
       SHOW_PROPERTIES =
@@ -185,13 +276,20 @@ module Neuron
           :name          => SCHEMA.nullable_string(:required => true),
           :ad_links      => SCHEMA.ad_links(:required => true),
           :response_type => SCHEMA.choice_of([], :required => true),
+          :iris_version  => SCHEMA.missing_or_null,
           :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,
+          # Iris 2.0
+          :mute             => SCHEMA.missing_or_null,
+          :autoplay         => SCHEMA.missing_or_null,
+          # Iris 2.5
+          :playlist_mode    => SCHEMA.missing_or_null,
+          :volume           => SCHEMA.missing_or_null,
+          :color            => SCHEMA.missing_or_null,
+          :playback_mode    => SCHEMA.missing_or_null,
+          :overlay_provider => SCHEMA.missing_or_null,
+          :overlay_feed_url => SCHEMA.missing_or_null,
         }
 
       UPDATE_PROPERTIES =
@@ -201,13 +299,20 @@ module Neuron
           :name          => SCHEMA.nullable_string(:required => false),
           :ad_links      => SCHEMA.ad_links(:required => false),
           :response_type => SCHEMA.choice_of([], :required => false),
+          :iris_version  => SCHEMA.missing_or_null,
           :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,
+          # Iris 2.0
+          :mute             => SCHEMA.missing_or_null,
+          :autoplay         => SCHEMA.missing_or_null,
+          # Iris 2.5
+          :playlist_mode    => SCHEMA.missing_or_null,
+          :volume           => SCHEMA.missing_or_null,
+          :color            => SCHEMA.missing_or_null,
+          :playback_mode    => SCHEMA.missing_or_null,
+          :overlay_provider => SCHEMA.missing_or_null,
+          :overlay_feed_url => SCHEMA.missing_or_null,
         }
     end
   end

data/lib/neuron-client/version.rb

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

data/spec/lib/model/ad_spec.rb

@@ -178,7 +178,7 @@ module Neuron
             ad = Ad.new(@minimal_attributes.merge('id' => 7))
             @connection.should_receive(:get).with('ads/7/recent/impressions', {'by' => 'zone'}).and_return('return_value')
 
-            ad.recent('impressions', 'zone').should == 'return_value'
+            ad.recent('impressions', :by => 'zone').should == 'return_value'
           end
         end
 

data/spec/lib/model/zone_spec.rb

@@ -4,16 +4,21 @@ module Neuron
       before(:each) do
         @datetime = "2011-11-11T11:11:11Z"
         @minimal_attributes = {
-          'ad_links'       => nil,
-          'name'           => nil,
-          'response_type'  => nil,
-          'template_slug'  => nil,
-          'mute'           => nil,
-          'autoplay'       => nil,
-          'channel'        => nil,
-          'expand'         => nil,
-          'text_overlay'   => nil,
-          'nami_feed_url'  => nil,
+          'ad_links'         => nil,
+          'name'             => nil,
+          'response_type'    => nil,
+          'iris_version'     => nil,
+          'template_slug'    => nil,
+          'mute'             => nil,
+          'autoplay'         => nil,
+          'channel'          => nil,
+          'expand'           => nil,
+          'playlist_mode'    => nil,
+          'volume'           => nil,
+          'color'            => nil,
+          'playback_mode'    => nil,
+          'overlay_provider' => nil,
+          'overlay_feed_url' => nil,
         }
       end
       context "when connected to the admin server" do

data/spec/lib/schema/zone_spec.rb

@@ -58,7 +58,7 @@ module Neuron
           }}, :against => Zone::SCHEMA.create)
         end
 
-        it "should approve an example iris zone" do
+        it "should approve an example iris 2.0 zone" do
           validate({"zone" => {
             "name" => "example_iris_zone",
             "response_type" => "Iris",
@@ -67,9 +67,23 @@ module Neuron
             "mute" => "No",
             "autoplay" => "Yes",
             "channel" => "drivel",
+            "template_slug" => "300x250"
+          }}, :against => Zone::SCHEMA.create)
+        end
+
+        it "should approve an example iris 2.5 zone" do
+          validate({"zone" => {
+            "name" => "example_iris_zone",
+            "response_type" => "Iris",
+            "ad_links" => {},
+            "expand" => "Yes",
+            "channel" => "drivel",
             "template_slug" => "300x250",
-            "text_overlay" => "Yes",
-            "nami_feed_url" => "http://example.com/"
+            "playlist_mode" => "MAXI",
+            "playback_mode" => "AUTO",
+            "volume" => "10",
+            "color" => "#FF0000",
+            "iris_version" => "2_5"
           }}, :against => Zone::SCHEMA.create)
         end
 
@@ -118,7 +132,7 @@ module Neuron
           }}, :against => Zone::SCHEMA.show)
         end
 
-        it "should approve an example iris zone" do
+        it "should approve an example iris 2.0 zone" do
           validate({"zone" => {
             "name" => "example_iris_zone",
             "response_type" => "Iris",
@@ -128,8 +142,27 @@ module Neuron
             "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 iris 2.5 zone" do
+          validate({"zone" => {
+            "name" => "example_iris_zone",
+            "response_type" => "Iris",
+            "ad_links" => {},
+            "expand" => "Yes",
+            "channel" => "drivel",
+            "template_slug" => "300x250",
+            "playlist_mode" => "MAXI",
+            "playback_mode" => "AUTO",
+            "volume" => "10",
+            "color" => "#FF0000",
+            "overlay_provider" => "NAMI",
+            "overlay_feed_url" => "http://example.com/",
+            "iris_version" => "2_5",
             "created_at" => @datetime,
             "updated_at" => @datetime,
             "id" => "abc123"
@@ -188,7 +221,7 @@ module Neuron
           }}, :against => Zone::SCHEMA.update)
         end
 
-        it "should approve an example iris zone" do
+        it "should approve an example iris 2.0 zone" do
           validate({"zone" => {
             "name" => "example_iris_zone",
             "response_type" => "Iris",
@@ -197,13 +230,30 @@ module Neuron
             "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 iris 2.5 zone" do
+          validate({"zone" => {
+            "name" => "example_iris_zone",
+            "response_type" => "Iris",
+            "ad_links" => {},
+            "expand" => "Yes",
+            "channel" => "drivel",
+            "template_slug" => "300x250",
+            "playlist_mode" => "MAXI",
+            "playback_mode" => "AUTO",
+            "volume" => "10",
+            "color" => "#FF0000",
+            "overlay_provider" => "NAMI",
+            "overlay_feed_url" => "http://example.com/",
+            "iris_version" => "2_5",
+            "id" => "abc123"
+          }}, :against => Zone::SCHEMA.update)
+        end
+
         it "should approve an example vast zone" do
           validate({"zone" => {
             "name" => "example vast zone",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: neuron-client
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - RMM Online
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-11 00:00:00 Z
+date: 2012-01-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client