esi 0.2.34 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 062220cdbbcb83eb80529009f74272754fcd939b
-  data.tar.gz: '0957dd64a0549ee45d5e8ec383c7e2e71975bf92'
+  metadata.gz: e1c7c9881ffd3be2d8d42fa51cf9e4ba6828cb3c
+  data.tar.gz: 0c3cf816d472ef63c6d071a8ee6589cbc4e58e8f
 SHA512:
-  metadata.gz: 719ca8eb1fc4ace7c04b7c38a0447e732cf2bee75d0c16a00e73f46a96d97f09d7a26353cfed0de9e3ac4bcefc574a2d113959a9b6b37a426e12ddd1a99c046b
-  data.tar.gz: f4ccc8bf6046dc2949095a200323e7747502d671d235f7e53f11fecd29dc9ff76cbcc82ddaca98d25ef5e8db8279f909bb189844bb08362971b08d443789eb45
+  metadata.gz: d801070c1264b959f51312455eabfb010c3ee37b49edbed942f8d0e2a531946aaa42de24d98d4c5fd228e77df19a244f60800e7e934bb08790c47702741d4892
+  data.tar.gz: c5acc9810725635caf1cab02facd1c144be550f6110398fcaef533d53b852b54fee7b3116d1d9957e0d75e3c835c266fe53f39842039cac87f422cc59810fea9

data/README.md

@@ -1,5 +1,7 @@
 # Esi
 
+[![TravisCI build status](https://travis-ci.org/dhiemstra/esi.svg?branch=master)](https://travis-ci.org/dhiemstra/esi)
+
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/esi`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 TODO: Delete this and the text above, and describe your gem
@@ -22,7 +24,7 @@ Or install it yourself as:
 
 ## Usage
 
-    esi = Esi::Client.new(token: 'YOUR_TOKEN', refresh_token: 'REFRESH_TOKEN', token_expires_at: EXPIRE_TIMESTAMP)
+    esi = Esi::Client.new(token: 'YOUR_TOKEN', refresh_token: 'REFRESH_TOKEN', expires_at: EXPIRE_TIMESTAMP)
     esi.character()
 
 ### You can optionally specify a callback that will be executed after a new token has been received using the refresh token
@@ -57,3 +59,6 @@ Create a file `config/initializers/esi.rb` with the following options:
 
     # Save all responses in this folder
     Esi.config.response_log_path = Rails.root.join('tmp', 'esi')
+
+    # Enable Caching
+    Esi.config.cache = Rails.cache

data/lib/esi/calls.rb

@@ -54,7 +54,7 @@ module Esi
 
     class Regions < Base
       def initialize
-        @path = "/universe/regions/#{region_id}"
+        @path = "/universe/regions/"
       end
     end
 
@@ -66,7 +66,7 @@ module Esi
 
     class Constellations < Base
       def initialize
-        @path = "/universe/constellations"
+        @path = "/universe/constellations/"
       end
     end
 
@@ -82,6 +82,54 @@ module Esi
       end
     end
 
+    class SolarSystems < Base
+      def initialize
+        @path = "/universe/systems/"
+      end
+    end
+
+    class Star < Base
+      def initialize(star_id)
+        @path = "/universe/stars/#{star_id}"
+      end
+    end
+
+    class Planet < Base
+      def initialize(planet_id)
+        @path = "/universe/planets/#{planet_id}"
+      end
+    end
+
+    class Moon < Base
+      def initialize(moon_id)
+        @path = "/universe/moons/#{moon_id}"
+      end
+    end
+
+    class Stargate < Base
+      def initialize(stargate_id)
+        @path = "/universe/stargates/#{stargate_id}"
+      end
+    end
+
+    class Station < Base
+      def initialize(station_id)
+        @path = "/universe/stations/#{station_id}"
+      end
+    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 Types < Base
       def initialize
         @path = "/universe/types"
@@ -95,6 +143,30 @@ module Esi
       end
     end
 
+    class DogmaAttributes < Base
+      def initialize
+        @path = "/dogma/attributes/"
+      end
+    end
+
+    class DogmaAttribute < Base
+      def initialize(attribute_id)
+        @path = "/dogma/attributes/#{attribute_id}"
+      end
+    end
+
+    class DogmaEffects < Base
+      def initialize
+        @path = "/dogma/effects/"
+      end
+    end
+
+    class DogmaEffect < Base
+      def initialize(effect_id)
+        @path = "/dogma/effects/#{effect_id}"
+      end
+    end
+
     class IndustryFacilities < Base
       self.scope = nil
       self.cache_duration = 3600

data/lib/esi/client.rb

@@ -1,3 +1,6 @@
+require 'active_support/core_ext/string'
+require 'set'
+
 module Esi
   class Client
     MAX_ATTEMPTS = 2
@@ -7,7 +10,7 @@ module Esi
 
     def initialize(token: nil, refresh_token: nil, expires_at: nil)
       @logger = Esi.logger
-      @token = token
+      @access_token = token
       @refresh_token = refresh_token
       @expires_at = expires_at
     end
@@ -15,16 +18,28 @@ module Esi
     def method_missing(name, *args, &block)
       klass = nil
       ActiveSupport::Notifications.instrument('esi.client.detect_call') do
-        class_name = name.to_s.split('_').map(&:capitalize).join
+        class_name = method_to_class_name name
         begin
           klass = Esi::Calls.const_get(class_name)
         rescue NameError
           super(name, *args, &block)
         end
       end
+      cached_response(klass, *args, &block)
+    end
 
-      call = klass.new(*args)
-      call.paginated? ? request_paginated(call, &block) : request(call, &block)
+    def method?(name)
+      begin
+        klass = Esi::Calls.const_get(method_to_class_name(name))
+      rescue NameError
+        return false
+      end
+      !klass.nil?
+    end
+
+    def plural_method?(name)
+      plural = name.to_s.pluralize.to_sym
+      method? plural
     end
 
     def log(message)
@@ -37,13 +52,30 @@ module Esi
 
     private
 
+    def make_call(call, &block)
+      call.paginated? ? request_paginated(call, &block) : request(call, &block)
+    end
+
+    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
+        make_call(call, &block)
+      end
+    end
+
+    def method_to_class_name(name)
+      name.dup.to_s.split('_').map(&:capitalize).join
+    end
+
     def oauth
       @oauth ||= OAuth.new(
-        access_token: @token,
+        access_token: @access_token,
         refresh_token: @refresh_token,
         expires_at: @expires_at,
         callback: -> (token, expires_at) {
-          @token = token
+          @access_token = token
           @expires_at = expires_at
           if refresh_callback.respond_to?(:call)
             refresh_callback.call(token, expires_at)

data/lib/esi/version.rb

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

data/lib/esi.rb

@@ -5,7 +5,7 @@ require "addressable/uri"
 require "active_support/notifications"
 
 module Esi
-  autoload :Version,     'esi/version'
+  autoload :VERSION,     'esi/version'
   autoload :AccessToken, 'esi/access_token'
   autoload :OAuth,       'esi/o_auth'
   autoload :Calls,       'esi/calls'
@@ -70,6 +70,7 @@ module Esi
     timeout: 60,
     client_id: nil,
     client_secret: nil,
+    cache: nil,
     scopes: SCOPES
   }
 
@@ -86,6 +87,10 @@ module Esi
       end
     end
 
+    def cache
+      Esi.config.cache
+    end
+
     def api_version
       @api_version || :latest
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esi
 version: !ruby/object:Gem::Version
-  version: 0.2.34
+  version: 0.3.6
 platform: ruby
 authors:
 - Danny Hiemstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2