Merge pull request #129 from sparkapi/extract-models

bhornseth · web-flow · commit 87248eb2f56a · 2017-01-13T07:19:44.000-06:00
MWEB-1465 extract SharedLink and EmailLink
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,7 @@
+v1.4.10
+ - add `id` method to SparkApi::Models::Base as a more familiar alias of `Id`
+ - add SharedLink and EmailLink models, extracted from FBS internal code
+
 v1.4.9
  - add AccountReport and AccountRoster models
 
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.4.9
+1.4.10
diff --git a/lib/spark_api/models.rb b/lib/spark_api/models.rb
@@ -15,6 +15,7 @@
 require 'spark_api/models/comment'
 require 'spark_api/models/custom_fields'
 require 'spark_api/models/document'
+require 'spark_api/models/email_link'
 require 'spark_api/models/fields'
 require 'spark_api/models/idx'
 require 'spark_api/models/idx_link'
@@ -34,6 +35,7 @@
 require 'spark_api/models/rental_calendar'
 require 'spark_api/models/saved_search'
 require 'spark_api/models/search_template/quick_search'
+require 'spark_api/models/shared_link'
 require 'spark_api/models/shared_listing'
 require 'spark_api/models/sort'
 require 'spark_api/models/standard_fields'
diff --git a/lib/spark_api/models/base.rb b/lib/spark_api/models/base.rb
@@ -9,6 +9,11 @@ class Base
 
       attr_accessor :attributes, :errors, :parent
 
+      # More familiar accessor for our Spark API Id method
+      def id
+        self.Id
+      end
+
       # Name of the resource as related to the path name
       def self.element_name
         # TODO I'd love to pull in active model at this point to provide default naming
diff --git a/lib/spark_api/models/email_link.rb b/lib/spark_api/models/email_link.rb
@@ -0,0 +1,21 @@
+module SparkApi
+  module Models
+    class EmailLink < Base
+
+      extend Finders
+
+      self.prefix = "/flexmls/"
+      self.element_name = "emaillinks"
+
+      attr_accessor :template, :sort_id
+
+      def filter
+        "EmailLink Eq '#{id}'"
+      end
+
+      def listing_search_role
+        :public
+      end
+    end
+  end
+end
diff --git a/lib/spark_api/models/newsfeed.rb b/lib/spark_api/models/newsfeed.rb
@@ -3,10 +3,14 @@ module Models
     class Newsfeed < Base 
       
       extend Finders
-      include Concerns::Savable
+      include Concerns::Destroyable,
+              Concerns::Savable
 
       self.element_name = 'newsfeeds'
 
+      def listing_search_role
+        :public
+      end
     end
   end
 end
diff --git a/lib/spark_api/models/notification.rb b/lib/spark_api/models/notification.rb
@@ -37,6 +37,9 @@ def self.mark_read(notifications, arguments={})
         result = connection.put "#{self.path}/#{ids.join(',')}", {'Read' => true}, arguments
       end
 
+      def listing_search_role
+        :public
+      end
     end
   end
 end
diff --git a/lib/spark_api/models/saved_search.rb b/lib/spark_api/models/saved_search.rb
@@ -6,7 +6,6 @@ class SavedSearch < Base
       include Concerns::Savable,
               Concerns::Destroyable
 
-
       self.element_name="savedsearches"
 
       def self.provided()
@@ -89,6 +88,10 @@ def has_inactive_newsfeed?
         end
       end
 
+      def listing_search_role
+        :public if path =~ /contact/
+      end
+
       private
 
       def resource_pluralized; "SavedSearches" end
diff --git a/lib/spark_api/models/shared_link.rb b/lib/spark_api/models/shared_link.rb
@@ -0,0 +1,53 @@
+module SparkApi
+  module Models
+    class SharedLink < Base
+      extend Finders
+
+      attr_accessor :sort_id
+      attr_writer :name
+
+      self.element_name = "sharedlinks"
+
+      def self.create(data)
+        SharedLink.new SparkApi.client.post("#{path}/#{resource_type(data)}", data).first
+      rescue SparkApi::BadResourceRequest
+        false
+      end
+
+      def name
+        if @name
+          @name
+        elsif respond_to?(:ListingCart) && self.ListingCart.respond_to?(:Name)
+          self.ListingCart.Name
+        elsif respond_to?(:SavedSearch) && self.SavedSearch.respond_to?(:Name)
+          self.SavedSearch.Name
+        end
+      end
+
+      def template
+        if respond_to?(:SavedSearch) && self.SavedSearch.respond_to?(:template)
+          self.SavedSearch.template
+        end
+      end
+
+      def filter
+        "SharedLink Eq '#{id}'"
+      end
+
+      def listing_search_role
+        self.Mode.downcase.to_sym
+      end
+
+      private
+
+      def self.resource_type(data)
+        case data.keys[0].to_sym
+          when :ListingIds; "listings"
+          when :SearchId;   "search"
+          when :CartId;     "cart"
+        end
+      end
+
+    end
+  end
+end
diff --git a/spec/fixtures/sharedlinks/success.json b/spec/fixtures/sharedlinks/success.json
@@ -0,0 +1,10 @@
+{
+  "D": {
+    "Success": true,
+    "Results": [
+      {
+        "ResourceUri": "/sharedlinks/YUNO"
+      }
+    ]
+  }
+}
diff --git a/spec/support/search_container_shared_examples.rb b/spec/support/search_container_shared_examples.rb
@@ -0,0 +1,10 @@
+shared_examples_for 'search_container' do
+  let(:instance) { described_class.new( respond_to?(:initialization_args) ? initialization_args : {} ) }
+
+  methods = [:template, :filter, :sort_id, :sort_id=].each do |method|
+
+    it "responds to the method ##{method.to_s}" do
+      expect(instance.respond_to?(method)).to eq(true)
+    end
+  end
+end
diff --git a/spec/unit/spark_api/models/base_spec.rb b/spec/unit/spark_api/models/base_spec.rb
@@ -76,6 +76,7 @@ class MyDefaultModel < Base
       end
       it "should get first result" do
         MyExampleModel.first.Id.should == 1
+        MyExampleModel.first.Id.should eq(MyExampleModel.first.id)
       end
     end
   end
diff --git a/spec/unit/spark_api/models/email_link_spec.rb b/spec/unit/spark_api/models/email_link_spec.rb
@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe EmailLink do
+  it_behaves_like 'search_container'
+
+  let(:email_link) { EmailLink.new(Id: 5) }
+
+  describe 'filter' do
+    it 'returns a filter for the email link' do
+      expect(email_link.filter).to eq "EmailLink Eq '#{email_link.id}'"
+    end    
+  end  
+
+  describe 'listing_search_role' do
+    it 'returns a symbol' do
+      expect(EmailLink.new().listing_search_role).to eq(:public)
+    end
+  end
+end
diff --git a/spec/unit/spark_api/models/newsfeed_spec.rb b/spec/unit/spark_api/models/newsfeed_spec.rb
@@ -15,7 +15,5 @@
       @newsfeed.update!(:Active => false)
       expect(@newsfeed.Active) == false
     end
-
   end
-
 end
diff --git a/spec/unit/spark_api/models/saved_search_spec.rb b/spec/unit/spark_api/models/saved_search_spec.rb
@@ -222,5 +222,19 @@
       resource.newsfeeds.should be_an(Array)
     end
   end
+
+  describe "listing_search_role" do
+    it "specifics public when accessed on behalf of a contact" do
+      contact = Contact.new({"Id" => "5"})
+      search = SavedSearch.new({"Id" => "2"*26})
+      search.parent = contact
+      expect(search.listing_search_role).to eq(:public)
+    end
+
+    it "is nil when not accessed on behalf of a contact" do
+      search = SavedSearch.new({"Id" => "2"*26})
+      expect(search.listing_search_role).to be_nil
+    end
+  end
   
 end
diff --git a/spec/unit/spark_api/models/shared_link_spec.rb b/spec/unit/spark_api/models/shared_link_spec.rb
@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe SharedLink do
+
+  let(:shared_link) { SharedLink.new(Id: 5) }
+
+  it_behaves_like 'search_container'
+
+  it "returns the right path" do
+    expect(shared_link.path).to eq("/sharedlinks")
+  end
+
+  describe "create" do
+    before(:each) do
+      stub_auth_request
+    end
+
+    it "creates a shared link for listings" do
+      data = { ListingIds: ["5", "6"] }
+      stub_api_post("/sharedlinks/listings", data, 'sharedlinks/success.json')
+      expect(SharedLink.create(data)).to be_a(SharedLink)
+    end
+
+    it "works with string keys" do
+      data = { "ListingIds" => ["5", "6"] }
+      stub_api_post("/sharedlinks/listings", data, 'sharedlinks/success.json')
+      expect(SharedLink.create(data)).to be_a(SharedLink)
+    end
+
+    it "creates a shared link for searches" do
+      data = { SearchId: "5" }
+      stub_api_post("/sharedlinks/search", data, 'sharedlinks/success.json')
+      expect(SharedLink.create(data)).to be_a(SharedLink)
+    end
+
+    it "creates a shared link for collections" do
+      data = { CartId: "5" }
+      stub_api_post("/sharedlinks/cart", data, 'sharedlinks/success.json')
+      expect(SharedLink.create(data)).to be_a(SharedLink)
+    end
+
+    describe "errors" do
+
+      it "returns false if there is an error" do
+        data = { ListingIds: ["5", "6"] }
+        allow(SparkApi).to receive(:client) { raise SparkApi::BadResourceRequest }
+        expect(SharedLink.create(data)).to be false
+      end
+
+    end
+
+  end
+
+  describe 'name' do
+
+    it 'returns the name of the referenced listing cart' do
+      listing_cart = ListingCart.new(Name: 'the name for the listing cart')
+      shared_link.ListingCart = listing_cart
+      expect(shared_link.name).to eq listing_cart.Name
+    end
+
+    it 'returns the name of the referenced saved search' do
+      saved_search = SavedSearch.new({"Id" => "5"*26, "Name" => "My Search"})
+      shared_link.SavedSearch = saved_search
+      expect(shared_link.name).to eq saved_search.Name
+    end
+
+    it 'returns nil if there is no listing cart or saved search' do
+      shared_link.SavedSearch = nil
+      shared_link.ListingCart = nil
+      expect(shared_link.name).to be_nil
+    end
+
+    it 'can be set to override the default name' do
+      shared_link.name = "my custom name"
+      expect(shared_link.name).to eq "my custom name"
+    end
+
+  end
+
+  describe 'template' do
+  
+    it 'returns the template from the saved search' do
+      saved_search = SavedSearch.new({"Id" => "5"*26})
+      template = QuickSearch.new({"Id" => "8"*26})
+      allow(saved_search).to receive(:template).and_return(template)
+      shared_link.SavedSearch = saved_search
+      expect(shared_link.template).to eq saved_search.template
+    end
+
+    it 'returns nil if the shared link is not for a saved search' do
+      expect(shared_link.template).to eq nil
+    end
+  end
+
+  describe 'filter' do
+    it 'returns the filter' do
+      expect(shared_link.filter).to eq "SharedLink Eq '#{shared_link.id}'"
+    end
+  end
+
+  describe 'listing_search_role' do
+    it 'returns a symbol' do
+      expect(SharedLink.new({"Mode" => "Idx"}).listing_search_role).to eq(:idx)
+      expect(SharedLink.new({"Mode" => "Public"}).listing_search_role).to eq(:public)
+    end
+  end
+end
