fmrest 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f72f9afbde054df91f3abc73b54752c7c19cca4f4ec1c5299ab6cc2edb8978fb
-  data.tar.gz: 3ff30b1db7976a76783cbe99c14d9224e5477a8f8d3ba68e8df27adb9d547678
+  metadata.gz: 185e6173a3f500ea6fc8ad40df8f52ba538fdd8e3545537e947f19bfd79a3124
+  data.tar.gz: 89f5c6774366599e1baeef57662af77a3ceb5174abd58e6fd562c2aa29b85384
 SHA512:
-  metadata.gz: 7aee8096187d1082475e941ae4f4b9509d7b16a8d3f660c0e6989632f1b11ae7d7da5569fd5788862975190810a4dd91643d5f0c66630191bbdea95c2fcd4c7f
-  data.tar.gz: 6775c47687abcf09a0a27e06697deaa90021114559675c82d1189420ee58d5181d8e6cac9d6b20628f468223aaed7e8a075838b06b9a818e68eaf8465eddfc05
+  metadata.gz: b7aa56e455da60fe7b571e2ce4d70ae118ca7ade57356cbdade2b0679f66d10e9d689a4bc3af5ddfb06dfc6d7395af35b0518c23077dbfb28a9e395b845e0841
+  data.tar.gz: c764ee1dc1962b3f6264ed6a4f26f0b88dd5c69cb62bca93dd269398c3e0d350ced4177b2842ce24136d7d0b84cb9a4809ce23ca1965b923fb91fc7b37ae39e1

data/.yardopts

@@ -1 +1,2 @@
 --markup markdown
+--plugin activesupport-concern

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 0.6.0
+
+* Implemented session logout
+  ([#16](https://github.com/beezwax/fmrest-ruby/issues/16))
+
 ### 0.5.2
 
 * Improved support for legacy ActiveModel 4.x

data/README.md

@@ -61,6 +61,28 @@ end
 For each request fmrest-ruby will first request a session token (using the
 provided username and password) if it doesn't yet have one in store.
 
+### Logging out of the database session
+
+The Data API requires sending a DELETE request to
+`/fmi/data/:version/databases/:database_name/sessions/:session_token`
+in order to log out from the session
+([see docs](https://fmhelp.filemaker.com/docs/18/en/dataapi/#connect-database_log-out)).
+
+Since fmrest-ruby handles the storage of session tokens internally, and the
+token is required to build the logout URL, this becomes a non-trivial action.
+
+To remedy this, fmrest-ruby connections recognize when you're trying to logout
+and substitute whatever is in the `:session_token` section of the logout path
+with the actual session token:
+
+```ruby
+# Logout from the database session
+connection.delete "sessions/this-will-be-replaced-with-the-actual-token"
+```
+
+If you're using the ORM features this becomes much easier, see
+[Model.logout](#modellogout) below.
+
 ## Connection settings
 
 In addition to the required `:host`, `:database`, `:username` and `:password`
@@ -335,6 +357,15 @@ Data API models.
 Note that you only need to set this if the name of the model and the name of
 the layout differ, otherwise the default will just work.
 
+### Model.logout
+
+Use `logout` to log out from the database session (you may call it on any model
+that uses the database session you want to log out from).
+
+```ruby
+Honeybee.logout
+```
+
 ### Mapped Model.attributes
 
 Spyke allows you to define your model's attributes using `attributes`, however
@@ -852,7 +883,7 @@ FM Data API reference: https://fmhelp.filemaker.com/docs/18/en/dataapi/
 | Log in using OAuth                  | No                            | No                               |
 | Log in to an external data source   | No                            | No                               |
 | Log in using a FileMaker ID account | No                            | No                               |
-| Log out                             | Manual*                       | No                               |
+| Log out                             | Yes                           | Yes
 | Get product information             | Manual*                       | No                               |
 | Get database names                  | Manual*                       | No                               |
 | Get script names                    | Manual*                       | No                               |

data/fmrest.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "mock_redis"
   spec.add_development_dependency "moneta"
   spec.add_development_dependency "yard"
+  spec.add_development_dependency "yard-activesupport-concern"
 end

data/lib/fmrest/spyke/model.rb

@@ -8,6 +8,7 @@ require "fmrest/spyke/model/associations"
 require "fmrest/spyke/model/orm"
 require "fmrest/spyke/model/container_fields"
 require "fmrest/spyke/model/http"
+require "fmrest/spyke/model/auth"
 
 module FmRest
   module Spyke
@@ -22,6 +23,7 @@ module FmRest
       include Orm
       include ContainerFields
       include Http
+      include Auth
 
       included do
         # @return [Integer] the record's modId

data/lib/fmrest/spyke/model/auth.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module FmRest
+  module Spyke
+    module Model
+      module Auth
+        extend ::ActiveSupport::Concern
+
+        class_methods do
+          # Logs out the database session for this model (and other models
+          # using the same credentials).
+          #
+          # @raise [FmRest::V1::TokenSession::NoSessionTokenSet] if no session
+          #   token was set (and no request is sent).
+          def logout!
+            connection.delete(FmRest::V1.session_path("dummy-token"))
+          end
+
+          # Logs out the database session for this model (and other models
+          # using the same credentials). Unlike `logout!`, no exception is
+          # raised in case of missing session token.
+          #
+          # @return [Boolean] Whether the logout request was sent (it's only
+          #   sent if a session token was previously set)
+          def logout
+            logout!
+            true
+          rescue FmRest::V1::TokenSession::NoSessionTokenSet
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fmrest/v1/connection.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require "uri"
-require "fmrest/v1/token_session"
-require "fmrest/v1/raise_errors"
 
 module FmRest
   module V1
@@ -21,6 +19,7 @@ module FmRest
       # @option (see #base_connection)
       # @return (see #base_connection)
       def build_connection(options = FmRest.default_connection_settings, &block)
+
         base_connection(options) do |conn|
           conn.use RaiseErrors
           conn.use TokenSession, options
@@ -84,3 +83,6 @@ module FmRest
     end
   end
 end
+
+require "fmrest/v1/token_session"
+require "fmrest/v1/raise_errors"

data/lib/fmrest/v1/token_session.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
+require "fmrest/v1/connection"
+require "fmrest/errors"
+
 module FmRest
   module V1
     # FM Data API authentication middleware using the credentials strategy
     #
     class TokenSession < Faraday::Middleware
+      class NoSessionTokenSet < FmRest::Error; end
+
       HEADER_KEY = "Authorization".freeze
       TOKEN_STORE_INTERFACE = [:load, :store, :delete].freeze
+      LOGOUT_PATH_MATCHER = %r{\A(#{FmRest::V1::Connection::BASE_PATH}/[^/]+/sessions/)[^/]+\Z}.freeze
 
       def initialize(app, options = FmRest.default_connection_settings)
         super(app)
@@ -16,6 +22,8 @@ module FmRest
       # Entry point for the middleware when sending a request
       #
       def call(env)
+        return handle_logout(env) if is_logout_request?(env)
+
         set_auth_header(env)
 
         request_body = env[:body] # After failure env[:body] is set to the response body
@@ -32,6 +40,25 @@ module FmRest
 
       private
 
+      def handle_logout(env)
+        token = token_store.load(token_store_key)
+
+        raise NoSessionTokenSet, "Couldn't send logout request because no session token was set" unless token
+
+        env.url.path = env.url.path.gsub(LOGOUT_PATH_MATCHER, "\\1#{token}")
+
+        @app.call(env).on_complete do |response_env|
+          if response_env[:status] == 200
+            token_store.delete(token_store_key)
+          end
+        end
+      end
+
+      def is_logout_request?(env)
+        return false unless env.method == :delete
+        return env.url.path.match?(LOGOUT_PATH_MATCHER)
+      end
+
       def set_auth_header(env)
         env.request_headers[HEADER_KEY] = "Bearer #{token}"
       end

data/lib/fmrest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FmRest
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2020-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -204,6 +204,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-activesupport-concern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: FileMaker Data API client using Faraday, with optional ActiveRecord-like
   ORM based on Spyke
 email:
@@ -232,6 +246,7 @@ files:
 - lib/fmrest/spyke/model.rb
 - lib/fmrest/spyke/model/associations.rb
 - lib/fmrest/spyke/model/attributes.rb
+- lib/fmrest/spyke/model/auth.rb
 - lib/fmrest/spyke/model/connection.rb
 - lib/fmrest/spyke/model/container_fields.rb
 - lib/fmrest/spyke/model/http.rb