eve 1.0.2 → 2.0.1

data/lib/eve/api.rb

@@ -217,7 +217,8 @@ module Eve
       [@options[:includes]].flatten.each do |mod|
         next unless mod
         mod = mod.to_s unless mod.kind_of?(String)
-        eigenclass.send(:include, "::Eve::API::Services::#{mod.camelize}".constantize)
+        mod = "::Eve::API::Services::#{mod.camelize}".constantize
+        eigenclass.send(:include, mod)
       end
     end
 
@@ -226,6 +227,7 @@ module Eve
         next unless mod
         instance_variable_set("@#{mod}", ::Eve::API.new(options.merge(:includes => mod, :submodules => nil)))
         eigenclass.send(:attr_reader, mod)
+        eigenclass.send(:public, mod)
       end
     end
 

data/lib/eve/api/response/inspection.rb

@@ -5,7 +5,7 @@ module Eve
         def protected_instance_variables
           (respond_to?(:content) && !content.blank? ? [] : ["@content"]) +
           #(respond_to?(:rowsets) && !rowsets.empty? ? rowsets.collect { |r| "@#{r.name}" } : []) +
-          %w(@rowsets @options @xml @columns @row @name)
+          [:@rowsets, :@options, :@xml, :@columns, :@row, :@name]
         end
 
         def inspected_name

data/lib/eve/api/response/rowsets.rb

@@ -33,7 +33,7 @@ module Eve
 
         def value_for(candidate)
           candidate.kind_of?(String) ? YAML::load(candidate) : candidate
-        rescue
+        rescue (defined?(Psych::SyntaxError) ? Psych::SyntaxError : StandardError)
           candidate
         end
       end

data/lib/eve/dependencies.rb

@@ -1,18 +1,48 @@
-unless defined?(Gem)
-  require 'rubygems'
-  gem 'hpricot',       '>= 0.8.2'
-  gem 'actionpack',    '>= 2.3.5'
-  gem 'activesupport', '>= 2.3.5'
-end
-
 require 'net/http'
 require 'hpricot'
 require 'yaml'
-require 'action_pack'
-require 'action_controller'
-require 'action_view'
+require 'sc-core-ext'
 
 gem_path = File.expand_path(File.dirname(__FILE__), "..")
 $LOAD_PATH.unshift gem_path
-ActiveSupport::Dependencies.load_paths.unshift gem_path
-ActiveSupport::Dependencies.load_once_paths.unshift gem_path
+
+module Eve
+  autoload :Errors,           "eve/errors"
+  autoload :API,              "eve/api"
+  autoload :Errors,           "eve/errors"
+  autoload :JavascriptHelper, "eve/javascript_helper"
+  autoload :Trust,            "eve/trust"
+  autoload :Version,          "eve/version"
+  autoload :VERSION,          "eve/version"
+
+  require 'eve/deprecation'
+
+  # Railtie for bootstrapping to Rails
+  begin
+    require 'rails'
+    # we just required Rails -- are these next 3 necessary?
+    require 'action_pack'
+    require 'action_controller'
+    require 'action_view'
+
+    class Railtie < Rails::Railtie
+      config.after_initialize do
+        if defined?(Mime::Type)
+          # *.igb.erb format
+          Mime::Type.register_alias "text/html", :eve
+          Mime::Type.register_alias "text/html", :igb
+        end
+
+        # controller extensions
+        ActionController::Base.send(:include, Eve::Trust::ControllerHelpers)
+
+        # view extensions
+        ActionView::Base.send(:delegate, :igb,  :to => :controller)
+        ActionView::Base.send(:delegate, :igb?, :to => :igb)
+        ActionView::Base.send(:include, Eve::JavascriptHelper)
+      end
+    end
+  rescue LoadError
+    # no rails? no problem.
+  end
+end

data/lib/eve/deprecation.rb

@@ -0,0 +1,3 @@
+ActiveSupport::Deprecation.deprecate_methods(Eve::Trust::ControllerHelpers, {
+  :prefer_trust  => "The EVE IGB no longer accepts trust headers. Please use <%=request_trust%> in your view, instead."
+})

data/lib/eve/javascript_helper.rb

@@ -0,0 +1,196 @@
+module Eve
+  # In addition to the helpers listed below, this library also exposes the "igb" method as described in
+  # Eve::Trust.
+  module JavascriptHelper
+    # Returns the numeric type ID for a string, so you don't have to manage "magic numbers" in your application.
+    # The argument can be a string or a symbol, and is case insensitive. Underscores will be converted to spaces.
+    #
+    # Examples:
+    #   type_id('alliance')       # => 16159
+    #   type_id('character')      # => 1377
+    #   type_id('corporation')    # => 2
+    #   type_id('constellation')  # => 4
+    #   type_id('region')         # => 3
+    #   type_id('Solar System')   # => 5
+    #   type_id(:solar_system)    # => 5
+    #   type_id(:station)         # => 3867
+    #
+    def type_id(which)
+      which = which.to_s.humanize unless which.kind_of?(String)
+      which.downcase!
+      case which
+        when 'alliance' then 16159
+        when 'character' then 1377
+        when 'corporation' then 2
+        when 'constellation' then 4
+        when 'region' then 3
+        when 'solar system', 'solarsystem' then 5
+        when 'station' then 3867
+        else raise ArgumentError, "Unknown type: #{which}"
+      end
+    end
+
+    # Creates a hyperlink that results in opening the client's EVE mail inbox.
+    def link_to_evemail(text, *args)
+      link_to_function(text, "CCPEVE.openEveMail()", *args)
+    end
+
+    # Creates a hyperlink that results in the "show info" dialog being displayed on the client's screen.
+    # If item_id is given, the show info window will open for that item.
+    #
+    #  type_id (Number)
+    #    Type ID of item to show info on.
+    #  item_id (Number)
+    #    Optional item ID of specific item of type type_id to show info on. This is required for specific types of
+    #    items, such as solar systems, stations, regions, and constellations.
+    #
+    def link_to_info(text, type_id, item_id = nil, *args)
+      function = "CCPEVE.showInfo(#{type_id.inspect}"
+      function.concat ", #{item_id.inspect}" if item_id
+      function.concat ")"
+      link_to_function text, function, *args
+    end
+
+    # Creates a hyperlink that results in opening the preview window for type_id.
+    #
+    #  type_id (Number)
+    #    Type ID of item to preview.
+    #
+    def link_to_preview(text, type_id, *args)
+      link_to_function text, "CCPEVE.showPreview(#{type_id.inspect})", *args
+    end
+
+    # Creates a hyperlink that results in showing the route to the destination_id from the source_id.
+    # If source_id is not given, the source system is taken to be the system the user is currently in.
+    #
+    def link_to_route(text, destination_id, source_id = nil, *args)
+      function = "CCPEVE.showRouteTo(#{destination_id.inspect}"
+      function.concat ", #{source_id.inspect}" if source_id
+      function.concat ")"
+      link_to_function text, function, *args
+    end
+
+    # Creates a hyperlink that results in opening the map. If system_id is given, the map will focus on that system.
+    #
+    #  system_id (Number)
+    #    Optional ID of solar system to focus map on.
+    #
+    def link_to_map(text, system_id = nil, *args)
+      link_to_function text, "CCPEVE.showMap(#{system_id ? system_id.inspect : ''})", *args
+    end
+
+    # Creates a hyperlink that results in opening the fitting window and displays the fitting represented by fitting.
+    #
+    #  fitting (String)
+    #    A Ship DNA string.
+    #
+    # See http://wiki.eveonline.com/en/wiki/Ship_DNA for details
+    def link_to_fitting(text, ship_dna_string, *args)
+      link_to_function text, "CCPEVE.showFitting(#{ship_dna_string.inspect})", *args
+    end
+
+    # Creatse a hyperlink that results in opening the contract window and displaying the contract represented by the
+    # contract_id argument. Contracts are, however, assigned per-solar-system, and so a solar_system_id must also be
+    # provided.
+    #
+    #  solar_system_id (Number)
+    #    The ID number of the solar system in which the contract is located.
+    #  contract_id (Number)
+    #    The ID number of the contract to display.
+    def link_to_contract(text, solar_system_id, contract_id, *args)
+      link_to_function text, "CCPEVE.showContract(#{solar_system_id.inspect}, #{contract_id.inspect})", *args
+    end
+
+    # Creates a hyperlink which results in opening the market details window and displays the information about the
+    # item represented by type_id.
+    #
+    #  typeID (Number)
+    #    Type ID to display market details about
+    #
+    def link_to_market_details(text, type_id, *args)
+      link_to_function text, "CCPEVE.showMarketDetails(#{type_id.inspect})", *args
+    end
+
+    # Produces a hyperlink that will result in a pop-up a trust prompt in the client, allowing the user to either
+    # grant the trust request, ignore it, or always ignore trust requests from your site.
+    #
+    #  trust_url (String)
+    #    This is a fully-qualified domain name and path (e.g. http://wiki.eveonline.com/w/) to which your site would
+    #    like the user to grant trust.
+    #
+    # The page will not be automatically refreshed if the user grants the trust request. Trust will take effect the
+    # next time the user refreshes the page, or navigates within the site.
+    #
+    # Note that trust_url is processed and only the protocol, domain and path will be used from it. If you supply a
+    # query string or anchor, they will be discarded. It is recommended that you primarily pass in only
+    # fully-qualified domain names without paths (e.g. http://wiki.eveonline.com instead of
+    # http://wiki.eveonline.com/w/index.php), as this avoids pestering the user for trust on every page.
+    #
+    def link_to_trust_request(text, trust_url = "http://#{request.host}/", *args)
+      trust_url = url_for(trust_url.merge(:only_path => false)) if trust_url.kind_of?(Hash)
+      link_to_function text, "CCPEVE.requestTrust(#{trust_url.inspect})", *args
+    end
+
+    # This will generate a method call that produces a pop-up a trust prompt in the client, allowing the user to
+    # either grant the trust request, ignore it, or always ignore trust requests from your site.
+    #
+    #  trust_url (String)
+    #    This is a fully-qualified domain name and path (e.g. http://wiki.eveonline.com/w/) to which your site would
+    #    like the user to grant trust.
+    #
+    # The page will not be automatically refreshed if the user grants the trust request. Trust will take effect the
+    # next time the user refreshes the page, or navigates within the site.
+    #
+    # Note that trust_url is processed and only the protocol, domain and path will be used from it. If you supply a
+    # query string or anchor, they will be discarded. It is recommended that you primarily pass in only
+    # fully-qualified domain names without paths (e.g. http://wiki.eveonline.com instead of
+    # http://wiki.eveonline.com/w/index.php), as this avoids pestering the user for trust on every page.
+    #
+    def request_trust(trust_url = "http://#{request.host}/", *args)
+      trust_url = url_for(trust_url.merge(:only_path => false)) if trust_url.kind_of?(Hash)
+      javascript_tag "CCPEVE.requestTrust(#{trust_url.inspect});", *args
+    end
+
+    # Sets the client's autopilot destination to the specified solar system.
+    #
+    #  solar_system_id (Number)
+    #    The numerical identifier of the solar system to which you wish to set the client's autopilot destination.
+    #
+    # This method requires that the user grant Trust to the calling site.
+    def link_to_destination(text, solar_system_id, *args)
+      link_to_function text, "CCPEVE.setDestination(#{solar_system_id.inspect})", *args
+    end
+
+    # Adds the specified solar system to the end of the client's autopilot route. If the solar system is already in
+    # the route, no changes are made and the method fails silently.
+    #
+    #  solar_system_id (Number)
+    #    The numerical identifier of the solar system which you wish to append to the client's autopilot route.
+    #
+    # This method requires that the user grant Trust to the calling site.
+    def link_to_waypoint(text, solar_system_id, *args)
+      link_to_function text, "CCPEVE.addWaypoint(#{solar_system_id.inspect})", *args
+    end
+
+    # Causes the user to attempt to join the named channel. Normal channel access control rules apply. If the user is
+    # unable to join the channel, the method fails silently.
+    #
+    #  channel_name (String)
+    #    The name of the channel which the user will join.
+    #
+    # This method requires that the user grant Trust to the calling site.
+    def link_to_channel(text, channel_name, *args)
+      link_to_function text, "CCPEVE.joinChannel(#{channel_name.inspect})", *args
+    end
+
+    # Causes the user to subscribe to the named mailing list.
+    #
+    #  mailing_list_name (String)
+    #    The name of the mailing list which the user will join.
+    #
+    # This method requires that the user grant Trust to the calling site.
+    def link_to_mailing_list(text, mailing_list_name, *args)
+      link_to_function text, "CCPEVE.joinMailingList(#{mailing_list_name.inspect})", *args
+    end
+  end
+end

data/lib/eve/trust.rb

@@ -1,11 +1,10 @@
-require 'eve/trust/mime_types'
 require 'eve/trust/controller_helpers'
 require 'eve/trust/igb_interface'
 
 module Eve
   # == Trust
   # The primary purpose for the ActionController is to figure out which View should be rendered, and what data to send
-  # to that View. In keeping with this design, a few helper methods have been established that allow you to establish
+  # to that View. In keeping with this paradigm, a few helper methods have been added that allow you to establish
   # trust with the In-Game Browser (IGB), which in turn provides access to more useful information such as the player's
   # current location. To establish trust with a compatible browser, simply add one line to your controller:
   #

data/lib/eve/trust/controller_helpers.rb

@@ -1,83 +1,23 @@
 module Eve
   module Trust
     module ControllerHelpers
-      # None of this exists unless ActionController exists first.
-      if defined?(ActionController::Base)
-        class ::ActionController::Base
+      def self.included(base)
+        base.instance_eval do
           hide_action :trust_message, :trust_message=, :detect_igb, :template_exists?,
                       :set_igb_or_default, :default_template_exists?, :mock_methods_for_testing!,
                       :igb, :igb?, :set_igb, :require_trust, :prefer_trust, :deliver_trust_message
-          class_inheritable_accessor :trust_message
-          read_inheritable_attribute(:trust_message) || write_inheritable_attribute(:trust_message,
-                                                                      "This web site is requesting your trust.")
+          class_attribute :trust_message
+          self.trust_message ||= "This web site is requesting your trust."
+
           delegate :igb?, :to => :igb
-          attr_reader :igb
           before_filter :detect_igb
 
-          def require_trust(trust_message = self.class.trust_message)
-            if igb? && !igb.trusted?
-              deliver_trust_message(trust_message)
-              return false
-            end
-            true
-          end
-
-          def prefer_trust(trust_message = self.class.trust_message)
-            if igb? && !igb.trusted?
-              deliver_trust_message(trust_message)
-            end
-            true
-          end
-
-          def deliver_trust_message(trust_message = self.class.trust_message)
-            trust_uri = "http://#{request.host}/"
-            head 'eve.trustme' => "#{trust_uri}::#{trust_message}"
-          end
-
-          def detect_igb
-            @igb = Eve::Trust::IgbInterface.new(request)
-            mock_methods_for_testing! if request.headers['mock_methods']
-            if igb.igb?
-              set_igb_or_default
-            end
-          end
-
-          def set_igb_or_default
-            if default_template_exists? :igb
-              set_igb
-            end
-          end
-
-          def set_igb
-            request.format = :igb
-          end
-
-          def default_template_exists?(format = response.template.template_format)
-            template_exists?(default_template_name, format)
-          end
-
-          def template_exists?(template_name, format = response.template.template_format)
-            self.view_paths.find_template(template_name, format)
-          rescue ActionView::MissingTemplate, Errno::ENOENT
-            false
-          end
-
-          # a quick and dirty mocking solution. I should really make it better, but it works fine, and doesn't interfere
-          # with anything in prod, so I'll procrastinate a bit.
-          def mock_methods_for_testing! #:nodoc:
-            request.headers['mock_methods'].each do |method_name, return_value|
-              (class << self; self; end).instance_eval do
-                define_method(method_name) { |*not_used| return_value }
-              end
-            end
-          end
-
           class << self
             def requires_trust(message = trust_message)
               self.trust_message = message if message != trust_message
               before_filter :require_trust
             end
-
+  
             def prefers_trust(message = trust_message)
               self.trust_message = message if message != trust_message
               before_filter :prefer_trust
@@ -85,6 +25,62 @@ module Eve
           end
         end
       end
+      
+      def igb
+        @igb ||= Eve::Trust::IgbInterface.new(request)
+      end
+
+      def require_trust(trust_message = self.class.trust_message)
+        if igb? && !igb.trusted?
+          render :text => "<body onload=\"CCPEVE.requestTrust('http://#{request.host_with_port}')\">", :layout => false
+        end
+        true
+      end
+      
+      def prefer_trust(trust_message = self.class.trust_message)
+        if igb? && !igb.trusted?
+          deliver_trust_message(trust_message)
+        end
+        true
+      end
+
+      def deliver_trust_message(trust_message = self.class.trust_message)
+        trust_uri = "http://#{request.host_with_port}/"
+        headers['Eve.trustme'] = "#{trust_uri}::#{trust_message}"
+      end
+
+      def detect_igb
+        if igb.igb?
+          set_igb_or_default
+        end
+      end
+
+      def set_igb_or_default
+        if default_template_exists? :igb
+          set_igb
+        end
+      end
+
+      def set_igb
+        request.format = :igb
+        igb
+      end
+      
+      unless defined?(default_template_name)
+        def default_template_name
+          # FIXME: I didn't check how Rails3 actually decides which template to render --
+          # we should really follow the same rules so we don't break anything unintentionally.
+          action_name
+        end
+      end
+
+      def default_template_exists?(format = request.format)
+        formats = lookup_context.formats
+        lookup_context.formats = [format]
+        lookup_context.exists?(default_template_name, controller_path)
+      ensure
+        lookup_context.formats = formats
+      end
     end
   end
 end