flexmls_api 0.6.5 → 0.7.0

data/History.txt

@@ -1,3 +1,14 @@
+== 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
+* ListPrice save operation for listings
+* Listing contraints processing
+== v0.6.7 2011-09-02
+* YAML key management
+== v0.6.6 2011-08-30
+* Added methods for returning street, region, and full address for a listing
+== v0.6.5 2011-08-02
+*  Fixed some recursive gemspec issues from jewler by removing jeweler and going with some of our own custom rake tasks.
 == v0.6.4 2011-08-02
 *  added public method for the listing carts service specified
 *  added spec for portal listing cart method
@@ -121,4 +132,4 @@
 == v0.1.1 2010-12-23
 *  IDX link and market stat models.
 == v0.1.0 2010-12-13
-* Initial usable release with request interface and models 
+* Initial usable release with request interface and models 

data/VERSION

@@ -1 +1 @@
-0.6.5
+0.7.0

data/lib/flexmls_api.rb

@@ -1,24 +1,25 @@
-# Flexmlsapi
 require 'rubygems'
 require 'curb'
 require 'json'
 require 'logger'
 
-require File.expand_path('../flexmls_api/version', __FILE__)
-require File.expand_path('../flexmls_api/configuration', __FILE__)
-require File.expand_path('../flexmls_api/multi_client', __FILE__)
-require File.expand_path('../flexmls_api/authentication', __FILE__)
-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__)
+require 'flexmls_api/version'
+require 'flexmls_api/configuration'
+require 'flexmls_api/multi_client'
+require 'flexmls_api/authentication'
+require 'flexmls_api/response'
+require 'flexmls_api/paginate'
+require 'flexmls_api/request'
+require 'flexmls_api/client'
+require 'flexmls_api/faraday'
+require 'flexmls_api/primary_array'
+require 'flexmls_api/models'
 
 module FlexmlsApi
   extend Configuration
   extend MultiClient
  
+  #:nocov:
   def self.logger
     if @logger.nil?
       @logger = Logger.new(STDOUT)
@@ -26,6 +27,7 @@ module FlexmlsApi
     end
     @logger
   end
+  #:nocov:
 
   def self.client(opts={})
     Thread.current[:flexmls_api_client] ||= FlexmlsApi::Client.new(opts)

data/lib/flexmls_api/authentication/api_auth.rb

@@ -12,7 +12,7 @@ module FlexmlsApi
     class ApiAuth < BaseAuth
       
       def initialize(client)
-        @client = client
+        super(client)
       end
       
       def authenticate
@@ -55,14 +55,16 @@ module FlexmlsApi
   
       # Sign a request with request data.
       def sign_token(path, params = {}, post_data="")
-        sign("#{@client.api_secret}ApiKey#{@client.api_key}ServicePath#{path}#{build_param_string(params)}#{post_data}")
+        token_string = "#{@client.api_secret}ApiKey#{@client.api_key}ServicePath#{path}#{build_param_string(params)}#{post_data}"
+        signed = sign(token_string)
+        signed
       end
       
       # Perform an HTTP request (no data)
       def request(method, path, body, options)
         escaped_path = URI.escape(path)
         request_opts = {
-          "AuthToken" => @session.auth_token
+          :AuthToken => @session.auth_token
         }
         unless @client.api_user.nil?
           request_opts.merge!(:ApiUser => "#{@client.api_user}")

data/lib/flexmls_api/authentication/oauth2.rb

@@ -5,14 +5,6 @@ module FlexmlsApi
 
   module Authentication
     
-    module OAuth2Impl
-      require 'flexmls_api/authentication/oauth2_impl/middleware'
-      require 'flexmls_api/authentication/oauth2_impl/grant_type_base'
-      require 'flexmls_api/authentication/oauth2_impl/grant_type_refresh'
-      require 'flexmls_api/authentication/oauth2_impl/grant_type_code'
-      require 'flexmls_api/authentication/oauth2_impl/grant_type_password'
-    end
-    
     #=OAuth2 Authentication
     # Auth implementation to the API using the OAuth2 service endpoint.  Current adheres to the 10 
     # draft of the OAuth2 specification.  With OAuth2, the application supplies credentials for the 
@@ -30,7 +22,7 @@ module FlexmlsApi
     class OAuth2 < BaseAuth
       
       def initialize(client)
-        @client = client
+        super(client)
         @provider = client.oauth2_provider
       end
       
@@ -120,18 +112,23 @@ module FlexmlsApi
     #  @client_id - OAuth2 provided application identifier
     #  @client_secret - OAuth2 provided password for the client id
     class BaseOAuth2Provider
-      
-      attr_accessor :authorization_uri, :access_uri, :grant_type, :client_id, :client_secret
-      
+      attr_accessor *Configuration::OAUTH2_KEYS
       # Requirements for authorization_code grant type
-      attr_accessor :code, :redirect_uri
-      # Requirements for password grant type
-      attr_accessor :username, :password
+      attr_accessor :code
+      attr_accessor :grant_type
+      
+      def initialize(opts={})
+        Configuration::OAUTH2_KEYS.each do |key|
+          send("#{key}=", opts[key]) if opts.include? key
+        end
+        @grant_type = :authorization_code
+      end
       
       def grant_type
-        :authorization_code
+        # backwards compatibility check
+        @grant_type.nil? ?  :authorization_code : @grant_type
       end
-
+      
       # Application using the client must handle user redirect for user authentication.  For 
       # command line applications, this method is called prior to initial client requests so that  
       # the process can notify the user to go to the url and retrieve the access_code for the app.  
@@ -166,6 +163,15 @@ module FlexmlsApi
 
     end
 
+    module OAuth2Impl
+      require 'flexmls_api/authentication/oauth2_impl/middleware'
+      require 'flexmls_api/authentication/oauth2_impl/grant_type_base'
+      require 'flexmls_api/authentication/oauth2_impl/grant_type_refresh'
+      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'
+    end
+    
   end
  
 end

data/lib/flexmls_api/authentication/oauth2_impl/password_provider.rb

@@ -0,0 +1,25 @@
+
+module FlexmlsApi
+  module Authentication
+    module OAuth2Impl
+      class PasswordProvider < FlexmlsApi::Authentication::BaseOAuth2Provider
+        def initialize(credentials)
+          super(credentials)
+          @grant_type = :password
+        end
+        
+        def load_session()
+          @session
+        end
+      
+        def save_session(session)
+          @session = session
+        end
+      
+        def destroy_session
+          @session = nil
+        end
+      end
+    end
+  end
+end

data/lib/flexmls_api/cli.rb

@@ -1,5 +1,15 @@
 require 'optparse'
 
+if ENV["FLEXMLS_API_CONSOLE"].nil?
+  require 'flexmls_api'
+else
+  puts "Enabling console mode for local gem"
+  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'
+end
+
 module FlexmlsApi
   module CLI
     class ConsoleCLI
@@ -16,7 +26,7 @@ module FlexmlsApi
         :api_secret => "API_SECRET",
         :api_user => "API_USER",
         # OTHER
-        :verbose => "VERBOSE",
+        :debug=> "DEBUG",
         :console => "FLEXMLS_API_CONSOLE"  # not a public option, meant to distinguish bin/flexmls_api and script/console
       }
       
@@ -38,7 +48,7 @@ module FlexmlsApi
       
       private
       def self.setup_options(stdout,arguments)
-        options = {
+        env_options = {
           :oauth2            => false,
           :endpoint          => ENV[OPTIONS_ENV[:endpoint]],
           # OAUTH2 Options
@@ -53,9 +63,11 @@ module FlexmlsApi
           :api_user => ENV[OPTIONS_ENV[:api_user]],
           :console => ENV[OPTIONS_ENV[:console]]
         }
-        
+        cli_options = {}
+        file_options = {}
         parser = OptionParser.new do |opts|
           opts.banner = <<-BANNER.gsub(/^          /,'')
+            #{version}
             FlexmlsApi Client Console - http://www.flexmls.com/developers/api/
             
             Usage: #{File.basename($0)} [options]
@@ -68,47 +80,51 @@ module FlexmlsApi
           opts.on("-o","--oauth2",
                   "Run the API using OAuth2 credentials.  The client defaults to using the flexmls API authentication mode for access. ",
                   "See http://www.flexmls.com/developers/api/api-services/authentication/ for more information on authentication types.",
-                  "Default: false") { |arg| options[:oauth2] = arg }
-          opts.on("-e","--endpoint",
+                  "Default: false") { |arg| cli_options[:oauth2] = arg }
+          opts.on("-e","--endpoint ENDPOINT",
                   "URI of the API.",
-                  "Default: ENV['#{OPTIONS_ENV[:endpoint]}']") { |arg| options[:endpoint] = arg }
+                  "Default: ENV['#{OPTIONS_ENV[:endpoint]}']") { |arg| cli_options[:endpoint] = arg }
 
           # OAUTH2
-          opts.on("--client_id",
+          opts.on("--client_id CLIENT_ID",
                   "OAuth2 client id",
-                  "Default: ENV['#{OPTIONS_ENV[:client_id]}']") { |arg| options[:client_id] = arg }
-          opts.on("--client_secret",
+                  "Default: ENV['#{OPTIONS_ENV[:client_id]}']") { |arg| cli_options[:client_id] = arg }
+          opts.on("--client_secret CLIENT_SECRET",
                   "OAuth2 client secret",
-                  "Default: ENV['#{OPTIONS_ENV[:client_secret]}']") { |arg| options[:client_secret] = arg }
-          opts.on("-u","--username",
+                  "Default: ENV['#{OPTIONS_ENV[:client_secret]}']") { |arg| cli_options[:client_secret] = arg }
+          opts.on("-u","--username USERNAME",
                   "OAuth2 username",
-                  "Default: ENV['#{OPTIONS_ENV[:username]}']") { |arg| options[:username] = arg }
-          opts.on("-p","--password",
+                  "Default: ENV['#{OPTIONS_ENV[:username]}']") { |arg| cli_options[:username] = arg }
+          opts.on("-p","--password PASSWORD",
                   "OAuth2 password",
-                  "Default: ENV['#{OPTIONS_ENV[:password]}']") { |arg| options[:password] = arg }
-          opts.on("--access_uri",
+                  "Default: ENV['#{OPTIONS_ENV[:password]}']") { |arg| cli_options[:password] = arg }
+          opts.on("--access_uri ACCESS_URI",
                   "OAuth2 path for granting access to the application",
-                  "Default: ENV['#{OPTIONS_ENV[:access_uri]}']") { |arg| options[:access_uri] = arg }
+                  "Default: ENV['#{OPTIONS_ENV[:access_uri]}']") { |arg| cli_options[:access_uri] = arg }
                     
           # API AUTH
-          opts.on("--api_key",
+          opts.on("--api_key API_KEY",
                   "Authentication key for running the api using the default api authentication",
-                  "Default: ENV['#{OPTIONS_ENV[:api_key]}']") { |arg| options[:api_key] = arg }
-          opts.on("--api_secret",
+                  "Default: ENV['#{OPTIONS_ENV[:api_key]}']") { |arg| cli_options[:api_key] = arg }
+          opts.on("--api_secret API_SECRET",
                   "API secret for the api key",
-                   "Default: ENV['#{OPTIONS_ENV[:api_secret]}']") { |arg| options[:api_secret] = arg }
-          opts.on("--api_user",
+                   "Default: ENV['#{OPTIONS_ENV[:api_secret]}']") { |arg| cli_options[:api_secret] = arg }
+          opts.on("--api_user API_USER",
                   "ID of the flexmls user to run the client as.",
-                  "Default: ENV['#{OPTIONS_ENV[:api_user]}']") { |arg| options[:api_user] = arg }
+                  "Default: ENV['#{OPTIONS_ENV[:api_user]}']") { |arg| cli_options[:api_user] = arg }
                     
-          opts.on("-v", "--verbose",
-                  "Show detailed request logging information.") { |arg| options[:verbose] = arg }
+          opts.on("-f", "--file FILE",
+                  "Load configuration for yaml file.") { |arg| file_options = parse_file_options(arg) }
+          opts.on("-d", "--debug",
+                  "Show detailed request logging information.") { |arg| cli_options[:debug] = arg }
+          opts.on("-v", "--version",
+                  "Show client version.") { stdout.puts version; exit }
           opts.on("-h", "--help",
                   "Show this help message.") { stdout.puts opts; exit }
           opts.parse!(arguments)
         
         end
-        
+        options = env_options.merge(file_options.merge(cli_options))
         return options
       end
       
@@ -127,6 +143,16 @@ module FlexmlsApi
         end
         run_env
       end
+      
+      private 
+      def self.parse_file_options(file)
+        yaml = FlexmlsApi::Configuration::YamlConfig.new(file)
+        return {:oauth2 => yaml.oauth2}.merge(yaml.client_keys.merge(yaml.oauth2_keys))
+      end
+      
+      def self.version
+        "flexmlsApi v#{FlexmlsApi::VERSION}"
+      end
     end
   end
 end

data/lib/flexmls_api/cli/oauth2.rb

@@ -1,36 +1,7 @@
 require File.dirname(__FILE__) + "/../cli/setup"
 
-class CLIOAuth2Provider < FlexmlsApi::Authentication::BaseOAuth2Provider
-  def initialize(credentials)
-    @authorization_uri = credentials[:authorization_uri]
-    @access_uri        = credentials[:access_uri]
-    @redirect_uri      = credentials[:redirect_uri]
-    @client_id         = credentials[:client_id]
-    @client_secret     = credentials[:client_secret]
-    @username          = credentials[:username]
-    @password          = credentials[:password]
-    @session           = nil
-  end
-
-  def grant_type
-    :password
-  end
-  
-  def load_session()
-    @session
-  end
-
-  def save_session(session)
-    @session = session
-  end
-
-  def destroy_session
-    @session = nil
-  end
-end
-
 FlexmlsApi.configure do |config|
-  config.oauth2_provider = CLIOAuth2Provider.new(
+  config.oauth2_provider = FlexmlsApi::Authentication::OAuth2Impl::PasswordProvider.new(
                             :authorization_uri=> ENV["AUTH_URI"],
                             :access_uri  => ENV["ACCESS_URI"],
                             :username=> ENV["USERNAME"],

data/lib/flexmls_api/cli/setup.rb

@@ -1,5 +1,8 @@
 require "rubygems"
 require 'pp'
+require 'irb/ext/save-history'
+IRB.conf[:SAVE_HISTORY] = 1000
+IRB.conf[:HISTORY_FILE] = "#{ENV['HOME']}/.flexmls-api-history"
 
 if ENV["FLEXMLS_API_CONSOLE"].nil?
   require 'flexmls_api'
@@ -29,7 +32,7 @@ module FlexmlsApi
   def self.logger
     if @logger.nil?
       @logger = Logger.new(STDOUT)
-      @logger.level = ENV["VERBOSE"].nil? ? Logger::WARN : Logger::DEBUG
+      @logger.level = ENV["DEBUG"].nil? ? Logger::WARN : Logger::DEBUG
     end
     @logger
   end

data/lib/flexmls_api/client.rb

@@ -21,6 +21,6 @@ module FlexmlsApi
       # Instanciate the authenication class passed in.
       @authenticator = authentication_mode.send("new", self)
     end
-
+    
   end
 end

data/lib/flexmls_api/configuration.rb

@@ -1,7 +1,17 @@
+
 module FlexmlsApi
   module Configuration
+    
     # valid configuration options
     VALID_OPTION_KEYS = [:api_key, :api_secret, :api_user, :endpoint, :user_agent, :version, :ssl, :oauth2_provider, :authentication_mode].freeze
+    OAUTH2_KEYS = [:authorization_uri, :access_uri, :client_id, :client_secret,
+      # Requirements for authorization_code grant type
+      :redirect_uri,  
+      # Requirements for password grant type
+      :username, :password
+    ]
+      
+    require File.expand_path('../configuration/yaml', __FILE__)
     
     DEFAULT_API_KEY = nil
     DEFAULT_API_SECRET = nil

data/lib/flexmls_api/configuration/yaml.rb

@@ -0,0 +1,81 @@
+require 'erb'
+module FlexmlsApi
+  module Configuration
+    class YamlConfig
+      KEY_CONFIGURATIONS = VALID_OPTION_KEYS  + [:oauth2] + OAUTH2_KEYS  
+      
+      attr_accessor *KEY_CONFIGURATIONS
+      attr_reader :client_keys, :oauth2_keys
+      
+      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
+      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
+        "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
+
+    end
+  end
+end
+