glib-web 0.5.44 → 0.5.45

data/lib/glib/json_crawler/http.rb

@@ -1,120 +1,120 @@
-module Glib
-  module JsonCrawler
-    class Http
-      attr_accessor :history, :response_times, :user, :router
-
-      URI_REGEXP = /\A#{URI.regexp}\z/
-
-      VALID_RESPONSE_CODES = [
-        (200..299).to_a,
-        ## Note, the JSON API does not allow redirects
-        # 401, ## UNAUTHORIZED Should be used for not-logged-in
-        # 403, ## FORBIDDEN Should be used for logged-in but not allowed to access
-      ].flatten
-
-      def initialize(context, user, router)
-        @context = context
-        @history = []
-        @response_times = []
-        @user = user
-        @router = router
-      end
-
-      def get(url, action, params = {}, inspect_result = true)
-        fetch(:get, url, action, params, inspect_result)
-      end
-
-      def post(url, action, params)
-        fetch(:post, url, action, params)
-      end
-
-      def patch(url, action, params)
-        fetch(:patch, url, action, params)
-      end
-
-      def put(url, action, params)
-        fetch(:put, url, action, params)
-      end
-
-      def delete(url, action, params = {})
-        fetch(:delete, url, action, {})
-      end
-
-      private
-        Response = Struct.new :code, :headers, :media_type, :body do
-          def initialize(*)
-            super
-            self.headers ||= {}
-            self.media_type ||= 'text/plain'
-          end
-        end
-
-        def fetch(method, url, action, params = {}, inspect_result = true)
-          return nil if url.blank?
-
-          if method == :get
-            return nil if history.include?(url)
-
-            history << url
-          end
-
-          if !URI_REGEXP.match(url)
-            raise "Invalid URL: `#{url}`. Make sure to use the absolute URL."
-          end
-
-          http_header = {
-            'Client-DeviceOS' => user[:device],
-            'Client-Version' => user[:version],
-            'X-CSRF-Token' => user[:token]
-          }
-          http_header.merge!(params[:headers]) if params[:headers].present?
-
-          params.each do |name, value|
-            params[name] = '' if value.is_a?(Array) && value.size == 0
-          end
-
-          response = nil
-          begin
-            @context.send(method, url, params: params, headers: http_header)
-            raw_response = @context.response
-            response = Response.new(raw_response.code.to_i, raw_response.headers, raw_response.media_type, raw_response.body)
-
-            if (controller = @context.controller)
-              Glib::JsonCrawler::Coverage.coverage_files.add(controller.class.instance_method(controller.action_name).source_location.first)
-            end
-          rescue => ex
-            if !inspect_result
-              case ex
-              when ActionController::RoutingError, ActiveRecord::RecordNotFound
-                response = Response.new(404)
-              end
-            end
-
-            if !response
-              puts "Crashed on #{url}"
-              raise
-            end
-          end
-
-          @router.log(action, url, response)
-
-          if inspect_result
-            if (code = response.code) == 302
-              redirect_uri = URI(response.headers['Location'])
-              redirect_uri.query = [redirect_uri.query, 'format=json'].compact.join('&')
-              get redirect_uri.to_s, action, params
-            else
-              response_times << response.headers['X-Runtime'].to_f
-
-              @context.assert_includes VALID_RESPONSE_CODES, code, "Expected a valid response but was [#{response.code}] #{Rack::Utils::HTTP_STATUS_CODES[response.code.to_i]}:\n#{url}"
-              if response.media_type == 'application/json'
-                JSON.parse(response.body)
-              else
-                nil
-              end
-            end
-          end
-        end
-    end
-  end
-end
+module Glib
+  module JsonCrawler
+    class Http
+      attr_accessor :history, :response_times, :user, :router
+
+      URI_REGEXP = /\A#{URI.regexp}\z/
+
+      VALID_RESPONSE_CODES = [
+        (200..299).to_a,
+        ## Note, the JSON API does not allow redirects
+        # 401, ## UNAUTHORIZED Should be used for not-logged-in
+        # 403, ## FORBIDDEN Should be used for logged-in but not allowed to access
+      ].flatten
+
+      def initialize(context, user, router)
+        @context = context
+        @history = []
+        @response_times = []
+        @user = user
+        @router = router
+      end
+
+      def get(url, action, params = {}, inspect_result = true)
+        fetch(:get, url, action, params, inspect_result)
+      end
+
+      def post(url, action, params)
+        fetch(:post, url, action, params)
+      end
+
+      def patch(url, action, params)
+        fetch(:patch, url, action, params)
+      end
+
+      def put(url, action, params)
+        fetch(:put, url, action, params)
+      end
+
+      def delete(url, action, params = {})
+        fetch(:delete, url, action, {})
+      end
+
+      private
+        Response = Struct.new :code, :headers, :media_type, :body do
+          def initialize(*)
+            super
+            self.headers ||= {}
+            self.media_type ||= 'text/plain'
+          end
+        end
+
+        def fetch(method, url, action, params = {}, inspect_result = true)
+          return nil if url.blank?
+
+          if method == :get
+            return nil if history.include?(url)
+
+            history << url
+          end
+
+          if !URI_REGEXP.match(url)
+            raise "Invalid URL: `#{url}`. Make sure to use the absolute URL."
+          end
+
+          http_header = {
+            'Client-DeviceOS' => user[:device],
+            'Client-Version' => user[:version],
+            'X-CSRF-Token' => user[:token]
+          }
+          http_header.merge!(params[:headers]) if params[:headers].present?
+
+          params.each do |name, value|
+            params[name] = '' if value.is_a?(Array) && value.size == 0
+          end
+
+          response = nil
+          begin
+            @context.send(method, url, params: params, headers: http_header)
+            raw_response = @context.response
+            response = Response.new(raw_response.code.to_i, raw_response.headers, raw_response.media_type, raw_response.body)
+
+            if (controller = @context.controller)
+              Glib::JsonCrawler::Coverage.coverage_files.add(controller.class.instance_method(controller.action_name).source_location.first)
+            end
+          rescue => ex
+            if !inspect_result
+              case ex
+              when ActionController::RoutingError, ActiveRecord::RecordNotFound
+                response = Response.new(404)
+              end
+            end
+
+            if !response
+              puts "Crashed on #{url}"
+              raise
+            end
+          end
+
+          @router.log(action, url, response)
+
+          if inspect_result
+            if (code = response.code) == 302
+              redirect_uri = URI(response.headers['Location'])
+              redirect_uri.query = [redirect_uri.query, 'format=json'].compact.join('&')
+              get redirect_uri.to_s, action, params
+            else
+              response_times << response.headers['X-Runtime'].to_f
+
+              @context.assert_includes VALID_RESPONSE_CODES, code, "Expected a valid response but was [#{response.code}] #{Rack::Utils::HTTP_STATUS_CODES[response.code.to_i]}:\n#{url}"
+              if response.media_type == 'application/json'
+                JSON.parse(response.body)
+              else
+                nil
+              end
+            end
+          end
+        end
+    end
+  end
+end

data/lib/glib/json_crawler/router.rb

@@ -1,96 +1,96 @@
-module Glib
-  module JsonCrawler
-    class Router
-      attr_reader :read_only_actions
-
-      def log(action, url, response = nil)
-        @logger.puts '  ' * @depth + [
-          action,
-          response.present? ? response.code : nil,
-          url
-        ].compact.join(' :: ')
-      end
-
-      def initialize(logger)
-        @depth = -1
-        @logger = logger
-        @visitor = Glib::Json::Traversal::Visitor.new
-        @read_only_actions = Set.new
-      end
-
-      def step(http, args)
-        # TODO: Refactor
-        case args['view']
-        when 'fields/submit-v1', 'fields/submit'
-          @depth += 1
-          forms = @visitor.forms
-          JsonCrawler::FormsSubmit.new(http, forms.last)
-          @depth -= 1
-          return
-        end
-
-        if args.is_a?(Hash) && args['rel'] != 'nofollow'
-          if (on_click = (args.fetch('onClick', nil)))
-            process_action(http, on_click)
-          end
-        end
-      end
-
-      def process_action(http, spec)
-        action = spec['action']
-        params = spec
-
-        if action.present?
-          @depth += 1
-          case action
-          when 'initiate_navigation'
-            @read_only_actions.add([action, params['url']])
-            JsonCrawler::NavInitiate.new(http, params, action)
-          when 'runMultiple-v1', 'runMultiple'
-            JsonCrawler::RunMultiple.new(http, params, action)
-          when 'windows/open-v1', 'dialogs/open-v1', 'windows/reload-v1', 'windows/open', 'dialogs/open', 'windows/reload'
-            @read_only_actions.add([action, params['url']])
-            JsonCrawler::WindowsOpen.new(http, params, action)
-          when 'sheets/select-v1', 'sheets/select'
-            JsonCrawler::Menu.new(http, params, action)
-          when 'http/post-v1', 'http/post'
-            JsonCrawler::ActionHttp.new(:post, http, params, action)
-          when 'forms/submit-v1', 'forms/submit'
-            forms = @visitor.forms
-            # raise 'Submit action needs to be inside a form' if forms.size < 1
-            JsonCrawler::FormsSubmit.new(http, forms.last)
-          else
-            unless [
-              'http/delete-v1', 'dialogs/oauth-v1', 'windows/openWeb-v1',
-              'http/delete', 'dialogs/oauth', 'windows/openWeb'
-            ].include?(action)
-              @read_only_actions.add([action, params['url']])
-            end
-            self.log action, params['url']
-          end
-          @depth -= 1
-        end
-      end
-
-      def follow(http, target_router)
-        @depth += 1
-        target_router.read_only_actions.each do |crawler_action|
-          action, url = crawler_action
-          http.get(url, action, {}, false)
-        end
-      end
-
-      def tear_down
-        # NOTE: Experimental, to address issue where sometimes changes don't get saved.
-        # FINDING: Doesn't work
-        # @logger.flush
-
-        @logger.close
-      end
-
-      def crawl_multiple(views, block)
-        @visitor.traverse_multiple views, block
-      end
-    end
-  end
-end
+module Glib
+  module JsonCrawler
+    class Router
+      attr_reader :read_only_actions
+
+      def log(action, url, response = nil)
+        @logger.puts '  ' * @depth + [
+          action,
+          response.present? ? response.code : nil,
+          url
+        ].compact.join(' :: ')
+      end
+
+      def initialize(logger)
+        @depth = -1
+        @logger = logger
+        @visitor = Glib::Json::Traversal::Visitor.new
+        @read_only_actions = Set.new
+      end
+
+      def step(http, args)
+        # TODO: Refactor
+        case args['view']
+        when 'fields/submit-v1', 'fields/submit'
+          @depth += 1
+          forms = @visitor.forms
+          JsonCrawler::FormsSubmit.new(http, forms.last)
+          @depth -= 1
+          return
+        end
+
+        if args.is_a?(Hash) && args['rel'] != 'nofollow'
+          if (on_click = (args.fetch('onClick', nil)))
+            process_action(http, on_click)
+          end
+        end
+      end
+
+      def process_action(http, spec)
+        action = spec['action']
+        params = spec
+
+        if action.present?
+          @depth += 1
+          case action
+          when 'initiate_navigation'
+            @read_only_actions.add([action, params['url']])
+            JsonCrawler::NavInitiate.new(http, params, action)
+          when 'runMultiple-v1', 'runMultiple'
+            JsonCrawler::RunMultiple.new(http, params, action)
+          when 'windows/open-v1', 'dialogs/open-v1', 'windows/reload-v1', 'windows/open', 'dialogs/open', 'windows/reload'
+            @read_only_actions.add([action, params['url']])
+            JsonCrawler::WindowsOpen.new(http, params, action)
+          when 'sheets/select-v1', 'sheets/select'
+            JsonCrawler::Menu.new(http, params, action)
+          when 'http/post-v1', 'http/post'
+            JsonCrawler::ActionHttp.new(:post, http, params, action)
+          when 'forms/submit-v1', 'forms/submit'
+            forms = @visitor.forms
+            # raise 'Submit action needs to be inside a form' if forms.size < 1
+            JsonCrawler::FormsSubmit.new(http, forms.last)
+          else
+            unless [
+              'http/delete-v1', 'dialogs/oauth-v1', 'windows/openWeb-v1',
+              'http/delete', 'dialogs/oauth', 'windows/openWeb'
+            ].include?(action)
+              @read_only_actions.add([action, params['url']])
+            end
+            self.log action, params['url']
+          end
+          @depth -= 1
+        end
+      end
+
+      def follow(http, target_router)
+        @depth += 1
+        target_router.read_only_actions.each do |crawler_action|
+          action, url = crawler_action
+          http.get(url, action, {}, false)
+        end
+      end
+
+      def tear_down
+        # NOTE: Experimental, to address issue where sometimes changes don't get saved.
+        # FINDING: Doesn't work
+        # @logger.flush
+
+        @logger.close
+      end
+
+      def crawl_multiple(views, block)
+        @visitor.traverse_multiple views, block
+      end
+    end
+  end
+end

data/lib/glib/mailer_tester.rb

@@ -1,36 +1,36 @@
-module Glib
-  module MailerTester
-    extend ActiveSupport::Concern
-
-    included do
-      project_root = Rails.root
-      paths = Dir.glob(project_root + 'test/mailers/previews/*')
-      paths.each do |file|
-        require file
-      end
-
-      ActionMailer::Preview.subclasses.each do |preview_class|
-        preview = preview_class.new
-
-        preview_class.instance_methods(false).each do |mailer_method|
-          test "mailer for #{preview_class}##{mailer_method}" do
-            preview.send(mailer_method).deliver_now
-
-            logfile = File.join(log_dir, "#{preview_class.name.underscore}##{mailer_method}.txt")
-
-            # Use rstrip to avoid trailing space issues
-            expected = File.exist?(logfile) ? File.read(logfile).rstrip : ''
-            last_delivery = ActionMailer::Base.deliveries.last
-            result = last_delivery.html_part.body.raw_source.rstrip
-
-            logger = File.open(logfile, 'w')
-            logger.puts result
-            logger.close
-
-            assert_equal expected, result, "Result mismatch! #{logfile.sub(/\.txt$/, '')}"
-          end
-        end
-      end
-    end
-  end
-end
+module Glib
+  module MailerTester
+    extend ActiveSupport::Concern
+
+    included do
+      project_root = Rails.root
+      paths = Dir.glob(project_root + 'test/mailers/previews/*')
+      paths.each do |file|
+        require file
+      end
+
+      ActionMailer::Preview.subclasses.each do |preview_class|
+        preview = preview_class.new
+
+        preview_class.instance_methods(false).each do |mailer_method|
+          test "mailer for #{preview_class}##{mailer_method}" do
+            preview.send(mailer_method).deliver_now
+
+            logfile = File.join(log_dir, "#{preview_class.name.underscore}##{mailer_method}.txt")
+
+            # Use rstrip to avoid trailing space issues
+            expected = File.exist?(logfile) ? File.read(logfile).rstrip : ''
+            last_delivery = ActionMailer::Base.deliveries.last
+            result = last_delivery.html_part.body.raw_source.rstrip
+
+            logger = File.open(logfile, 'w')
+            logger.puts result
+            logger.close
+
+            assert_equal expected, result, "Result mismatch! #{logfile.sub(/\.txt$/, '')}"
+          end
+        end
+      end
+    end
+  end
+end