spark_api 1.3.26 → 1.3.27

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmZlZWJkMzM5MDNjZjk3OTk1NTMxOGQwNmRiMTgyYjAyMmI5MjkwNg==
+    NDVkM2ZjNzEwMTE4ZDQ5ODE0MjY5NjUxZjNiMjEzNDViMjdhMmM3Mg==
   data.tar.gz: !binary |-
-    NWUzZjlmOGJkOWYwZjgyMWQzODZjNGE5OTgyNzYxNjc5ZTk4MzRkOA==
+    ZTA0NGE5NWRmNmI1Mzc4Y2Y3NDRhMzBjMjQ2MzgzZWFhNDNhNWFmMg==
 SHA512:
   metadata.gz: !binary |-
-    MjM3MjdhOGMyZjUzMWE4NjY2MGE1MjBlNWQxYjQxZjM3YWNkYTAzMTlkMjUz
-    NjNhYjRkNjAyNzgxMDZkNzM0OWE1Y2MxZGU2NjBhZDk4MWMzOTEwZTFlN2U4
-    ZjExNjdlZTBhMDQxNTQ4ZGIxZTA2NWRjNDQxNzIzZjc5MTcyM2U=
+    YTVlMmNiZjVlNDcyYzBmMDBlY2RjNzY2MzMyY2Q3YTRhZWU2OTE3MmFkMzcz
+    MDk3YzZjNmE5MzBiNWRiOGFjY2QxYWJlZWJiZmJmMzg5NmVkZDkzOTI3OTQ1
+    OTZmYWI5NTFiYjNhZjliNzhmYTJiMjBmMDhhMzE3NDhjMzllMWI=
   data.tar.gz: !binary |-
-    OWZkMzAwNmY1ZDQ1MGQ2MWFjZDg0NjU1MDdhNTUxZjE1NmY2NDVhZTE4YWE4
-    YThmZjMwYjY2Y2YwMmI2NWY2ODMyOTZmMzI5ZWRmMGU5YTYzODZkMzJkNWQ2
-    MWQxZDA4YWU5ZGYzYjdiMzA0ZjVlYjRmMDU0YmIyZDVkMGNhZTU=
+    NzM2ZmY1NTZhNzgxYjZhMTlmM2Y0Nzg1Y2Q2M2ZmZDVmZDBjM2M2YjMyNGJi
+    Nzg4Mjc0MWZlNDI3ODczMDY0NTdhYWRhZjlhM2JjMjg4NjJiMDM1MzJlYjI4
+    MDc0MGQxZmZhYmIwNzM4MjVhYTM4YzBhNzljMzA4NDQxZmQ1ZDA=

data/VERSION

@@ -1 +1 @@
-1.3.26
+1.3.27

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/news_feed_meta'
 require 'spark_api/models/newsfeed'
 require 'spark_api/models/note'
 require 'spark_api/models/notification'

data/lib/spark_api/models/idx_link.rb

@@ -4,44 +4,15 @@ module SparkApi
 
       extend Finders
       
-      self.element_name="idxlinks"
+      self.element_name = "idxlinks"
       
       LINK_TYPES = ["QuickSearch", "SavedSearch", "MyListings", "Roster"]
 
-      #TODO Work all below into common base class
-      def self.find(*arguments)
-        scope = arguments.slice!(0)
-        options = arguments.slice!(0) || {}
-        
-        case scope
-          when :all   then find_every(options)
-          when :first then find_every(options).first
-          when :last  then find_every(options).last
-          when :one   then find_one(options)
-          else             find_single(scope, options)
-        end
-      end
-      
-      def self.first(*arguments)
-        find(:first, *arguments)
-      end
-
-      def self.last(*arguments)
-        find(:last, *arguments)
-      end
-
       def self.default(options = {})
         response = connection.get("/#{self.element_name}/default", options).first
         response.nil? ? nil : new(response)
       end
 
-      private
-
-      def self.find_single(scope, options)
-        resp = SparkApi.client.get("/idxlinks/#{scope}", options)
-        new(resp.first)
-      end
-
     end
   end
 end

data/lib/spark_api/models/news_feed_meta.rb

@@ -0,0 +1,40 @@
+module SparkApi
+  module Models
+    class NewsFeedMeta < Base
+
+      attr_accessor :data
+
+      self.element_name = "newsfeeds/meta"
+
+      def initialize
+        super
+        @data = connection.get(self.path).first
+      end
+
+      def minimum_core_fields
+        @data['Subscriptions']['SavedSearches']['MinimumCoreFields']
+      end
+
+      def core_field_names
+        fields = @data['Subscriptions']['SavedSearches']['CoreSearchFields']
+
+        @data['Subscriptions']['SavedSearches']['CoreStandardFields'].each do |field|
+          fields << field[1]['Label']
+        end
+
+        fields
+      end
+
+      def core_fields
+        fields = @data['Subscriptions']['SavedSearches']['CoreSearchFields']
+
+        @data['Subscriptions']['SavedSearches']['CoreStandardFields'].each do |field|
+          fields << field.first
+        end
+
+        fields
+      end
+
+    end
+  end
+end

data/lib/spark_api/models/saved_search.rb

@@ -8,11 +8,6 @@ module SparkApi
 
       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={})
@@ -82,11 +77,11 @@ module SparkApi
 
         number_of_filters = 0
 
-        QUALIFYING_FIELDS_FOR_NEWSFEED.each do |field|
+        news_feed_meta.core_fields.each do |field|
           number_of_filters += 1 if self.Filter.include? field
         end
         
-        number_of_filters >= 3
+        number_of_filters >= news_feed_meta.minimum_core_fields
 
       end
 
@@ -124,6 +119,10 @@ module SparkApi
         end
       end
 
+      def news_feed_meta
+        @news_feed_meta ||= NewsFeedMeta.new
+      end
+
     end
 
   end

data/spec/fixtures/newsfeeds/meta.json

@@ -0,0 +1,131 @@
+{
+  "D": {
+    "Results": [
+      {
+        "Events": ["New", "PriceChange", "Sold", "OpenHouse", "Pending", "BackOnMarket", "Extension", "StatusChange", "Recommended", "Shared", "Seeded"],
+        "Subscriptions": {
+          "SavedSearches": {
+            "CoreStandardFields": {
+                      "MlsStatus": {
+                  "ResourceUri": "/v1/standardfields/MlsStatus",
+                   "MlsVisible": ["A", "I", "J", "K", "N"],
+                   "Searchable": true,
+                      "HasList": true,
+                  "MaxListSize": 7,
+                         "Type": "Character",
+                  "MultiSelect": false,
+                "FieldCategory": "Main",
+                        "Label": "Status"
+              },
+                   "PropertyType": {
+                  "ResourceUri": "/v1/standardfields/PropertyType",
+                   "MlsVisible": ["A", "I", "J", "K", "N"],
+                   "Searchable": true,
+                      "HasList": false,
+                  "MaxListSize": 0,
+                         "Type": "Character",
+                  "MultiSelect": false,
+                "FieldCategory": "Main",
+                        "Label": "Property Type"
+              },
+                     "PostalCode": {
+                  "ResourceUri": "/v1/standardfields/PostalCode",
+                   "MlsVisible": ["A", "I", "J", "K", "N"],
+                   "Searchable": true,
+                      "HasList": false,
+                  "MaxListSize": 0,
+                         "Type": "Character",
+                  "MultiSelect": false,
+                "FieldCategory": "Main",
+                        "Label": "Postal Code"
+              },
+                      "ListPrice": {
+                  "ResourceUri": "/v1/standardfields/ListPrice",
+                   "MlsVisible": ["A", "I", "J", "K"],
+                   "Searchable": true,
+                      "HasList": false,
+                  "MaxListSize": 0,
+                         "Type": "Decimal",
+                  "MultiSelect": false,
+                     "Currency": true,
+                "FieldCategory": "Main",
+                        "Label": "List Price"
+              },
+                      "BedsTotal": {
+                  "ResourceUri": "/v1/standardfields/BedsTotal",
+                   "MlsVisible": ["A", "K", "N"],
+                   "Searchable": true,
+                      "HasList": false,
+                  "MaxListSize": 0,
+                         "Type": "Integer",
+                  "MultiSelect": false,
+                "FieldCategory": "Main",
+                        "Label": "Total Bedrooms"
+              },
+                      "YearBuilt": {
+                  "ResourceUri": "/v1/standardfields/YearBuilt",
+                   "MlsVisible": ["A", "I", "K", "N"],
+                   "Searchable": true,
+                      "HasList": false,
+                  "MaxListSize": 0,
+                         "Type": "Integer",
+                  "MultiSelect": false,
+                "FieldCategory": "Main",
+                        "Label": "Year Built"
+              },
+              "BuildingAreaTotal": {
+                  "ResourceUri": "/v1/standardfields/BuildingAreaTotal",
+                   "MlsVisible": ["A", "I", "K", "N"], 
+                   "Searchable": true, 
+                      "HasList": false,
+                  "MaxListSize": 0,
+                         "Type": "Decimal",
+                  "MultiSelect": false,
+                "FieldCategory": "Main",
+                        "Label": "Total SqFt."
+              },
+                "PropertySubType": {
+                  "ResourceUri": "/v1/standardfields/PropertySubType",
+                   "MlsVisible": ["A", "I", "J", "K", "N"],
+                   "Searchable": true,
+                      "HasList": true,
+                  "MaxListSize": 9,
+                         "Type": "Character",
+                  "MultiSelect": false,
+                "FieldCategory": "Main",
+                        "Label": "Sub Type"
+              },
+                "SubdivisionName": {
+                  "ResourceUri": "/v1/standardfields/SubdivisionName",
+                   "MlsVisible": ["A", "I", "J", "K", "N"],
+                   "Searchable": true,
+                      "HasList": false,
+                  "MaxListSize": 0,
+                         "Type": "Character",
+                  "MultiSelect": false,
+                "FieldCategory": "Main",
+                        "Label": "Subdivision"
+              },
+                   "MLSAreaMinor": {
+                  "ResourceUri": "/v1/standardfields/MLSAreaMinor",
+                   "MlsVisible": ["A", "I", "J", "K", "N"],
+                   "Searchable": true,
+                      "HasList": true,
+                  "MaxListSize": 51,
+                         "Type": "Character",
+                  "MultiSelect": false,
+                "FieldCategory": "Main",
+                        "Label": "Map Area"
+              }
+            },
+              "CoreSearchFields": [
+              "Location"
+            ],
+             "MinimumCoreFields": 3
+          }
+        }
+      }
+    ],
+    "Success": true
+  }
+}

data/spec/spec_helper.rb

@@ -54,6 +54,7 @@ RSpec.configure do |config|
   config.alias_example_to :on_post_it, :method => 'POST'
   config.alias_example_to :on_delete_it, :method => 'DELETE'
   config.before(:all) { reset_config }
+  config.color_enabled = true
 end
 
 def jruby? 

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

@@ -0,0 +1,35 @@
+require './spec/spec_helper'
+
+
+describe NewsFeedMeta do
+
+  let(:news_feed_meta) { NewsFeedMeta.new }
+
+  before(:each) do
+    stub_auth_request
+    stub_api_get("/newsfeeds/meta", "newsfeeds/meta.json")
+  end
+
+  describe 'minimum_core_fields' do
+    it 'returns the minimum number of required fields' do
+      expect(news_feed_meta.minimum_core_fields).to eq 3
+    end
+  end
+
+  describe 'core_field_names' do
+    it 'returns an array including both the CoreSearchFields and the CoreStandardFields' do
+      field_array = ["Location", "Status", "Property Type", "Postal Code", "List Price", "Total Bedrooms", 
+        "Year Built", "Total SqFt.", "Sub Type", "Subdivision", "Map Area"]
+      expect(news_feed_meta.core_field_names).to eq field_array    
+    end
+  end
+
+  describe 'core_fields' do
+    it 'returns an array including both the CoreSearchFields and the CoreStandardFields' do
+      field_array = ["Location", "MlsStatus", "PropertyType", "PostalCode", "ListPrice", "BedsTotal", 
+        "YearBuilt", "BuildingAreaTotal", "PropertySubType", "SubdivisionName", "MLSAreaMinor"]
+      expect(news_feed_meta.core_fields).to eq field_array    
+    end
+  end
+
+end

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

@@ -178,12 +178,16 @@ describe SavedSearch do
 
   describe "can_have_newsfeed?" do
 
+    before do
+      stub_api_get("/newsfeeds/meta", "newsfeeds/meta.json")
+    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.Filter = "MlsStatus Eq 'Active' And PropertyType Eq 'A'"
       resource.can_have_newsfeed?.should == false
     end
 
@@ -192,6 +196,7 @@ describe SavedSearch do
       resource = subject.class.find(id)
       resource.stub(:has_active_newsfeed?) { false }
       resource.stub(:has_inactive_newsfeed?) { false }
+      resource.Filter = "MlsStatus Eq 'Active' And PropertyType Eq 'A' And ListPrice Eq 1000000"
       resource.can_have_newsfeed?.should == true
     end
 
@@ -243,11 +248,5 @@ describe SavedSearch do
       resource.newsfeeds.should be_an(Array)
     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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spark_api
 version: !ruby/object:Gem::Version
-  version: 1.3.26
+  version: 1.3.27
 platform: ruby
 authors:
 - Brandon Hornseth
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -177,20 +177,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.0
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.9
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.9
 - !ruby/object:Gem::Dependency
   name: rb-readline
   requirement: !ruby/object:Gem::Requirement
@@ -308,6 +294,7 @@ files:
 - lib/spark_api/models/listing_cart.rb
 - lib/spark_api/models/market_statistics.rb
 - lib/spark_api/models/message.rb
+- lib/spark_api/models/news_feed_meta.rb
 - lib/spark_api/models/newsfeed.rb
 - lib/spark_api/models/note.rb
 - lib/spark_api/models/notification.rb
@@ -431,6 +418,7 @@ files:
 - spec/fixtures/messages/post.json
 - spec/fixtures/newsfeeds/get.json
 - spec/fixtures/newsfeeds/inactive.json
+- spec/fixtures/newsfeeds/meta.json
 - spec/fixtures/no_results.json
 - spec/fixtures/notes/add.json
 - spec/fixtures/notes/agent_shared.json
@@ -500,6 +488,7 @@ files:
 - spec/unit/spark_api/models/listing_cart_spec.rb
 - spec/unit/spark_api/models/listing_spec.rb
 - spec/unit/spark_api/models/message_spec.rb
+- spec/unit/spark_api/models/news_feed_meta_spec.rb
 - spec/unit/spark_api/models/newsfeed_spec.rb
 - spec/unit/spark_api/models/note_spec.rb
 - spec/unit/spark_api/models/notification_spec.rb
@@ -545,7 +534,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '1.8'
 requirements: []
 rubyforge_project: spark_api
-rubygems_version: 2.2.1
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: A library for interacting with the Spark web services.
@@ -611,6 +600,7 @@ test_files:
 - spec/fixtures/errors/failure_with_msg.json
 - spec/fixtures/errors/failure.json
 - spec/fixtures/errors/failure_with_constraint.json
+- spec/fixtures/newsfeeds/meta.json
 - spec/fixtures/newsfeeds/inactive.json
 - spec/fixtures/newsfeeds/get.json
 - spec/fixtures/property_types/property_types.json
@@ -696,6 +686,7 @@ test_files:
 - spec/unit/spark_api/authentication/base_auth_spec.rb
 - spec/unit/spark_api/configuration_spec.rb
 - spec/unit/spark_api/request_spec.rb
+- spec/unit/spark_api/models/news_feed_meta_spec.rb
 - spec/unit/spark_api/models/open_house_spec.rb
 - spec/unit/spark_api/models/document_spec.rb
 - spec/unit/spark_api/models/system_info_spec.rb