flexmls_api 0.4.5 → 0.6.4

data/lib/flexmls_api/models/shared_listing.rb

@@ -0,0 +1,35 @@
+module FlexmlsApi
+  module Models
+    class SharedListing < Base 
+      extend Finders
+      self.element_name="sharedlistings"
+      
+      def ListingIds=(listing_ids)
+        attributes["ListingIds"] = Array(listing_ids)
+      end
+      def ViewId=(id)
+        attributes["ViewId"] = id
+      end
+      def ReportId=(id)
+        attributes["ReportId"] = id
+      end
+      
+      def save(arguments={})
+        begin
+          return save!(arguments)
+        rescue BadResourceRequest => e
+        rescue NotFound => e
+          # log and leave
+          FlexmlsApi.logger.error("Failed to save SharedListing #{self}: #{e.message}")
+        end
+        false
+      end
+      def save!(arguments={})
+        results = connection.post self.class.path, attributes, arguments
+        result = results.first
+        attributes['ResourceUri'] = result['ResourceUri']
+        true
+      end
+    end
+  end
+end

data/lib/flexmls_api/multi_client.rb

@@ -0,0 +1,37 @@
+module FlexmlsApi
+  #===Active support for multiple clients
+  module MultiClient
+    
+    # Activate a specific instance of the client (with appropriate config settings).  Each client 
+    # is lazily instanciated by calling the matching FlexmlsApi.symbol_name method on the 
+    # FlexmlsApi module.  It's the developers responsibility to extend the module and provide this
+    # method.
+    # Parameters
+    #  @sym - the unique symbol identifier for a client configuration.
+    #  &block - a block of code to run with the specified client enabled, after which the original
+    #    client setting will be reenabled
+    def activate(sym)
+      if block_given?
+        original_client = Thread.current[:flexmls_api_client]
+        activate_client(sym)
+        begin
+          yield
+        ensure
+          Thread.current[:flexmls_api_client] = original_client
+        end
+      else
+        activate_client(sym)
+      end
+    end
+    
+    private 
+    
+    # set the active client for the symbol
+    def activate_client(sym)
+      active_client = Thread.current[sym] || FlexmlsApi.send(sym)
+      Thread.current[:flexmls_api_client] = active_client unless active_client.nil?
+    rescue NoMethodError => e
+      raise ArgumentError, "The symbol #{sym} is missing a corresponding FlexmlsApi.#{sym} method.", e.backtrace
+    end
+  end
+end

data/lib/flexmls_api/paginate.rb

@@ -40,6 +40,11 @@ module FlexmlsApi
     # :returns:
     #   An array of class instances for the Class of the calling finder
     def collect(result_array)
+      
+      # when conducting a count (pagination=count), the result_array is not an array
+      # in those cases, simply return the Fixnum
+      return result_array unless result_array.kind_of? Array
+      
       collection = result_array.collect { |item| new(item)}
       result_array.replace(collection)
       result_array

data/lib/flexmls_api/request.rb

@@ -125,10 +125,14 @@ module FlexmlsApi
   class InvalidResponse < StandardError; end
   class ClientError < StandardError
     attr_reader :code, :status
-    def initialize (code, status)
-      @code = code
-      @status = status
+    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]
+      super(opts[:message])
     end
+    
   end
   class NotFound < ClientError; end
   class PermissionDenied < ClientError; end

data/script/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# File: script/console
+
+require File.dirname(__FILE__) + '/../lib/flexmls_api/cli'
+ENV["FLEXMLS_API_CONSOLE"] = "true"
+FlexmlsApi::CLI::ConsoleCLI.execute(STDOUT, ARGV)

data/script/example.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require "rubygems"
+
+Bundler.require(:default, "development") if defined?(Bundler)
+
+path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+require path + '/flexmls_api'
+
+FlexmlsApi.logger.info("Hello!")
+
+FlexmlsApi.configure do |config|
+  config.api_key = "agent_key"
+  config.api_secret = "agent_secret"
+  config.version = "v1"
+  config.endpoint = "https://api.flexmls.com"
+end
+
+client = FlexmlsApi.client
+
+list = client.get '/contacts'
+puts "client: #{list.inspect}"
+list = FlexmlsApi::Models::Contact.get
+puts "model: #{list.inspect}"
+
+
+

data/spec/fixtures/accounts/all.json

@@ -0,0 +1,160 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [
+            {
+                "Name" : "Sample User",
+                "Id" : "20000426173054342350000000",
+                "Office" : "Sample Office Inc",
+                "OfficeId" : "20030426173014239760000000",
+                "Mls" : "Your Local MLS",
+                "MlsId": "20000426143505724628000000",
+                "Emails": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work E-mail",
+                        "Address": "work@test.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile E-mail",
+                        "Address": "mobile@test.com"
+                    }
+                ],
+                "Phones": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Phone",
+                        "Number": "701-555-1212",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Phone",
+                        "Number": "702-555-1313"
+                    }
+                ],
+                "Websites": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Website",
+                        "Uri": "http://iamthebestagent.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Website",
+                        "Uri": "http://m.iamthebestagent.com"
+                    }
+                ],
+                "Addresses": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Address",
+                        "Address": "101 Main Ave, Phoenix, AZ 12345",
+                        "Primary": true
+                    }
+                ],
+                "Images": [
+                    {
+                        "Type": "Photo",
+                        "Name": "My Photo",
+                        "Uri": "http://photos.flexmls.com/az/...."
+                    },
+                    {
+                        "Type": "Logo",
+                        "Name": "My Logo",
+                        "Uri": "http://photos.flexmls.com/az/...."
+                    }
+                ]
+            },
+            {
+                "Name" : "Other User",
+                "Id" : "20000426173054382350000000",
+                "Office" : "Sample Office Inc",
+                "OfficeId" : "20030426173014239760000000",
+                "Mls" : "Your Local MLS",
+                "MlsId": "20000426143505724628000000",
+                "Emails": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work E-mail",
+                        "Address": "otherwork@test.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile E-mail",
+                        "Address": "othermobile@test.com"
+                    }
+                ],
+                "Phones": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Phone",
+                        "Number": "701-555-1414",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Phone",
+                        "Number": "702-555-1515"
+                    }
+                ],
+                "Websites": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Website",
+                        "Uri": "http://iamtheotheragent.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Website",
+                        "Uri": "http://m.iamtheotheragent.com"
+                    }
+                ],
+                "Addresses": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Address",
+                        "Address": "101 Main Ave, Phoenix, AZ 12345",
+                        "Primary": true
+                    }
+                ],
+                "Images": [
+                    {
+                        "Type": "Photo",
+                        "Name": "My Photo",
+                        "Uri": "http://photos.flexmls.com/az/1234.jpg"
+                    },
+                    {
+                        "Type": "Logo",
+                        "Name": "My Logo",
+                        "Uri": "http://photos.flexmls.com/az/logo.jpg"
+                    }
+                ]
+            },
+            {
+                "Name" : "Empty User",
+                "Id" : "20110126173054382350000000",
+                "Office" : "New Office Inc",
+                "OfficeId" : "20110426173014239760000000",
+                "Mls" : "New MLS",
+                "MlsId": "20110426143505724628000000",
+                "Emails": [
+                ],
+                "Phones": [
+                ],
+                "Websites": [
+                ],
+                "Addresses": [
+                ],
+                "Images": [
+                ]
+            }
+            
+        ]
+    }
+}

data/spec/fixtures/accounts/my.json

@@ -0,0 +1,74 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [
+            {
+                "Name" : "Sample User",
+                "Id" : "20000426173054342350000000",
+                "Office" : "Sample Office Inc",
+                "OfficeId" : "20030426173014239760000000",
+                "Mls" : "Your Local MLS",
+                "MlsId": "20000426143505724628000000",
+                "Emails": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work E-mail",
+                        "Address": "work@test.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile E-mail",
+                        "Address": "mobile@test.com"
+                    }
+                ],
+                "Phones": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Phone",
+                        "Number": "701-555-1212",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Phone",
+                        "Number": "702-555-1313"
+                    }
+                ],
+                "Websites": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Website",
+                        "Uri": "http://iamthebestagent.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Website",
+                        "Uri": "http://m.iamthebestagent.com"
+                    }
+                ],
+                "Addresses": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Address",
+                        "Address": "101 Main Ave, Phoenix, AZ 12345",
+                        "Primary": true
+                    }
+                ],
+                "Images": [
+                    {
+                        "Type": "Photo",
+                        "Name": "My Photo",
+                        "Uri": "http://photos.flexmls.com/az/...."
+                    },
+                    {
+                        "Type": "Logo",
+                        "Name": "My Logo",
+                        "Uri": "http://photos.flexmls.com/az/...."
+                    }
+                ]
+            }
+        ]
+    }
+}

data/spec/fixtures/accounts/my_portal.json

@@ -0,0 +1,20 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [
+            {
+                "Name" : "Portal User",
+                "Id" : "20110426173054342350000000",
+                "Emails": [
+                ],
+                "Phones": [
+                ],
+                "Websites": [
+                ],
+                "Addresses": [
+                ],
+		        "GetEmailUpdates": false
+            }
+        ]
+    }
+}

data/spec/fixtures/accounts/my_put.json

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

data/spec/fixtures/accounts/my_save.json

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

data/spec/fixtures/accounts/office.json

@@ -0,0 +1,142 @@
+{
+    "D": {
+        "Success": true,
+        "Results": [
+            {
+                "Name" : "Sample User",
+                "Id" : "20000426173054342350000000",
+                "Office" : "Sample Office Inc",
+                "OfficeId" : "20030426173014239760000000",
+                "Mls" : "Your Local MLS",
+                "MlsId": "20000426143505724628000000",
+                "Emails": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work E-mail",
+                        "Address": "work@test.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile E-mail",
+                        "Address": "mobile@test.com"
+                    }
+                ],
+                "Phones": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Phone",
+                        "Number": "701-555-1212",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Phone",
+                        "Number": "702-555-1313"
+                    }
+                ],
+                "Websites": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Website",
+                        "Uri": "http://iamthebestagent.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Website",
+                        "Uri": "http://m.iamthebestagent.com"
+                    }
+                ],
+                "Addresses": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Address",
+                        "Address": "101 Main Ave, Phoenix, AZ 12345",
+                        "Primary": true
+                    }
+                ],
+                "Images": [
+                    {
+                        "Type": "Photo",
+                        "Name": "My Photo",
+                        "Uri": "http://photos.flexmls.com/az/...."
+                    },
+                    {
+                        "Type": "Logo",
+                        "Name": "My Logo",
+                        "Uri": "http://photos.flexmls.com/az/...."
+                    }
+                ]
+            },
+            {
+                "Name" : "Other User",
+                "Id" : "20000426173054382350000000",
+                "Office" : "Sample Office Inc",
+                "OfficeId" : "20030426173014239760000000",
+                "Mls" : "Your Local MLS",
+                "MlsId": "20000426143505724628000000",
+                "Emails": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work E-mail",
+                        "Address": "otherwork@test.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile E-mail",
+                        "Address": "othermobile@test.com"
+                    }
+                ],
+                "Phones": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Phone",
+                        "Number": "701-555-1414",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Phone",
+                        "Number": "702-555-1515"
+                    }
+                ],
+                "Websites": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Website",
+                        "Uri": "http://iamtheotheragent.com",
+                        "Primary": true
+                    },
+                    {
+                        "Type": "Mobile",
+                        "Name": "My Mobile Website",
+                        "Uri": "http://m.iamtheotheragent.com"
+                    }
+                ],
+                "Addresses": [
+                    {
+                        "Type": "Work",
+                        "Name": "My Work Address",
+                        "Address": "101 Main Ave, Phoenix, AZ 12345",
+                        "Primary": true
+                    }
+                ],
+                "Images": [
+                    {
+                        "Type": "Photo",
+                        "Name": "My Photo",
+                        "Uri": "http://photos.flexmls.com/az/1234.jpg"
+                    },
+                    {
+                        "Type": "Logo",
+                        "Name": "My Logo",
+                        "Uri": "http://photos.flexmls.com/az/logo.jpg"
+                    }
+                ]
+            }
+            
+        ]
+    }
+}