flexmls_api 0.3.2 → 0.3.3

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/lib/flexmls_api/authentication.rb

@@ -11,9 +11,9 @@ module FlexmlsApi
     # Main authentication step.  Run before any api request unless the user session exists and is 
     # still valid.
     #
-    # :returns:
+    # *returns*
     #   The user session object when authentication succeeds
-    # :raises:
+    # *raises*
     #   FlexmlsApi::ClientError when authentication fails
     def authenticate
       sig = sign("#{@api_secret}ApiKey#{@api_key}")
@@ -28,6 +28,18 @@ module FlexmlsApi
       @session
     end
     
+    # Delete the current session
+    def logout
+      FlexmlsApi.logger.info("Logging out.")
+      delete("/session/#{@session.auth_token}") unless @session.nil?
+      @session = nil
+    end
+
+    # Active session object
+    def session
+      @session
+    end
+    
     # Builds an ordered list of key value pairs and concatenates it all as one big string.  Used 
     # specifically for signing a request.
     def build_param_string(param_hash)

data/lib/flexmls_api/faraday.rb

@@ -6,7 +6,6 @@ module FlexmlsApi
       begin
         def self.register_on_complete(env)
           env[:response].on_complete do |finished_env|
-            FlexmlsApi.logger.debug("hashed response: #{finished_env[:body].inspect}")
             validate_and_build_response(finished_env)
           end
         end

data/spec/fixtures/success.json

@@ -0,0 +1,5 @@
+{
+    "D": {
+        "Success": true
+    }
+}

data/spec/unit/flexmls_api/authentication_spec.rb

@@ -0,0 +1,30 @@
+require './spec/spec_helper'
+
+describe FlexmlsApi::Authentication do
+  it "should give me a session object" do
+    stub_auth_request
+    stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/session/c401736bf3d3f754f07c04e460e09573").
+      with(:query => {
+        :ApiSig => "5596eff4550d74ec6802ac2d637ae5ae",
+        :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+      }).
+      to_return(:body => fixture("session.json"))
+    client = FlexmlsApi.client
+    stub_auth_request
+    session = client.get "/session/c401736bf3d3f754f07c04e460e09573"
+    session[0]["AuthToken"].should eq "c401736bf3d3f754f07c04e460e09573"
+  end
+  it "should delete a session" do
+    stub_auth_request
+    stub_request(:delete, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/session/c401736bf3d3f754f07c04e460e09573").
+      with(:query => {
+        :ApiSig => "5596eff4550d74ec6802ac2d637ae5ae",
+        :AuthToken => "c401736bf3d3f754f07c04e460e09573"
+      }).
+      to_return(:body => fixture("success.json"))
+    client = FlexmlsApi.client
+    client.logout
+    client.session.should eq nil
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flexmls_api
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Brandon Hornseth
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-28 00:00:00 -06:00
+date: 2011-03-01 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -242,8 +242,10 @@ files:
 - spec/fixtures/listing_with_videos.json
 - spec/fixtures/listing_with_vtour.json
 - spec/fixtures/session.json
+- spec/fixtures/success.json
 - spec/json_helper.rb
 - spec/spec_helper.rb
+- spec/unit/flexmls_api/authentication_spec.rb
 - spec/unit/flexmls_api/configuration_spec.rb
 - spec/unit/flexmls_api/faraday_spec.rb
 - spec/unit/flexmls_api/models/base_spec.rb
@@ -297,6 +299,7 @@ summary: A library for interacting with the flexmls web services.
 test_files: 
 - spec/json_helper.rb
 - spec/spec_helper.rb
+- spec/unit/flexmls_api/authentication_spec.rb
 - spec/unit/flexmls_api/configuration_spec.rb
 - spec/unit/flexmls_api/faraday_spec.rb
 - spec/unit/flexmls_api/models/base_spec.rb