Merge pull request #99 from ryanhertz/saved-search-subscriptions

updated provided saved searches to allow newsfeeds

Author: mjobrien

lib/spark_api/models/saved_search.rb

@@ -8,6 +8,11 @@ class SavedSearch < Base
 
       attr_accessor :newsfeeds
 
+      # Newsfeed restriction criteria for saved searches:
+      # http://alpha.sparkplatform.com/docs/api_services/newsfeed/restrictions#criteria
+      QUALIFYING_FIELDS_FOR_NEWSFEED = %w(BathsTotal BedsTotal City CountyOrParish ListPrice Location MlsStatus 
+        PostalCode PropertyType RoomsTotal State)
+
       self.element_name="savedsearches"
 
       def initialize(attributes={})
@@ -22,9 +27,6 @@ def self.provided()
           def provided_search?
             true
           end
-          def newsfeeds
-            []
-          end
           SparkApi.logger.info("#{self.name}.path: #{provided.path}")
         end
       end
@@ -69,12 +71,8 @@ def listings(args = {})
       end
 
       def newsfeeds
-        if @newsfeeds.nil?
-          response = SparkApi.client.get("/savedsearches/#{@attributes["Id"]}", :_expand => "NewsFeeds").first["NewsFeeds"]
-              # the response from the api is just a bunch of hashes, but we can turn them into Newsfeed instances
-          @newsfeeds = response.map { |hash| Newsfeed.new(hash) }
-        end
-        @newsfeeds
+        Newsfeed.collect(connection.get("#{self.class.path}/#{@attributes["Id"]}", 
+          :_expand => "NewsFeeds").first["NewsFeeds"])
       end
 
       def provided_search?
@@ -83,16 +81,11 @@ def provided_search?
 
       def can_have_newsfeed?
 
-        return false if provided_search? 
         return true  if has_active_newsfeed? || has_inactive_newsfeed?
 
-        # Newsfeed restriction criteria for saved searches:
-        # http://alpha.sparkplatform.com/docs/api_services/newsfeed/restrictions#criteria
-        standard_fields = %w(BathsTotal BedsTotal City CountyOrParish ListPrice Location MlsStatus PostalCode PropertyType RoomsTotal State)
-
         number_of_filters = 0
 
-        standard_fields.each do |field|
+        QUALIFYING_FIELDS_FOR_NEWSFEED.each do |field|
           number_of_filters += 1 if self.Filter.include? field
         end
 
@@ -101,24 +94,22 @@ def can_have_newsfeed?
       end
 
       def has_active_newsfeed?
-        return false if provided_search? 
-
         if self.respond_to? "NewsFeedSubscriptionSummary"
           self.NewsFeedSubscriptionSummary['ActiveSubscription']
         else
-          saved_search = SavedSearch.find( self.Id, {"_expand" => "NewsFeedSubscriptionSummary"})
-          saved_search.NewsFeedSubscriptionSummary['ActiveSubscription']
+          search = connection.get "#{self.class.path}/#{@attributes['Id']}", 
+            {"_expand" => "NewsFeedSubscriptionSummary"}
+          search.first["NewsFeedSubscriptionSummary"]["ActiveSubscription"]
         end
       end
 
       def has_inactive_newsfeed?
-        return false if provided_search? 
-       
-        if self.respond_to? "NewsFeedSubscriptionSummary"
-          !self.NewsFeedSubscriptionSummary['ActiveSubscription']
+        if self.respond_to?("NewsFeeds") && self.respond_to?("NewsFeedSubscriptionSummary")
+          self.NewsFeeds.any? && !self.NewsFeedSubscriptionSummary['ActiveSubscription']
         else
-          saved_search = SavedSearch.find( self.Id, {"_expand" => "NewsFeedSubscriptionSummary"})
-          !saved_search.NewsFeedSubscriptionSummary['ActiveSubscription']
+          search = connection.get("#{self.class.path}/#{@attributes['Id']}", 
+            {"_expand" => "NewsFeedSubscriptionSummary, NewsFeeds"}).first
+          search["NewsFeeds"].any? && !search["NewsFeedSubscriptionSummary"]["ActiveSubscription"]
         end
       end
 

spec/fixtures/saved_searches/without_newsfeed.json

@@ -0,0 +1,20 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [
+            { 
+              "ResourceUri": "/v1/savedsearches/20100815220615294367000000",
+              "Id":  "20100815220615294367000000",
+              "Name": "Search name here",
+              "ContactIds": [
+                "20100815220615294367000000"
+              ],
+              "NewsFeedSubscriptionSummary": {
+                "ActiveSubscription": false
+              },
+              "NewsFeeds": []
+            }
+
+        ]
+    }
+}

spec/unit/spark_api/models/saved_search_spec.rb

@@ -167,15 +167,11 @@
 
   describe "can_have_newsfeed?" do
 
-    it "should return false for a provided search" do
-      stub_api_get("/provided/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
-      resource = subject.class.provided.find(id)
-      resource.can_have_newsfeed?.should == false
-    end
-
     it "should return false without at least three filter parameters" do
       stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
       resource = subject.class.find(id)
+      resource.stub(:has_active_newsfeed?) { false }
+      resource.stub(:has_inactive_newsfeed?) { false }
       resource.Filter = "City Eq 'Moorhead' And MlsStatus Eq 'Active'"
       resource.can_have_newsfeed?.should == false
     end
@@ -201,9 +197,12 @@
       resource.has_active_newsfeed?.should == true
     end
 
-    it "should return false for a provided search" do
-      stub_api_get("/provided/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
-      resource = subject.class.provided.find(id)
+    it "should return false if the search doesn't have a newsfeed" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/without_newsfeed.json',
+        { "_expand" => "NewsFeedSubscriptionSummary" } )
+      resource = subject.class.find(id)
+      resource.stub(:provided_search?) { false }
       resource.has_active_newsfeed?.should == false
     end
   end
@@ -218,11 +217,15 @@
       resource.has_inactive_newsfeed?.should == true
     end
 
-    it "should return false for a provided search" do
-      stub_api_get("/provided/#{subject.class.element_name}/#{id}", 'saved_searches/with_inactive_newsfeed.json')
-      resource = subject.class.provided.find(id)
+    it "should return false if the search doesn't have a newsfeed" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/without_newsfeed.json',
+        { "_expand" => "NewsFeedSubscriptionSummary, NewsFeeds" } )
+      resource = subject.class.find(id)
+      # resource.stub(:provided_search?) { false }
       resource.has_inactive_newsfeed?.should == false
     end
+
   end
 
   describe "newsfeed" do
@@ -235,4 +238,10 @@
     end
   end
 
+  describe "QUALIFYING_FIELDS_FOR_NEWSFEED" do
+    it "should return an array" do
+      subject.class::QUALIFYING_FIELDS_FOR_NEWSFEED.should be_an(Array)
+    end
+  end
+  
 end