MWEB-1179: added Defaultable module

Author: ryanhertz

CHANGELOG

@@ -1,3 +1,6 @@
+v1.4.2
+ - Added Defaultable module
+
 v1.4.1
  - Fixed bug in NewsFeedMeta core_fields and core_field_names. Calling either of those methods modified the data array when it should have only been reading the array. Later calls to these methods were then incorrect.
 

VERSION

@@ -1 +1 @@
-1.4.1
+1.4.2

lib/spark_api/models.rb

@@ -2,6 +2,7 @@
 require 'spark_api/models/base'
 require 'spark_api/models/constraint'
 require 'spark_api/models/finders'
+require 'spark_api/models/defaultable'
 require 'spark_api/models/subresource'
 require 'spark_api/models/concerns'
 

lib/spark_api/models/defaultable.rb

@@ -0,0 +1,37 @@
+module SparkApi
+  module Models
+    module Defaultable
+
+      DEFAULT_ID = "default"
+
+      extend Finders
+
+      def self.included(base)
+
+        class << base
+          alias original_find find
+        end
+
+        base.extend(ClassMethods)
+
+      end
+  
+      module ClassMethods
+
+        def default(options = {})
+          find(DEFAULT_ID, options)
+        end
+
+        def find(*arguments)
+          result = original_find(*arguments)
+          if arguments.first == DEFAULT_ID
+            result.Id = DEFAULT_ID if result.Id.nil?
+          end
+          result
+        end
+
+      end
+
+    end
+  end
+end

lib/spark_api/models/idx_link.rb

@@ -3,16 +3,12 @@ module Models
     class IdxLink < Base
 
       extend Finders
+      include Defaultable
 
       self.element_name = "idxlinks"
 
       LINK_TYPES = ["QuickSearch", "SavedSearch", "MyListings", "Roster"]
 
-      def self.default(options = {})
-        response = connection.get("/#{self.element_name}/default", options).first
-        response.nil? ? nil : new(response)
-      end
-
     end
   end
 end

lib/spark_api/models/search_template/quick_search.rb

@@ -2,6 +2,7 @@ module SparkApi
   module Models
     class QuickSearch < Base 
       extend Finders
+      include Defaultable
       include Concerns::Savable,
               Concerns::Destroyable
 

spec/unit/spark_api/models/defaultable_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Defaultable do
+
+  module SparkApi
+    module Models
+      class TestClass < Base
+        extend Finders
+        include Defaultable
+        self.element_name = 'testclass'
+      end
+    end
+  end
+
+  describe 'default' do
+
+    it 'calls find' do
+      expect(TestClass).to receive(:find).with('default', {})
+      TestClass.default
+    end
+    
+  end
+  
+  describe 'find' do
+
+    it "adds the id 'default'" do
+      allow(TestClass).to receive(:connection).and_return(double(get: [{Id: nil, Name: 'foo'}]))
+      default = TestClass.find(TestClass::DEFAULT_ID)
+      expect(default.Id).to eq 'default'
+    end
+
+    it "doesn't override the id if one is present" do
+      allow(TestClass).to receive(:connection).and_return(double(get: [{Id: '5', Name: 'foo'}]))
+      expect(TestClass.find(TestClass::DEFAULT_ID).Id).to eq '5'
+    end
+
+    it "calls Finders.find when given a normal id" do
+      connection = double
+      expect(connection).to receive(:get).with("/testclass/5", {foo: true}).and_return([{}])
+      allow(TestClass).to receive(:connection).and_return(connection)
+      TestClass.find('5', foo: true)
+    end
+    
+  end
+
+end