flexmls_api 0.4.5 → 0.6.4

data/Gemfile

@@ -1,20 +1,5 @@
 source :rubygems
 
-gem 'curb', '0.7.8'
-gem 'faraday', '0.5.3'
-gem 'faraday_middleware', '0.3.1'
-gem 'multi_json', '0.0.5'
-gem 'json', '1.4.6'
-gem 'yajl-ruby', '0.7.8'
-gem 'builder', '2.1.2'
+# Refer to the flexmls_api.gemspec or Rakefile for dependency information
+gemspec :development_group => :test
 
-gem 'will_paginate', '~> 3.0.pre2'
-
-group :test do
-  gem 'rspec'
-  gem 'webmock'
-  gem 'jeweler'
-  gem 'typhoeus' 
-  gem 'ci_reporter', '>=1.6.3'
-  gem 'rcov'
-end

data/Gemfile.lock

@@ -1,28 +1,43 @@
+PATH
+  remote: .
+  specs:
+    flexmls_api (0.6.4)
+      addressable (~> 2.2.5)
+      builder (< 4.0.0, >= 2.1.2)
+      curb (~> 0.7.15)
+      faraday (~> 0.6.1)
+      faraday_middleware (~> 0.6.3)
+      flexmls_api
+      json (~> 1.5.1)
+      multi_json (~> 1.0.0)
+      will_paginate (< 4.0.0, >= 3.0.pre2)
+      yajl-ruby (~> 0.8.2)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.2.2)
+    addressable (2.2.6)
     builder (2.1.2)
     ci_reporter (1.6.3)
       builder (>= 2.1.2)
     crack (0.1.8)
-    curb (0.7.8)
+    curb (0.7.15)
     diff-lcs (1.1.2)
-    faraday (0.5.3)
-      addressable (~> 2.2.2)
-      multipart-post (~> 1.0.1)
-      rack (>= 1.1.0, < 2)
-    faraday_middleware (0.3.1)
-      faraday (~> 0.5.3)
+    faraday (0.6.1)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (< 2, >= 1.1.0)
+    faraday_middleware (0.6.5)
+      faraday (~> 0.6.0)
     git (1.2.5)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    json (1.4.6)
-    multi_json (0.0.5)
-    multipart-post (1.0.1)
-    rack (1.2.1)
+    json (1.5.3)
+    multi_json (1.0.3)
+    multipart-post (1.1.2)
+    rack (1.3.1)
     rake (0.8.7)
     rcov (0.9.9)
     rspec (2.3.0)
@@ -38,23 +53,16 @@ GEM
       addressable (>= 2.2.2)
       crack (>= 0.1.7)
     will_paginate (3.0.pre2)
-    yajl-ruby (0.7.8)
+    yajl-ruby (0.8.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  builder (= 2.1.2)
-  ci_reporter (>= 1.6.3)
-  curb (= 0.7.8)
-  faraday (= 0.5.3)
-  faraday_middleware (= 0.3.1)
-  jeweler
-  json (= 1.4.6)
-  multi_json (= 0.0.5)
-  rcov
-  rspec
-  typhoeus
-  webmock
-  will_paginate (~> 3.0.pre2)
-  yajl-ruby (= 0.7.8)
+  ci_reporter (~> 1.6.3)
+  flexmls_api!
+  jeweler (~> 1.5.2)
+  rcov (~> 0.9.9)
+  rspec (~> 2.3.0)
+  typhoeus (~> 0.2.0)
+  webmock (~> 1.4.0)

data/README.md

@@ -14,6 +14,8 @@ Installation
 
 Usage Examples
 ------------------------
+
+#### Ruby Script
     # initialize the gem with your key/secret
     # api_key and _api_secret are the only required settings
     # other options and their defaults:
@@ -31,6 +33,26 @@ Usage Examples
 
     # Grab your listings!
     my_listings = Listing.my()
+    
+    
+#### Interactive Console
+Included in the gem is a simple setup script to run the client in IRB.  To use it, first create the file called _.flexmls_api_testing_ filling in the credentials for your account.
+
+    API_USER="20110101000000000000000000" # ID for an api user
+    API_ENDPOINT="http://api.developers.flexmls.com"
+    API_KEY="my_test_key"
+    API_SECRET="my_test_secret"
+    
+    export API_USER API_ENDPOINT API_KEY API_SECRET
+
+Now, to run with this setup, run the following from the command line:
+
+    > source .flexmls_api_testing
+    > bin/flexmls_api
+    flemxlsApi> FlexmlsApi.client.get '/my/account'
+
+You can also provide these options from the command line, see "script/console -h" for more information
+
 
 Authentication
 --------------
@@ -40,7 +62,7 @@ Authentication is handled transparently by the request framework in the gem, so
 Usually supplied for a single user, this authentication mode is the simplest, and is setup as the default.  The example usage above demonstrates how to get started using this authentication mode.
 
 #### OAuth2 Authentication
-Authentication mode the separates application and user authentication.  This mode requires further setup which is described in lib/flexmls_api/authentication/oauth2.rb
+Authentication mode the separates application and user authentication.  This mode requires further setup which is described in _lib/flexmls_api/authentication/oauth2.rb_
 
 Error Codes
 ---------------------

data/Rakefile

@@ -15,11 +15,24 @@ begin
     gemspec.homepage = "https://github.com/flexmls/flexmls_api"
     gemspec.authors = ["Brandon Hornseth", "Wade McEwen"]
     # Need to skip spec/reports for CI builds
-    gemspec.files =  FileList["[A-Z]*", "{lib,spec/fixtures,spec/unit}/**/*", "spec/*.rb"]
-    gemspec.add_development_dependency "rspec"
-    gemspec.add_development_dependency "jeweler"
-    gemspec.add_development_dependency "curb"
-    gemspec.add_development_dependency "json"
+    gemspec.files =  FileList["[A-Z]*", "{bin,lib,spec/fixtures,script,spec/unit}/**/*", "spec/*.rb"]
+    # GEMS
+    gemspec.add_dependency 'curb', '~> 0.7.15'
+    gemspec.add_dependency 'faraday', '~> 0.6.1'
+    gemspec.add_dependency 'faraday_middleware', '~> 0.6.3'
+    gemspec.add_dependency 'multi_json', '~> 1.0.0'
+    gemspec.add_dependency 'json', '~> 1.5.1'
+    gemspec.add_dependency 'yajl-ruby', '~> 0.8.2'
+    gemspec.add_dependency 'builder', '>= 2.1.2', '< 4.0.0'
+    gemspec.add_dependency 'addressable', '~> 2.2.5'
+    gemspec.add_dependency 'will_paginate', '>= 3.0.pre2', '< 4.0.0'
+    # TEST GEMS
+    gemspec.add_development_dependency 'rspec', '~> 2.3.0'
+    gemspec.add_development_dependency 'webmock', '~> 1.4.0'
+    gemspec.add_development_dependency 'jeweler', '~> 1.5.2'
+    gemspec.add_development_dependency 'typhoeus', '~> 0.2.0'
+    gemspec.add_development_dependency 'ci_reporter', '~> 1.6.3'
+    gemspec.add_development_dependency 'rcov', '~> 0.9.9'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.4.5
+0.6.4

data/bin/flexmls_api

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# File: bin/flexmls_api
+
+require File.dirname(__FILE__) + '/../lib/flexmls_api/cli'
+
+FlexmlsApi::CLI::ConsoleCLI.execute(STDOUT, ARGV)
+
+

data/lib/flexmls_api.rb

@@ -6,6 +6,7 @@ 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__)
@@ -16,6 +17,7 @@ require File.expand_path('../flexmls_api/models', __FILE__)
 
 module FlexmlsApi
   extend Configuration
+  extend MultiClient
  
   def self.logger
     if @logger.nil?

data/lib/flexmls_api/authentication.rb

@@ -5,9 +5,9 @@ require 'faraday_middleware'
 require 'yajl'
 require 'date'
 
-require File.expand_path('../authentication/base_auth', __FILE__)
-require File.expand_path('../authentication/api_auth', __FILE__)
-require File.expand_path('../authentication/oauth2', __FILE__)
+require 'flexmls_api/authentication/base_auth'
+require 'flexmls_api/authentication/api_auth'
+require 'flexmls_api/authentication/oauth2'
 
 module FlexmlsApi
   # =Authentication
@@ -66,7 +66,6 @@ module FlexmlsApi
       end
       conn = Faraday::Connection.new(opts) do |builder|
         builder.adapter Faraday.default_adapter
-        builder.use Faraday::Response::ParseJson
         builder.use FlexmlsApi::FaradayExt::FlexmlsMiddleware
       end
       FlexmlsApi.logger.debug("Connection: #{conn.inspect}")
@@ -78,8 +77,8 @@ module FlexmlsApi
       {
         :accept => 'application/json',
         :content_type => 'application/json',
-        :user_agent => user_agent,
-        'X-flexmlsApi-User-Agent' => user_agent
+        :user_agent => Configuration::DEFAULT_USER_AGENT,
+        Configuration::X_FLEXMLS_API_USER_AGENT => user_agent
       }
     end
     

data/lib/flexmls_api/authentication/api_auth.rb

@@ -23,6 +23,7 @@ module FlexmlsApi
         resp = @client.connection(true).post request_path, ""
         request_time = Time.now - start_time
         FlexmlsApi.logger.info("[#{(request_time * 1000).to_i}ms] Api: POST #{request_path}")
+        FlexmlsApi.logger.debug("Authentication Response: #{resp.inspect}")
         @session = Session.new(resp.body.results.first)
         FlexmlsApi.logger.debug("Authentication: #{@session.inspect}")
         @session
@@ -59,6 +60,7 @@ module FlexmlsApi
       
       # Perform an HTTP request (no data)
       def request(method, path, body, options)
+        escaped_path = URI.escape(path)
         request_opts = {
           "AuthToken" => @session.auth_token
         }
@@ -66,8 +68,8 @@ module FlexmlsApi
           request_opts.merge!(:ApiUser => "#{@client.api_user}")
         end
         request_opts.merge!(options)
-        sig = sign_token(path, request_opts, body)
-        request_path = "#{path}?#{build_url_parameters({"ApiSig"=>sig}.merge(request_opts))}"
+        sig = sign_token(escaped_path, request_opts, body)
+        request_path = "#{escaped_path}?#{build_url_parameters({"ApiSig"=>sig}.merge(request_opts))}"
         FlexmlsApi.logger.debug("Request: #{request_path}")
         if body.nil?
           response = @client.connection.send(method, request_path)

data/lib/flexmls_api/authentication/oauth2.rb

@@ -1,8 +1,18 @@
 require 'uri'
 
+
 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 
@@ -19,60 +29,31 @@ module FlexmlsApi
     # Implementation the BaseAuth interface for API style authentication  
     class OAuth2 < BaseAuth
       
-      def session
-        @provider.load_session()
-      end
-      def session=(s)
-        @provider.save_session(s)
-      end
-      
       def initialize(client)
         @client = client
         @provider = client.oauth2_provider
       end
       
-      # Generate the appropriate request uri for authorizing this application for current user.
-      def authorization_url
-        params = {
-          "client_id" => @provider.client_id,
-          "response_type" => "code",
-          "redirect_uri" => @provider.redirect_uri
-        }
-        "#{@provider.authorization_uri}?#{build_url_parameters(params)}"
+      def session
+        @provider.load_session()
       end
-      
-      def token_params
-        params = {
-          "client_id" => @provider.client_id,
-          "client_secret" => @provider.client_secret,
-          "grant_type" => "authorization_code",
-          "code" => @provider.code,
-          "redirect_uri" => @provider.redirect_uri
-        }
-        "?#{build_url_parameters(params)}"
+      def session=(s)
+        @provider.save_session(s)
       end
       
       def authenticate
-        if(@provider.code.nil?)
-          FlexmlsApi.logger.debug("Redirecting to provider to get the authorization code")
-          @provider.redirect(authorization_url)
-        end
-        FlexmlsApi.logger.debug("Authenticating to #{@provider.access_uri}")
-        uri = URI.parse(@provider.access_uri)
-        request_path = "#{uri.path}#{token_params}"
-        response = oauth_access_connection("#{uri.scheme}://#{uri.host}").post(request_path, "").body
-        response.expires_in = @provider.session_timeout if response.expires_in.nil?
-        self.session=response
-        response
+        granter = OAuth2Impl::GrantTypeBase.create(@client, @provider, session)
+        self.session = granter.authenticate
+        session
       end
       
       # Perform an HTTP request (no data)
-      def request(method, path, body, options)
+      def request(method, path, body, options={})
+        escaped_path = URI.escape(path)
         connection = @client.connection(true)  # SSL Only!
         connection.headers.merge!(self.auth_header)
-        request_opts = {}
-        request_opts.merge!(options)
-        request_path = "#{path}?#{build_url_parameters({:access_token => session.access_token}.merge(options))}"
+        parameter_string = options.size > 0 ? "?#{build_url_parameters(options)}" : ""
+        request_path = "#{escaped_path}#{parameter_string}"
         FlexmlsApi.logger.debug("Request: #{request_path}")
         if body.nil?
           response = connection.send(method, request_path)
@@ -86,6 +67,15 @@ module FlexmlsApi
       def logout
         @provider.save_session(nil)
       end
+      
+      def authorization_url()
+        params = {
+          "client_id" => @provider.client_id,
+          "response_type" => "code",
+          "redirect_uri" => @provider.redirect_uri
+        }
+        "#{@provider.authorization_uri}?#{build_url_parameters(params)}"
+      end
 
             
       protected
@@ -94,35 +84,29 @@ module FlexmlsApi
         {"Authorization"=> "OAuth #{session.access_token}"}
       end
       
-      # Setup a faraday connection for dealing with an OAuth2 endpoint
-      def oauth_access_connection(endpoint)
-        opts = {
-          :headers => @client.headers
-        }
-        opts[:ssl] = {:verify => false }
-        opts[:url] = endpoint       
-        conn = Faraday::Connection.new(opts) do |builder|
-          builder.adapter Faraday.default_adapter
-          builder.use Faraday::Response::ParseJson
-          builder.use FlexmlsApi::Authentication::FlexmlsOAuth2Middleware
-        end
+      def provider
+        @provider
+      end
+      def client
+        @client
       end
+
     end
     
     # Representation of a session with the api using oauth2
     class OAuthSession
-      attr_accessor :access_token, :expires_in, :scope, :refresh_token
+      attr_accessor :access_token, :expires_in, :scope, :refresh_token, :refresh_timeout
       def initialize(options={})
         @access_token = options["access_token"]
-        # TODO The current oauth2 service does not send an expiration time.  I'm setting it to default to 1 hour.
         @expires_in = options["expires_in"]
         @scope = options["scope"]
         @refresh_token = options["refresh_token"]
         @start_time = DateTime.now
+        @refresh_timeout = 3600
       end
       #  Is the user session token expired?
       def expired?
-        @start_time + Rational(@expires_in, 24*60*60) < DateTime.now
+        @start_time + Rational(@expires_in - @refresh_timeout, 86400) < DateTime.now
       end
     end
     
@@ -137,7 +121,16 @@ module FlexmlsApi
     #  @client_secret - OAuth2 provided password for the client id
     class BaseOAuth2Provider
       
-      attr_accessor :authorization_uri, :code, :access_uri, :redirect_uri, :client_id, :client_secret
+      attr_accessor :authorization_uri, :access_uri, :grant_type, :client_id, :client_secret
+      
+      # Requirements for authorization_code grant type
+      attr_accessor :code, :redirect_uri
+      # Requirements for password grant type
+      attr_accessor :username, :password
+      
+      def grant_type
+        :authorization_code
+      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  
@@ -168,52 +161,11 @@ module FlexmlsApi
       # Provides a default session time out
       # returns - the session timeout length (in seconds)
       def session_timeout
-        3600
+        86400 # 1.day
       end
-      
-    end
 
-    #==OAuth2 Faraday response middleware
-    # HTTP Response after filter to package oauth2 responses and bubble up basic api errors.
-    class FlexmlsOAuth2Middleware < Faraday::Response::Middleware
-      begin
-        def self.register_on_complete(env)
-          env[:response].on_complete do |finished_env|
-            validate_and_build_response(finished_env)
-          end
-        end
-      rescue LoadError, NameError => e
-        self.load_error = e
-      end
-      
-      def self.validate_and_build_response(finished_env)
-        body = finished_env[:body]
-        FlexmlsApi.logger.debug("Response Body: #{body.inspect}")
-        unless body.is_a?(Hash)
-          raise InvalidResponse, "The server response could not be understood"
-        end
-        case finished_env[:status]
-        when 200..299
-          FlexmlsApi.logger.debug("Success!")
-          session = OAuthSession.new(body)
-        else 
-          # 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 ClientError.new(0, finished_env[:status]), body["error"]
-        end
-        FlexmlsApi.logger.debug("Session= #{session.inspect}")
-        finished_env[:body] = session
-      end
-  
-      def initialize(app)
-        super
-        @parser = nil
-      end
-      
     end
-    
+
   end
  
 end