spark_api 1.1.2 → 1.2.0

data/spec/unit/spark_api/configuration_spec.rb

@@ -1,15 +1,12 @@
 require './spec/spec_helper'
 
 describe SparkApi::Client, "Client config"  do
-  after(:all) do
-    reset_config
-  end
-
   describe "default settings" do
     it "should return the proper defaults when called with no arguments" do
       SparkApi.api_key.should be_nil
       SparkApi.api_secret.should be_nil
       SparkApi.version.should match("v1")
+      SparkApi.ssl_verify.should be_true
       SparkApi.auth_endpoint.should match("sparkplatform.com/openid")
       SparkApi.endpoint.should match("api.sparkapi.com")
       SparkApi.user_agent.should match(/Spark API Ruby Gem .*/)
@@ -33,6 +30,22 @@ describe SparkApi::Client, "Client config"  do
       client.endpoint.should match("http://api.wade.dev.fbsdata.com")
       client.version.should match("v1")
     end
+    
+    it "should allow unverified ssl certificates when verification is off" do
+      client = SparkApi::Client.new(:auth_endpoint => "https://login.wade.dev.fbsdata.com",
+                                    :endpoint => "https://api.wade.dev.fbsdata.com",
+                                    :ssl_verify => false)
+      client.ssl_verify.should be_false
+      client.connection.ssl.should eq({:verify=>false})
+    end
+
+    it "should allow restrict ssl certificates when verification is on" do
+      client = SparkApi::Client.new(:auth_endpoint => "https://login.wade.dev.fbsdata.com",
+                                    :endpoint => "https://api.wade.dev.fbsdata.com",
+                                    :ssl_verify => true)
+      client.ssl_verify.should be_true
+      client.connection.ssl.should eq({})
+    end
   end
 
   describe "oauth2 instance configuration" do
@@ -44,7 +57,7 @@ describe SparkApi::Client, "Client config"  do
                            :endpoint => "http://api.wade.dev.fbsdata.com",
                            :authentication_mode => SparkApi::Authentication::OAuth2)
     end
-
+    
     it "should convert the configuration to oauth2 when specified" do
       oauth2_client.oauthify!
       oauth2_client.oauth2_provider.should be_a(SparkApi::Authentication::SimpleProvider)
@@ -144,19 +157,20 @@ describe SparkApi::Client, "Client config"  do
     end
     
     it "should have correct headers based on configuration" do
+      reset_config
       stub_auth_request
       stub_request(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/headers").
           with(:query => {
-            :ApiSig => "6f0cfef263e0bfe7a9ae1f60063a8ad9",
+            :ApiUser => "foobar",
+            :ApiSig => "717a066c4f4302c5ca9507e484db4812",
             :AuthToken => "c401736bf3d3f754f07c04e460e09573"
           }).
           to_return(:body => '{"D":{"Success": true,"Results": []}}')
-      SparkApi.reset
       SparkApi.configure do |config|
         config.user_agent = "my useragent"
       end
       SparkApi.client.get '/headers'
-      WebMock.should have_requested(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/headers?ApiSig=6f0cfef263e0bfe7a9ae1f60063a8ad9&AuthToken=c401736bf3d3f754f07c04e460e09573").
+      WebMock.should have_requested(:get, "#{SparkApi.endpoint}/#{SparkApi.version}/headers?ApiUser=foobar&ApiSig=717a066c4f4302c5ca9507e484db4812&AuthToken=c401736bf3d3f754f07c04e460e09573").
         with(:headers => {
           'User-Agent' => SparkApi::Configuration::DEFAULT_USER_AGENT,
           SparkApi::Configuration::X_SPARK_API_USER_AGENT => "my useragent",

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

@@ -72,6 +72,11 @@ describe Account do
             "Name"=>"My Photo two",
             "Uri"=>"http://photos.flexmls.com/az/...."
           },
+          {
+            "Type"=>"Photo",
+            "Name"=>nil,
+            "Uri"=>"http://photos.flexmls.com/az/...."
+          },
           {
             "Type"=>"Logo",
             "Name"=>"1 My Logo",

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

@@ -9,8 +9,23 @@ end
 class MyDefaultModel < Base
 end
 
+describe MyExampleModel, "Example model" do
+  before(:each) do
+    stub_auth_request
+    stub_api_get("/test/example", 'base.json')
+    @model = MyExampleModel.first
+  end
+  it "should be persisted" do
+    @model.persisted?.should eq(true)
+  end
+  it "should not be persisted" do
+    @new_model = MyExampleModel.new()
+    @new_model.persisted?.should eq(false)
+  end
+end
 
 describe Base, "Base model" do
+
   describe "class methods" do
     it "should set the element name" do
       MyExampleModel.element_name.should eq("example")
@@ -69,6 +84,10 @@ describe Base, "Base model" do
       @model.Name?.should satisfy { |p| [true, false].include?(p) }
     end
 
+    it "should return a boolean for whether or not a model is persisted through the api" do
+      @model.persisted?.should satisfy { |p| [true, false].include?(p) }
+    end
+
     it "should raise an Error for a predicate for a non-existant attribute" do
       lambda { @model.Nonsense? }.should raise_error(NoMethodError)
     end
@@ -101,6 +120,14 @@ describe Base, "Base model" do
       @model.should respond_to(:freeze)
     end
 
+    it "should respond_to a will_change! method for an existing attribute" do
+      @model.should respond_to(:Name_will_change!)
+    end
+
+    it "should not respond_to a will_change! method for a non-existant attribute" do
+      @model.should_not respond_to(:Nonsense_will_change!)
+    end
+
   end
 
 end

data/spec/unit/spark_api/models/concerns/destroyable_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+class MyExampleModel < Base
+  include Concerns::Destroyable
+  self.prefix = "/test/"
+  self.element_name = "example"
+end
+
+describe Concerns::Destroyable, "Destroyable Concern" do
+
+  before :each do
+    stub_auth_request
+    stub_api_get("/test/example", 'base.json')
+    @model = MyExampleModel.first
+  end
+
+  it "should not be destroyed" do
+    @model.destroyed?.should eq(false)
+  end
+
+  it "should be destroyable" do
+    stub_api_delete("/test/example/1")
+    @model = MyExampleModel.first
+    @model.destroy
+    @model.destroyed?.should eq(true)
+  end
+
+end

data/spec/unit/spark_api/models/concerns/savable_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+class MyExampleModel < Base
+  include Concerns::Savable
+  self.prefix = "/test/"
+  self.element_name = "example"
+end
+
+class MyOtherExampleModel < Base
+  include Concerns::Savable
+  self.prefix = "/test/"
+  self.element_name = "example"
+  private
+  def resource_pluralized
+    "MyOtherExampleModelThatIsPluralized"
+  end
+end
+
+class MyPluralizedModels < Base
+  include Concerns::Savable
+  self.prefix = "/test/"
+  self.element_name = "example"
+end
+
+describe Concerns::Savable, "Model" do
+
+  before :each do
+    stub_auth_request
+  end
+
+  it "should be creatable" do
+    @model = MyExampleModel.new({ :Name => "my name" })
+    stub_api_post("/test/example", { :MyExampleModels => [ @model.attributes ] }, "base.json")
+    @model.save.should eq(true)
+    @model.persisted?.should eq(true)
+  end
+
+  it "should be updatable" do
+    stub_api_get("/test/example", 'base.json')
+    @model = MyExampleModel.first
+    @model.Name = "new name"
+    stub_api_put("/test/example/1", @model.dirty_attributes)
+    @model.save.should eq(true)
+    @model.persisted?.should eq(true)
+  end
+
+  it "should allow the pluralize method to be overriden" do
+    @model = MyOtherExampleModel.new({ :Name => "my name" })
+    stub_api_post("/test/example", { :MyOtherExampleModelThatIsPluralized => [ @model.attributes ] }, "base.json")
+    @model.save.should eq(true)
+    @model.persisted?.should eq(true)
+  end
+
+  it "should not pluralize the resource if it already is" do
+    @model = MyPluralizedModels.new({ :Name => "my name" })
+    stub_api_post("/test/example", { :MyPluralizedModels => [ @model.attributes ] }, "base.json")
+    @model.save.should eq(true)
+    @model.persisted?.should eq(true)
+  end
+
+end

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

@@ -1,6 +1,5 @@
 require './spec/spec_helper'
 
-
 describe Contact do
   before(:each) do
     stub_auth_request
@@ -23,20 +22,21 @@ describe Contact do
     on_post_it "should save a new contact" do
       stub_api_post("/contacts", 'contacts/new.json', 'contacts/post.json')
       c=Contact.new
-      c.attributes["DisplayName"] = "Contact Four"
-      c.attributes["PrimaryEmail"] = "contact4@fbsdata.com"
+      c.DisplayName = "Contact Four"
+      c.PrimaryEmail = "contact4@fbsdata.com"
       c.save.should be(true)
       c.Id.should eq('20101230223226074204000000')
     end
 
     on_post_it "should save a new contact and notify" do
       stub_api_post("/contacts", 'contacts/new_notify.json', 'contacts/post.json')
-      c=Contact.new
-      c.notify=true
+      c = Contact.new
+      c.notify = true
       c.attributes["DisplayName"] = "Contact Four"
       c.attributes["PrimaryEmail"] = "contact4@fbsdata.com"
       c.save.should be(true)
       c.Id.should eq('20101230223226074204000000')
+      c.ResourceUri.should eq('/v1/contacts/20101230223226074204000000')
     end
 
     on_post_it "should fail saving" do

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

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+class MyExampleModel < Base
+  include Concerns::Savable
+  self.prefix = "/test/"
+  self.element_name = "example"
+end
+
+describe Dirty do
+
+  before :each do
+    stub_auth_request
+    @model = MyExampleModel.new(:Name => "some old name")
+    @model.Name = "a new name"
+  end
+
+  it "should return an array of the attributes that have been changed" do
+    @model.changed.should eq(["Name"])
+  end
+
+  it "should return a hash diff of current changes on a model" do
+    @model.changes.should eq({
+      "Name" => ["some old name", "a new name"]
+    })
+  end
+
+  it "should return previously changed attributes after save" do
+    stub_api_post('/test/example', { :MyExampleModels => [ @model.attributes ] }, 'base.json')
+    @model.save
+    @model.previous_changes.should eq({
+    })
+  end
+
+  it "should return changed attributes with old values" do
+    @model.changed_attributes.should eq({
+      "Name" => "some old name"
+    })
+  end
+
+  it "should return changed attributes with new values" do
+    @model.dirty_attributes.should eq({
+      "Name" => "a new name"
+    })
+  end
+
+end

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

@@ -9,22 +9,15 @@ describe Finders, "Finders model" do
 
   before(:each) do
     stub_auth_request
-  end
-
-  it "should get all results" do
     stub_api_get("/my_resource", 'finders.json')
-    resources = MyResource.all
-    resources.size.should eq(2)
   end
 
   it "should get first result" do
-    stub_api_get("/my_resource", 'finders.json')
     resource = MyResource.first
     resource.Id.should eq(1)
   end
 
   it "should get last result" do
-    stub_api_get("/my_resource", 'finders.json')
     resource = MyResource.last
     resource.Id.should eq(2)
   end

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

@@ -9,27 +9,58 @@ describe SavedSearch do
   let(:id){ "20100815220615294367000000" }
 
   context "/savedsearches", :support do
+
     on_get_it "should get all SavedSearches" do
-      stub_api_get("/#{subject.class.element_name}", 'listings/saved_search.json')
+      stub_api_get("/#{subject.class.element_name}", 'saved_searches/get.json')
       resources = subject.class.get
       resources.should be_an(Array)
       resources.length.should eq(2)
       resources.first.Id.should eq(id)
     end
+
+    on_post_it "should create a saved search" do
+      stub_api_post("/#{subject.class.element_name}", "saved_searches/new.json", "saved_searches/post.json")
+      resource = SavedSearch.new({ :Name => "A new search name here" })
+      resource.should respond_to(:save)
+      resource.save
+      resource.persisted?.should eq(true)
+      resource.attributes['Id'].should eq("20100815220615294367000000")
+      resource.attributes['ResourceUri'].should eq("/v1/savedsearches/20100815220615294367000000")
+    end
+
   end
 
   context "/savedsearches/<search_id>", :support do
+
     on_get_it "should get a SavedSearch" do
-      stub_api_get("/#{subject.class.element_name}/#{id}", 'listings/saved_search.json')
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
       resource = subject.class.find(id)
       resource.Id.should eq(id)
       resource.Name.should eq("Search name here")
     end
+
+    on_put_it "should update a SavedSearch" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", "saved_searches/get.json")
+      stub_api_put("/#{subject.class.element_name}/#{id}", "saved_searches/update.json", "saved_searches/post.json")
+      resource = subject.class.find(id)
+      resource.should respond_to(:save)
+      resource.Name = "A new search name here"
+      resource.save
+    end
+
+    on_delete_it "should delete a saved search" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", "saved_searches/get.json")
+      stub_api_delete("/#{subject.class.element_name}/#{id}", "generic_delete.json")
+      resource = subject.class.find(id)
+      resource.should respond_to(:delete)
+      resource.delete
+    end
+
   end
 
   context "/provided/savedsearches", :support do
     on_get_it "should get provided SavedSearches" do
-      stub_api_get("/provided/#{subject.class.element_name}", 'listings/saved_search.json')
+      stub_api_get("/provided/#{subject.class.element_name}", 'saved_searches/get.json')
       resources = subject.class.provided.get
       resources.should be_an(Array)
       resources.length.should eq(2)

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

@@ -20,7 +20,7 @@ describe SharedListing do
     end
 
     on_post_it "should fail creating" do
-      stub_api_post("/#{subject.class.element_name}",'empty.json') do |request|
+      stub_api_post("/#{subject.class.element_name}",{}) do |request|
         request.to_return(:status => 400, :body => fixture('errors/failure.json'))
       end
       subject

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

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Subscription do
+
+  it "responds to crud methods" do
+    Subscription.should respond_to(:get)
+    Subscription.new.should respond_to(:save)
+    Subscription.new.should respond_to(:delete)
+  end
+
+  before :each do
+    stub_auth_request
+  end
+
+  let(:id){ "20101230223226074204000000" }
+
+  context "/subscriptions", :support do
+
+    on_get_it "should get sum subscriptions" do
+      stub_api_get("/subscriptions", "subscriptions/get.json")
+      subject.class.get
+    end
+
+    on_post_it "should create a new subscription" do
+      @subscription = Subscription.new({
+        :Name => "A new subscription name",
+        :SearchId => "20101230223226074204000000",
+        :RecipientIds => [ "20101230223226074204000000" ],
+        :Subject => "my subject",
+        :Message => "my message"
+      })
+      stub_api_post("/subscriptions", 'subscriptions/new.json', 'subscriptions/post.json')
+      @subscription.save.should be(true)
+      @subscription.persisted?.should eq(true)
+    end
+
+    it "should subscribe a contact by id" do
+      stub_api_get("/subscriptions/#{id}", "subscriptions/get.json")
+      stub_api_put("/subscriptions/#{id}/subscribers/20101230223226074306000000", nil, 'subscriptions/subscribe.json')
+      resource = subject.class.find(id)
+      resource.subscribe("20101230223226074306000000")
+      resource.RecipientIds.size.should eq(2)
+      resource.RecipientIds.any? { |c| c == "20101230223226074306000000" }.should eq(true)
+    end
+
+    it "should unsubscribe a contact by id" do
+      stub_api_get("/subscriptions/#{id}", "subscriptions/get.json")
+      stub_api_delete("/subscriptions/#{id}/subscribers/20101230223226074307000000", 'generic_delete.json')
+      resource = subject.class.find(id)
+      resource.unsubscribe("20101230223226074307000000")
+      resource.RecipientIds.size.should eq(0)
+    end
+
+    it "should subscribe a contact by Contact object" do
+      stub_api_get("/subscriptions/#{id}", "subscriptions/get.json")
+      stub_api_put("/subscriptions/#{id}/subscribers/20101230223226074306000000", nil, 'subscriptions/subscribe.json')
+      resource = subject.class.find(id)
+      resource.subscribe(Contact.new({ :Id => "20101230223226074306000000" }))
+      resource.RecipientIds.size.should eq(2)
+      resource.RecipientIds.any? { |c| c == "20101230223226074306000000" }.should eq(true)
+    end
+
+    it "should unsubscribe a contact by Contact object" do
+      stub_api_get("/subscriptions/#{id}", "subscriptions/get.json")
+      stub_api_delete("/subscriptions/#{id}/subscribers/20101230223226074307000000", 'generic_delete.json')
+      resource = subject.class.find(id)
+      resource.unsubscribe(Contact.new({ :Id => "20101230223226074307000000" }))
+      resource.RecipientIds.size.should eq(0)
+    end
+
+    it "should initialize RecipientIds as an array if nil" do
+      stub_api_get("/subscriptions/#{id}", "subscriptions/get.json")
+      stub_api_put("/subscriptions/#{id}/subscribers/20101230223226074306000000", nil, 'subscriptions/subscribe.json')
+      resource = subject.class.find(id)
+      resource.RecipientIds = nil
+      resource.subscribe(Contact.new({ :Id => "20101230223226074306000000" }))
+      resource.RecipientIds.size.should eq(1)
+    end
+
+  end
+
+  context "/subscriptions/:id", :support do
+
+    on_get_it "should get a subscription" do
+      stub_api_get("/subscriptions/#{id}", "subscriptions/get.json")
+      subject.class.find(id)
+    end
+
+    on_put_it "should update a subscription" do
+      stub_api_get("/subscriptions/#{id}", 'subscriptions/get.json')
+      stub_api_put("/subscriptions/#{id}", 'subscriptions/update.json', 'subscriptions/post.json')
+      resource = subject.class.find(id)
+      resource.Name = "A new subscription name"
+      resource.save.should be(true)
+    end
+
+    on_delete_it "should delete a subscription" do
+      stub_api_get("/subscriptions/#{id}", 'subscriptions/get.json')
+      stub_api_delete("/subscriptions/#{id}", 'generic_delete.json')
+      resource = subject.class.find(id)
+      resource.delete
+    end
+
+  end
+
+end