spark_api 1.0.0

data/lib/spark_api/configuration/yaml.rb

@@ -0,0 +1,101 @@
+require 'erb'
+
+module SparkApi
+  module Configuration
+    class YamlConfig
+      KEY_CONFIGURATIONS = VALID_OPTION_KEYS  + [:oauth2] + OAUTH2_KEYS  
+      DEFAULT_OAUTH2_PROVIDER = "SparkApi::Authentication::OAuth2Impl::PasswordProvider"
+      attr_accessor *KEY_CONFIGURATIONS
+      attr_reader :client_keys, :oauth2_keys, :provider
+      
+      def initialize(filename=nil)
+        @oauth2 = false
+        load_file(filename) unless filename.nil?()
+      end
+      def load_file(file)
+        @file = file
+        @name = File.basename(file, ".yml")
+        config = YAML.load(ERB.new(File.read(file)).result)[api_env]
+        config["oauth2"] == true  ? load_oauth2(config) : load_api_auth(config)
+      rescue => e
+        SparkApi.logger().error("Unable to load config file #{file}[#{api_env}]")
+        raise e
+      end
+      
+      def oauth2?
+        return oauth2 == true
+      end
+      
+      def name
+        @name
+      end
+      def api_env
+        current_env = "development"
+        if env.include?("SPARK_API_ENV")
+          current_env = env["SPARK_API_ENV"]
+        elsif env.include?("RAILS_ENV")
+          current_env = env["RAILS_ENV"]
+        end
+        return current_env
+      end
+      
+      # Used to specify the root of where to look for SparkApi config files
+      def self.config_path
+        path_prefix + "config/spark_api"
+      end
+      
+      def self.config_keys()
+        files = Dir["#{config_path}/*.yml"]
+        files.map {|f| File.basename(f,".yml") }
+      end
+      
+      def self.exists?(name)
+        File.exists? "#{config_path}/#{name}.yml"
+      end
+
+      def self.build(name)
+        yaml = YamlConfig.new("#{config_path}/#{name}.yml")
+      end
+      
+      protected
+      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/spark_api/configuration/yaml.rb~

@@ -0,0 +1,101 @@
+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, :provider
+      
+      def initialize(filename=nil)
+        @oauth2 = false
+        load_file(filename) unless filename.nil?()
+      end
+      def load_file(file)
+        @file = file
+        @name = File.basename(file, ".yml")
+        config = YAML.load(ERB.new(File.read(file)).result)[api_env]
+        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
+      end
+      
+      def oauth2?
+        return oauth2 == true
+      end
+      
+      def name
+        @name
+      end
+      def api_env
+        current_env = "development"
+        if env.include?("FLEXMLS_API_ENV")
+          current_env = env["FLEXMLS_API_ENV"]
+        elsif env.include?("RAILS_ENV")
+          current_env = env["RAILS_ENV"]
+        end
+        return current_env
+      end
+      
+      # Used to specify the root of where to look for flexmlsApi config files
+      def self.config_path
+        path_prefix + "config/flexmls_api"
+      end
+      
+      def self.config_keys()
+        files = Dir["#{config_path}/*.yml"]
+        files.map {|f| File.basename(f,".yml") }
+      end
+      
+      def self.exists?(name)
+        File.exists? "#{config_path}/#{name}.yml"
+      end
+
+      def self.build(name)
+        yaml = YamlConfig.new("#{config_path}/#{name}.yml")
+      end
+      
+      protected
+      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/spark_api/connection.rb

@@ -0,0 +1,42 @@
+require 'openssl'
+require 'faraday'
+require 'faraday_middleware'
+require 'yajl'
+
+module SparkApi
+  # =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 SparkApi::FaradayExt::SparkMiddleware
+      end
+      SparkApi.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_SPARK_API_USER_AGENT => user_agent
+      }
+    end
+    
+  end
+end

data/lib/spark_api/faraday.rb

@@ -0,0 +1,64 @@
+module SparkApi
+  module FaradayExt
+    #=Spark API Faraday middleware
+    # HTTP Response after filter to package api responses and bubble up basic api errors.
+    class SparkMiddleware < Faraday::Response::ParseJson
+      include SparkApi::PaginateHelper      
+      # Handles pretty much all the api response parsing and error handling.  All responses that
+      # indicate a failure will raise a SparkApi::ClientError exception
+      def on_complete(finished_env)
+        body = parse(finished_env[:body])
+        SparkApi.logger.debug("Response Body: #{body.inspect}")
+        unless body.is_a?(Hash) && body.key?("D")
+          raise InvalidResponse, "The server response could not be understood"
+        end
+        response = ApiResponse.new body
+        paging = response.pagination
+        if paging.nil?
+          results = response
+        else
+          if finished_env[:url].query_values["_pagination"] == "count"
+            results = paging['TotalRows']
+          else
+            results = paginate_response(response, paging)
+          end
+        end
+        case 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.
+          auth_header_error = finished_env[:request_headers]["WWW-Authenticate"]
+          SparkApi.logger.warn("Authentication error #{auth_header_error}") unless auth_header_error.nil?
+          raise PermissionDenied, {:message => response.message, :code => response.code, :status => finished_env[:status]}
+        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]}
+        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
+          SparkApi.logger.debug("Success!")
+        else 
+          raise ClientError, {:message => response.message, :code => response.code, :status => finished_env[:status]}
+        end
+        finished_env[:body] = results
+      end
+      
+      def initialize(app)
+        super(app)
+      end
+      
+    end
+  end
+end

data/lib/spark_api/faraday.rb~

@@ -0,0 +1,64 @@
+module FlexmlsApi
+  module FaradayExt
+    #=Flexmls API Faraday middleware
+    # HTTP Response after filter to package api responses and bubble up basic api errors.
+    class FlexmlsMiddleware < Faraday::Response::ParseJson
+      include FlexmlsApi::PaginateHelper      
+      # Handles pretty much all the api response parsing and error handling.  All responses that
+      # indicate a failure will raise a FlexmlsApi::ClientError exception
+      def on_complete(finished_env)
+        body = parse(finished_env[:body])
+        FlexmlsApi.logger.debug("Response Body: #{body.inspect}")
+        unless body.is_a?(Hash) && body.key?("D")
+          raise InvalidResponse, "The server response could not be understood"
+        end
+        response = ApiResponse.new body
+        paging = response.pagination
+        if paging.nil?
+          results = response
+        else
+          if finished_env[:url].query_values["_pagination"] == "count"
+            results = paging['TotalRows']
+          else
+            results = paginate_response(response, paging)
+          end
+        end
+        case 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.
+          auth_header_error = finished_env[:request_headers]["WWW-Authenticate"]
+          FlexmlsApi.logger.warn("Authentication error #{auth_header_error}") unless auth_header_error.nil?
+          raise PermissionDenied, {:message => response.message, :code => response.code, :status => finished_env[:status]}
+        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]}
+        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
+          FlexmlsApi.logger.debug("Success!")
+        else 
+          raise ClientError, {:message => response.message, :code => response.code, :status => finished_env[:status]}
+        end
+        finished_env[:body] = results
+      end
+      
+      def initialize(app)
+        super(app)
+      end
+      
+    end
+  end
+end

data/lib/spark_api/models.rb

@@ -0,0 +1,33 @@
+require 'spark_api/models/base'
+require 'spark_api/models/constraint'
+require 'spark_api/models/finders'
+require 'spark_api/models/subresource'
+
+require 'spark_api/models/account'
+require 'spark_api/models/connect_prefs'
+require 'spark_api/models/contact'
+require 'spark_api/models/custom_fields'
+require 'spark_api/models/document'
+require 'spark_api/models/idx_link'
+require 'spark_api/models/listing'
+require 'spark_api/models/listing_cart'
+require 'spark_api/models/market_statistics'
+require 'spark_api/models/message'
+require 'spark_api/models/note'
+require 'spark_api/models/notification'
+require 'spark_api/models/open_house'
+require 'spark_api/models/photo'
+require 'spark_api/models/property_types'
+require 'spark_api/models/saved_search'
+require 'spark_api/models/shared_listing'
+require 'spark_api/models/standard_fields'
+require 'spark_api/models/system_info'
+require 'spark_api/models/tour_of_home'
+require 'spark_api/models/video'
+require 'spark_api/models/virtual_tour'
+
+module SparkApi
+  module Models
+
+  end
+end

data/lib/spark_api/models.rb~

@@ -0,0 +1,33 @@
+require 'flexmls_api/models/base'
+require 'flexmls_api/models/constraint'
+require 'flexmls_api/models/finders'
+require 'flexmls_api/models/subresource'
+
+require 'flexmls_api/models/account'
+require 'flexmls_api/models/connect_prefs'
+require 'flexmls_api/models/contact'
+require 'flexmls_api/models/custom_fields'
+require 'flexmls_api/models/document'
+require 'flexmls_api/models/idx_link'
+require 'flexmls_api/models/listing'
+require 'flexmls_api/models/listing_cart'
+require 'flexmls_api/models/market_statistics'
+require 'flexmls_api/models/message'
+require 'flexmls_api/models/note'
+require 'flexmls_api/models/notification'
+require 'flexmls_api/models/open_house'
+require 'flexmls_api/models/photo'
+require 'flexmls_api/models/property_types'
+require 'flexmls_api/models/saved_search'
+require 'flexmls_api/models/shared_listing'
+require 'flexmls_api/models/standard_fields'
+require 'flexmls_api/models/system_info'
+require 'flexmls_api/models/tour_of_home'
+require 'flexmls_api/models/video'
+require 'flexmls_api/models/virtual_tour'
+
+module FlexmlsApi
+  module Models
+
+  end
+end