spark_api 1.3.21 → 1.3.23

data/VERSION

@@ -1 +1 @@
-1.3.21
+1.3.23

data/lib/spark_api/authentication/oauth2_impl/faraday_middleware.rb

@@ -34,7 +34,7 @@ module SparkApi
         end
 
       end
-      Faraday.register_middleware :response, :oauth2_impl => FaradayMiddleware
+      Faraday::Response.register_middleware :oauth2_impl => FaradayMiddleware
       
       #==OAuth2 Faraday response middleware
       # HTTP Response after filter to package oauth2 responses and bubble up basic api errors.
@@ -62,7 +62,7 @@ module SparkApi
         end
   
       end
-      Faraday.register_middleware :response, :sparkbar_impl => SparkbarFaradayMiddleware
+      Faraday::Response.register_middleware :sparkbar_impl => SparkbarFaradayMiddleware
 
     end
   end

data/lib/spark_api/faraday_middleware.rb

@@ -80,6 +80,6 @@ module SparkApi
     end
     
   end
-  Faraday.register_middleware :response, :spark_api => FaradayMiddleware
+  Faraday::Response.register_middleware :spark_api => FaradayMiddleware
 
 end

data/lib/spark_api/models.rb

@@ -18,6 +18,7 @@ require 'spark_api/models/listing'
 require 'spark_api/models/listing_cart'
 require 'spark_api/models/market_statistics'
 require 'spark_api/models/message'
+require 'spark_api/models/newsfeed'
 require 'spark_api/models/note'
 require 'spark_api/models/notification'
 require 'spark_api/models/open_house'

data/lib/spark_api/models/base.rb

@@ -94,7 +94,7 @@ module SparkApi
           end 
         else
           return attributes[method_name] if attributes.include?(method_name)
-          super # GTFO
+          super
         end
       end
 

data/lib/spark_api/models/finders.rb

@@ -8,6 +8,7 @@ module SparkApi
         scope = arguments.slice!(0)
         options = arguments.slice!(0) || {}
         case scope
+          when nil    then raise ArgumentError, "Argument for find() can't be nil"
           when :all   then find_every(options)
           when :first then find_every(options).first
           when :last  then find_every(options).last
@@ -31,11 +32,11 @@ module SparkApi
       private
 
       def find_every(options)
-        collect(connection.get("/#{element_name}", options))
+        collect(connection.get("#{path}", options))
       end
 
       def find_single(scope, options)
-        resp = connection.get("/#{element_name}/#{scope}", options)
+        resp = connection.get("#{path}/#{scope}", options)
         new(resp.first)
       end
             

data/lib/spark_api/models/listing.rb

@@ -233,7 +233,7 @@ module SparkApi
         else 
           return attributes[method_name] if attributes.include?(method_name)
           return @attributes['StandardFields'][method_name] if attributes['StandardFields'].include?(method_name)
-          super # GTFO
+          super
         end
       end
 

data/lib/spark_api/models/newsfeed.rb

@@ -0,0 +1,12 @@
+module SparkApi
+  module Models
+    class Newsfeed < Base 
+      
+      extend Finders
+      include Concerns::Savable
+
+      self.element_name = 'newsfeeds'
+
+    end
+  end
+end

data/lib/spark_api/models/saved_search.rb

@@ -6,12 +6,25 @@ module SparkApi
       include Concerns::Savable,
               Concerns::Destroyable
 
+      attr_accessor :newsfeeds
+
       self.element_name="savedsearches"
 
+      def initialize(attributes={})
+        @newsfeeds = nil
+        super(attributes)
+      end
+
       def self.provided()
         Class.new(self).tap do |provided|
           provided.element_name = '/savedsearches'
           provided.prefix = '/provided'
+          def provided_search?
+            true
+          end
+          def newsfeeds
+            []
+          end
           SparkApi.logger.info("#{self.name}.path: #{provided.path}")
         end
       end
@@ -49,6 +62,65 @@ module SparkApi
         end
       end
 
+      def listings(args = {})
+        arguments = {:_filter => self.Filter}.merge(args)
+        @listings ||= Listing.collect(connection.get("/listings", arguments))
+      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
+      end
+
+      def provided_search?
+        false
+      end
+
+      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|
+          number_of_filters += 1 if self.Filter.include? field
+        end
+        
+        number_of_filters >= 3
+
+      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']
+        end
+      end
+
+      def has_inactive_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']
+        end
+      end
+
       private
 
       def resource_pluralized; "SavedSearches" end

data/spec/fixtures/newsfeeds/get.json

@@ -0,0 +1,30 @@
+{
+  "D": {
+    "Success": true,
+    "Results": [
+      {
+        "Id": "20130625195235039712000000",
+        "ResourceUri": "/vX/newsfeeds/20130625195235039712000000",
+        "Active": true,
+        "NotificationsActive": true,
+        "Curated": false,
+        "Name": "My Newsfeed Subscription",
+        "Type": "SavedSearch",
+        "NotificationMethods": ["Email"],
+        "CreatedTimestamp": "2013-06-27T10:01:06-05:00",
+        "ModificationTimestamp": "2013-06-27T10:01:06-05:00",
+        "LastEventTimestamp": "2013-07-07T12:12:06-05:00",
+        "ExpirationDate": "2014-10-10",
+        "Subscription": {
+          "ResourceUri": "/vX/savedsearches/20100815220615294367000000",
+          "Id":  "20100815220615294367000000",
+          "OwnerId": "20090815223215294334000000",
+          "Name": "Search name here",
+          "Description": "A longer description of the search",
+          "Filter": null,
+          "ModificationTimestamp": "2011-03-14T08:39:38-05:00"
+        }
+      }
+    ]
+  }
+}

data/spec/fixtures/newsfeeds/inactive.json

@@ -0,0 +1,30 @@
+{
+  "D": {
+    "Success": true,
+    "Results": [
+      {
+        "Id": "20130625195235039712000000",
+        "ResourceUri": "/vX/newsfeeds/20130625195235039712000000",
+        "Active": false,
+        "NotificationsActive": true,
+        "Curated": false,
+        "Name": "My Newsfeed Subscription",
+        "Type": "SavedSearch",
+        "NotificationMethods": ["Email"],
+        "CreatedTimestamp": "2013-06-27T10:01:06-05:00",
+        "ModificationTimestamp": "2013-06-27T10:01:06-05:00",
+        "LastEventTimestamp": "2013-07-07T12:12:06-05:00",
+        "ExpirationDate": "2014-10-10",
+        "Subscription": {
+          "ResourceUri": "/vX/savedsearches/20100815220615294367000000",
+          "Id":  "20100815220615294367000000",
+          "OwnerId": "20090815223215294334000000",
+          "Name": "Search name here",
+          "Description": "A longer description of the search",
+          "Filter": null,
+          "ModificationTimestamp": "2011-03-14T08:39:38-05:00"
+        }
+      }
+    ]
+  }
+}

data/spec/fixtures/saved_searches/get.json

@@ -6,6 +6,7 @@
               "ResourceUri": "/v1/savedsearches/20100815220615294367000000",
               "Id":  "20100815220615294367000000",
               "Name": "Search name here",
+              "Filter": "City Eq 'Moorhead' And MlsStatus Eq 'Active' And PropertyType Eq 'A'",
               "ContactIds": [
                 "20100815220615294367000000"
               ]

data/spec/fixtures/saved_searches/with_inactive_newsfeed.json

@@ -0,0 +1,35 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [
+            { 
+              "ResourceUri": "/v1/savedsearches/20100815220615294367000000",
+              "Id":  "20100815220615294367000000",
+              "Name": "Search name here",
+              "ContactIds": [
+                "20100815220615294367000000"
+              ],
+              "NewsFeedSubscriptionSummary": {
+                "ActiveSubscription": false
+              },
+              "NewsFeeds": [
+                {
+                  "ResourceUri": "/v1/newsfeeds/20141203082619076323088319",
+                  "Name": "My Very Special Newsfeed",
+                  "OwnerId": "20000426143505724628000000",
+                  "ProspectLinkId": "",
+                  "CreatedTimestamp": "2014-12-03T08:26:19Z",
+                  "Id": "20141203082619076323088319",
+                  "Active": "false",
+                  "ModificationTimestamp": "2014-12-03T08:26:19Z",
+                  "ExpirationDate": "2015-03-03",
+                  "Curated": "false",
+                  "NotificationMethods": ["Email"],
+                  "LastEventTimestamp": "",
+                  "Type": "SavedSearch"
+                }
+              ]
+            }
+        ]
+    }
+}

data/spec/fixtures/saved_searches/with_newsfeed.json

@@ -0,0 +1,35 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [
+            { 
+              "ResourceUri": "/v1/savedsearches/20100815220615294367000000",
+              "Id":  "20100815220615294367000000",
+              "Name": "Search name here",
+              "ContactIds": [
+                "20100815220615294367000000"
+              ],
+              "NewsFeedSubscriptionSummary": {
+                "ActiveSubscription": true
+              },
+              "NewsFeeds": [
+                {
+                  "ResourceUri": "/v1/newsfeeds/20141203082619076323088319",
+                  "Name": "My Very Special Newsfeed",
+                  "OwnerId": "20000426143505724628000000",
+                  "ProspectLinkId": "",
+                  "CreatedTimestamp": "2014-12-03T08:26:19Z",
+                  "Id": "20141203082619076323088319",
+                  "Active": "true",
+                  "ModificationTimestamp": "2014-12-03T08:26:19Z",
+                  "ExpirationDate": "2015-03-03",
+                  "Curated": "false",
+                  "NotificationMethods": ["Email"],
+                  "LastEventTimestamp": "",
+                  "Type": "SavedSearch"
+                }
+              ]
+            }
+        ]
+    }
+}

data/spec/unit/spark_api/configuration_spec.rb

@@ -39,7 +39,7 @@ describe SparkApi::Client, "Client config"  do
                                     :endpoint => "https://api.wade.dev.fbsdata.com",
                                     :ssl_verify => false)
       client.ssl_verify.should be_false
-      client.connection.ssl.should eq({:verify=>false})
+      client.connection.ssl.verify.should be_false
     end
 
     it "should allow restrict ssl certificates when verification is on" do
@@ -47,7 +47,7 @@ describe SparkApi::Client, "Client config"  do
                                     :endpoint => "https://api.wade.dev.fbsdata.com",
                                     :ssl_verify => true)
       client.ssl_verify.should be_true
-      client.connection.ssl.should eq({})
+      client.connection.ssl.should be_empty
     end
   end
 

data/spec/unit/spark_api/models/finders_spec.rb

@@ -32,4 +32,21 @@ describe Finders, "Finders model" do
     resource.Id.should eq(1)
   end
 
+  describe "find" do
+
+    it "should throw an error if no argument is passed" do
+      stub_api_get("/my_resource/", 'finders.json')
+      lambda {
+        MyResource.find()
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should throw an error when the first argument is nil" do
+      stub_api_get("/my_resource/", 'finders.json', {:_limit => 1})
+      lambda {
+        MyResource.find(nil, {:_limit => 1})
+      }.should raise_error(ArgumentError)
+    end
+
+  end
 end

data/spec/unit/spark_api/models/newsfeed_spec.rb

@@ -0,0 +1,21 @@
+require './spec/spec_helper'
+
+
+describe Newsfeed do
+
+  before do
+    stub_auth_request
+  end
+
+  describe "update!" do
+    it "should update the attributes" do
+      stub_api_get("/newsfeeds/20130625195235039712000000", "newsfeeds/get.json")
+      stub_api_put("/newsfeeds/20130625195235039712000000", {:Active => false}, "newsfeeds/inactive.json")
+      @newsfeed = Newsfeed.find("20130625195235039712000000")
+      @newsfeed.update!(:Active => false)
+      expect(@newsfeed.Active) == false
+    end
+
+  end
+
+end

data/spec/unit/spark_api/models/saved_search_spec.rb

@@ -136,4 +136,80 @@ describe SavedSearch do
     end
   end
 
+  describe "can_have_newsfeed?" do
+
+    it "should return false for a provided search" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      resource = subject.class.find(id)
+      resource.stub(:provided_search?) { true }
+      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(:provided_search?) { false }
+      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
+
+    it "should return true with three filter parameters" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      resource = subject.class.find(id)
+      resource.stub(:provided_search?) { false }
+      resource.stub(:has_active_newsfeed?) { false }
+      resource.stub(:has_inactive_newsfeed?) { false }
+      resource.can_have_newsfeed?.should == true
+    end
+
+  end
+
+  describe "has_active_newsfeed?" do
+    it "should return true if the search already has 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/with_newsfeed.json',
+        { "_expand" => "NewsFeedSubscriptionSummary" } )
+      resource = subject.class.find(id)
+      resource.stub(:provided_search?) { false }
+      resource.has_active_newsfeed?.should == true
+    end
+
+    it "should return false for a provided search" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      resource = subject.class.find(id)
+      resource.stub(:provided_search?) { true }
+      resource.has_active_newsfeed?.should == false
+    end
+  end
+
+  describe "has_inactive_newsfeed?" do
+    it "should return true if the search has an inactive newsfeed" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/with_inactive_newsfeed.json')
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/with_inactive_newsfeed.json',
+        { "_expand" => "NewsFeedSubscriptionSummary" } )
+      resource = subject.class.find(id)
+      resource.stub(:provided_search?) { false }
+      resource.has_inactive_newsfeed?.should == true
+    end
+
+    it "should return false for a provided search" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/with_inactive_newsfeed.json')
+      resource = subject.class.find(id)
+      resource.stub(:provided_search?) { true }
+      resource.has_inactive_newsfeed?.should == false
+    end
+  end
+
+  describe "newsfeed" do
+    it "should return the newsfeed for the saved search" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/with_newsfeed.json',
+        { "_expand" => "NewsFeeds" } )      
+      resource = subject.class.find(id)
+      resource.newsfeeds.should be_an(Array)
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: spark_api
 version: !ruby/object:Gem::Version 
-  hash: 49
+  hash: 53
   prerelease: 
   segments: 
   - 1
   - 3
-  - 21
-  version: 1.3.21
+  - 23
+  version: 1.3.23
 platform: ruby
 authors: 
 - Brandon Hornseth
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-01-12 00:00:00 Z
+date: 2015-02-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -25,12 +25,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 61
+        hash: 59
         segments: 
         - 0
-        - 8
-        - 1
-        version: 0.8.1
+        - 9
+        - 0
+        version: 0.9.0
   version_requirements: *id001
   prerelease: false
   name: faraday
@@ -339,6 +339,7 @@ files:
 - lib/spark_api/models/fields.rb
 - lib/spark_api/models/system_info.rb
 - lib/spark_api/models/document.rb
+- lib/spark_api/models/newsfeed.rb
 - lib/spark_api/models/comment.rb
 - lib/spark_api/models/market_statistics.rb
 - lib/spark_api/models/photo.rb
@@ -415,6 +416,8 @@ files:
 - spec/fixtures/errors/failure_with_msg.json
 - spec/fixtures/errors/failure.json
 - spec/fixtures/errors/failure_with_constraint.json
+- spec/fixtures/newsfeeds/inactive.json
+- spec/fixtures/newsfeeds/get.json
 - spec/fixtures/property_types/property_types.json
 - spec/fixtures/empty.json
 - spec/fixtures/logo_fbs.png
@@ -424,7 +427,9 @@ files:
 - spec/fixtures/saved_searches/post.json
 - spec/fixtures/saved_searches/update.json
 - spec/fixtures/saved_searches/new.json
+- spec/fixtures/saved_searches/with_newsfeed.json
 - spec/fixtures/saved_searches/get.json
+- spec/fixtures/saved_searches/with_inactive_newsfeed.json
 - spec/fixtures/messages/post.json
 - spec/fixtures/messages/new_with_recipients.json
 - spec/fixtures/messages/new.json
@@ -514,6 +519,7 @@ files:
 - spec/unit/spark_api/models/notification_spec.rb
 - spec/unit/spark_api/models/note_spec.rb
 - spec/unit/spark_api/models/connect_prefs_spec.rb
+- spec/unit/spark_api/models/newsfeed_spec.rb
 - spec/unit/spark_api/models/fields_spec.rb
 - spec/unit/spark_api/models/concerns/destroyable_spec.rb
 - spec/unit/spark_api/models/concerns/savable_spec.rb
@@ -621,6 +627,8 @@ test_files:
 - spec/fixtures/errors/failure_with_msg.json
 - spec/fixtures/errors/failure.json
 - spec/fixtures/errors/failure_with_constraint.json
+- spec/fixtures/newsfeeds/inactive.json
+- spec/fixtures/newsfeeds/get.json
 - spec/fixtures/property_types/property_types.json
 - spec/fixtures/empty.json
 - spec/fixtures/logo_fbs.png
@@ -630,7 +638,9 @@ test_files:
 - spec/fixtures/saved_searches/post.json
 - spec/fixtures/saved_searches/update.json
 - spec/fixtures/saved_searches/new.json
+- spec/fixtures/saved_searches/with_newsfeed.json
 - spec/fixtures/saved_searches/get.json
+- spec/fixtures/saved_searches/with_inactive_newsfeed.json
 - spec/fixtures/messages/post.json
 - spec/fixtures/messages/new_with_recipients.json
 - spec/fixtures/messages/new.json
@@ -720,6 +730,7 @@ test_files:
 - spec/unit/spark_api/models/notification_spec.rb
 - spec/unit/spark_api/models/note_spec.rb
 - spec/unit/spark_api/models/connect_prefs_spec.rb
+- spec/unit/spark_api/models/newsfeed_spec.rb
 - spec/unit/spark_api/models/fields_spec.rb
 - spec/unit/spark_api/models/concerns/destroyable_spec.rb
 - spec/unit/spark_api/models/concerns/savable_spec.rb