spark_api 1.0.0

data/lib/spark_api/response.rb

@@ -0,0 +1,70 @@
+module SparkApi
+  # API Response interface
+  module Response
+    ATTRIBUTES = [:code, :message, :results, :success, :pagination, :details]
+    attr_accessor *ATTRIBUTES
+    def success?
+      @success
+    end
+  end
+  
+  # All known response codes listed in the API
+  module ResponseCodes
+    NOT_FOUND = 404
+    METHOD_NOT_ALLOWED = 405
+    INVALID_KEY = 1000
+    DISABLED_KEY = 1010
+    API_USER_REQUIRED = 1015
+    SESSION_TOKEN_EXPIRED = 1020
+    SSL_REQUIRED = 1030
+    INVALID_JSON = 1035
+    INVALID_FIELD = 1040
+    MISSING_PARAMETER = 1050
+    INVALID_PARAMETER = 1053
+    CONFLICTING_DATA = 1055
+    NOT_AVAILABLE= 1500
+    RATE_LIMIT_EXCEEDED = 1550
+  end
+  
+  # Errors built from API responses
+  class InvalidResponse < StandardError; end
+  class ClientError < StandardError
+    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
+    
+  end
+  class NotFound < ClientError; end
+  class PermissionDenied < ClientError; end
+  class NotAllowed < ClientError; end
+  class BadResourceRequest < ClientError; end
+  
+  # Nice and handy class wrapper for the api response hash
+  class ApiResponse < ::Array
+    include SparkApi::Response
+    def initialize(d)
+      begin
+        hash = d["D"]
+        if hash.nil? || hash.empty?
+          raise InvalidResponse, "The server response could not be understood"
+        end
+        self.message    = hash["Message"]
+        self.code       = hash["Code"]
+        self.results    = Array(hash["Results"])
+        self.success    = hash["Success"]
+        self.pagination = hash["Pagination"]
+        self.details    = hash["Details"] || []
+        super(results)
+      rescue Exception => e
+        SparkApi.logger.error "Unable to understand the response! #{d}"
+        raise
+      end
+    end
+  end
+end

data/lib/spark_api/response.rb~

@@ -0,0 +1,70 @@
+module FlexmlsApi
+  # API Response interface
+  module Response
+    ATTRIBUTES = [:code, :message, :results, :success, :pagination, :details]
+    attr_accessor *ATTRIBUTES
+    def success?
+      @success
+    end
+  end
+  
+  # All known response codes listed in the API
+  module ResponseCodes
+    NOT_FOUND = 404
+    METHOD_NOT_ALLOWED = 405
+    INVALID_KEY = 1000
+    DISABLED_KEY = 1010
+    API_USER_REQUIRED = 1015
+    SESSION_TOKEN_EXPIRED = 1020
+    SSL_REQUIRED = 1030
+    INVALID_JSON = 1035
+    INVALID_FIELD = 1040
+    MISSING_PARAMETER = 1050
+    INVALID_PARAMETER = 1053
+    CONFLICTING_DATA = 1055
+    NOT_AVAILABLE= 1500
+    RATE_LIMIT_EXCEEDED = 1550
+  end
+  
+  # Errors built from API responses
+  class InvalidResponse < StandardError; end
+  class ClientError < StandardError
+    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
+    
+  end
+  class NotFound < ClientError; end
+  class PermissionDenied < ClientError; end
+  class NotAllowed < ClientError; end
+  class BadResourceRequest < ClientError; end
+  
+  # Nice and handy class wrapper for the api response hash
+  class ApiResponse < ::Array
+    include FlexmlsApi::Response
+    def initialize(d)
+      begin
+        hash = d["D"]
+        if hash.nil? || hash.empty?
+          raise InvalidResponse, "The server response could not be understood"
+        end
+        self.message    = hash["Message"]
+        self.code       = hash["Code"]
+        self.results    = Array(hash["Results"])
+        self.success    = hash["Success"]
+        self.pagination = hash["Pagination"]
+        self.details    = hash["Details"] || []
+        super(results)
+      rescue Exception => e
+        FlexmlsApi.logger.error "Unable to understand the response! #{d}"
+        raise
+      end
+    end
+  end
+end

data/lib/spark_api/version.rb

@@ -0,0 +1,4 @@
+# Gem version information
+module SparkApi
+  VERSION = File.read(File.dirname(__FILE__) + "/../../VERSION").chomp
+end

data/lib/spark_api/version.rb~

@@ -0,0 +1,4 @@
+# Gem version information
+module FlexmlsApi
+  VERSION = File.read(File.dirname(__FILE__) + "/../../VERSION").chomp
+end

data/script/console

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

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 + '/spark_api'
+
+SparkApi.logger.info("Hello!")
+
+SparkApi.configure do |config|
+  config.api_key = "agent_key"
+  config.api_secret = "agent_secret"
+  config.version = "v1"
+  config.endpoint = "https://api.sparkapi.com"
+end
+
+client = SparkApi.client
+
+list = client.get '/contacts'
+puts "client: #{list.inspect}"
+list = SparkApi::Models::Contact.get
+puts "model: #{list.inspect}"
+
+
+

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/...."
+                    }
+                ]
+            }
+        ]
+    }
+}