device_cloud 0.1.0 → 0.2.0

data/README.md

@@ -1,6 +1,8 @@
 # DeviceCloud
 
-TODO: Write a gem description
+TODO:
+- remove any assumptions about Device Cloud FileData contents .. probably should only parse them if asked
+- add code for maintaining monitors 
 
 ## Installation
 
@@ -20,6 +22,58 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+## Example Push Notification
+
+```json
+{
+  "Document": {
+    "Msg": {
+      "timestamp": "2013-10-21T19:34:56Z",
+      "topic": "4044/FileData/db/4044_MadGlory_Interactive/00000000-00000000-001395FF-FF0E6017/event/parking_lot_event_exit-0966595cdcdd11e2abf50013950e6017.json",
+      "FileData": {
+        "id": {
+          "fdPath": " /db/4044_MadGlory_Interactive/00000000-00000000-001395FF-FF0E6017/event/",
+          "fdName": "parking_lot_event_exit-0966595cdcdd11e2abf50013950e6017.json"
+        },
+        "fdLastModifiedDate": "2013-10-21T19:34:56Z",
+        "fdSize": 545,
+        "fdContentType": "application/json",
+        "fdData": "eyJ2YWx1ZSI6eyJwbGF0ZSI6Ijk0MUdWVCIsImNvbmZpZGVuY2UiOiI5OSIsImNvdW50cnkiOiJVUyIsInRvd2FyZHNfY2FtZXJhIjoiZmFsc2UiLCJ0aW1lc3RhbXAiOiIyMDEzLTEwLTIxVDE0OjM0OjQwWiIsIm92ZXJ2aWV3X2ltYWdlX2lkIjoibG90X292ZXJ2aWV3X2NhcF8xMF8yMV8yMDEzXzE0MzQ0MC5qcGciLCJzdGF0ZSI6Ik1OIiwicGF0Y2hfaW1hZ2VfaWQiOiJsb3RfcGF0Y2hfY2FwXzEwXzIxXzIwMTNfMTQzNDQwLmpwZyJ9LCJjbGFzcyI6ImV2ZW50IiwicXVldWVkX2R0IjoiMjAxMy0xMC0yMVQxOTozNDo1NloiLCJ0eXBlIjoicGFya2luZ19sb3RfZXZlbnRfZXhpdCIsImlkIjoiZGQ5ZDU3MzYzYTg3MTFlM2E5YmQwMDEzOTUwZTYwMTciLCJkZXZpY2VfaWQiOiJtOjAwMTM5NTBFNjAxNyJ9",
+        "fdArchive": false,
+        "cstId": 4044,
+        "fdType": "event",
+        "fdCreatedDate": "2013-06-24T14:52:55.421Z"
+      },
+      "operation": "INSERTION",
+      "replay": true,
+      "group": "*"
+    }
+  }
+}
+```
+
+That notification's unencoded fdData:
+
+```json
+{
+  "value": {
+    "plate": "941GVT",
+    "confidence": "99",
+    "country": "US",
+    "towards_camera": "false",
+    "timestamp": "2013-10-21T14:34:40Z",
+    "overview_image_id": "lot_overview_cap_10_21_2013_143440.jpg",
+    "state": "MN",
+    "patch_image_id": "lot_patch_cap_10_21_2013_143440.jpg"
+  },
+  "class": "event",
+  "queued_dt": "2013-10-21T19:34:56Z",
+  "type": "parking_lot_event_exit",
+  "id": "dd9d57363a8711e3a9bd0013950e6017",
+  "device_id": "m:0013950E6017"
+}
+```
+
 ## Contributing
 
 1. Fork it

data/lib/device_cloud/configuration.rb

@@ -20,16 +20,33 @@ module DeviceCloud
     # Proc will be called with the event notification object
     attr_accessor :event_notification_handler
 
+    # Proc that will be called for handling
+    # DeviceCloud::PushNotification::EventNotification objects that
+    # do not contain file data (data too large - over 120KB)
+    # Proc will be called with the event notification object
+    attr_accessor :empty_event_notification_handler
+
     # Proc that will be called for handling
     # DeviceCloud::PushNotification::AlertNotification objects
     # Proc will be called with the alert notification object
     attr_accessor :alert_notification_handler
 
+    # Proc that will be called for handling
+    # DeviceCloud::PushNotification::AlertNotification objects that
+    # do not contain file data (data too large - over 120KB)
+    # Proc will be called with the alert notification object
+    attr_accessor :empty_alert_notification_handler
+
     # Proc that will be called for handling
     # DeviceCloud::PushNotification::DataNotification objects
     # Proc will be called with the data notification object
     attr_accessor :data_notification_handler
 
+    # Proc that will be called for handling
+    # DeviceCloud::PushNotification::DataNotification objects that
+    # do not contain file data (data too large - over 120KB)
+    # Proc will be called with the data notification object
+    attr_accessor :empty_data_notification_handler
 
     # Yield self to be able to configure ActivityFeed with
     # block-style configuration.

data/lib/device_cloud/push_notification/alert_notification.rb

@@ -3,5 +3,9 @@ module DeviceCloud
     def handle!
       DeviceCloud.alert_notification_handler.call(self)
     end
+
+    def handle_no_content!
+      DeviceCloud.empty_alert_notification_handler.call(self)
+    end
   end
 end

data/lib/device_cloud/push_notification/base_notification.rb

@@ -7,6 +7,11 @@ module DeviceCloud
       event.handle!
     end
 
+    def self.handle_no_content!(file_data)
+      event = new(file_data)
+      event.hanlde_no_content!
+    end
+
     def initialize(file_data)
       @file_data = file_data
       @id = data["id"]
@@ -21,6 +26,10 @@ module DeviceCloud
       raise NotImplementedError
     end
 
+    def handle_no_content!
+      DeviceCloud.logger.info "DeviceCloud::PushNotification::BaseNotification - No FileData content - NotImplemented #{@full_path}"
+    end
+
     def file_name
       @file_data.file_name
     end

data/lib/device_cloud/push_notification/data_notification.rb

@@ -3,5 +3,9 @@ module DeviceCloud
     def handle!
       DeviceCloud.data_notification_handler.call(self)
     end
+
+    def handle_no_content!
+      DeviceCloud.empty_data_notification_handler.call(self)
+    end
   end
 end

data/lib/device_cloud/push_notification/event_notification.rb

@@ -3,5 +3,9 @@ module DeviceCloud
     def handle!
       DeviceCloud.event_notification_handler.call(self)
     end
+
+    def handle_no_content!
+      DeviceCloud.empty_event_notification_handler.call(self)
+    end
   end
 end

data/lib/device_cloud/push_notification/message/file_data.rb

@@ -4,14 +4,14 @@ require 'base64'
 module DeviceCloud
   class PushNotification::Message::FileData
     attr_accessor :id, :fdLastModifiedDate, :fdSize, :fdContentType, :fdData, :fdArchive, :cstId, :fdType, :fdCreatedDate
-    attr_reader :errors
+    attr_reader :no_content
 
     def initialize(attributes = {})
-      @errors = []
+      @no_content = false
       attributes.each do |name, value|
         send("#{name}=", value)
       end
-      DeviceCloud.logger.warn "DeviceCloud::PushNotification::Message::FileData Invalid (#{errors.join(',')}) - #{full_path}" unless valid?
+      validate_content!
     end
 
     def full_path
@@ -23,8 +23,7 @@ module DeviceCloud
     end
 
     def data
-      return false unless valid?
-      @data ||= if json_data?
+      @data ||= if json_data? && content?
         JSON.parse unencoded_data
       else
         unencoded_data
@@ -32,18 +31,21 @@ module DeviceCloud
     end
 
     def file_name
-      return '' unless id
+      return '' unless id && id['fdName']
       id['fdName']
     end
 
     def file_path
-      return '' unless id
+      return '' unless id && id['fdPath']
       id['fdPath']
     end
 
-    def valid?
-      return false if @errors.any?
-      validate_content!
+    def no_content?
+      @no_content
+    end
+
+    def content?
+      !no_content?
     end
   private
     def json_data?
@@ -51,16 +53,11 @@ module DeviceCloud
     end
 
     def unencoded_data
-      @unencoded_data ||= Base64.decode64(fdData)
+      @unencoded_data ||= no_content? ? '' : Base64.decode64(fdData)
     end
 
     def validate_content!
-      if !fdData || fdData.size == 0 || fdSize.to_i < 1
-        @errors << 'no content'
-        false
-      else
-        true
-      end
+      @no_content = !fdData || fdData.size == 0 || fdSize.to_i < 1
     end
   end
 end

data/lib/device_cloud/push_notification/message.rb

@@ -2,8 +2,6 @@ module DeviceCloud
   class PushNotification::Message
     attr_accessor :timestamp, :topic, :file_data, :operation, :group, :replay
 
-    ALLOWED_TOPICS = %w{alert event data}
-
     def self.parse_raw_messages(raw_message_data)
       if raw_message_data.is_a? Array
         messages = raw_message_data.map {|message| new(message) }
@@ -21,7 +19,7 @@ module DeviceCloud
           send("#{name}=", value)
         end
       end
-      DeviceCloud.logger.warn "DeviceCloud::PushNotification::Message Invalid (no content) - #{topic}" unless valid?
+      DeviceCloud.logger.info "DeviceCloud::PushNotification::Message Invalid (no FileData) - #{topic}" unless valid?
     end
 
     def parsed_file_data
@@ -29,26 +27,12 @@ module DeviceCloud
       @parsed_file_data ||= FileData.new file_data
     end
 
-    def valid?
-      !!file_data && topic_allowed?
+    def no_content?
+      parsed_file_data.no_content?
     end
 
-    def valid_parsed_file_data?
-      parsed_file_data.valid?
-    end
-
-    def topic_type
-      topic_matches.first
-    end
-
-  private
-    def topic_allowed?
-      return false if !topic
-      topic_matches.any?
-    end
-
-    def topic_matches
-      topic.split('/') & ALLOWED_TOPICS
+    def valid?
+      !!file_data
     end
   end
 end

data/lib/device_cloud/push_notification.rb

@@ -8,11 +8,11 @@ module DeviceCloud
 
     def handle_each!
       messages.each do |message|
-        next unless message.valid? && message.valid_parsed_file_data?
+        next unless message.valid?
 
         klass = class_type(message.topic_type)
-        
-        klass.handle!(message.parsed_file_data)
+
+        message.no_content? ? klass.handle_no_content!(message.parsed_file_data) : klass.handle!(message.parsed_file_data)
       end
     end
   private

data/lib/device_cloud/version.rb

@@ -1,3 +1,3 @@
 module DeviceCloud
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/device_cloud/push_notification/base_notification_spec.rb

@@ -5,7 +5,7 @@ describe DeviceCloud::PushNotification::BaseNotification do
   let(:raw_file_data) do
     {
       "id" => {
-        "fdPath" => " /db/4044_MadGlory_Interactive/00000000-00000000-001395FF-FF0E6012/alert/",
+        "fdPath" => "/db/4044_MadGlory_Interactive/00000000-00000000-001395FF-FF0E6012/alert/",
         "fdName" => "foo-0966595cdcdd11e2abf50013950e6012.json"
       },
       "fdLastModifiedDate" => "2013-06-24T14:52:55.421Z",
@@ -42,6 +42,22 @@ describe DeviceCloud::PushNotification::BaseNotification do
     end
   end
 
+  describe "#handle_no_content!" do
+    let(:logger) { double('logger') }
+    before(:each) do
+      DeviceCloud.logger = logger
+    end
+
+    after(:each) do
+      DeviceCloud.logger = Logger.new(STDOUT)
+    end
+
+    it "should raise NotImplementedError" do
+      logger.should_receive(:info).with("DeviceCloud::PushNotification::BaseNotification - No FileData content - NotImplemented #{raw_file_data['id']['fdPath']}#{raw_file_data['id']['fdName']}")
+      subject.handle_no_content!
+    end
+  end
+
   describe "#mac_address" do
     context "when device_id present" do
       its(:mac_address) { should eq('00:13:95:0E:60:12') }

data/spec/device_cloud/push_notification/message/file_data_spec.rb

@@ -31,31 +31,59 @@ describe DeviceCloud::PushNotification::Message::FileData do
     its(:fdData) { should eq(raw_file_data["fdData"]) }
   end
 
-  describe '#valid?' do
-    context 'without content' do
-      let(:raw_file_data) do
+  describe '#no_content?' do
+    let(:raw_file_data) do
+      {
+        "id" => {
+          "fdPath" => " /db/4044_MadGlory_Interactive/00000000-00000000-001395FF-FF0E6012/alert/",
+          "fdName" => "foo-0966595cdcdd11e2abf50013950e6012.json"
+        },
+        "fdLastModifiedDate" => "2013-06-24T14:52:55.421Z",
+        "fdSize" => 156,
+        "fdContentType" => "application/octet-stream",
+        "fdData" => fd_data_content,
+        "fdArchive" => false,
+        "cstId" => 4044,
+        "fdType" => "file",
+        "fdCreatedDate" => "2013-06-24T14:52:55.421Z"
+      }
+    end
+    subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data }
+
+    context 'when fdData blank' do
+      let(:fd_data_content) { '' }
+      its(:no_content?) { should be_true }
+    end
+
+    context 'when fdData null' do
+      let(:fd_data_content) { nil }
+      its(:no_content?) { should be_true }
+    end
+
+    context 'when fdData missing' do
+      let(:missing_fd_data) do
         {
           "id" => {
             "fdPath" => " /db/4044_MadGlory_Interactive/00000000-00000000-001395FF-FF0E6012/alert/",
             "fdName" => "foo-0966595cdcdd11e2abf50013950e6012.json"
           },
           "fdLastModifiedDate" => "2013-06-24T14:52:55.421Z",
-          "fdSize" => 156,
+          "fdSize" => 0,
           "fdContentType" => "application/octet-stream",
-          "fdData" => "",
           "fdArchive" => false,
           "cstId" => 4044,
           "fdType" => "file",
           "fdCreatedDate" => "2013-06-24T14:52:55.421Z"
         }
       end
+      subject { DeviceCloud::PushNotification::Message::FileData.new missing_fd_data }
+      its(:no_content?) { should be_true }
+    end
 
-      subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data}
-      its(:valid?) { should be_false }
-      it "should set a 'no content' error" do
-        subject.valid?
-        expect(subject.errors.include?('no content')).to be_true
-      end
+    context 'when fdData present' do
+      let(:fd_data_content) { 'jibberish' }
+      subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data }
+      its(:no_content) { should be_false }
     end
   end
 
@@ -66,10 +94,15 @@ describe DeviceCloud::PushNotification::Message::FileData do
       its(:file_path) { should eq raw_file_data['id']['fdPath'] }
     end
 
-    context "when id blank" do
+    context "when id not present" do
       subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data.merge( 'id' => nil ) }
       its(:file_path) { should eq '' }
     end
+
+    context "when id blank" do
+      subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data.merge( 'id' => '' ) }
+      its(:file_path) { should eq '' }
+    end
   end
 
   describe "#file_name" do
@@ -79,14 +112,19 @@ describe DeviceCloud::PushNotification::Message::FileData do
       its(:file_name) { should eq raw_file_data['id']['fdName'] }
     end
 
-    context "when id blank" do
+    context "when id not present" do
       subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data.merge( 'id' => nil ) }
       its(:file_name) { should eq '' }
     end
+
+    context "when id blank" do
+      subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data.merge( 'id' => '' ) }
+      its(:file_name) { should eq '' }
+    end
   end
 
   describe "#data" do
-    context 'when valid' do
+    context 'when content present' do
       context "json content-type" do
         subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data }
         its(:data) { should eq(JSON.parse(Base64.decode64(raw_file_data['fdData']))) }
@@ -103,12 +141,12 @@ describe DeviceCloud::PushNotification::Message::FileData do
       end
     end
 
-    context 'when invalid' do
+    context 'when content not present' do
       subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data.merge('fdData' => '') }
-      its(:data) { should be_false }
+      its(:data) { should eq '' }
 
       subject { DeviceCloud::PushNotification::Message::FileData.new raw_file_data.merge('fdData' => nil) }
-      its(:data) { should be_false }
+      its(:data) { should eq '' }
     end
   end
 

data/spec/device_cloud/push_notification/message_spec.rb

@@ -104,31 +104,45 @@ describe DeviceCloud::PushNotification::Message do
     end
 
     describe "#valid?" do
-      context "with file_data and allowed topic" do
-        subject { DeviceCloud::PushNotification::Message.new 'FileData' => 'present', 'topic' => DeviceCloud::PushNotification::Message::ALLOWED_TOPICS.sample }
+      context "with file_data" do
+        subject { DeviceCloud::PushNotification::Message.new 'FileData' => 'present' }
         its(:valid?) { should be_true }
       end
 
       context "without file_data" do
-        subject { DeviceCloud::PushNotification::Message.new 'topic' => DeviceCloud::PushNotification::Message::ALLOWED_TOPICS.sample }
-        its(:valid?) { should_not be_true }
-      end
+        let(:logger) { double('logger') }
+        before(:each) do
+          DeviceCloud.logger = logger
+          logger.should_receive(:info)
+        end
 
-      context "without allowed topic" do
-        subject { DeviceCloud::PushNotification::Message.new 'FileData' => 'present' }
+        after(:each) do
+          DeviceCloud.logger = Logger.new(STDOUT)
+        end
+
+        subject { DeviceCloud::PushNotification::Message.new }
         its(:valid?) { should_not be_true }
       end
     end
 
     describe "#parsed_file_data" do
       context "when invalid" do
+        let(:logger) { double('logger') }
+        before(:each) do
+          DeviceCloud.logger = logger
+          logger.should_receive(:info)
+        end
+
+        after(:each) do
+          DeviceCloud.logger = Logger.new(STDOUT)
+        end
         it "should be false" do
           expect(subject.parsed_file_data).to be_false
         end
       end
 
       context "when valid" do
-        subject { DeviceCloud::PushNotification::Message.new 'FileData' => single_raw_message["FileData"], 'topic' => DeviceCloud::PushNotification::Message::ALLOWED_TOPICS.sample }
+        subject { DeviceCloud::PushNotification::Message.new 'FileData' => single_raw_message["FileData"] }
 
         it "should return a DeviceCloud::PushNotification::Message::FileData object" do
           expect(subject.parsed_file_data.class).to eq(DeviceCloud::PushNotification::Message::FileData)

data/spec/device_cloud/push_notification_spec.rb

@@ -12,19 +12,34 @@ describe DeviceCloud::PushNotification do
     [
       OpenStruct.new(
         valid?: true,
-        valid_parsed_file_data?: true,
         topic_type: 'alert',
         parsed_file_data: 'the alert data'
       ),
       OpenStruct.new(
         valid?: true,
-        valid_parsed_file_data?: true,
         topic_type: 'event',
         parsed_file_data: 'the event data'
       ),
       OpenStruct.new(
         valid?: true,
-        valid_parsed_file_data?: true,
+        topic_type: 'data',
+        parsed_file_data: 'the data data'
+      ),
+      OpenStruct.new(
+        valid?: true,
+        no_content?: true,
+        topic_type: 'alert',
+        parsed_file_data: 'the alert data'
+      ),
+      OpenStruct.new(
+        valid?: true,
+        no_content?: true,
+        topic_type: 'event',
+        parsed_file_data: 'the event data'
+      ),
+      OpenStruct.new(
+        valid?: true,
+        no_content?: true,
         topic_type: 'data',
         parsed_file_data: 'the data data'
       )
@@ -54,6 +69,12 @@ describe DeviceCloud::PushNotification do
 
         DeviceCloud::PushNotification::DataNotification.should_receive(:handle!).with(valid_parsed_messages[2].parsed_file_data)
 
+        DeviceCloud::PushNotification::AlertNotification.should_receive(:handle_no_content!).with(valid_parsed_messages[3].parsed_file_data)
+
+        DeviceCloud::PushNotification::EventNotification.should_receive(:handle_no_content!).with(valid_parsed_messages[4].parsed_file_data)
+
+        DeviceCloud::PushNotification::DataNotification.should_receive(:handle_no_content!).with(valid_parsed_messages[5].parsed_file_data)
+
         subject.handle_each!
 
       end
@@ -63,7 +84,6 @@ describe DeviceCloud::PushNotification do
       it "should not be handled" do
         valid_parsed_messages[0] = OpenStruct.new(
           valid?: false, # test condition
-          valid_parsed_file_data?: true,
           topic_type: 'alert',
           parsed_file_data: 'the alert data'
         )
@@ -73,23 +93,11 @@ describe DeviceCloud::PushNotification do
         DeviceCloud::PushNotification::EventNotification.should_receive(:handle!)
         DeviceCloud::PushNotification::DataNotification.should_receive(:handle!)
 
-        subject.handle_each!
-      end
-    end
+        DeviceCloud::PushNotification::AlertNotification.should_receive(:handle_no_content!)
 
-    context "an invalid parsed_file_data" do
-      it "should not be handled" do
-        valid_parsed_messages[0] = OpenStruct.new(
-          valid?: true,
-          valid_parsed_file_data?: false, # test condition
-          topic_type: 'alert',
-          parsed_file_data: 'the alert data'
-        )
-
-        DeviceCloud::PushNotification::AlertNotification.should_not_receive(:handle!)
-
-        DeviceCloud::PushNotification::EventNotification.should_receive(:handle!)
-        DeviceCloud::PushNotification::DataNotification.should_receive(:handle!)
+        DeviceCloud::PushNotification::EventNotification.should_receive(:handle_no_content!)
+        
+        DeviceCloud::PushNotification::DataNotification.should_receive(:handle_no_content!)
 
         subject.handle_each!
       end

data/spec/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe 'DeviceCloud::VERSION' do
   it 'should be the correct version' do
-    DeviceCloud::VERSION.should == '0.1.0'
+    DeviceCloud::VERSION.should == '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: device_cloud
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler