esi 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5d0ba8745382e4dc76d80883f103938d1db197f
-  data.tar.gz: 86b2d0155c58f106b2115ae636cd9dcf152b667d
+  metadata.gz: 7cca478fd5427ecdcc25baebef64a0a6fd4f0f74
+  data.tar.gz: b61b8a1527217628dd0644b49668f31e0011ee79
 SHA512:
-  metadata.gz: 495ca804fd67f4e55a327a9e6990613ab9cb36682d921c8913413c2e2ff8b4b161bac61e4536441817a75cb94f6740dba3b2059f7cde0fac8b970f83dd554d48
-  data.tar.gz: 3117e5bf411a9808f9fcbc621df104e79d2c9527e567975723c7500b0ec3d96a2b3717ceaa33e8b2dc7c0b854d51b92f02d5034723009918ebcf2d931aaa2e54
+  metadata.gz: 8e33ddf6dae4e6c65876e528cf4f7e4fe6b3fc5df725ba0660d4d9e50f8cdab47d45dc25c0d958281f4d75391d3029ada2ff2fb509aed49255dccc998af07e54
+  data.tar.gz: 45a8329ca80fa71af75a9406f6fddd66d27847f8a6fd0021740285ceca63feb8db09ed90f018c7c50057af8db36e7cb93c1a89278ea4d53998fdd2fa8798fed8

data/README.md

@@ -27,7 +27,7 @@ Or install it yourself as:
 
 ### You can optionally specify a callback that will be executed after a new token has been received using the refresh token
 
-    esi.refresh_callback = ~> (token, expires_at) {
+    esi.refresh_callback = -> (token, expires_at) {
       # save new token & expires at
     }
 

data/esi.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "oauth2", "~> 1.2"
   spec.add_dependency "addressable", "~> 2.3"
   spec.add_dependency "recursive-open-struct", "~> 1"
+  spec.add_dependency "activesupport"
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

data/lib/esi.rb

@@ -2,6 +2,7 @@ require "oauth2"
 require "forwardable"
 require "ostruct"
 require "addressable/uri"
+require "active_support/notifications"
 
 module Esi
   autoload :Version,     'esi/version'
@@ -12,47 +13,51 @@ module Esi
   autoload :Response,    'esi/response'
 
   SCOPES = %w(
-    esi-calendar.respond_calendar_events.v1
+    esi-assets.read_assets.v1
+    esi-bookmarks.read_character_bookmarks.v1
     esi-calendar.read_calendar_events.v1
+    esi-calendar.respond_calendar_events.v1
+    esi-characters.read_agents_research.v1
+    esi-characters.read_blueprints.v1
+    esi-characters.read_chat_channels.v1
+    esi-characters.read_contacts.v1
+    esi-characters.read_corporation_roles.v1
+    esi-characters.read_fatigue.v1
+    esi-characters.read_loyalty.v1
+    esi-characters.read_medals.v1
+    esi-characters.read_opportunities.v1
+    esi-characters.read_standings.v1
+    esi-characters.write_contacts.v1
+    esi-clones.read_clones.v1
+    esi-clones.read_implants.v1
+    esi-contracts.read_character_contracts.v1
+    esi-corporations.read_corporation_membership.v1
+    esi-corporations.read_structures.v1
+    esi-corporations.track_members.v1
+    esi-corporations.write_structures.v1
+    esi-fittings.read_fittings.v1
+    esi-fittings.write_fittings.v1
+    esi-fleets.read_fleet.v1
+    esi-fleets.write_fleet.v1
+    esi-industry.read_character_jobs.v1
+    esi-killmails.read_killmails.v1
     esi-location.read_location.v1
+    esi-location.read_online.v1
     esi-location.read_ship_type.v1
     esi-mail.organize_mail.v1
     esi-mail.read_mail.v1
     esi-mail.send_mail.v1
-    esi-skills.read_skills.v1
-    esi-skills.read_skillqueue.v1
-    esi-wallet.read_character_wallet.v1
-    esi-search.search_structures.v1
-    esi-clones.read_clones.v1
-    esi-characters.read_contacts.v1
-    esi-universe.read_structures.v1
-    esi-bookmarks.read_character_bookmarks.v1
-    esi-killmails.read_killmails.v1
-    esi-corporations.read_corporation_membership.v1
-    esi-assets.read_assets.v1
+    esi-markets.read_character_orders.v1
+    esi-markets.structure_markets.v1
     esi-planets.manage_planets.v1
-    esi-fleets.read_fleet.v1
-    esi-fleets.write_fleet.v1
+    esi-search.search_structures.v1
+    esi-skills.read_skillqueue.v1
+    esi-skills.read_skills.v1
     esi-ui.open_window.v1
     esi-ui.write_waypoint.v1
-    esi-characters.write_contacts.v1
-    esi-fittings.read_fittings.v1
-    esi-fittings.write_fittings.v1
-    esi-markets.structure_markets.v1
-    esi-corporations.read_structures.v1
-    esi-corporations.write_structures.v1
-    esi-characters.read_loyalty.v1
-    esi-characters.read_opportunities.v1
-    esi-characters.read_chat_channels.v1
-    esi-characters.read_medals.v1
-    esi-characters.read_standings.v1
-    esi-characters.read_agents_research.v1
-    esi-industry.read_character_jobs.v1
-    esi-markets.read_character_orders.v1
-    esi-characters.read_blueprints.v1
-    esi-characters.read_corporation_roles.v1
-    esi-location.read_online.v1
-    esi-contracts.read_character_contracts.v1
+    esi-universe.read_structures.v1
+    esi-wallet.read_character_wallet.v1
+    esi-wallet.read_corporation_wallets.v1
   )
   DEFAULT_CONFIG = {
     datasource: :tranquility,

data/lib/esi/calls.rb

@@ -1,6 +1,8 @@
 module Esi
   class Calls
     class Base
+      class_attribute :scope
+      class_attribute :cache_duration
       attr_accessor :path, :params
 
       def method
@@ -21,14 +23,6 @@ module Esi
       end
     end
 
-    class OpenMarketDetails < Base
-      def initialize(type_id)
-        @path = "/ui/openwindow/marketdetails"
-        @method = :post
-        @params = { type_id: type_id }
-      end
-    end
-
     class SolarSystem < Base
       def initialize(system_id)
         @path = "/universe/systems/#{system_id}"
@@ -55,126 +49,164 @@ module Esi
       end
     end
 
-    class Characters < Base
-      def initialize(character_ids)
-        @path = "/characters/names"
-        @params = { character_ids: character_ids.join(',') }
+    class StructureOrders < Base
+      def initialize(structure_id:)
+        @path = "/markets/structures/#{structure_id}"
+        @paginated = true
+      end
+    end
+
+    class MarketHistory < Base
+      def initialize(type_id:, region_id: Region::FORGE)
+        @path = "/markets/#{region_id}/history"
+        @params = { type_id: type_id }
       end
     end
 
     class CharacterNames < Base
+      self.cache_duration = 3600
+
       def initialize(character_ids)
         @path = "/characters/names"
         @params = { character_ids: character_ids.join(',') }
       end
     end
 
-    # Link: https://esi.tech.ccp.is/latest/#!/Character/get_characters_character_id
-    # Cache: 1 hour
     class Character < Base
+      self.cache_duration = 3600
+
       def initialize(character_id)
         @path = "/characters/#{character_id}"
       end
     end
 
-    # Link: https://esi.tech.ccp.is/dev/#!/Wallet/get_characters_character_id_wallet
-    # Scope: esi-wallet.read_character_wallet.v1
     # Cache: 2 minutes
     class CharacterWallet < Base
+      self.scope = 'esi-wallet.read_character_wallet.v1'
+      self.cache_duration = 120
+
       def initialize(character_id)
         @path = "/characters/#{character_id}/wallet"
       end
     end
 
-    # Link: https://esi.tech.ccp.is/dev/#!/Wallet/get_characters_character_id_wallet_journal
-    # Scope: esi-wallet.read_character_wallet.v1
-    # Cache: 1 hour
     class CharacterWalletJournal < Base
+      self.scope = 'esi-wallet.read_character_wallet.v1'
+      self.cache_duration = 3600
+
       def initialize(character_id)
         @path = "/characters/#{character_id}/wallet/journal"
       end
     end
 
-    # Link: https://esi.tech.ccp.is/dev/#!/Wallet/get_characters_character_id_wallet_transactions
-    # Scope: esi-wallet.read_character_wallet.v1
-    # Cache: 1 hour
     class CharacterWalletTransactions < Base
+      self.scope = 'esi-wallet.read_character_wallet.v1'
+      self.cache_duration = 3600
+
       def initialize(character_id)
         @path = "/characters/#{character_id}/wallet/transactions"
       end
     end
 
-    # Link: https://esi.tech.ccp.is/latest/#!/Market/get_characters_character_id_orders
-    # Scope: esi-markets.read_character_orders.v1
-    # Cache: 1 hour
     class CharacterOrders < Base
+      self.scope = 'esi-markets.read_character_orders.v1'
+      self.cache_duration = 3600
+
       def initialize(character_id)
         @path = "/characters/#{character_id}/orders"
       end
     end
 
-    # Link: https://esi.tech.ccp.is/latest/#!/Industry/get_characters_character_id_industry_jobs
-    # Scope: esi-industry.read_character_jobs.v1
-    # Cache: 5 minutes
     class CharacterIndustryJobs < Base
+      self.scope = 'esi-industry.read_character_jobs.v1'
+      self.cache_duration = 300
+
       def initialize(character_id, with_completed: false)
         @path = "/characters/#{character_id}/industry/jobs"
         @params = { with_completed: with_completed }
       end
     end
 
-    # Link: https://esi.tech.ccp.is/dev/?datasource=tranquility#!/Contacts/get_characters_character_id_contacts
-    # Scope: esi-contracts.read_character_contracts.v1
-    # Cache: 1 hour
     class CharacterContracts < Base
-      def initialize(character_id)
-        @path = "/characters/#{character_id}/contracts"
-      end
-    end
+      self.scope = 'esi-contracts.read_character_contracts.v1'
+      self.cache_duration = 3600
 
-    # Link: https://esi.tech.ccp.is/dev/#!/Location/get_characters_character_id_location
-    # Scope: esi-location.read_location.v1
-    # Cache: 1 hour
-    class CharacterLocation < Base
       def initialize(character_id)
-        @path = "/characters/#{character_id}/location"
+        @path = "/characters/#{character_id}/contracts"
       end
     end
 
-    # Link: https://esi.tech.ccp.is/dev/#!/Contracts/get_characters_character_id_contracts_contract_id_items
-    # Scope: esi-contracts.read_character_contracts.v1
-    # Cache: 1 hour
     class ContractItems < Base
+      self.scope = 'esi-contracts.read_character_contracts.v1'
+      self.cache_duration = 3600
+
       def initialize(character_id, contract_id)
         @path = "/characters/#{character_id}/contracts/#{contract_id}/items"
       end
     end
 
-    # Link: https://esi.tech.ccp.is/dev/#!/Location/get_characters_character_id_location
-    # Scope: esi-location.read_location.v1
-    # Cache: 5 seconds
     class CharacterLocation < Base
+      self.scope = 'esi-location.read_location.v1'
+      self.cache_duration = 5
+
       def initialize(character_id)
         @path = "/characters/#{character_id}/location"
       end
     end
 
-    # Link: https://esi.tech.ccp.is/dev/#!/Assets/get_characters_character_id_assets
-    # Scope: esi-assets.read_assets.v1
-    # Cache: 1 hour
+    # characters/{character_id}/online
+    # esi-location.read_online.v1
+    # 60
+
+    # /characters/{character_id}/attributes
+    # esi-skills.read_skills.v1
+    # 3600
+
+    # /characters/{character_id}/chat_channels
+    # esi-characters.read_chat_channels.v1
+    # 300
+
+    # /characters/{character_id}/clones
+    # esi-clones.read_clones.v1
+    # 120
+
+    # /characters/{character_id}/implants
+    # esi-clones.read_implants.v1
+    # 3600
+
+    # /characters/{character_id}/roles
+    # esi-characters.read_corporation_roles.v1
+    # 3600
+
+    class CharacterMail < Base
+      self.scope = 'esi-mail.read_mail.v1'
+      self.cache_duration = 30
+
+      def initialize(character_id)
+        @path = "/characters/#{character_id}/mail"
+      end
+    end
+
     class Assets < Base
+      self.scope = 'esi-assets.read_assets.v1'
+      self.cache_duration = 3600
+
       def initialize(character_id)
         @path = "/characters/#{character_id}/assets"
       end
     end
 
     class Alliances < Base
+      self.cache_duration = 3600
+
       def initialize
         @path = "/alliances"
       end
     end
 
     class AllianceNames < Base
+      self.cache_duration = 3600
+
       def initialize(alliance_ids)
         @path = "/alliances/names"
         @params = { alliance_ids: alliance_ids.join(',') }
@@ -182,12 +214,16 @@ module Esi
     end
 
     class Alliance < Base
+      self.cache_duration = 3600
+
       def initialize(alliance_id)
         @path = "/alliances/#{alliance_id}"
       end
     end
 
     class CorporationNames < Base
+      self.cache_duration = 3600
+
       def initialize(corporation_ids)
         @path = "/corporations/names"
         @params = { corporation_ids: corporation_ids.join(',') }
@@ -195,41 +231,64 @@ module Esi
     end
 
     class Corporation < Base
+      self.cache_duration = 3600
+
       def initialize(corporation_id)
         @path = "/corporations/#{corporation_id}"
       end
     end
 
-    class CorporationStructures < Base
+    class CorporationWallet < Base
+      self.scope = 'esi-wallet.read_corporation_wallet.v1'
+      self.cache_duration = 120
+
       def initialize(corporation_id)
-        @path = "/corporations/#{corporation_id}/structures"
+        @path = "/corporations/#{corporation_id}/wallets"
       end
     end
 
-    class CorporationStructure < Base
-      def initialize(corporation_id, structure_id)
-        @path = "/corporations/#{corporation_id}/structures/#{structure_id}"
+    class CorporationStructures < Base
+      self.scope = 'esi-corporations.read_structures.v1'
+      self.cache_duration = 3600
+
+      def initialize(corporation_id)
+        @path = "/corporations/#{corporation_id}/structures"
       end
     end
 
-    # Link: https://esi.tech.ccp.is/dev/#!/Corporation/get_corporations_corporation_id_members
-    # Scope: esi-corporations.read_corporation_membership.v1
-    # Cache: 1 hour
     class CorporationMembers < Base
+      self.scope = 'esi-corporations.read_corporation_membership.v1'
+      self.cache_duration = 3600
+
       def initialize(corporation_id)
         @path = "/corporations/#{corporation_id}/members"
       end
     end
 
+    class CorporationMemberTracking < Base
+      self.scope = 'esi-corporations.track_members.v1'
+      self.cache_duration = 3600
+
+      def initialize(corporation_id)
+        @path = "/corporations/#{corporation_id}/membertracking"
+      end
+    end
+
     # Link: https://esi.tech.ccp.is/dev/#!/Corporation/get_corporations_corporation_id_roles
-    # Scope: esi-corporations.read_corporation_membership.v1
-    # Cache: 1 hour
     class CorporationRoles < Base
+      self.scope = 'esi-corporations.read_corporation_membership.v1'
+      self.cache_duration = 3600
+
       def initialize(corporation_id)
         @path = "/corporations/#{corporation_id}/roles"
       end
     end
 
+    class CorporationWallets < Base
+      self.scope = 'esi-wallet.read_corporation_wallets.v1'
+      self.cache_duration = 300
+    end
+
     class Structures < Base
       def initialize
         @path = "/universe/structures"
@@ -277,21 +336,9 @@ module Esi
       end
     end
 
-    class StructureOrders < Base
-      def initialize(structure_id:)
-        @path = "/markets/structures/#{structure_id}"
-        @paginated = true
-      end
-    end
-
-    class MarketHistory < Base
-      def initialize(type_id:, region_id: Region::FORGE)
-        @path = "/markets/#{region_id}/history"
-        @params = { type_id: type_id }
-      end
-    end
-
     class Killmails < Base
+      self.scope = 'esi-killmails.read_killmails.v1'
+
       def initialize(character_id:, max_count: 50, max_kill_id: nil)
         @path = "/characters/#{character_id}/killmails/recent"
         @params = { max_count: max_count }
@@ -324,6 +371,8 @@ module Esi
     end
 
     class Fittings < Base
+      self.scope = 'esi-fittings.read_fittings.v1'
+
       def initialize(character_id)
         @path = "characters/#{character_id}/fittings"
       end
@@ -335,5 +384,15 @@ module Esi
         @method = :delete
       end
     end
+
+    class OpenMarketDetails < Base
+      self.scope = 'esi-ui.open_window.v1'
+
+      def initialize(type_id)
+        @path = "/ui/openwindow/marketdetails"
+        @method = :post
+        @params = { type_id: type_id }
+      end
+    end
   end
 end

data/lib/esi/client.rb

@@ -13,11 +13,14 @@ module Esi
     end
 
     def method_missing(name, *args, &block)
-      class_name = name.to_s.split('_').map(&:capitalize).join
-      begin
-        klass = Esi::Calls.const_get(class_name)
-      rescue NameError
-        super(name, *args, &block)
+      klass = nil
+      ActiveSupport::Notifications.instrument('esi.client.detect_call') do
+        class_name = name.to_s.split('_').map(&:capitalize).join
+        begin
+          klass = Esi::Calls.const_get(class_name)
+        rescue NameError
+          super(name, *args, &block)
+        end
       end
 
       call = klass.new(*args)
@@ -53,12 +56,14 @@ module Esi
       items = []
       page = 1
 
-      loop do
-        call.page = page
-        response = request(call, &block)
-        break if response.data.blank?
-        items += response.data
-        page += 1
+      ActiveSupport::Notifications.instrument('esi.client.request.paginated') do
+        loop do
+          call.page = page
+          response = request(call, &block)
+          break if response.data.blank?
+          items += response.data
+          page += 1
+        end
       end
 
       items
@@ -67,54 +72,59 @@ module Esi
     def request(call, url=nil, &block)
       response = nil
       url ||= call.url
-
       debug "Starting request: #{url}"
 
-      1.upto(MAX_ATTEMPTS) do |try|
-        begin
-          response = oauth.request(call.method, url)
-        rescue OAuth2::Error => e
-          case e.response.status
-          when 502 # Temporary server error
-            logger.error "TemporaryServerError, sleeping for 15 seconds"
-            sleep 15
-            next
-          when 503 # Rate Limit
-            logger.error "RateLimit error, sleeping for 15 seconds"
-            sleep 15
-            next
-          when 403 # Forbidden
-            logger.error "ApiForbiddenError: #{e.response.status}: #{e.response.body}"
-            logger.error url
-            raise Esi::ApiForbiddenError.new(Response.new(e.response))
-          when 404 # Not Found
-            raise Esi::ApiNotFoundError.new(Response.new(e.response))
-          else
-            response = Response.new(e.response)
-            logger.error "ApiUnknownError (#{response.status}): #{url}"
-
-            case response.error
-            when 'invalid_client' then
-              raise ApiInvalidAppClientKeysError.new(response)
+      ActiveSupport::Notifications.instrument('esi.client.request') do
+        1.upto(MAX_ATTEMPTS) do |try|
+          begin
+            response = oauth.request(call.method, url)
+          rescue OAuth2::Error => e
+            case e.response.status
+            when 502 # Temporary server error
+              logger.error "TemporaryServerError, sleeping for 15 seconds"
+              sleep 15
+              next
+            when 503 # Rate Limit
+              logger.error "RateLimit error, sleeping for 15 seconds"
+              sleep 15
+              next
+            when 403 # Forbidden
+              logger.error "ApiForbiddenError: #{e.response.status}: #{e.response.body}"
+              logger.error url
+              raise Esi::ApiForbiddenError.new(Response.new(e.response))
+            when 404 # Not Found
+              raise Esi::ApiNotFoundError.new(Response.new(e.response))
             else
-              raise Esi::ApiUnknownError.new(response)
+              response = Response.new(e.response)
+              logger.error "ApiUnknownError (#{response.status}): #{url}"
+
+              case response.error
+              when 'invalid_client' then
+                raise ApiInvalidAppClientKeysError.new(response)
+              else
+                raise Esi::ApiUnknownError.new(response)
+              end
             end
           end
+          break if response
         end
-        break if response
       end
 
       debug "Request finished"
-      response = Response.new(response)
-
-      if Esi.config.response_log_path && Dir.exists?(Esi.config.response_log_path)
-        call_name = call.class.to_s.downcase.split('::').last
-        folder = Pathname.new(Esi.config.response_log_path).join(call_name)
-        FileUtils.mkdir_p(folder)
-        File.write(folder.join("#{Time.now.to_i.to_s}.json"), response.to_s)
+      ActiveSupport::Notifications.instrument('esi.client.response.initialize') do
+        response = Response.new(response)
+      end
+      ActiveSupport::Notifications.instrument('esi.client.response.save') do
+        if Esi.config.response_log_path && Dir.exists?(Esi.config.response_log_path)
+          call_name = call.class.to_s.downcase.split('::').last
+          folder = Pathname.new(Esi.config.response_log_path).join(call_name)
+          FileUtils.mkdir_p(folder)
+          File.write(folder.join("#{Time.now.to_i.to_s}.json"), response.to_s)
+        end
+      end
+      ActiveSupport::Notifications.instrument('esi.client.response.classify') do
+        response.data.each { |item| block.call(item) } if block
       end
-
-      response.data.each { |item| block.call(item) } if block
       response
     end
   end

data/lib/esi/o_auth.rb

@@ -12,7 +12,9 @@ module Esi
       end
 
       def obtain_token(code)
-        Esi::AccessToken.new(client.auth_code.get_token(code))
+        ActiveSupport::Notifications.instrument('esi.oauth.obtain_token') do
+          Esi::AccessToken.new(client.auth_code.get_token(code))
+        end
       end
 
       def client
@@ -45,10 +47,12 @@ module Esi
     end
 
     def refresh_access_token
-      @token = @token.refresh!
-      @access_token = @token.token
-      @expires_at = @token.expires_at.integer? ? Time.at(@token.expires_at) : @token.expires_at
-      @callback.call(@access_token, @expires_at) if @callback
+      ActiveSupport::Notifications.instrument('esi.oauth.refresh_token') do
+        @token = @token.refresh!
+        @access_token = @token.token
+        @expires_at = @token.expires_at.integer? ? Time.at(@token.expires_at) : @token.expires_at
+        @callback.call(@access_token, @expires_at) if @callback
+      end
     end
   end
 end

data/lib/esi/response.rb

@@ -6,6 +6,7 @@ module Esi
 
     attr_reader :original_response, :json
     def_delegators :original_response, :status, :body, :headers
+    def_delegators :data, :each
 
     def initialize(response)
       @original_response = response

data/lib/esi/version.rb

@@ -1,3 +1,3 @@
 module Esi
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Danny Hiemstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: EVE ESI API wrapper