flexmls_api 0.7.3 → 0.7.5

data/VERSION

@@ -1 +1 @@
-0.7.3
+0.7.5

data/lib/flexmls_api/authentication/oauth2.rb

@@ -87,19 +87,32 @@ module FlexmlsApi
     
     # Representation of a session with the api using oauth2
     class OAuthSession
-      attr_accessor :access_token, :expires_in, :scope, :refresh_token, :refresh_timeout
+      SESSION_ATTRIBUTES = [:access_token, :expires_in, :scope, :refresh_token, :refresh_timeout, :start_time]
+      attr_accessor *SESSION_ATTRIBUTES
       def initialize(options={})
         @access_token = options["access_token"]
         @expires_in = options["expires_in"]
         @scope = options["scope"]
         @refresh_token = options["refresh_token"]
-        @start_time = DateTime.now
-        @refresh_timeout = 3600
+        @start_time = options.fetch("start_time", DateTime.now)
+        @refresh_timeout = options.fetch("refresh_timeout",3600)
+        if @start_time.is_a? String
+          @start_time = DateTime.parse(@start_time)
+        end
       end
       #  Is the user session token expired?
       def expired?
         @start_time + Rational(@expires_in - @refresh_timeout, 86400) < DateTime.now
       end
+      
+      def to_json(*a)
+        hash = {}
+        SESSION_ATTRIBUTES.each do |k|
+          value = self.send(k)
+          hash[k.to_s] = value unless value.nil?
+        end
+        hash.to_json(*a)
+      end
     end
     
     #=OAuth2 configuration provider for applications

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

@@ -17,6 +17,7 @@ module FlexmlsApi
           else
             raise ClientError, "Unsupported grant type [#{provider.grant_type}]"
           end
+          FlexmlsApi.logger.debug("[oauth2] setup #{granter.class.name}")
           granter
         end
         
@@ -37,11 +38,12 @@ module FlexmlsApi
         protected
 
         def create_session(token_params)
-          FlexmlsApi.logger.debug("Authenticating to #{provider.access_uri}")
+          FlexmlsApi.logger.debug("[oauth2] create_session to #{provider.access_uri} params #{token_params}")
           uri = URI.parse(provider.access_uri)
           request_path = "#{uri.path}"
           response = oauth_access_connection("#{uri.scheme}://#{uri.host}").post(request_path, "#{token_params}").body
           response.expires_in = provider.session_timeout if response.expires_in.nil?
+          FlexmlsApi.logger.debug("[oauth2] New session created #{response}")
           response
         end
                 

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

@@ -11,7 +11,7 @@ module FlexmlsApi
         end
         def authenticate
           if(provider.code.nil?)
-            FlexmlsApi.logger.debug("Redirecting to provider to get the authorization code")
+            FlexmlsApi.logger.debug("[oauth2] No authoriztion code present. Redirecting to #{authorization_url}.")
             provider.redirect(authorization_url)
           end
           if needs_refreshing?
@@ -22,11 +22,12 @@ module FlexmlsApi
         end
         
         def refresh()
+          FlexmlsApi.logger.debug("[oauth2] Refresh oauth session.")
           refresher = GrantTypeRefresh.new(client,provider,session)
           refresher.params = {"redirect_uri" => @provider.redirect_uri}
           refresher.authenticate
         rescue ClientError => e
-          FlexmlsApi.logger.info("Refreshing token failed, the library will try and authenticate from scratch: #{e.message}")
+          FlexmlsApi.logger.info("[oauth2] Refreshing token failed, the library will try and authenticate from scratch: #{e.message}")
           nil
         end
 

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

@@ -21,7 +21,7 @@ module FlexmlsApi
         def refresh()
           GrantTypeRefresh.new(client,provider,session).authenticate
         rescue ClientError => e
-          FlexmlsApi.logger.info("Refreshing token failed, the library will try and authenticate from scratch: #{e.message}")
+          FlexmlsApi.logger.info("[oauth2] Refreshing token failed, the library will try and authenticate from scratch: #{e.message}")
           nil
         end
 

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

@@ -13,7 +13,7 @@ module FlexmlsApi
         def authenticate
           new_session = nil
           unless @session.refresh_token.nil?
-            FlexmlsApi.logger.debug("Refreshing authentication to #{provider.access_uri} using [#{session.refresh_token}]")
+            FlexmlsApi.logger.debug("[oauth2] Refreshing authentication to #{provider.access_uri} using [#{session.refresh_token}]")
             new_session = create_session(token_params)
           end
           new_session 

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

@@ -10,13 +10,13 @@ module FlexmlsApi
       class Middleware < Faraday::Response::ParseJson
         def on_complete(finished_env)
           body = parse(finished_env[:body])
-          FlexmlsApi.logger.debug("Response Body: #{body.inspect}")
+          FlexmlsApi.logger.debug("[oauth2] 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!")
+            FlexmlsApi.logger.debug("[oauth2] Success!")
             session = OAuthSession.new(body)
           else 
             # Handle the WWW-Authenticate Response Header Field if present. This can be returned by 
@@ -25,7 +25,7 @@ module FlexmlsApi
             FlexmlsApi.logger.warn("Authentication error #{auth_header_error}") unless auth_header_error.nil?
             raise ClientError, {:message => body["error"], :code =>0, :status => finished_env[:status]}
           end
-          FlexmlsApi.logger.debug("Session= #{session.inspect}")
+          FlexmlsApi.logger.debug("[oauth2] Session=#{session.inspect}")
           finished_env[:body] = session
         end
     

data/spec/unit/flexmls_api/authentication/oauth2_spec.rb

@@ -186,4 +186,20 @@ describe FlexmlsApi::Authentication::OAuth2Impl  do
     expect{FlexmlsApi::Authentication::OAuth2Impl.load_provider(bad_example,{}).class.to_s.should eq(bad_example)}.to raise_error(ArgumentError)
   end
 
-end
+end
+
+describe FlexmlsApi::Authentication::OAuthSession do
+  it "should serialize to json" do
+    args = {
+      "access_token" => "abc", 
+      "expires_in" => 3600, 
+      "refresh_token" => "123", 
+      "refresh_timeout" => 10000,
+      "start_time" => "2012-01-01T00:00:00+00:00"
+    }
+    session = FlexmlsApi::Authentication::OAuthSession.new(args)
+    session.start_time.should eq(DateTime.parse(args["start_time"]))
+    JSON.parse(session.to_json).should eq(args)
+    
+  end
+end

data/spec/unit/flexmls_api/configuration/yaml_spec.rb

@@ -46,7 +46,7 @@ describe FlexmlsApi::Configuration::YamlConfig, "Yaml Config"  do
       subject.endpoint.should eq("http://api.dev.flexmls.com")
       subject.oauth2_provider.should eq("FlexmlsApi::TestOAuth2Provider")
       subject.name.should eq("test_oauth")
-      subject.client_keys.keys.should eq([:endpoint, :oauth2_provider])
+      subject.client_keys.keys.should =~ [:endpoint, :oauth2_provider]
       subject.oauth2_keys.keys.should =~ [:authorization_uri, :client_id, :access_uri, :client_secret, :redirect_uri]
     end
     it "should load a configured api key for production" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flexmls_api
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 7
-  - 3
-  version: 0.7.3
+  - 5
+  version: 0.7.5
 platform: ruby
 authors: 
 - Brandon Hornseth
@@ -72,12 +72,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 5
         segments: 
         - 1
         - 5
-        - 1
-        version: 1.5.1
+        version: "1.5"
   requirement: *id004
   prerelease: false
   name: json