pansophy_authenticator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5389e1b9e496f50d0e02ff349030429e5a05afc2
-  data.tar.gz: 51e58d9bd27a7b1870723408686ec61c0f248e4e
+  metadata.gz: 7af7e60f259d600f0f144d92093cf6e72281e89f
+  data.tar.gz: 19fcf4ca69a64465d75e2a963744ccff2d3738a3
 SHA512:
-  metadata.gz: ba533aef72cc47c5c1cb4aae7d76e158f3d0a6eff8ece870ebed26b62a563fb5b3b6ffdc244ab4ab80e855898f21b515d546cd1ad28bdf3bdb16b7dd689c489e
-  data.tar.gz: 2616febd95f06d566a2a652f89eeed0644e2c8323167f6811ef39716423a779a58471067888be394fa9eccd5a30f5cd7e785ba262dc01c04f3312e8cf2961774
+  metadata.gz: 1aa802262c4c530e651a9a3c32b5237827181c54c550802f3087f902828ad232ac5c0ea8efb0f967d04e6c09e315b38409289b720c383f5877b483cbbf236537
+  data.tar.gz: 617e24f95dec81945c00dd7363351b1c557fcf5a8827e6dd54550699d0c5ed7244f15de7340848e345a525998414765e4ea41c54dcfc65e591e8751a5ee5cf97

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.2.0 (2016-02-02)
+
+Features:
+
+  - caching via cache store
+
+## 0.1.0 (2016-02-01)
+
+Initial release

data/README.md

@@ -90,6 +90,48 @@ AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
 AWS_REGION=ap-southeast-2
 ```
 
+### Caching
+
+By default application keys are cached in memory
+
+The cache can be cleared, forcing the keys to be fetched again on the next request, by calling
+
+```ruby
+PansophyAuthenticator.clear_cached_keys
+```
+
+A different cache store can be specified during initial configuration
+
+```ruby
+PansophyAuthenticator.configure do |configuration|
+  # ... previous configuration options
+  configuration.cache_store = MyCacheStore.new
+end
+```
+
+A cache store must respond to the following methods:
+
+```ruby
+class MyCacheStore
+  def read(key)
+    # Fetches data from the cache, using the given key. 
+    # Returns the data if its in the cache with the given key, nil otherwise.
+  end
+
+  def write(key, value)
+    # Writes the value to the cache for the given key.
+  end
+
+  def delete(key)
+    # Deletes the entry in the cache for the given key.
+  end
+
+  def exist?(key)
+    # Returns true if the cache contains an entry for the given key, false otherwise.
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pansophy_authenticator/application_keys.rb

@@ -4,7 +4,7 @@ module PansophyAuthenticator
   class ApplicationKeys
     include Singleton
 
-    %i(own key valid? validate!).each do |method|
+    %i(own key valid? validate! clear_cache).each do |method|
       define_singleton_method(method) { |*args| instance.send(method, *args) }
     end
 
@@ -24,17 +24,29 @@ module PansophyAuthenticator
       matcher(application).validate!(key)
     end
 
+    def clear_cache
+      cache.delete
+    end
+
     private
 
     def matcher(application)
-      Matcher.new(retriever.instance.keys, application)
+      Matcher.new(keys, application)
+    end
+
+    def keys
+      cache.fetch { fetcher.keys }
+    end
+
+    def cache
+      Cache.new(configuration.cache_store)
     end
 
-    def retriever
+    def fetcher
       if PansophyAuthenticator.remote?
-        Remote::ApplicationKeys
+        Remote::Fetcher.new
       else
-        Local::ApplicationKeys
+        Local::Fetcher.new
       end
     end
 

data/lib/pansophy_authenticator/cache.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module PansophyAuthenticator
+  class Cache
+    CACHE_KEY = 'pansophy_authenticator_application_keys'.freeze
+
+    def initialize(cache_store)
+      @cache_store = cache_store
+    end
+
+    def read
+      @cache_store.read CACHE_KEY
+    end
+
+    def write(value)
+      @cache_store.write CACHE_KEY, value
+    end
+
+    def delete
+      @cache_store.delete CACHE_KEY
+    end
+
+    def exist?
+      @cache_store.exist? CACHE_KEY
+    end
+
+    def fetch
+      return read if exist?
+      return nil unless block_given?
+      yield(CACHE_KEY).tap do |value|
+        write(value)
+      end
+    end
+  end
+end

data/lib/pansophy_authenticator/cache_stores/memory.rb

@@ -0,0 +1,25 @@
+module PansophyAuthenticator
+  module CacheStores
+    class Memory
+      def initialize
+        @hash = {}
+      end
+
+      def read(key)
+        @hash[key.to_s]
+      end
+
+      def write(key, value)
+        @hash[key.to_s] = value
+      end
+
+      def delete(key)
+        @hash.delete(key.to_s)
+      end
+
+      def exist?(key)
+        @hash.key?(key.to_s)
+      end
+    end
+  end
+end

data/lib/pansophy_authenticator/configuration/configurator.rb

@@ -2,24 +2,43 @@ module PansophyAuthenticator
   module Configuration
     class Configurator
       attr_accessor :local, :bucket_name, :file_path, :configuration_path, :application
+      attr_writer :cache_store
 
       def configuration
-        from_env
+        build_configuration
+      end
+
+      def cache_store
+        @cache_store ||= CacheStores::Memory.new
       end
 
       private
 
+      def build_configuration
+        Instance.new(
+          local:       config_values.local,
+          bucket_name: config_values.bucket_name,
+          file_path:   config_values.file_path,
+          application: config_values.application,
+          cache_store: cache_store
+        )
+      end
+
+      def config_values
+        @config_values ||= from_env
+      end
+
       def base_config
         return self if @configuration_path.nil?
         from_file
       end
 
       def from_file
-        FromFile.new(self).configuration
+        FromFile.new(self)
       end
 
       def from_env
-        FromEnv.new(base_config).configuration
+        FromEnv.new(base_config)
       end
     end
   end

data/lib/pansophy_authenticator/configuration/from_env.rb

@@ -5,17 +5,6 @@ module PansophyAuthenticator
         @base_configuration = base_configuration
       end
 
-      def configuration
-        Instance.new(
-          local:       local,
-          bucket_name: bucket_name,
-          file_path:   file_path,
-          application: application
-        )
-      end
-
-      private
-
       def local
         local = ENV.fetch('PANSOPHY_AUTHENTICATOR_LOCAL') { @base_configuration.local }
         local.to_s == 'true'

data/lib/pansophy_authenticator/configuration/from_file.rb

@@ -13,17 +13,6 @@ module PansophyAuthenticator
         @base_configuration = base_configuration
       end
 
-      def configuration
-        Instance.new(
-          local:       local,
-          bucket_name: bucket_name,
-          file_path:   file_path,
-          application: application
-        )
-      end
-
-      private
-
       def local
         content.fetch('local') { @base_configuration.local }
       end
@@ -40,6 +29,8 @@ module PansophyAuthenticator
         content.fetch('application') { @base_configuration.application }
       end
 
+      private
+
       def pathname
         Pathname.new(@base_configuration.configuration_path)
       end

data/lib/pansophy_authenticator/configuration/instance.rb

@@ -3,7 +3,7 @@ require 'anima'
 module PansophyAuthenticator
   module Configuration
     class Instance
-      include Anima.new(:local, :bucket_name, :file_path, :application)
+      include Anima.new :local, :bucket_name, :file_path, :application, :cache_store
 
       def local?
         @local

data/lib/pansophy_authenticator/local/{application_keys.rb → build_loader.rb}

@@ -1,15 +1,13 @@
-require 'singleton'
 require 'memoizable'
 require 'yamload'
 
 module PansophyAuthenticator
   module Local
-    class ApplicationKeys
-      include Singleton
+    class BuildLoader
       include Memoizable
 
-      def keys
-        content
+      def call
+        Yamload::Loader.new(filename, dirname)
       end
 
       private
@@ -27,15 +25,6 @@ module PansophyAuthenticator
         pathname.basename('.yml')
       end
 
-      def content
-        loader.content
-      end
-      memoize :content
-
-      def loader
-        Yamload::Loader.new(filename, dirname)
-      end
-
       def configuration
         PansophyAuthenticator.configuration
       end

data/lib/pansophy_authenticator/local/fetcher.rb

@@ -0,0 +1,15 @@
+module PansophyAuthenticator
+  module Local
+    class Fetcher
+      def keys
+        loader.content
+      end
+
+      private
+
+      def loader
+        @loader ||= BuildLoader.new.call
+      end
+    end
+  end
+end

data/lib/pansophy_authenticator/local.rb

@@ -3,4 +3,5 @@ module PansophyAuthenticator
   end
 end
 
-require 'pansophy_authenticator/local/application_keys'
+require 'pansophy_authenticator/local/build_loader'
+require 'pansophy_authenticator/local/fetcher'

data/lib/pansophy_authenticator/remote/{application_keys.rb → fetcher.rb}

@@ -1,20 +1,18 @@
-require 'singleton'
-require 'memoizable'
 require 'pansophy'
 
 module PansophyAuthenticator
   module Remote
-    class ApplicationKeys
-      include Singleton
-      include Memoizable
-
+    class Fetcher
       def keys
-        Pansophy.read(configuration.bucket_name, configuration.file_path)
+        @keys ||= fetch
       end
-      memoize :keys
 
       private
 
+      def fetch
+        Pansophy.read(configuration.bucket_name, configuration.file_path)
+      end
+
       def configuration
         PansophyAuthenticator.configuration
       end

data/lib/pansophy_authenticator/remote.rb

@@ -3,4 +3,4 @@ module PansophyAuthenticator
   end
 end
 
-require 'pansophy_authenticator/remote/application_keys'
+require 'pansophy_authenticator/remote/fetcher'

data/lib/pansophy_authenticator/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module PansophyAuthenticator
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/pansophy_authenticator.rb

@@ -23,6 +23,10 @@ module PansophyAuthenticator
     ApplicationKeys.validate!(application, key)
   end
 
+  def self.clear_cached_keys
+    ApplicationKeys.clear_cache
+  end
+
   %i(key valid?).each do |method|
     define_singleton_method(method) { |*args| ApplicationKeys.send(method, *args) }
   end
@@ -35,3 +39,5 @@ require 'pansophy_authenticator/application_keys'
 require 'pansophy_authenticator/matcher'
 require 'pansophy_authenticator/local'
 require 'pansophy_authenticator/remote'
+require 'pansophy_authenticator/cache_stores/memory'
+require 'pansophy_authenticator/cache'

data/pansophy_authenticator.gemspec

@@ -28,15 +28,16 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'memoize', '~> 1.3'
   spec.add_dependency 'anima', '~> 0.3'
-  spec.add_dependency 'pansophy', '~> 0.2.6'
-  spec.add_dependency 'yamload', '~> 0.2.1'
+  spec.add_dependency 'pansophy', '~> 0.3'
+  spec.add_dependency 'yamload', '~> 0.2'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'simplecov-rcov'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'travis'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'timecop', '~> 0.8'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'simplecov-rcov', '~> 0.2'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'rubocop', '~> 0.36'
+  spec.add_development_dependency 'travis', '~> 1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pansophy_authenticator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alessandro Berardi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoize
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: yamload
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,84 +100,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.36'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 description: By configuring a set of applications authentication keys in a filestored
   in an S3 bucket, applications can authenticate with each otherby submitting their
   authentication key, which the receiver can matchagainst the key stored in S3.S3
@@ -193,6 +207,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -202,16 +217,19 @@ files:
 - bin/setup
 - lib/pansophy_authenticator.rb
 - lib/pansophy_authenticator/application_keys.rb
+- lib/pansophy_authenticator/cache.rb
+- lib/pansophy_authenticator/cache_stores/memory.rb
 - lib/pansophy_authenticator/configuration.rb
 - lib/pansophy_authenticator/configuration/configurator.rb
 - lib/pansophy_authenticator/configuration/from_env.rb
 - lib/pansophy_authenticator/configuration/from_file.rb
 - lib/pansophy_authenticator/configuration/instance.rb
 - lib/pansophy_authenticator/local.rb
-- lib/pansophy_authenticator/local/application_keys.rb
+- lib/pansophy_authenticator/local/build_loader.rb
+- lib/pansophy_authenticator/local/fetcher.rb
 - lib/pansophy_authenticator/matcher.rb
 - lib/pansophy_authenticator/remote.rb
-- lib/pansophy_authenticator/remote/application_keys.rb
+- lib/pansophy_authenticator/remote/fetcher.rb
 - lib/pansophy_authenticator/version.rb
 - pansophy_authenticator.gemspec
 homepage: https://github.com/sealink/pansophy_authenticator