flexmls_api 0.3.3 → 0.3.6

data/Rakefile

@@ -13,7 +13,7 @@ begin
     gemspec.description = "A library for interacting with the flexmls web services."
     gemspec.email = "api-support@flexmls.com"
     gemspec.homepage = "https://github.com/flexmls/flexmls_api"
-    gemspec.authors = ["Brandon Hornseth"]
+    gemspec.authors = ["Brandon Hornseth", "Wade McEwen"]
     gemspec.files =  FileList["[A-Z]*", "{lib,spec}/**/*"]
     gemspec.add_development_dependency "rspec"
     gemspec.add_development_dependency "jeweler"

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.6

data/lib/flexmls_api.rb

@@ -11,6 +11,7 @@ require File.expand_path('../flexmls_api/paginate', __FILE__)
 require File.expand_path('../flexmls_api/request', __FILE__)
 require File.expand_path('../flexmls_api/client', __FILE__)
 require File.expand_path('../flexmls_api/faraday', __FILE__)
+require File.expand_path('../flexmls_api/primary_array', __FILE__)
 require File.expand_path('../flexmls_api/models', __FILE__)
 
 module FlexmlsApi

data/lib/flexmls_api/authentication.rb

@@ -22,7 +22,7 @@ module FlexmlsApi
       request_path = "/#{version}/session?ApiKey=#{api_key}&ApiSig=#{sig}"
       resp = connection(true).post request_path, ""
       request_time = Time.now - start_time
-      FlexmlsApi.logger.info("[#{request_time}s] Api: POST #{request_path}")
+      FlexmlsApi.logger.info("[#{(request_time * 1000).to_i}ms] Api: POST #{request_path}")
       @session = Session.new(resp.body.results[0])
       FlexmlsApi.logger.debug("Authentication: #{@session.inspect}")
       @session

data/lib/flexmls_api/configuration.rb

@@ -1,10 +1,11 @@
 module FlexmlsApi
   module Configuration
     # valid configuration options
-    VALID_OPTION_KEYS = [:api_key, :api_secret, :endpoint, :user_agent, :version, :ssl].freeze
+    VALID_OPTION_KEYS = [:api_key, :api_secret, :api_user, :endpoint, :user_agent, :version, :ssl].freeze
 
     DEFAULT_API_KEY = nil
     DEFAULT_API_SECRET = nil
+    DEFAULT_API_USER = nil
     DEFAULT_ENDPOINT = 'http://api.flexmls.com'
     DEFAULT_VERSION = 'v1'
     DEFAULT_USER_AGENT = "flexmls API Ruby Gem #{VERSION}"
@@ -30,6 +31,7 @@ module FlexmlsApi
     def reset_configuration
       self.api_key     = DEFAULT_API_KEY
       self.api_secret  = DEFAULT_API_SECRET
+      self.api_user    = DEFAULT_API_USER
       self.endpoint    = DEFAULT_ENDPOINT
       self.version     = DEFAULT_VERSION
       self.user_agent  = DEFAULT_USER_AGENT

data/lib/flexmls_api/faraday.rb

@@ -17,7 +17,7 @@ module FlexmlsApi
       # indicate a failure will raise a FlexmlsApi::ClientError exception
       def self.validate_and_build_response(finished_env)
         body = finished_env[:body]
-        FlexmlsApi.logger.debug("Response Body: #{body.inspect}")
+        FlexmlsApi.logger.debug("Response Body: #{body}")
         unless body.is_a?(Hash) && body.key?("D")
           raise InvalidResponse, "The server response could not be understood"
         end
@@ -47,5 +47,6 @@ module FlexmlsApi
       end
       
     end
+
   end
 end

data/lib/flexmls_api/models.rb

@@ -1,4 +1,6 @@
 require File.expand_path('../models/base', __FILE__)
+require File.expand_path('../models/finders', __FILE__)
+require File.expand_path('../models/account', __FILE__)
 require File.expand_path('../models/listing', __FILE__)
 require File.expand_path('../models/subresource', __FILE__)
 require File.expand_path('../models/photo', __FILE__)

data/lib/flexmls_api/models/account.rb

@@ -0,0 +1,55 @@
+module FlexmlsApi
+  module Models
+    class Account < Base
+      self.element_name="accounts"
+      
+      SUBELEMENTS = [:emails, :phones, :websites, :addresses, :images]
+      attr_accessor *SUBELEMENTS
+      
+      def initialize(attributes={})
+        @emails = subresource(Email, "Emails", attributes)
+        @phones = subresource(Phone, "Phones", attributes)
+        @websites = subresource(Website, "Websites", attributes)
+        @addresses = subresource(Address, "Addresses", attributes)
+        @images = subresource(Image, "Images", attributes)
+        super(attributes)
+      end
+
+      def self.my(arguments={})
+        collect(connection.get("/my/account", arguments)).first
+      end
+
+      private
+
+      def subresource(klass, key, attributes)
+        return nil unless attributes.key?(key)
+        array = attributes[key]
+        result = PrimaryArray.new()
+        array.each do |i|
+          result << klass.new(i)
+        end
+        result
+      end
+
+      class Email < Base
+        include Primary
+      end
+
+      class Phone < Base
+        include Primary
+      end
+
+      class Website < Base
+        include Primary
+      end
+
+      class Address < Base
+        include Primary
+      end
+      class Image < Base
+        include Primary
+      end
+    end
+  end
+
+end

data/lib/flexmls_api/models/base.rb

@@ -54,7 +54,7 @@ module FlexmlsApi
       def self.first(options={})
         get(options)[0]
       end
-
+      
       def method_missing(method_symbol, *arguments)
         method_name = method_symbol.to_s
 

data/lib/flexmls_api/models/finders.rb

@@ -0,0 +1,45 @@
+module FlexmlsApi
+  module Models
+    # =Rails-like finders module
+    # Adds the base set of finder class methods to the models that support them (not all of them do) 
+    module Finders
+
+      def find(*arguments)
+        scope = arguments.slice!(0)
+        options = arguments.slice!(0) || {}
+        case scope
+          when :all   then find_every(options)
+          when :first then find_every(options).first
+          when :last  then find_every(options).last
+          when :one   then find_one(options)
+          else             find_single(scope, options)
+        end
+      end
+      
+      def first(*arguments)
+        find(:first, *arguments)
+      end
+      
+      def last(*arguments)
+        find(:last, *arguments)
+      end
+      
+      private
+
+      def find_every(options)
+        collect(connection.get("/#{element_name}", options))
+      end
+
+      def find_one(options)
+        raise NotImplementedError # TODO um... what?
+      end
+
+      def find_single(scope, options)
+        resp = connection.get("/#{element_name}/#{scope}", options)
+        new(resp[0])
+      end
+            
+    end
+  end
+end
+    

data/lib/flexmls_api/models/idx_link.rb

@@ -2,6 +2,8 @@ module FlexmlsApi
   module Models
     class IdxLink < Base
       self.element_name="idxlinks"
+      
+      LINK_TYPES = ["QuickSearch", "SavedSearch", "MyListings", "Roster"]
 
       #TODO Work all below into common base class
       def self.find(*arguments)

data/lib/flexmls_api/models/listing.rb

@@ -1,6 +1,7 @@
 module FlexmlsApi
   module Models
     class Listing < Base 
+      extend Finders
       attr_accessor :photos, :videos, :virtual_tours, :documents
       self.element_name="listings"
 
@@ -39,53 +40,24 @@ module FlexmlsApi
         super(attributes)
       end
 
-
-      def self.find(*arguments)
-        scope = arguments.slice!(0)
-        options = arguments.slice!(0) || {}
-        
-        case scope
-          when :all   then find_every(options)
-          when :first then find_every(options).first
-          when :last  then find_every(options).last
-          when :one   then find_one(options)
-          else             find_single(scope, options)
-        end
-      end
-
       def self.find_by_cart_id(cart_id, owner, options={}) 
         options.merge!({ :ApiUser => owner, :_filter => "ListingCart Eq '#{cart_id}'" })
         find(:all, options) 
       end
       
-      def self.first(*arguments)
-        find(:first, *arguments)
-      end
-
-      def self.last(*arguments)
-        find(:last, *arguments)
-      end
-
       def self.my(arguments={})
         collect(connection.get("/my/listings", arguments))
       end
 
-
-      private
-
-      def self.find_every(options)
-        collect(connection.get('/listings', options))
+      def self.office(arguments={})
+        collect(connection.get("/office/listings", arguments))
       end
 
-      def self.find_one(options)
-        raise NotImplementedError # TODO
-      end
-
-      def self.find_single(scope, options)
-        resp = FlexmlsApi.client.get("/listings/#{scope}", options)
-        new(resp[0])
+      def self.company(arguments={})
+        collect(connection.get("/company/listings", arguments))
       end
 
+      private
 
       # TODO trim this down so we're only overriding the StandardFields access
       def method_missing(method_symbol, *arguments)

data/lib/flexmls_api/primary_array.rb

@@ -0,0 +1,29 @@
+module FlexmlsApi
+  class PrimaryArray < Array
+    
+    def primary
+      find_primary
+    end
+
+    private 
+    
+    # This is a very simplistic but reliable implementation.
+    def find_primary
+      self.each do |arg|
+        if arg.primary?
+          return arg
+        end
+      end
+      nil
+    end
+  end
+  
+  #=== Primary: interface to implement for elements that are added to a "PrimaryArray" collection
+  module Primary
+    # Return true if the element is the primary resource in a collection.
+    # Default implementation looks for a "Primary" attribute
+    def primary?
+      @attributes.key?("Primary") && self.Primary == true
+    end
+  end
+end

data/lib/flexmls_api/request.rb

@@ -1,3 +1,4 @@
+require 'cgi'
 
 module FlexmlsApi
   # HTTP request wrapper.  Performs all the api session mumbo jumbo so that the models don't have to.
@@ -65,6 +66,9 @@ module FlexmlsApi
         request_opts = {
           "AuthToken" => @session.auth_token
         }
+        unless self.api_user.nil?
+          request_opts.merge!(:ApiUser => "#{api_user}")
+        end
         request_opts.merge!(options)
         post_data = body.nil? ? nil : {"D" => body }.to_json
         sig = sign_token(path, request_opts, post_data)
@@ -78,7 +82,7 @@ module FlexmlsApi
           response = connection.send(method, request_path, post_data)
         end
         request_time = Time.now - start_time
-        FlexmlsApi.logger.info("[#{request_time}s] Api: #{method.to_s.upcase} #{request_path}")
+        FlexmlsApi.logger.info("[#{(request_time * 1000).to_i}ms] Api: #{method.to_s.upcase} #{request_path}")
       rescue PermissionDenied => e
         if(ResponseCodes::SESSION_TOKEN_EXPIRED == e.code)
           unless (attempts +=1) > 1
@@ -106,7 +110,8 @@ module FlexmlsApi
     def build_url_parameters(parameters={})
       str = ""
       parameters.map do |key,value|
-        str << "&#{key}=#{value}"
+        escaped_value = CGI.escape("#{value}")
+        str << "&#{key}=#{escaped_value}"
       end
       str
     end    

data/spec/unit/flexmls_api/configuration_spec.rb

@@ -9,11 +9,11 @@ describe FlexmlsApi::Client, "Client config"  do
     it "should return the proper defaults when called with no arguments" do
       FlexmlsApi.api_key.should be_nil
       FlexmlsApi.api_secret.should be_nil
-      FlexmlsApi.version.should match "v1"
-      FlexmlsApi.endpoint.should match "api.flexmls.com"
+      FlexmlsApi.version.should match("v1")
+      FlexmlsApi.endpoint.should match("api.flexmls.com")
 
       FlexmlsApi.api_key = "my_api_key"
-      FlexmlsApi.api_key.should match "my_api_key"
+      FlexmlsApi.api_key.should match("my_api_key")
     end
   end
 
@@ -21,12 +21,14 @@ describe FlexmlsApi::Client, "Client config"  do
     it "should return a properly configured client" do
       client = FlexmlsApi::Client.new(:api_key => "key_of_wade", 
                                       :api_secret => "TopSecret", 
+                                      :api_user => "1234",
                                       :endpoint => "http://api.wade.dev.fbsdata.com")
  
-      client.api_key.should match "key_of_wade"
-      client.api_secret.should match "TopSecret"
-      client.endpoint.should match "http://api.wade.dev.fbsdata.com"
-      client.version.should match "v1"
+      client.api_key.should match("key_of_wade")
+      client.api_secret.should match("TopSecret")
+      client.api_user.should match("1234")
+      client.endpoint.should match("http://api.wade.dev.fbsdata.com")
+      client.version.should match("v1")
     end
   end
 
@@ -35,16 +37,18 @@ describe FlexmlsApi::Client, "Client config"  do
       FlexmlsApi.configure do |config|
         config.api_key = "my_key"
         config.api_secret = "my_secret"
+        config.api_user = "1234"
         config.version = "veleventy"
         config.endpoint = "test.api.flexmls.com"
         config.user_agent = "my useragent"
       end
 
-      FlexmlsApi.api_key.should match "my_key"
-      FlexmlsApi.api_secret.should match "my_secret"
-      FlexmlsApi.version.should match "veleventy"
-      FlexmlsApi.endpoint.should match "test.api.flexmls.com"
-      FlexmlsApi.user_agent.should match "my useragent"
+      FlexmlsApi.api_key.should match("my_key")
+      FlexmlsApi.api_secret.should match("my_secret")
+      FlexmlsApi.api_user.should match("1234")
+      FlexmlsApi.version.should match("veleventy")
+      FlexmlsApi.endpoint.should match("test.api.flexmls.com")
+      FlexmlsApi.user_agent.should match("my useragent")
 
     end
     
@@ -57,7 +61,7 @@ describe FlexmlsApi::Client, "Client config"  do
         config.user_agent = "my useragent"
       end
       
-      FlexmlsApi.api_key.should match "my_key"
+      FlexmlsApi.api_key.should match("my_key")
       FlexmlsApi.reset
       FlexmlsApi.api_key.should == FlexmlsApi::Configuration::DEFAULT_API_KEY
     
@@ -74,7 +78,7 @@ describe FlexmlsApi::Client, "Client config"  do
           }).
           to_return(:body => '{"D":{"Success": true,"Results": [{"SSL":false}]}}')
           
-      FlexmlsApi.client.get('/connections')[0]["SSL"].should eq false
+      FlexmlsApi.client.get('/connections')[0]["SSL"].should eq(false)
 
     end
 
@@ -88,7 +92,7 @@ describe FlexmlsApi::Client, "Client config"  do
           to_return(:body => '{"D":{"Success": true,"Results": [{"SSL":true}]}}')
       c = FlexmlsApi::Client.new(:endpoint => "https://api.flexmls.com",
                                 :ssl => true)
-      c.get('/connections')[0]["SSL"].should eq true
+      c.get('/connections')[0]["SSL"].should eq(true)
     end
     
   end

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

@@ -0,0 +1,96 @@
+require './spec/spec_helper'
+
+describe Account do
+  before(:each) do
+    @account = Account.new({
+      "Name"=>"Sample User",
+      "Id"=>"20000426173054342350000000",
+      "Office"=>"Sample Office",
+      "Mls"=>"Sample MLS",
+      "MlsId"=>"20000426143505724628000000",
+      "Emails"=>[
+        {
+          "Type"=>"Work",
+          "Name"=>"My Work E-mail",
+          "Address"=>"work@test.com",
+          "Primary"=>true
+        },
+        {
+          "Type"=>"Home",
+          "Name"=>"My Home E-mail",
+          "Address"=>"home@test.com"
+        }
+      ],
+      "Phones"=>[
+        {
+          "Type"=>"Work",
+          "Name"=>"My Work Phone",
+          "Number"=>"701-555-1212",
+          "Primary"=>true
+        },
+        {
+          "Type"=>"Home",
+          "Name"=>"My Home Phone",
+          "Number"=>"702-555-1313"
+        }
+      ],
+      "Websites"=>[
+        {
+          "Type"=>"Work",
+          "Name"=>"My Work Website",
+          "Uri"=>"http://iamthebestagent.com",
+          "Primary"=>true
+        },
+        {
+          "Type"=>"Home",
+          "Name"=>"My Home Website",
+          "Uri"=>"http://myspace.com/lolcats"
+        }
+      ],
+      "Addresses"=>[
+        {
+          "Type"=>"Work",
+          "Name"=>"My Work Address",
+          "Address"=>"101 Main Ave, Phoenix, AZ 12345",
+          "Primary"=>true
+        },
+        {
+          "Type"=>"Home",
+          "Name"=>"My Home Address",
+          "Address"=>"102 Main Ave, Gilbert, AZ 54321"
+        }
+      ],
+      "Images"=>[
+        {
+          "Type"=>"Photo",
+          "Name"=>"My Photo",
+          "Uri"=>"http://photos.flexmls.com/az/...."
+        },
+        {
+          "Type"=>"Logo",
+          "Name"=>"My Logo",
+          "Uri"=>"http://photos.flexmls.com/az/...."
+        }
+      ]
+    })
+  end
+
+  it "should respond to attributes" do
+    ['Name','Id','Mls','MlsId','Office'].each do |k|
+      (@account.send k.to_sym).should be_a(String)
+    end
+  end
+
+  it "should have primary subresources" do
+    @account.emails.primary.Address.should eq("work@test.com")
+    @account.phones.primary.Number.should eq("701-555-1212")
+    @account.addresses.primary.Address.should eq("101 Main Ave, Phoenix, AZ 12345")
+    @account.websites.primary.Uri.should eq("http://iamthebestagent.com")
+    @account.images.primary.should be(nil)
+  end
+
+  after(:each) do
+    @acount = nil
+  end
+
+end

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

@@ -31,22 +31,22 @@ describe Contact do
   
   it "should get all my contacts" do
     contacts = Contact.get
-    contacts.should be_an Array
-    contacts.length.should eq 3
-    contacts.first.Id.should eq "20101230223226074201000000"
+    contacts.should be_an(Array)
+    contacts.length.should eq(3)
+    contacts.first.Id.should eq("20101230223226074201000000")
   end
 
   it "should save a new contact" do
     c=Contact.new
     c.attributes["DisplayName"] = "Contact Four"
     c.attributes["PrimaryEmail"] = "contact4@fbsdata.com"
-    c.save.should be true
-    c.Id.should eq '20101230223226074204000000'
+    c.save.should be(true)
+    c.Id.should eq('20101230223226074204000000')
   end
 
   it "should fail saving" do
     c=Contact.new
-    c.save.should be false
+    c.save.should be(false)
     expect{ c.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 400 }
   end
   

data/spec/unit/flexmls_api/paginate_spec.rb

@@ -38,54 +38,54 @@ describe FlexmlsApi::PaginateResponse do
       json = "{#{paginate_json}}"
       hash = JSON.parse(json)
       results = subject.paginate_response([1,2,3,4,5,6,7,8,9,10], hash["Pagination"])
-      results.offset.should eq 0
-      results.next_page.should eq 2
-      results.previous_page.should eq nil
-      results.current_page.should eq 1
-      results.per_page.should eq 10
-      results.total_pages.should eq 4
-      results.total_entries.should eq 38
-      results[0].should eq 1
+      results.offset.should eq(0)
+      results.next_page.should eq(2)
+      results.previous_page.should eq(nil)
+      results.current_page.should eq(1)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(1)
     end
     it "should give me the second page" do
       json = "{#{paginate_json(2)}}"
       hash = JSON.parse(json)
       results = subject.paginate_response([11,12,13,14,15,16,17,18,19,20], hash["Pagination"])
-      results.offset.should eq 10
-      results.next_page.should eq 3
-      results.previous_page.should eq 1
-      results.current_page.should eq 2
-      results.per_page.should eq 10
-      results.total_pages.should eq 4
-      results.total_entries.should eq 38
-      results[0].should eq 11
+      results.offset.should eq(10)
+      results.next_page.should eq(3)
+      results.previous_page.should eq(1)
+      results.current_page.should eq(2)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(11)
     end
     it "should give me the third page" do
       json = "{#{paginate_json(3)}}"
       hash = JSON.parse(json)
       results = subject.paginate_response([21,22,23,24,25,26,27,28,29,30], hash["Pagination"])
-      results.offset.should eq 20
-      results.next_page.should eq 4
-      results.previous_page.should eq 2
-      results.current_page.should eq 3
-      results.per_page.should eq 10
-      results.total_pages.should eq 4
-      results.total_entries.should eq 38
-      results[0].should eq 21
+      results.offset.should eq(20)
+      results.next_page.should eq(4)
+      results.previous_page.should eq(2)
+      results.current_page.should eq(3)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(21)
     end
     it "should give me the last page" do
       json = "{#{paginate_json(4)}}"
       hash = JSON.parse(json)
       results = subject.paginate_response([31,32,33,34,35,36,37,38], hash["Pagination"])
-      results.offset.should eq 30
-      results.next_page.should eq nil
-      results.previous_page.should eq 3
-      results.current_page.should eq 4
-      results.per_page.should eq 10
-      results.total_pages.should eq 4
-      results.total_entries.should eq 38
-      results[0].should eq 31
-      results[-1].should eq 38
+      results.offset.should eq(30)
+      results.next_page.should eq(nil)
+      results.previous_page.should eq(3)
+      results.current_page.should eq(4)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results[0].should eq(31)
+      results[-1].should eq(38)
     end
   end
 end
@@ -94,27 +94,27 @@ describe FlexmlsApi::Paginate do
   describe "paginate" do
     it "should give me a will paginate collection" do
       results = PaginateModelTester.paginate(:page => 1)
-      results.class.should eq WillPaginate::Collection
-      results.offset.should eq 0
-      results.next_page.should eq 2
-      results.previous_page.should eq nil
-      results.current_page.should eq 1
-      results.per_page.should eq 10
-      results.total_pages.should eq 4
-      results.total_entries.should eq 38
+      results.class.should eq(WillPaginate::Collection)
+      results.offset.should eq(0)
+      results.next_page.should eq(2)
+      results.previous_page.should eq(nil)
+      results.current_page.should eq(1)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
       
-      results[0].class.should eq PaginateModelTester
-      results[0].val.should eq 1
+      results[0].class.should eq(PaginateModelTester)
+      results[0].val.should eq(1)
       
     end
       
     it "should give me pagination options" do
       PaginateModelTester.paginate(:page => 1)
       opts = PaginateModelTester.options
-      opts["_pagination"].should eq 1
-      opts["_limit"].should eq 25
-      opts["_page"].should eq 1
-      opts.has_key?(:page).should eq false
+      opts["_pagination"].should eq(1)
+      opts["_limit"].should eq(25)
+      opts["_page"].should eq(1)
+      opts.has_key?(:page).should eq(false)
     end
   end
 
@@ -122,7 +122,7 @@ describe FlexmlsApi::Paginate do
     it "should set the default model max results per page" do
       results = PaginateModelTester50.paginate(:page => 1)
       opts = PaginateModelTester50.options
-      opts["_limit"].should eq 50
+      opts["_limit"].should eq(50)
     end
   end
   
@@ -151,18 +151,18 @@ describe FlexmlsApi::Paginate do
         }).
         to_return(:body => json)
       results = subject.paginate(:page=>1, :per_page=>10)
-      results.class.should eq WillPaginate::Collection
-      results.offset.should eq 0
-      results.next_page.should eq 2
-      results.previous_page.should eq nil
-      results.current_page.should eq 1
-      results.per_page.should eq 10
-      results.total_pages.should eq 4
-      results.total_entries.should eq 38
-      results.length.should eq 10
+      results.class.should eq(WillPaginate::Collection)
+      results.offset.should eq(0)
+      results.next_page.should eq(2)
+      results.previous_page.should eq(nil)
+      results.current_page.should eq(1)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
+      results.length.should eq(10)
       
-      results[0].class.should eq subject
-      results[0].ListPrice.should eq 50000.0
+      results[0].class.should eq(subject)
+      results[0].ListPrice.should eq(50000.0)
       
     end
     it "gives me page two of listings" do
@@ -183,9 +183,9 @@ describe FlexmlsApi::Paginate do
         }).
         to_return(:body => json)
       results = subject.paginate(:page=>2, :per_page=>10)
-      results.next_page.should eq 3
-      results.previous_page.should eq 1
-      results.current_page.should eq 2
+      results.next_page.should eq(3)
+      results.previous_page.should eq(1)
+      results.current_page.should eq(2)
     end
     it "gives me page four of listings" do
       json = <<-JSON 
@@ -205,16 +205,16 @@ describe FlexmlsApi::Paginate do
         }).
         to_return(:body => json)
       results = subject.paginate(:page=>4, :per_page=>10)
-      results.next_page.should eq nil
-      results.previous_page.should eq 3
-      results.current_page.should eq 4
-      results.per_page.should eq 10
-      results.total_pages.should eq 4
-      results.total_entries.should eq 38
+      results.next_page.should eq(nil)
+      results.previous_page.should eq(3)
+      results.current_page.should eq(4)
+      results.per_page.should eq(10)
+      results.total_pages.should eq(4)
+      results.total_entries.should eq(38)
       
-      results.length.should eq 8
-      results[0].class.should eq subject
-      results[0].ListPrice.should eq 50000.0
+      results.length.should eq(8)
+      results[0].class.should eq(subject)
+      results[0].ListPrice.should eq(50000.0)
     end
     
   end

data/spec/unit/flexmls_api/primary_array_spec.rb

@@ -0,0 +1,41 @@
+require './spec/spec_helper'
+
+class PrimaryModel
+  include FlexmlsApi::Primary
+  attr_accessor :Primary, :id, :attributes
+  def initialize(id, prime = false)
+    @id = id
+    @Primary = prime
+    @attributes = {"Primary" => prime }
+  end
+end
+
+describe FlexmlsApi::PrimaryArray do
+  it "should give me the primary element" do
+    a = PrimaryModel.new(1)
+    b = PrimaryModel.new(2)
+    c = PrimaryModel.new(3)
+    d = PrimaryModel.new(4, true)
+    e = PrimaryModel.new(5)
+    tester = subject.class.new([d,e])
+    tester.primary.should eq(d)
+    tester = subject.class.new([a,b,c,d,e])
+    tester.primary.should eq(d)
+    # Note, it doesn't care if there is more than one primary, just returns first in the list.
+    b.Primary = true
+    tester.primary.should eq(b)
+  end
+  it "should return nil when there is no primary element" do
+    a = PrimaryModel.new(1)
+    b = PrimaryModel.new(2)
+    c = PrimaryModel.new(3)
+    d = PrimaryModel.new(4)
+    e = PrimaryModel.new(5)
+    tester = subject.class.new([])
+    tester.primary.should be(nil)
+    tester = subject.class.new([a,b,c,d,e])
+    tester.primary.should be(nil)
+  end
+end
+
+

data/spec/unit/flexmls_api/request_spec.rb

@@ -21,12 +21,12 @@ describe FlexmlsApi do
     end
     it "should have results when successful" do
       r = FlexmlsApi::ApiResponse.new({"D"=>{"Success" => true, "Results" => []}})
-      r.success?.should be true
-      r.results.empty?.should be true
+      r.success?.should be(true)
+      r.results.empty?.should be(true)
     end
     it "should have a message on error" do
       r = FlexmlsApi::ApiResponse.new({"D"=>{"Success" => false, "Message" => "I am a failure."}})
-      r.success?.should be false
+      r.success?.should be(false)
       r.message.should be == "I am a failure."
     end
   end
@@ -100,6 +100,7 @@ describe FlexmlsApi do
       subject do 
         class RequestTest
           include FlexmlsApi::Request
+          attr_accessor *FlexmlsApi::Configuration::VALID_OPTION_KEYS
           def initialize(session)
             @session = session
           end
@@ -138,25 +139,25 @@ describe FlexmlsApi do
       it "should put to a service" do
         # This is a hypothetical unsupported service action at this time
         data = {"Contacts" => [{"DisplayName"=>"WLMCEWENS Contact","PrimaryEmail"=>"wlmcewen789@fbsdata.com"}]}
-        subject.put('/contacts/1000', data).should be nil
+        subject.put('/contacts/1000', data).should be(nil)
         # No validation here, if no error is raised, everything is hunky dory
       end
       it "should delete from a service" do
         # This is a hypothetical unsupported service action at this time
-        subject.delete('/contacts/1000').should be nil
+        subject.delete('/contacts/1000').should be(nil)
         # No validation here, if no error is raised, everything is hunky dory
       end
 
       it "should give me BigDecimal results for large floating point numbers" do
-        MultiJson.default_engine.should eq :yajl
+        MultiJson.default_engine.should eq(:yajl)
         result = subject.get('/listings/1000')[0]
-        result["StandardFields"]["BuildingAreaTotal"].class.should eq Float
+        result["StandardFields"]["BuildingAreaTotal"].class.should eq(Float)
         pending("our JSON parser does not support large decimal types.  Anyone feel like writing some c code?") do
-          result["StandardFields"]["BuildingAreaTotal"].class.should eq BigDecimal
+          result["StandardFields"]["BuildingAreaTotal"].class.should eq(BigDecimal)
           number = BigDecimal.new(result["StandardFields"]["BuildingAreaTotal"].to_s)
-          number.to_s.should eq BigDecimal.new("0.000000000000000000000000001").to_s
+          number.to_s.should eq(BigDecimal.new("0.000000000000000000000000001").to_s)
           number = BigDecimal.new(result["StandardFields"]["ListPrice"].to_s)
-          number.to_s.should eq BigDecimal.new("9999999999999999999999999.99").to_s
+          number.to_s.should eq(BigDecimal.new("9999999999999999999999999.99").to_s)
         end
       end
       
@@ -166,6 +167,7 @@ describe FlexmlsApi do
       subject do 
         class RequestAuthTest
           include FlexmlsApi::Request
+          attr_accessor *FlexmlsApi::Configuration::VALID_OPTION_KEYS
           def authenticate()
             @session ||= mock_session()
           end
@@ -194,6 +196,7 @@ describe FlexmlsApi do
       subject do 
         class RequestExpiredTest
           include FlexmlsApi::Request
+          attr_accessor *FlexmlsApi::Configuration::VALID_OPTION_KEYS
           def initialize(session)
             @session = session
             @reauthenticated = false
@@ -250,6 +253,7 @@ describe FlexmlsApi do
       subject do 
         class RequestAlwaysExpiredJerkTest
           include FlexmlsApi::Request
+          attr_accessor *FlexmlsApi::Configuration::VALID_OPTION_KEYS
           def initialize()
             @reauthenticated = 0
           end

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: flexmls_api
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 3
-  - 3
-  version: 0.3.3
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Brandon Hornseth
+- Wade McEwen
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 -06:00
+date: 2011-03-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -212,11 +213,13 @@ files:
 - lib/flexmls_api/configuration.rb
 - lib/flexmls_api/faraday.rb
 - lib/flexmls_api/models.rb
+- lib/flexmls_api/models/account.rb
 - lib/flexmls_api/models/base.rb
 - lib/flexmls_api/models/connect_prefs.rb
 - lib/flexmls_api/models/contact.rb
 - lib/flexmls_api/models/custom_fields.rb
 - lib/flexmls_api/models/document.rb
+- lib/flexmls_api/models/finders.rb
 - lib/flexmls_api/models/idx_link.rb
 - lib/flexmls_api/models/listing.rb
 - lib/flexmls_api/models/market_statistics.rb
@@ -228,6 +231,7 @@ files:
 - lib/flexmls_api/models/video.rb
 - lib/flexmls_api/models/virtual_tour.rb
 - lib/flexmls_api/paginate.rb
+- lib/flexmls_api/primary_array.rb
 - lib/flexmls_api/request.rb
 - lib/flexmls_api/version.rb
 - spec/fixtures/contacts.json
@@ -248,6 +252,7 @@ files:
 - spec/unit/flexmls_api/authentication_spec.rb
 - spec/unit/flexmls_api/configuration_spec.rb
 - spec/unit/flexmls_api/faraday_spec.rb
+- spec/unit/flexmls_api/models/account_spec.rb
 - spec/unit/flexmls_api/models/base_spec.rb
 - spec/unit/flexmls_api/models/connect_prefs_spec.rb
 - spec/unit/flexmls_api/models/contact_spec.rb
@@ -260,6 +265,7 @@ files:
 - spec/unit/flexmls_api/models/video_spec.rb
 - spec/unit/flexmls_api/models/virtual_tour_spec.rb
 - spec/unit/flexmls_api/paginate_spec.rb
+- spec/unit/flexmls_api/primary_array_spec.rb
 - spec/unit/flexmls_api/request_spec.rb
 - spec/unit/flexmls_api_spec.rb
 has_rdoc: true
@@ -302,6 +308,7 @@ test_files:
 - spec/unit/flexmls_api/authentication_spec.rb
 - spec/unit/flexmls_api/configuration_spec.rb
 - spec/unit/flexmls_api/faraday_spec.rb
+- spec/unit/flexmls_api/models/account_spec.rb
 - spec/unit/flexmls_api/models/base_spec.rb
 - spec/unit/flexmls_api/models/connect_prefs_spec.rb
 - spec/unit/flexmls_api/models/contact_spec.rb
@@ -314,5 +321,6 @@ test_files:
 - spec/unit/flexmls_api/models/video_spec.rb
 - spec/unit/flexmls_api/models/virtual_tour_spec.rb
 - spec/unit/flexmls_api/paginate_spec.rb
+- spec/unit/flexmls_api/primary_array_spec.rb
 - spec/unit/flexmls_api/request_spec.rb
 - spec/unit/flexmls_api_spec.rb