lifen 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f5c85c29e8ab9cc7f36987098d50f12a5beb96d
-  data.tar.gz: 74e319a77102bbc00630fa6f24acdec72d4ee789
+  metadata.gz: 48d8b72c4e7250d82b16d02e3f58f1f160e06289
+  data.tar.gz: ea331938beaafdf10c457464a141b77af6c71713
 SHA512:
-  metadata.gz: b6c8d52af33bb08e5c3926d8bbee08edbd50e6da9ded2303fe62f5b917e6c85c4e955d9233414f2ea79ab702624ef68589f16fe0c168f7e51aba58d68027ee32
-  data.tar.gz: 436d77f9de97847cf494d0336646a98a958ec12333bf9df5eaf7930d965e8b538fbba24da4d3338b4980fa2ba5986ec331756670f88a37b428c806cc96dc19d6
+  metadata.gz: bf51797de230eb1f6abc04cf09e858d8d72461eaed547919b4d3e7f04164209e8fc5fb272e3194e30ad583bee3d746988efecb169ba02b093db304c286b8ddf0
+  data.tar.gz: 2d855c4608cd0c93bda9b4d3fe47079d959f9986531e9e08f66fa095cd23cdb5ed35f7d6fbab214c280c50b3b64f43f5eec08af20b5205abb4ff0ce9cf79350d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+1.1.0
+-----
+
+- Added the `expiration_margin` configuration to force refresh soon-to-be-expired tokens
+- Check the validity of the provided URL [#1]
+
 1.0.2
 -----
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifen (1.0.2)
+    lifen (1.1.0)
       faraday (>= 0.9)
       inflecto
       virtus (>= 1.0)

data/README.md

@@ -6,7 +6,9 @@ Lifen is a ruby client for [Lifen](https://www.lifen.fr/) JSON API.
 
 Add this line to your application's Gemfile:
 
-    gem 'lifen'
+```ruby
+gem 'lifen'
+```
 
 And then execute:
 
@@ -22,38 +24,53 @@ Or install it yourself as:
 
 Lifen can be configured (ideally inside an initializer) like so:
 
-    Lifen.configure do |config|
-      config.site                      = "https://develop.lifen.fr/"
-      config.application_access_token  = "application_access_token"
-      config.proxy_url                 = "http://my.proxy.fr/"
-    end
+```ruby
+Lifen.configure do |config|
+  config.site                      = "https://develop.lifen.fr/"
+  config.application_access_token  = "application_access_token"
+  
+  # optionnal
+  config.proxy_url                 = "http://my.proxy.fr/" 
+  config.expiration_margin         = 60 # in seconds, default: 0
+end
+```
 
-`site` and `application_access_token` are mandatory attributes.
+Optionnal configuration:
+
+- `proxy_url`: enables you to route all your requests via a proxy
+- `expiration_margin`: by default a token is considered valid until the expiration time but you can add a security expiration margin
 
 ### Managing users
 
-    user = Lifen::User.new(email: "email@domain.tld", first_name: "Jean", last_name: "Dupont")
-    user.create
-    user.token.refresh
-    user.status.refresh
+```ruby
+user = Lifen::User.new(email: "email@domain.tld", first_name: "Jean", last_name: "Dupont")
+user.create
+user.token.refresh
+user.status.refresh
+```
 
 ### Managing flows
 
-    user = Lifen::User.new(uuid: "valid_uuid")
-    user.flows
+```ruby
+user = Lifen::User.new(uuid: "valid_uuid")
+user.flows
 
-    flow = Lifen::Flow.new(user: user, title: "honestica Rocks !")
-    flow.create
-    flow.attach_users(user)
-    flow.detach_users(user)
+flow = Lifen::Flow.new(user: user, title: "honestica Rocks !")
+flow.create
+flow.attach_users(user)
+flow.detach_users(user)
 
-    flow = Lifen::Flow.new(user: user, title: "honestica Rocks !", users: [user_1, user_2])
-    flow.create
+# alternate strategy
+flow = Lifen::Flow.new(user: user, title: "honestica Rocks !", users: [user_1, user_2])
+flow.create
+```
 
 ### Managing messages
 
-    message = Lifen::Message.new(flow: flow, content: "Hello World !")
-    message.create
+```ruby
+message = Lifen::Message.new(flow: flow, content: "Hello World !")
+message.create
+```
 
 ## Contributing
 

data/lib/lifen/configuration.rb

@@ -1,10 +1,24 @@
 module Lifen
   class Configuration
-    attr_accessor :site, :application_access_token, :proxy_url
+    attr_accessor :site, :application_access_token, :proxy_url, :expiration_margin
+
+    def initialize(args)
+       args.each do |k,v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    def site=(url)
+      if !/(.*)\/$/.match(url)
+        raise Lifen::Error, "Invalid 'site' provided in configuration: '#{url}', a trailing slash is missing"
+      end
+
+      @site = url
+    end
   end
 
   def self.configuration
-    @configuration ||= Configuration.new
+    @configuration ||= Configuration.new(expiration_margin: 0)
   end
 
   def self.configure

data/lib/lifen/token.rb

@@ -12,13 +12,19 @@ module Lifen
     end
 
     def active?
-      valid? and !has_expired?
+      valid? and !needs_to_be_refreshed?
     end
 
     def valid?
       !value.nil? and value.length > 0 and !expires_at.nil?
     end
 
+    def needs_to_be_refreshed?
+      return true if has_expired?
+
+      return (expires_at - expiration_margin) < Time.now.to_i
+    end
+
     def has_expired?
       return true if expires_at.nil?
 
@@ -46,5 +52,9 @@ module Lifen
         @client ||= AppAuthenticatedClient.new
       end
 
+      def expiration_margin
+        Lifen.configuration.expiration_margin
+      end
+
   end
 end

data/lib/lifen/version.rb

@@ -1,3 +1,3 @@
 module Lifen
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Lifen::Configuration do
+
+  describe ':site' do
+
+    context 'invalid site' do
+
+      let(:invalid_site) { "http://website.fr" }
+
+      it 'raises an error' do
+        expect{
+          Lifen.configure do |config|
+            config.site = invalid_site
+          end
+        }.to raise_error(Lifen::Error, "Invalid 'site' provided in configuration: 'http://website.fr', a trailing slash is missing")
+      end
+    end
+
+  end
+
+end

data/spec/token_spec.rb

@@ -2,16 +2,66 @@ require 'spec_helper'
 
 describe Lifen::Token do
 
+  describe ':needs_to_be_refreshed?' do
+
+    context 'default configuration' do
+      it 'knows when a token needs to be refreshed' do
+        token = Lifen::Token.new(value: "valid_token", expires_at: Time.now.to_i + 120)
+
+        expect(token.needs_to_be_refreshed?).to be_falsy
+      end
+
+      it 'knows when a token needs to be refreshed' do
+        token = Lifen::Token.new(value: "valid_token", expires_at: Time.now.to_i + 40)
+
+        expect(token.needs_to_be_refreshed?).to be_falsy
+      end
+    end
+
+    context 'custom configuration' do
+      before do
+        Lifen.configure do |config|
+          config.expiration_margin = 60
+        end
+      end
+
+      it 'knows when a token needs to be refreshed' do
+        token = Lifen::Token.new(value: "valid_token", expires_at: Time.now.to_i + 120)
+
+        expect(token.needs_to_be_refreshed?).to be_falsy
+      end
+
+      it 'knows when a token needs to be refreshed' do
+        token = Lifen::Token.new(value: "valid_token", expires_at: Time.now.to_i + 40)
+
+        expect(token.needs_to_be_refreshed?).to be_truthy
+      end
+
+      it 'refreshs the token' do
+        token = Lifen::Token.new(value: "valid_token", expires_at: Time.now.to_i + 40)
+
+        expect(token).to receive(:refresh) do
+          token.expires_at = Time.now.to_i + 120
+        end
+
+        token.refresh_once_if_needed
+      end
+    end
+
+  end
+
   describe 'expired token' do
 
     let(:expired_token)   { Lifen::Token.new(value: "valid_token", expires_at: Time.now.to_i - 60) }
 
-    it 'refreshs the token' do
-      expect(expired_token).to receive(:refresh) do
-        expired_token.expires_at = Time.now.to_i + 60
-      end
+    context ':refresh_once_if_needed' do
+      it 'refreshs the token' do
+        expect(expired_token).to receive(:refresh) do
+          expired_token.expires_at = Time.now.to_i + 60
+        end
 
-      expired_token.refresh_once_if_needed
+        expired_token.refresh_once_if_needed
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lifen
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Etienne Depaulis
@@ -186,6 +186,7 @@ files:
 - spec/cassettes/users/status/refresh/valid_token.yml
 - spec/cassettes/users/token/refresh/invalid_user_uuid.yml
 - spec/cassettes/users/token/refresh/valid_user_uuid.yml
+- spec/configuration_spec.rb
 - spec/flows_spec.rb
 - spec/messages_spec.rb
 - spec/spec_helper.rb
@@ -235,6 +236,7 @@ test_files:
 - spec/cassettes/users/status/refresh/valid_token.yml
 - spec/cassettes/users/token/refresh/invalid_user_uuid.yml
 - spec/cassettes/users/token/refresh/valid_user_uuid.yml
+- spec/configuration_spec.rb
 - spec/flows_spec.rb
 - spec/messages_spec.rb
 - spec/spec_helper.rb