esi 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c7c9881ffd3be2d8d42fa51cf9e4ba6828cb3c
-  data.tar.gz: 0c3cf816d472ef63c6d071a8ee6589cbc4e58e8f
+  metadata.gz: d47a1c60590cea3b27c56f4024cc40def5fe7c00
+  data.tar.gz: eaee95bd3df0a5899d39fffb81c78d805f803bfe
 SHA512:
-  metadata.gz: d801070c1264b959f51312455eabfb010c3ee37b49edbed942f8d0e2a531946aaa42de24d98d4c5fd228e77df19a244f60800e7e934bb08790c47702741d4892
-  data.tar.gz: c5acc9810725635caf1cab02facd1c144be550f6110398fcaef533d53b852b54fee7b3116d1d9957e0d75e3c835c266fe53f39842039cac87f422cc59810fea9
+  metadata.gz: c91589ff35b7c1779d97f181967dbd8b5becb0176862674086f134cf647581946b5a6e33c34830c030e3c827c876d7a74e681d0c9721617c9337d8045ff1061c
+  data.tar.gz: fc1779a7ac22b08b19789075f5d6029d60c29cc3468d19b5c01206e6d487d5aafe0a0966351a417dd91f1c23db3f836d0a0fcbce75f25a5fbd876d54e099696e

data/README.md

@@ -57,8 +57,13 @@ Create a file `config/initializers/esi.rb` with the following options:
     # Set esi api version to dev
     Esi.config.api_version = :dev
 
-    # Save all responses in this folder
+    # Save all raw JSON responses in this folder
     Esi.config.response_log_path = Rails.root.join('tmp', 'esi')
 
-    # Enable Caching
+# Caching
+
+ESI will cache API requests that auto expire based on the `Expires-At` header returned by ESI. By default [`ActiveSupport::Cache::MemoryStore`](http://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html) is used. When using Rails you can configure ESI to use the cache configured in your app by setting the `cache` config variable.
+
     Esi.config.cache = Rails.cache
+
+To disable caching you can set this value to `nil`.

data/lib/esi.rb

@@ -2,7 +2,10 @@ require "oauth2"
 require "forwardable"
 require "ostruct"
 require "addressable/uri"
+require "active_support/cache"
 require "active_support/notifications"
+require 'active_support/core_ext/string'
+require "active_support/core_ext/class/attribute"
 
 module Esi
   autoload :VERSION,     'esi/version'
@@ -70,12 +73,12 @@ module Esi
     timeout: 60,
     client_id: nil,
     client_secret: nil,
-    cache: nil,
+    cache: ActiveSupport::Cache::MemoryStore.new,
     scopes: SCOPES
   }
 
   class << self
-    attr_writer :api_version, :logger
+    attr_writer :api_version, :config, :logger, :cache
 
     def config
       @config ||= OpenStruct.new(DEFAULT_CONFIG)
@@ -88,7 +91,11 @@ module Esi
     end
 
     def cache
-      Esi.config.cache
+      if Esi.config.cache.nil?
+        @cache ||= ActiveSupport::Cache::NullStore.new
+      else
+        Esi.config.cache
+      end
     end
 
     def api_version

data/lib/esi/calls.rb

@@ -34,6 +34,14 @@ module Esi
 
       attr_accessor :path, :params
 
+      def name
+        @name ||= self.class.name.remove('Esi::Calls::').underscore.to_sym
+      end
+
+      def cache_key
+        @cache_key ||= ActiveSupport::Cache.expand_cache_key([name, params].flatten, :esi)
+      end
+
       def method
         @method ||= :get
       end
@@ -497,18 +505,6 @@ module Esi
       self.cache_duration = 300
     end
 
-    class Structures < Base
-      def initialize
-        @path = "/universe/structures"
-      end
-    end
-
-    class Structure < Base
-      def initialize(structure_id)
-        @path = "/universe/structures/#{structure_id}"
-      end
-    end
-
     class Route < Base
       def initialize(origin_id, destination_id)
         @path = "/route/#{origin_id}/#{destination_id}"

data/lib/esi/client.rb

@@ -1,6 +1,3 @@
-require 'active_support/core_ext/string'
-require 'set'
-
 module Esi
   class Client
     MAX_ATTEMPTS = 2
@@ -58,9 +55,7 @@ module Esi
 
     def cached_response(klass, *args, &block)
       call = klass.new(*args)
-      return make_call(call, &block) unless Esi.cache
-      cache_key = [klass.name, args].flatten.to_set.hash
-      Esi.cache.fetch(cache_key, expires_in: klass.cache_duration) do
+      Esi.cache.fetch(call.cache_key, expires_in: klass.cache_duration) do
         make_call(call, &block)
       end
     end

data/lib/esi/version.rb

@@ -1,3 +1,3 @@
 module Esi
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: esi
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Hiemstra