flexmls_api 0.7.0 → 0.7.3

data/History.txt

@@ -1,3 +1,7 @@
+== v0.7.1 2011-10-13
+* Updated connection dependencies
+* Added messaging model
+* ExpirationDate editable for Listing
 == v0.7.0 2011-10-03
 * Major changes to results object returned from the client (and models). Results are no longer allowed to be nil, and Array is decorated with non result response information.
 * Finished listing photo uploads

data/README.md

@@ -24,8 +24,9 @@ Usage Examples
     #  - ssl:         false
     #  - user_agent: 'flexmls API Ruby Gem'
     FlexmlsApi.configure do |config|
-        config.api_key    = 'your_api_key'
-        config.api_secret = 'your_api_secret'
+        config.endpoint   = 'http://api.developers.flexmls.com'
+        config.api_key    = 'my_api_key'
+        config.api_secret = 'my_api_secret'
     end
 
     # mixin the models so you can use them without prefix
@@ -38,23 +39,22 @@ Usage Examples
 #### Interactive Console
 Included in the gem is a simple setup script to run the client in IRB.  To use it, first create the file called _.flexmls_api_testing_ filling in the credentials for your account.
 
-    API_USER="20110101000000000000000000" # ID for an api user
     API_ENDPOINT="http://api.developers.flexmls.com"
-    API_KEY="my_test_key"
-    API_SECRET="my_test_secret"
+    API_KEY="my_api_key"
+    API_SECRET="my_api_secret"
     
     export API_USER API_ENDPOINT API_KEY API_SECRET
 
 Now, to run with this setup, run the following from the command line:
 
     > source .flexmls_api_testing
-    > bin/flexmls_api
+    > flexmls_api
     flemxlsApi> FlexmlsApi.client.get '/my/account'
 
-You can also provide these options from the command line, see "script/console -h" for more information
+You can also provide these options from the command line, see "flexmls_api -h" for more information
 
 
-Authentication
+Authentication Types
 --------------
 Authentication is handled transparently by the request framework in the gem, so you should never need to manually make an authentication request.  More than one mode of authentication is supported, so the client needs to be configured accordingly.
 

data/Rakefile

@@ -1,4 +1,5 @@
 require "rubygems"
+require 'rubygems/user_interaction'
 require 'flexmls_gems/tasks'
 require 'flexmls_gems/tasks/spec'
 require 'flexmls_gems/tasks/rdoc'

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.3

data/lib/flexmls_api.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-require 'curb'
 require 'json'
 require 'logger'
 
@@ -10,6 +9,7 @@ require 'flexmls_api/authentication'
 require 'flexmls_api/response'
 require 'flexmls_api/paginate'
 require 'flexmls_api/request'
+require 'flexmls_api/connection'
 require 'flexmls_api/client'
 require 'flexmls_api/faraday'
 require 'flexmls_api/primary_array'

data/lib/flexmls_api/authentication.rb

@@ -50,37 +50,6 @@ module FlexmlsApi
     def session=(active_session)
       @authenticator.session=active_session
     end
-    
-    # Main connection object for running requests.  Bootstraps the Faraday abstraction layer with 
-    # our client configuration.
-    def connection(force_ssl = false)
-      opts = {
-        :headers => headers
-      }
-      domain = @endpoint 
-      if(force_ssl || self.ssl)
-        opts[:ssl] = {:verify => false }
-        opts[:url] = @endpoint.sub /^http:/, "https:"
-      else 
-        opts[:url] = @endpoint.sub /^https:/, "http:"
-      end
-      conn = Faraday::Connection.new(opts) do |builder|
-        builder.adapter Faraday.default_adapter
-        builder.use FlexmlsApi::FaradayExt::FlexmlsMiddleware
-      end
-      FlexmlsApi.logger.debug("Connection: #{conn.inspect}")
-      conn
-    end
-    
-    # HTTP request headers for client requests
-    def headers
-      {
-        :accept => 'application/json',
-        :content_type => 'application/json',
-        :user_agent => Configuration::DEFAULT_USER_AGENT,
-        Configuration::X_FLEXMLS_API_USER_AGENT => user_agent
-      }
-    end
-    
+ 
   end
 end

data/lib/flexmls_api/authentication/oauth2.rb

@@ -170,6 +170,15 @@ module FlexmlsApi
       require 'flexmls_api/authentication/oauth2_impl/grant_type_code'
       require 'flexmls_api/authentication/oauth2_impl/grant_type_password'
       require 'flexmls_api/authentication/oauth2_impl/password_provider'
+      
+      # Loads a provider class from a string
+      def self.load_provider(string, args={})
+        constant = Object
+        string.split("::").compact.each { |name| constant = constant.const_get(name) unless name == ""}
+        constant.new(args)
+      rescue => e
+        raise ArgumentError, "The value '#{string}' is an invalid class name for an oauth2 provider:  #{e.message}"
+      end
     end
     
   end

data/lib/flexmls_api/client.rb

@@ -4,6 +4,7 @@ module FlexmlsApi
   # FlexmlsApi::client if the global configuration has been set as well.  Otherwise, this class may 
   # be instanciated separately with the configuration information.
   class Client
+    include Connection
     include Authentication
     include Request
     

data/lib/flexmls_api/configuration/yaml.rb

@@ -1,35 +1,22 @@
 require 'erb'
+
 module FlexmlsApi
   module Configuration
     class YamlConfig
       KEY_CONFIGURATIONS = VALID_OPTION_KEYS  + [:oauth2] + OAUTH2_KEYS  
-      
+      DEFAULT_OAUTH2_PROVIDER = "FlexmlsApi::Authentication::OAuth2Impl::PasswordProvider"
       attr_accessor *KEY_CONFIGURATIONS
-      attr_reader :client_keys, :oauth2_keys
+      attr_reader :client_keys, :oauth2_keys, :provider
       
       def initialize(filename=nil)
-        @client_keys = {}
-        @oauth2_keys = {}
         @oauth2 = false
         load_file(filename) unless filename.nil?()
       end
       def load_file(file)
-        @client_keys = {}
-        @oauth2_keys = {}
         @file = file
         @name = File.basename(file, ".yml")
         config = YAML.load(ERB.new(File.read(file)).result)[api_env]
-        config.each do |key,val|
-          sym = key.to_sym
-          if KEY_CONFIGURATIONS.include? sym
-            self.send("#{sym}=", val)
-            if VALID_OPTION_KEYS.include?(sym)
-              @client_keys[sym] = val
-            elsif OAUTH2_KEYS.include?(sym)
-              @oauth2_keys[sym] = val
-            end
-          end
-        end
+        config["oauth2"] == true  ? load_oauth2(config) : load_api_auth(config)
       rescue => e
         FlexmlsApi.logger().error("Unable to load config file #{file}[#{api_env}]")
         raise e
@@ -54,7 +41,7 @@ module FlexmlsApi
       
       # Used to specify the root of where to look for flexmlsApi config files
       def self.config_path
-        "config/flexmls_api"
+        path_prefix + "config/flexmls_api"
       end
       
       def self.config_keys()
@@ -74,8 +61,41 @@ module FlexmlsApi
       def env
         ENV
       end
-
+      
+      private 
+      def load_api_auth(config={})
+        @client_keys = {}
+        @oauth2_keys = {}
+        config.each do |key,val|
+          sym = key.to_sym
+          if VALID_OPTION_KEYS.include?(sym)
+            self.send("#{sym}=", val)
+            @client_keys[sym] = val
+          end
+        end
+      end
+      def load_oauth2(config={})
+        @oauth2_provider = DEFAULT_OAUTH2_PROVIDER
+        @client_keys = {:oauth2_provider => @oauth2_provider }
+        @oauth2_keys = {}
+        @oauth2 = true
+        config.each do |key,val|
+          sym = key.to_sym
+          if VALID_OPTION_KEYS.include?(sym)
+            self.send("#{sym}=", val)
+            @client_keys[sym] = val
+          elsif OAUTH2_KEYS.include? sym
+            self.send("#{sym}=", val)
+            @oauth2_keys[sym] = val
+          end
+        end
+      end
+      # In a rails app, default to the rails root, regardless of where that may be      
+      def self.path_prefix
+        "#{Rails.root}/"
+      rescue => e
+        ""
+      end
     end
   end
 end
-

data/lib/flexmls_api/connection.rb

@@ -0,0 +1,42 @@
+require 'openssl'
+require 'faraday'
+require 'faraday_middleware'
+require 'yajl'
+
+module FlexmlsApi
+  # =Connection
+  # Mixin module for handling http connection information
+  module Connection
+    # Main connection object for running requests.  Bootstraps the Faraday abstraction layer with 
+    # our client configuration.
+    def connection(force_ssl = false)
+      opts = {
+        :headers => headers
+      }
+      domain = @endpoint 
+      if(force_ssl || self.ssl)
+        opts[:ssl] = {:verify => false }
+        opts[:url] = @endpoint.sub /^http:/, "https:"
+      else 
+        opts[:url] = @endpoint.sub /^https:/, "http:"
+      end
+      conn = Faraday::Connection.new(opts) do |builder|
+        builder.adapter Faraday.default_adapter
+        builder.use FlexmlsApi::FaradayExt::FlexmlsMiddleware
+      end
+      FlexmlsApi.logger.debug("Connection: #{conn.inspect}")
+      conn
+    end
+    
+    # HTTP request headers for client requests
+    def headers
+      {
+        :accept => 'application/json',
+        :content_type => 'application/json',
+        :user_agent => Configuration::DEFAULT_USER_AGENT,
+        Configuration::X_FLEXMLS_API_USER_AGENT => user_agent
+      }
+    end
+    
+  end
+end

data/lib/flexmls_api/faraday.rb

@@ -24,8 +24,15 @@ module FlexmlsApi
           end
         end
         case finished_env[:status]
-        when 400, 409
-          raise BadResourceRequest, {:message => response.message, :code => response.code, :status => finished_env[:status]}
+        when 400
+          hash = {:message => response.message, :code => response.code, :status => finished_env[:status]}
+
+          # constraint violation
+          if response.code == 1053
+            details = body['D']['Details']
+            hash[:details] = details
+          end
+          raise BadResourceRequest,hash
         when 401
           # Handle the WWW-Authenticate Response Header Field if present. This can be returned by 
           # OAuth2 implementations and wouldn't hurt to log.
@@ -35,7 +42,9 @@ module FlexmlsApi
         when 404
           raise NotFound, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         when 405
-    raise NotAllowed, {:message => response.message, :code => response.code, :status => finished_env[:status]}
+          raise NotAllowed, {:message => response.message, :code => response.code, :status => finished_env[:status]}
+        when 409
+          raise BadResourceRequest, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         when 500
           raise ClientError, {:message => response.message, :code => response.code, :status => finished_env[:status]}
         when 200..299
@@ -51,6 +60,5 @@ module FlexmlsApi
       end
       
     end
-
   end
 end

data/lib/flexmls_api/models.rb

@@ -23,6 +23,7 @@ require 'flexmls_api/models/note'
 require 'flexmls_api/models/listing_cart'
 require 'flexmls_api/models/shared_listing'
 require 'flexmls_api/models/saved_search'
+require 'flexmls_api/models/message'
 
 module FlexmlsApi
   module Models

data/lib/flexmls_api/models/base.rb

@@ -6,7 +6,8 @@ module FlexmlsApi
     class Base
       extend Paginate
 
-      attr_accessor :attributes
+      attr_accessor :attributes, :errors
+      attr_reader :changed
       
       # Name of the resource as related to the path name
       def self.element_name
@@ -38,6 +39,8 @@ module FlexmlsApi
 
       def initialize(attributes={})
         @attributes = {}
+        @errors = []
+        @changed = []
         load(attributes)
       end
 
@@ -65,7 +68,7 @@ module FlexmlsApi
         if method_name =~ /(=|\?)$/
           case $1
           when "=" 
-            attributes[$`] = arguments.first
+            write_attribute($`, arguments.first)
             # TODO figure out a nice way to present setters for the standard fields
           when "?" 
             if attributes.include?($`)
@@ -79,7 +82,7 @@ module FlexmlsApi
           super # GTFO
         end
       end
-
+      
       def respond_to?(method_symbol, include_private=false)
         if super
           return true
@@ -100,6 +103,16 @@ module FlexmlsApi
       def parse_id(uri)
         uri[/\/.*\/(.+)$/, 1]
       end
+      
+      protected
+      
+      def write_attribute(attribute,  value)
+        unless attributes[attribute] == value
+          attributes[attribute] = value
+          @changed << attribute unless @changed.include?(attribute)
+        end
+      end
+        
     end
   end
 end

data/lib/flexmls_api/models/contact.rb

@@ -5,9 +5,13 @@ module FlexmlsApi
       self.element_name="contacts"
       
       def save(arguments={})
+        self.errors = [] # clear the errors hash
         begin
           return save!(arguments)
-        rescue NotFound, BadResourceRequest => e
+        rescue BadResourceRequest => e
+          self.errors << {:code => e.code, :message => e.message}
+          FlexmlsApi.logger.error("Failed to save resource #{self}: #{e.message}")
+        rescue NotFound => e
           FlexmlsApi.logger.error("Failed to save resource #{self}: #{e.message}")
         end
         false

data/lib/flexmls_api/models/listing.rb

@@ -6,6 +6,7 @@ module FlexmlsApi
       attr_accessor :constraints
       self.element_name="listings"
       DATA_MASK = "********"
+      WRITEABLE_FIELDS = ["ListPrice", "ExpirationDate"]
 
       def initialize(attributes={})
         @photos = []
@@ -58,6 +59,11 @@ module FlexmlsApi
         collect(connection.get("/company/listings", arguments))
       end
       
+      def self.nearby(latitude, longitude, arguments={})
+        nearby_args = {:Lat => latitude, :Lon => longitude}.merge(arguments)
+        collect(connection.get("/listings/nearby", nearby_args))
+      end
+      
       def tour_of_homes(arguments={})
         return @tour_of_homes unless @tour_of_homes.nil?
         @tour_of_homes = TourOfHome.find_by_listing_key(self.Id, arguments)
@@ -104,19 +110,37 @@ module FlexmlsApi
       end
       
       def save(arguments={})
+        self.errors = []
         begin
           return save!(arguments)
-        rescue NotFound, BadResourceRequest => e
+        rescue BadResourceRequest => e
+          self.errors << {:code => e.code, :message => e.message}
+          FlexmlsApi.logger.debug("BHDEBUG: #{e.inspect}")
+          if e.code == 1053
+            @constraints = []
+            e.details.each do |detail|
+              detail.each_pair do |k,v|
+                v.each { |constraint| @constraints << Constraint.new(constraint)}
+              end
+            end
+          end
+          FlexmlsApi.logger.error("Failed to save resource #{self}: #{e.message}")
+        rescue NotFound => e
           FlexmlsApi.logger.error("Failed to save resource #{self}: #{e.message}")
         end
         false
       end
       def save!(arguments={})
-        results = connection.put "#{self.class.path}/#{self.Id}", {"ListPrice"=> self.ListPrice}, arguments
-        @contstraints = []
-        results.details.each do |detail|
-          detail.each_pair do |k,v|
-            v.each { |constraint| @constraints << Constraint.new(constraint)}
+        writable_changed_keys = changed & WRITEABLE_FIELDS
+        if writable_changed_keys.empty?
+          FlexmlsApi.logger.warn("No supported listing change detected")
+        else
+          results = connection.put "#{self.class.path}/#{self.Id}", build_hash(writable_changed_keys), arguments
+          @contstraints = []
+          results.details.each do |detail|
+            detail.each_pair do |k,v|
+              v.each { |constraint| @constraints << Constraint.new(constraint)}
+            end
           end
         end
         true
@@ -131,6 +155,13 @@ module FlexmlsApi
         editable
       end
       
+      def ExpirationDate
+        attributes["ExpirationDate"]
+      end
+      def ExpirationDate=(value)
+        write_attribute("ExpirationDate", value)
+      end
+      
       
       private
 
@@ -141,7 +172,7 @@ module FlexmlsApi
         if method_name =~ /(=|\?)$/
           case $1
           when "="
-            attributes[$`] = arguments.first
+            write_attribute($`,arguments.first)
             # TODO figure out a nice way to present setters for the standard fields
           when "?"
             attributes[$`]
@@ -152,6 +183,15 @@ module FlexmlsApi
           super # GTFO
         end
       end
+      
+      def build_hash(keys)
+        hash = {}
+        keys.each do |key|
+          hash[key] = attributes[key]
+        end
+        hash
+      end
+      
     end
   end
 end

data/lib/flexmls_api/models/message.rb

@@ -0,0 +1,21 @@
+module FlexmlsApi
+  module Models
+    class Message < Base
+      self.element_name="messages"
+      
+      def save(arguments={})
+        begin
+          return save!(arguments)
+        rescue NotFound, BadResourceRequest => e
+          FlexmlsApi.logger.error("Failed to save resource #{self}: #{e.message}")
+        end
+        false
+      end
+      def save!(arguments={})
+        results = connection.post self.class.path, {"Messages" => [ attributes ]}, arguments
+        true
+      end
+      
+    end
+  end
+end

data/lib/flexmls_api/multi_client.rb

@@ -45,7 +45,14 @@ module FlexmlsApi
     def activate_client_from_config(symbol)
       FlexmlsApi.logger.debug("Loading multiclient [#{symbol.to_s}] from config")
       yaml = YamlConfig.build(symbol.to_s)
-      Client.new(yaml.client_keys)
+      if(yaml.oauth2?)
+        Client.new(yaml.client_keys.merge({
+              :oauth2_provider => Authentication::OAuth2Impl.load_provider(yaml.oauth2_provider, yaml.oauth2_keys),
+              :authentication_mode => FlexmlsApi::Authentication::OAuth2,
+            }))
+      else
+        Client.new(yaml.client_keys)
+      end
     end
     
   end

data/lib/flexmls_api/response.rb

@@ -29,12 +29,13 @@ module FlexmlsApi
   # Errors built from API responses
   class InvalidResponse < StandardError; end
   class ClientError < StandardError
-    attr_reader :code, :status
+    attr_reader :code, :status, :details
     def initialize (options = {})
       # Support the standard initializer for errors
       opts = options.is_a?(Hash) ? options : {:message => options.to_s}
       @code = opts[:code]
       @status = opts[:status]
+      @details = opts[:details]
       super(opts[:message])
     end
     
@@ -66,4 +67,4 @@ module FlexmlsApi
       end
     end
   end
-end
+end

data/spec/fixtures/errors/failure_with_constraint.json

@@ -0,0 +1,17 @@
+{
+  "D": {
+    "Message": "The data you provided failed constraints",
+    "Success": false,
+    "Details": [{
+      "ListPrice": [{
+        "RuleValue": 25.0,
+        "Value": 500000.0,
+        "RuleField": null,
+        "RuleFieldValue": null,
+        "RuleName": "MaxIncreasePercent"
+      }]
+    }],
+    "Code": 1053
+  }
+}
+

data/spec/fixtures/errors/failure_with_msg.json

@@ -0,0 +1,7 @@
+{
+  "D": {
+    "Message": "The e-mail address 'bhornseth@fbsdata.com' belongs to another prospect", 
+    "Success": false, 
+    "Code": 1055
+  }
+}

data/spec/fixtures/listings/put_expiration_date.json

@@ -0,0 +1,5 @@
+{
+    "D": {
+      "ExpirationDate": "2011-10-04"
+    }
+}

data/spec/fixtures/messages/new.json

@@ -0,0 +1,14 @@
+{
+    "D": {
+        "Messages": [
+            {
+                "Type": "ShowingRequest",
+                "EventDateTime": "2011-09-15T14:00:00",
+                "SenderId": "20110112234857732941000000",
+                "Subject": "Showing Request For 123 Main St, MLS # 12-345",
+                "Body": "A showing is requested for ...",
+                "ListingId": "20110112234857732941000000"
+            }
+    	]
+	}
+}

data/spec/fixtures/messages/new_empty.json

@@ -0,0 +1,7 @@
+{
+	"D": {
+		"Messages": [
+			{ }
+		]
+	}
+}

data/spec/fixtures/messages/new_with_recipients.json

@@ -0,0 +1,15 @@
+{
+    "D": {
+        "Messages": [
+            {
+                "Type": "ShowingRequest",
+                "EventDateTime": "2011-09-15T14:00:00",
+                "SenderId": "20110112234857732941000000",
+                "Subject": "Showing Request For 123 Main St, MLS # 12-345",
+                "Body": "A showing is requested for ...",
+                "ListingId": "20110112234857732941000000",
+                "Recipients": ["20110112234857732941000000","20110092234857738467000000"]
+            }
+	    ]
+	}
+}

data/spec/fixtures/messages/post.json

@@ -0,0 +1,5 @@
+{
+    "D": {
+        "Success": true
+    }
+}

data/spec/unit/flexmls_api/authentication/oauth2_spec.rb

@@ -176,3 +176,14 @@ describe "password authentication" do
     subject.authenticate.expires_in.should eq(60)
   end
 end
+describe FlexmlsApi::Authentication::OAuth2Impl  do
+  it "should load a provider" do
+    example = "FlexmlsApi::Authentication::OAuth2Impl::PasswordProvider"
+    FlexmlsApi::Authentication::OAuth2Impl.load_provider(example,{}).class.to_s.should eq(example)
+    prefix = "::#{example}"
+    FlexmlsApi::Authentication::OAuth2Impl.load_provider(prefix,{}).class.to_s.should eq(example)
+    bad_example = "Derp::Derp::Derp::DerpProvider"
+    expect{FlexmlsApi::Authentication::OAuth2Impl.load_provider(bad_example,{}).class.to_s.should eq(bad_example)}.to raise_error(ArgumentError)
+  end
+
+end

data/spec/unit/flexmls_api/configuration/yaml_spec.rb

@@ -44,8 +44,9 @@ describe FlexmlsApi::Configuration::YamlConfig, "Yaml Config"  do
       subject.client_id.should eq("developmentid124nj4qu3pua")
       subject.client_secret.should eq("developmentsecret4orkp29f")
       subject.endpoint.should eq("http://api.dev.flexmls.com")
+      subject.oauth2_provider.should eq("FlexmlsApi::TestOAuth2Provider")
       subject.name.should eq("test_oauth")
-      subject.client_keys.keys.should eq([:endpoint])
+      subject.client_keys.keys.should eq([:endpoint, :oauth2_provider])
       subject.oauth2_keys.keys.should =~ [:authorization_uri, :client_id, :access_uri, :client_secret, :redirect_uri]
     end
     it "should load a configured api key for production" do
@@ -59,6 +60,7 @@ describe FlexmlsApi::Configuration::YamlConfig, "Yaml Config"  do
       subject.client_id.should eq("production1id124nj4qu3pua")
       subject.client_secret.should eq("productionsecret4orkp29fv")
       subject.endpoint.should eq("http://api.flexmls.com")
+      subject.oauth2_provider.should eq(subject.class::DEFAULT_OAUTH2_PROVIDER)
       subject.name.should eq("test_oauth")
     end
     

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

@@ -72,6 +72,18 @@ describe Contact do
     c.save.should be(false)
     expect{ c.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 400 }
   end
+
+  it "should fail saving and set @errors" do
+    stub_api_post("/contacts", 'contacts/new_empty.json') do |request|
+      request.to_return(:status => 400, :body => fixture('errors/failure_with_msg.json'))
+    end
+
+    c=Contact.new
+    c.errors.length.should eq(0)
+    c.save.should be_false
+    c.errors.length.should eq(1)
+    c.errors.first[:code].should eq(1055)
+  end
   
   context "on an epic fail" do
     it "should fail saving and asplode" do

data/spec/unit/flexmls_api/models/listing_spec.rb

@@ -152,6 +152,12 @@ describe Listing do
       l.documents.length.should == 0
     end 
 
+    it "should return nearby homes" do
+      stub_api_get("/listings/nearby", 'listings/no_subresources.json', {:Lat => "45.45", :Lon => "-93.98"})
+      l = Listing.nearby(45.45, -93.98)
+      l.length.should == 1
+    end 
+    
     it "should return street address" do
         @listing.street_address.should eq("100 Someone's St")
     end
@@ -175,7 +181,7 @@ describe Listing do
   end
   
   context "on save" do
-    it "should save a listing that has modified" do
+    it "should save a listing that has modified ListPrice" do
       list_id = "20060725224713296297000000"
       stub_api_get("/listings/#{list_id}", 'listings/no_subresources.json')
       stub_api_put("/listings/#{list_id}", 'listings/put.json', 'success.json')
@@ -183,6 +189,14 @@ describe Listing do
       l.ListPrice = 10000.0
       l.save.should be(true)
     end
+    it "should save a listing that has modified ExpirationDate" do
+      list_id = "20060725224713296297000000"
+      stub_api_get("/listings/#{list_id}", 'listings/no_subresources.json')
+      stub_api_put("/listings/#{list_id}", 'listings/put_expiration_date.json', 'success.json')
+      l = Listing.find(list_id)
+      l.ExpirationDate = "2011-10-04"
+      l.save.should be(true)
+    end
     it "should not save a listing that does not exist" do
       list_id = "20060725224713296297000000"
       stub_api_get("/listings/#{list_id}", 'listings/no_subresources.json')
@@ -205,6 +219,22 @@ describe Listing do
       l.constraints.size.should eq(1)
       l.constraints.first.RuleName.should eq("MaxValue")
     end
+
+    it "should fail saving a listing with constraints and provide the constraints" do
+      list_id = "20060725224713296297000000"
+      stub_api_get("/listings/#{list_id}", 'listings/no_subresources.json')
+      stub_api_put("/listings/#{list_id}", 'listings/put.json') do |request|
+        request.to_return(:status => 400, :body => fixture('errors/failure_with_constraint.json'))
+      end 
+
+      l = Listing.find(list_id)
+      l.ListPrice = 10000.0
+      l.save.should be_false
+      l.constraints.size.should eq(1)
+      l.constraints.first.RuleName.should eq("MaxIncreasePercent")
+      l.errors.size.should eq(1)
+    end
+
     context "with pagination" do
       # This is really a bogus call, but we should make sure our pagination collection impl still behaves sanely
       it "should save a listing with constraints" do

data/spec/unit/flexmls_api/models/message_spec.rb

@@ -0,0 +1,44 @@
+require './spec/spec_helper'
+
+
+describe Message do
+  before(:each) do
+    stub_auth_request
+  end
+  
+  subject do
+    m = Message.new
+    m.attributes["Type"] = "ShowingRequest"
+    m.attributes["EventDateTime"] = "2011-09-15T14:00:00"
+    m.attributes["SenderId"] = "20110112234857732941000000"
+    m.attributes["Subject"] = "Showing Request For 123 Main St, MLS # 12-345"
+    m.attributes["Body"] = "A showing is requested for ..."
+    m.attributes["ListingId"] = "20110112234857732941000000"
+    m
+  end   
+  
+  it "should get all my messages"
+
+  it "should get a single message"
+
+  it "should save a new message" do
+    stub_api_post("/messages", 'messages/new.json', 'messages/post.json')
+    subject.save.should be(true)
+  end
+
+  it "should save a new message with recipients" do
+    stub_api_post("/messages", 'messages/new_with_recipients.json', 'messages/post.json')
+    subject.attributes["Recipients"] =  ["20110112234857732941000000","20110092234857738467000000"]
+    subject.save.should be(true)
+  end
+
+  it "should fail saving" do
+    stub_api_post("/messages", 'messages/new_empty.json') do |request|
+      request.to_return(:status => 400, :body => fixture('errors/failure.json'))
+    end
+    m=subject.class.new
+    m.save.should be(false)
+    expect{ m.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 400 }
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flexmls_api
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 7
-  - 0
-  version: 0.7.0
+  - 3
+  version: 0.7.3
 platform: ruby
 authors: 
 - Brandon Hornseth
@@ -16,60 +16,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-03 00:00:00 Z
+date: 2012-02-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 29
+        hash: 9
         segments: 
         - 0
         - 7
-        - 15
-        version: 0.7.15
-  version_requirements: *id001
-  name: curb
-- !ruby/object:Gem::Dependency 
+        - 5
+        version: 0.7.5
+  requirement: *id001
   prerelease: false
-  type: :runtime
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 6
-        - 1
-        version: 0.6.1
-  version_requirements: *id002
   name: faraday
-- !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
-  requirement: &id003 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 3
         segments: 
         - 0
-        - 6
-        - 3
-        version: 0.6.3
-  version_requirements: *id003
-  name: faraday_middleware
-- !ruby/object:Gem::Dependency 
+        - 7
+        - 0
+        version: 0.7.0
+  requirement: *id002
   prerelease: false
+  name: faraday_middleware
   type: :runtime
-  requirement: &id004 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -80,12 +62,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id004
-  name: multi_json
-- !ruby/object:Gem::Dependency 
+  requirement: *id003
   prerelease: false
+  name: multi_json
   type: :runtime
-  requirement: &id005 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -96,12 +78,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  version_requirements: *id005
-  name: json
-- !ruby/object:Gem::Dependency 
+  requirement: *id004
   prerelease: false
+  name: json
   type: :runtime
-  requirement: &id006 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -112,12 +94,12 @@ dependencies:
         - 8
         - 2
         version: 0.8.2
-  version_requirements: *id006
-  name: yajl-ruby
-- !ruby/object:Gem::Dependency 
+  requirement: *id005
   prerelease: false
+  name: yajl-ruby
   type: :runtime
-  requirement: &id007 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -136,12 +118,12 @@ dependencies:
         - 0
         - 0
         version: 4.0.0
-  version_requirements: *id007
-  name: builder
-- !ruby/object:Gem::Dependency 
+  requirement: *id006
   prerelease: false
+  name: builder
   type: :runtime
-  requirement: &id008 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -152,12 +134,12 @@ dependencies:
         - 2
         - 5
         version: 2.2.5
-  version_requirements: *id008
-  name: addressable
-- !ruby/object:Gem::Dependency 
+  requirement: *id007
   prerelease: false
+  name: addressable
   type: :runtime
-  requirement: &id009 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -177,26 +159,28 @@ dependencies:
         - 0
         - 0
         version: 4.0.0
-  version_requirements: *id009
+  requirement: *id008
+  prerelease: false
   name: will_paginate
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 63
         segments: 
         - 0
-        version: "0"
-  version_requirements: *id010
-  name: rake
-- !ruby/object:Gem::Dependency 
+        - 9
+        - 2
+        version: 0.9.2
+  requirement: *id009
   prerelease: false
+  name: rake
   type: :development
-  requirement: &id011 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -207,22 +191,22 @@ dependencies:
         - 3
         - 0
         version: 2.3.0
-  version_requirements: *id011
-  name: rspec
-- !ruby/object:Gem::Dependency 
+  requirement: *id010
   prerelease: false
+  name: rspec
   type: :development
-  requirement: &id012 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 11
         segments: 
         - 1
-        - 4
+        - 7
         - 0
-        version: 1.4.0
+        version: 1.7.0
     - - <
       - !ruby/object:Gem::Version 
         hash: 15
@@ -231,28 +215,28 @@ dependencies:
         - 0
         - 0
         version: 2.0.0
-  version_requirements: *id012
-  name: webmock
-- !ruby/object:Gem::Dependency 
+  requirement: *id011
   prerelease: false
+  name: webmock
   type: :development
-  requirement: &id013 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 31
         segments: 
         - 0
         - 2
-        - 0
-        version: 0.2.0
-  version_requirements: *id013
-  name: typhoeus
-- !ruby/object:Gem::Dependency 
+        - 4
+        version: 0.2.4
+  requirement: *id012
   prerelease: false
+  name: typhoeus
   type: :development
-  requirement: &id014 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -263,12 +247,12 @@ dependencies:
         - 6
         - 3
         version: 1.6.3
-  version_requirements: *id014
-  name: ci_reporter
-- !ruby/object:Gem::Dependency 
+  requirement: *id013
   prerelease: false
+  name: ci_reporter
   type: :development
-  requirement: &id015 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -279,24 +263,26 @@ dependencies:
         - 9
         - 9
         version: 0.9.9
-  version_requirements: *id015
-  name: rcov
-- !ruby/object:Gem::Dependency 
+  requirement: *id014
   prerelease: false
+  name: rcov
   type: :development
-  requirement: &id016 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 17
+        hash: 29
         segments: 
         - 0
         - 2
-        - 3
-        version: 0.2.3
-  version_requirements: *id016
+        - 5
+        version: 0.2.5
+  requirement: *id015
+  prerelease: false
   name: flexmls_gems
+  type: :development
 description: The FlexmlsApi gem handles most of the boilerplate for communicating with the flexmls API rest services, including authentication and request parsing.
 email: api-support@flexmls.com
 executables: 
@@ -327,6 +313,7 @@ files:
 - lib/flexmls_api/version.rb
 - lib/flexmls_api/response.rb
 - lib/flexmls_api/models.rb
+- lib/flexmls_api/connection.rb
 - lib/flexmls_api/multi_client.rb
 - lib/flexmls_api/models/document.rb
 - lib/flexmls_api/models/finders.rb
@@ -335,6 +322,7 @@ files:
 - lib/flexmls_api/models/contact.rb
 - lib/flexmls_api/models/video.rb
 - lib/flexmls_api/models/idx_link.rb
+- lib/flexmls_api/models/message.rb
 - lib/flexmls_api/models/system_info.rb
 - lib/flexmls_api/models/listing.rb
 - lib/flexmls_api/models/constraint.rb
@@ -366,7 +354,9 @@ files:
 - script/console
 - script/example.rb
 - spec/fixtures/oauth2_error.json
+- spec/fixtures/errors/failure_with_constraint.json
 - spec/fixtures/errors/expired.json
+- spec/fixtures/errors/failure_with_msg.json
 - spec/fixtures/errors/failure.json
 - spec/fixtures/count.json
 - spec/fixtures/notes/new.json
@@ -404,6 +394,7 @@ files:
 - spec/fixtures/listing_carts/post.json
 - spec/fixtures/listing_carts/add_listing.json
 - spec/fixtures/authentication_failure.json
+- spec/fixtures/listings/put_expiration_date.json
 - spec/fixtures/listings/no_subresources.json
 - spec/fixtures/listings/saved_search.json
 - spec/fixtures/listings/constraints_with_pagination.json
@@ -432,6 +423,10 @@ files:
 - spec/fixtures/contacts/new_notify.json
 - spec/fixtures/contacts/new.json
 - spec/fixtures/contacts/post.json
+- spec/fixtures/messages/new_with_recipients.json
+- spec/fixtures/messages/new_empty.json
+- spec/fixtures/messages/new.json
+- spec/fixtures/messages/post.json
 - spec/fixtures/logo_fbs.png
 - spec/unit/flexmls_api_spec.rb
 - spec/unit/flexmls_api/authentication/base_auth_spec.rb
@@ -450,6 +445,7 @@ files:
 - spec/unit/flexmls_api/models/video_spec.rb
 - spec/unit/flexmls_api/models/document_spec.rb
 - spec/unit/flexmls_api/models/property_types_spec.rb
+- spec/unit/flexmls_api/models/message_spec.rb
 - spec/unit/flexmls_api/models/listing_spec.rb
 - spec/unit/flexmls_api/models/shared_listing_spec.rb
 - spec/unit/flexmls_api/models/note_spec.rb
@@ -491,22 +487,24 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
+      hash: 55
       segments: 
       - 1
-      - 3
-      - 6
-      version: 1.3.6
+      - 8
+      - 0
+      version: 1.8.0
 requirements: []
 
 rubyforge_project: flexmls_api
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A library for interacting with the flexmls web services.
 test_files: 
 - spec/fixtures/oauth2_error.json
+- spec/fixtures/errors/failure_with_constraint.json
 - spec/fixtures/errors/expired.json
+- spec/fixtures/errors/failure_with_msg.json
 - spec/fixtures/errors/failure.json
 - spec/fixtures/count.json
 - spec/fixtures/notes/new.json
@@ -544,6 +542,7 @@ test_files:
 - spec/fixtures/listing_carts/post.json
 - spec/fixtures/listing_carts/add_listing.json
 - spec/fixtures/authentication_failure.json
+- spec/fixtures/listings/put_expiration_date.json
 - spec/fixtures/listings/no_subresources.json
 - spec/fixtures/listings/saved_search.json
 - spec/fixtures/listings/constraints_with_pagination.json
@@ -572,6 +571,10 @@ test_files:
 - spec/fixtures/contacts/new_notify.json
 - spec/fixtures/contacts/new.json
 - spec/fixtures/contacts/post.json
+- spec/fixtures/messages/new_with_recipients.json
+- spec/fixtures/messages/new_empty.json
+- spec/fixtures/messages/new.json
+- spec/fixtures/messages/post.json
 - spec/fixtures/logo_fbs.png
 - spec/unit/flexmls_api_spec.rb
 - spec/unit/flexmls_api/authentication/base_auth_spec.rb
@@ -590,6 +593,7 @@ test_files:
 - spec/unit/flexmls_api/models/video_spec.rb
 - spec/unit/flexmls_api/models/document_spec.rb
 - spec/unit/flexmls_api/models/property_types_spec.rb
+- spec/unit/flexmls_api/models/message_spec.rb
 - spec/unit/flexmls_api/models/listing_spec.rb
 - spec/unit/flexmls_api/models/shared_listing_spec.rb
 - spec/unit/flexmls_api/models/note_spec.rb