Merge pull request #98 from ryanhertz/messages-updates

Messages updates

Author: bhornseth

CHANGELOG

@@ -1,3 +1,7 @@
+v1.3.24
+ - added replies method and finders to message class
+ - added to_param method to base class
+
 v1.3.23
  - remove ruby 1.9 hash syntax
 

lib/spark_api/models/base.rb

@@ -125,6 +125,10 @@ def persisted?;
         !@attributes['Id'].nil? && !@attributes['ResourceUri'].nil?
       end
 
+      def to_param
+        attributes['Id']
+      end
+
       protected
 
       def write_attribute(attribute, value)

lib/spark_api/models/message.rb

@@ -1,6 +1,7 @@
 module SparkApi
   module Models
     class Message < Base
+      extend Finders
       self.element_name="messages"
 
       def save(arguments={})
@@ -13,11 +14,17 @@ def save(arguments={})
         end
         false
       end
+
       def save!(arguments={})
         results = connection.post self.class.path, {"Messages" => [ attributes ]}, arguments
         true
       end
-      
+
+      def replies(args = {})
+        arguments = {:_expand => "Body, Sender"}.merge(args)
+        Message.collect(connection.get("#{self.class.path}/#{self.Id}/replies", arguments))
+      end
+
     end
   end
 end

spec/fixtures/messages/get.json

@@ -0,0 +1,83 @@
+{
+  "D": {
+    "Success": true,
+    "Results": [
+      {
+        "Id": "20110353423434130982000000",
+        "ResourceUri": "/v1/messages/20110353423434130982000000",
+        "Type": "ShowingRequest",
+        "SenderId": "20110112234857732941000000",
+        "Sender": {
+          "Id": "20110112234857732941000000",
+          "ResourceUri": "/v1/accounts/20110112234857732941000000",
+          "UserType": "Member",
+          "Name": "Joe Realtor",
+          "OfficeId": "20100113238853732842000000",
+          "Office": "Joe's Realty",
+          "CompanyId": null,
+          "Company": null
+        },
+        "RecipientIds": ["20120212334957232744000000"],
+        "Recipients": [{
+          "Id": "20120212334957232744000000",
+          "ResourceUri": "/v1/accounts/20120212334957232744000000",
+          "UserType": "Member",
+          "Name": "Sue Realtor",
+          "OfficeId": "20100113238853732842000000",
+          "Office": "Joe's Realty",
+          "CompanyId": null,
+          "Company": null
+        }],
+        "ThreadInfo": {
+          "HasReplies": true,
+          "UnreadInThread": true
+        },
+        "Subject": "Showing Request For 123 Main St, MLS # 12-345",
+        "Body": "A showing is requested for ...",
+        "ListingId": "20110112234857732941000000",
+        "ReplyToId": null,
+        "RecipientIds": "20130212233857332441000000",
+        "CreatedTimestamp": "2013-06-11T11:00:00",
+        "ModificationTimestamp": "2013-06-11T11:00:00"
+      },
+      {
+        "Id": "20110353423434130982000000",
+        "ResourceUri": "/v1/messages/20110353423434130982000000",
+        "Type": "ShowingRequest",
+        "SenderId": "20110112234857732941000000",
+        "Sender": {
+          "Id": "20110112234857732941000000",
+          "ResourceUri": "/v1/accounts/20110112234857732941000000",
+          "UserType": "Member",
+          "Name": "Joe Realtor",
+          "OfficeId": "20100113238853732842000000",
+          "Office": "Joe's Realty",
+          "CompanyId": null,
+          "Company": null
+        },
+        "RecipientIds": ["20120212334957232744000000"],
+        "Recipients": [{
+          "Id": "20120212334957232744000000",
+          "ResourceUri": "/v1/accounts/20120212334957232744000000",
+          "UserType": "Member",
+          "Name": "Sue Realtor",
+          "OfficeId": "20100113238853732842000000",
+          "Office": "Joe's Realty",
+          "CompanyId": null,
+          "Company": null
+        }],
+        "ThreadInfo": {
+          "HasReplies": true,
+          "UnreadInThread": true
+        },
+        "Subject": "Showing Request For 123 Main St, MLS # 12-345",
+        "Body": "A showing is requested for ...",
+        "ListingId": "20110112234857732941000000",
+        "ReplyToId": null,
+        "RecipientIds": "20130212233857332441000000",
+        "CreatedTimestamp": "2013-06-11T11:00:00",
+        "ModificationTimestamp": "2013-06-11T11:00:00"
+      }
+    ]
+  }
+}

spec/formatters/api_support_formatter.rb

@@ -3,7 +3,7 @@
 # Formatter to support documenting currently-implemented API paths and
 # methods. This borrows heavily from the standard
 # DocumentationFormatter, but excludes example groups not related
-# tagged with :support. It also formats examples withe a :method tag
+# tagged with :support. It also formats examples with a :method tag
 # with the HTTP method and path ahead of the example description.
 class ApiSupportFormatter < RSpec::Core::Formatters::DocumentationFormatter
 

spec/unit/spark_api/models/message_spec.rb

@@ -18,7 +18,11 @@
   end
 
   context "/messages", :support do
-    on_get_it "should get all my messages"
+    on_get_it "should get all my messages" do
+      stub_api_get("/messages", 'messages/get.json')
+      messages = Message.find(:all)
+      messages.size.should == 2
+    end
 
     on_post_it "should save a new message" do
       stub_api_post("/messages", 'messages/new.json', 'messages/post.json')
@@ -42,6 +46,20 @@
   end
 
   context "/messages/<message_id>", :support do
-    on_get_it "should get a single message"
+    on_get_it "should get a single message" do
+      subject.attributes["Id"] = "20110353423434130982000000"
+      stub_api_get("/messages/#{subject.Id}", "messages/get.json")
+      subject.should be_a(Message)
+    end
   end
+
+  context "/messages/<message_id>/replies", :support do
+    on_get_it "should get all the replies" do
+      subject.attributes["Id"] = "20110353423434130982000000"
+      stub_api_get("/messages/#{subject.Id}/replies", "messages/get.json", :_expand => 'Body, Sender')
+      subject.replies.size.should == 2
+    end
+
+  end
+
 end