esi 0.4.6 → 0.4.7.pre.alpha.pre.60

data/lib/esi/calls/alliances.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Esi
+  class Calls
+    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(',') }
+      end
+    end
+
+    class Alliance < Base
+      self.cache_duration = 3600
+
+      def initialize(alliance_id)
+        @path = "/alliances/#{alliance_id}"
+      end
+    end
+  end
+end

data/lib/esi/calls/base.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module Esi
+  class Calls
+    # Base parent class used for all API calls. Provides basic functionality and state for caching
+    # and request initialization
+    class Base
+      CACHE_NAMESPACE = 'esi'
+
+      class_attribute :scope
+      class_attribute :cache_duration
+
+      attr_accessor :path, :params
+
+      # Returns an unique key based on the endpoint and params which is used for caching
+      # @return [String] cache key
+      def cache_key
+        @cache_key ||= begin
+          checksum = Digest::MD5.hexdigest("#{path.gsub(%r{^\/}, '')}:#{sorted_params}")
+          "#{CACHE_NAMESPACE}:#{checksum}"
+        end
+      end
+
+      # Returns the request HTTP method to use
+      # @return [Symbol] request method
+      def method
+        @method ||= :get
+      end
+
+      # Returns the generated endpoint URL including any parameters
+      # @return [String] request URI
+      def url
+        Esi.generate_url(path, params)
+      end
+
+      # @param page [Integer] page number
+      def page=(page)
+        self.params ||= {}
+        self.params[:page] = page
+      end
+
+      # Returns whether the endpoint supports pagination
+      # @return [Boolean]
+      def paginated?
+        !@paginated
+      end
+
+      private
+
+      # Transforms the params hash into a sorted array
+      # @return [Array] sorted array of params
+      def sorted_params
+        sorted = {}
+        params.each do |k, v|
+          sorted[k] = v.respond_to?(:sort) ? v.sort : v
+        end
+        sorted.sort
+      end
+    end
+  end
+end

data/lib/esi/calls/characters.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Esi
+  class Calls
+    class CharacterNames < Base
+      self.cache_duration = 3600
+
+      def initialize(character_ids)
+        @path = '/characters/names'
+        @params = { character_ids: character_ids.join(',') }
+      end
+    end
+
+    class Character < Base
+      self.cache_duration = 3600
+
+      def initialize(character_id)
+        @path = "/characters/#{character_id}"
+      end
+    end
+
+    # 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
+
+    class CharacterSkills < Base
+      self.scope = 'esi-skills.read_skills.v1'
+      self.cache_duration = 120
+
+      def initialize(character_id)
+        @path = "/characters/#{character_id}/skills"
+      end
+    end
+
+    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
+
+    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
+
+    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
+
+    class CharacterIndustryJobs < Base
+      self.scope = 'esi-industry.read_character_jobs.v1'
+      self.cache_duration = 300
+
+      def initialize(character_id, with_completed: true)
+        @path = "/characters/#{character_id}/industry/jobs"
+        @params = { include_completed: with_completed }
+      end
+    end
+
+    class CharacterBlueprints < Base
+      self.scope = 'esi-characters.read_blueprints.v1'
+      self.cache_duration = 3600
+
+      def initialize(character_id)
+        @path = "/characters/#{character_id}/blueprints"
+      end
+    end
+
+    # Character asset list
+    class CharacterAssets < Base
+      self.scope = 'esi-assets.read_assets.v1'
+      self.cache_duration = 3600
+
+      def initialize(character_id)
+        @path = "/characters/#{character_id}/assets"
+        @paginated = true
+      end
+    end
+
+    # @deprecated Use {CharacterAssets} instead
+    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 CharacterContracts < Base
+      self.scope = 'esi-contracts.read_character_contracts.v1'
+      self.cache_duration = 3600
+
+      def initialize(character_id)
+        @path = "/characters/#{character_id}/contracts"
+      end
+    end
+
+    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
+
+    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
+
+    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
+  end
+end

data/lib/esi/calls/corporations.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Esi
+  class Calls
+    class CorporationNames < Base
+      self.cache_duration = 3600
+
+      def initialize(corporation_ids)
+        @path = '/corporations/names'
+        @params = { corporation_ids: corporation_ids.join(',') }
+      end
+    end
+
+    class Corporation < Base
+      self.cache_duration = 3600
+
+      def initialize(corporation_id)
+        @path = "/corporations/#{corporation_id}"
+      end
+    end
+
+    class CorporationAssets < Base
+      self.scope = 'esi-assets.read_corporation_assets.v1'
+      self.cache_duration = 3600
+
+      def initialize(corporation_id)
+        @path = "/corporations/#{corporation_id}/assets"
+        @paginated = true
+      end
+    end
+
+    class CorporationIndustryJobs < Base
+      self.scope = 'esi-industry.read_corporation_jobs.v1'
+      self.cache_duration = 300
+
+      def initialize(corporation_id, with_completed: true)
+        @path = "/corporations/#{corporation_id}/industry/jobs"
+        @params = { include_completed: with_completed }
+      end
+    end
+
+    class CorporationBlueprints < Base
+      self.scope = 'esi-corporations.read_blueprints.v1'
+      self.cache_duration = 3600
+
+      def initialize(corporation_id)
+        @path = "/corporations/#{corporation_id}/blueprints"
+      end
+    end
+
+    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
+
+    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
+    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 CorporationWallet < Base
+      self.scope = 'esi-wallet.read_corporation_wallet.v1'
+      self.cache_duration = 120
+
+      def initialize(corporation_id)
+        @path = "/corporations/#{corporation_id}/wallets"
+      end
+    end
+
+    class CorporationWallets < Base
+      self.scope = 'esi-wallet.read_corporation_wallets.v1'
+      self.cache_duration = 300
+    end
+  end
+end

data/lib/esi/calls/dogma.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Esi
+  class Calls
+    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
+  end
+end

data/lib/esi/calls/fittings.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Esi
+  class Calls
+    class Fittings < Base
+      self.scope = 'esi-fittings.read_fittings.v1'
+
+      def initialize(character_id)
+        @path = "/characters/#{character_id}/fittings"
+      end
+    end
+
+    class DeleteFitting < Base
+      def initialize(character_id, fitting_id)
+        @path = "characters/#{character_id}/fittings/#{fitting_id}"
+        @method = :delete
+      end
+    end
+  end
+end

data/lib/esi/calls/fleets.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Esi
+  class Calls
+    class Fleet < Base
+      def initialize(fleet_id)
+        @path = "/fleets/#{fleet_id}"
+      end
+    end
+
+    class FleetMembers < Base
+      def initialize(fleet_id)
+        @path = "/fleets/#{fleet_id}/members"
+      end
+    end
+
+    class FleetWings < Base
+      def initialize(fleet_id)
+        @path = "/fleets/#{fleet_id}/wings"
+      end
+    end
+  end
+end

data/lib/esi/calls/industry.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Esi
+  class Calls
+    class IndustryFacilities < Base
+      self.scope = nil
+      self.cache_duration = 3600
+
+      def initialize
+        @path = '/industry/facilities'
+      end
+    end
+
+    class IndustrySystems < Base
+      self.scope = nil
+      self.cache_duration = 3600
+
+      def initialize
+        @path = '/industry/systems'
+      end
+    end
+  end
+end

data/lib/esi/calls/info.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Esi
+  class Calls
+    class Info
+      attr_reader :name, :call
+      delegate :scope, :cache_duration, to: :call
+
+      def initialize(name)
+        @name = name.to_sym
+        @call = Calls.const_get(name.to_s.camelize)
+      end
+
+      def to_s
+        @name.to_s
+      end
+
+      def character?
+        name.to_s.starts_with?('character')
+      end
+
+      def corporation?
+        name.to_s.starts_with?('corporat')
+      end
+    end
+  end
+end