glib-web 0.5.5

data/lib/generators/templates/dynamic_text.rb

@@ -0,0 +1,2 @@
+dt_redis_url = ENV.fetch('<%= options[:redis_env_key] %>', 'redis://localhost:6379')
+$dt_redis = Redis.new(url: dt_redis_url)

data/lib/glib-web.rb

@@ -0,0 +1,8 @@
+require "glib/version"
+require "glib/engine" if defined?(::Rails)
+require "glib/value"
+require "glib/json_crawler"
+
+require 'glib/dynamic_text'
+require 'glib/crypt'
+require 'glib/test_helpers'

data/lib/glib/crypt.rb

@@ -0,0 +1 @@
+require_relative './crypt/utils'

data/lib/glib/crypt/utils.rb

@@ -0,0 +1,26 @@
+module Glib
+  module Crypt
+    class Utils
+      def self.encrypt(original_message, encryption_secret, encryption_salt)
+        encryptor = message_encryptor(encryption_secret, encryption_salt)
+        CGI.escape(encryptor.encrypt_and_sign(original_message))
+      end
+
+      def self.decrypt(encrypted_message, encryption_secret, encryption_salt)
+        encryptor = message_encryptor(encryption_secret, encryption_salt)
+        begin
+          encryptor.decrypt_and_verify(CGI.unescape(encrypted_message))
+        rescue ActiveSupport::MessageEncryptor::InvalidMessage
+          nil
+        end
+      end
+
+      private
+        def self.message_encryptor(encryption_secret, encryption_salt)
+          key_generator = ActiveSupport::KeyGenerator.new(encryption_secret, iterations: 1000)
+          key_secret = key_generator.generate_key(encryption_salt, 32)
+          ActiveSupport::MessageEncryptor.new(key_secret, digest: 'SHA1', serializer: JSON)
+        end
+    end
+  end
+end

data/lib/glib/dynamic_text.rb

@@ -0,0 +1 @@
+require_relative './dynamic_text/config'

data/lib/glib/dynamic_text/config.rb

@@ -0,0 +1,21 @@
+module Glib
+  module DynamicText
+    class Config
+      @@redis = nil
+      @@database_url = nil
+
+      def self.redis
+        if @@redis.nil?
+          redis_url = ENV.fetch('DT_REDIS_URL', 'redis://localhost:6379')
+          # Allow application to specify their own $dt_redis
+          @@redis = $dt_redis || Redis.new(url: redis_url)
+        end
+        @@redis
+      end
+
+      def self.database_url
+        @@database_url ||= ENV['DT_DATABASE_URL']
+      end
+    end
+  end
+end

data/lib/glib/engine.rb

@@ -0,0 +1,7 @@
+module Glib
+  module Web
+    class Engine < ::Rails::Engine
+      # isolate_namespace Glib::Web
+    end
+  end
+end

data/lib/glib/json_crawler.rb

@@ -0,0 +1,10 @@
+require_relative './json_crawler/http'
+require_relative './json_crawler/router'
+require_relative './json_crawler/action_crawler'
+require_relative './json_crawler/coverage'
+
+require_relative './json_crawler/action_crawlers/nav_initiate'
+require_relative './json_crawler/action_crawlers/windows_open'
+require_relative './json_crawler/action_crawlers/action_http'
+require_relative './json_crawler/action_crawlers/forms_submit'
+require_relative './json_crawler/action_crawlers/menu'

data/lib/glib/json_crawler/action_crawler.rb

@@ -0,0 +1,20 @@
+module Glib
+  module JsonCrawler
+    class ActionCrawler
+      def initialize(http)
+        @http = http
+      end
+
+      def click(object)
+        @http.router.step(@http, object)
+      end
+
+      def crawl(views)
+        @http.router.crawl_multiple views, ->(view) do
+          click view
+        end
+      end
+    end
+
+  end
+end

data/lib/glib/json_crawler/action_crawlers/action_http.rb

@@ -0,0 +1,14 @@
+module Glib
+  module JsonCrawler
+    class ActionHttp < ActionCrawler
+      def initialize(method, http, args, controller)
+        @http = http
+        json = @http.send(method, args['url'], controller, args.fetch('formData', {}))
+
+        unless json.nil?
+          click(json)
+        end
+      end
+    end
+  end
+end

data/lib/glib/json_crawler/action_crawlers/forms_submit.rb

@@ -0,0 +1,48 @@
+module Glib
+  module JsonCrawler
+    class FormsSubmit < ActionCrawler
+      def initialize(http, form)
+        super(http)
+
+        raise 'Submit action needs to be inside a form' unless form
+
+        @http = http
+
+        method = form['method']
+        action = "forms/#{method}"
+
+        case method
+        when 'patch', 'put'
+          submit_update(form, action)
+        else
+          url = form['url']
+          http.router.log action, url
+        end
+      end
+
+      def submit_update(view, action)
+        url = view['url']
+        fields = []
+        params = {}
+        @http.router.crawl_multiple view['childViews'], ->(child) do
+          name = child['view']
+          if name.start_with?('fields/')
+            fields << child
+
+            include_params = case name
+            when 'fields/check', 'fields/check-v1'
+              child['checked']
+            else
+              true
+            end
+
+            params[child['name']] = child['value'] if include_params
+          end
+        end
+
+        json = @http.patch url, action, params
+        click(json)
+      end
+    end
+  end
+end

data/lib/glib/json_crawler/action_crawlers/menu.rb

@@ -0,0 +1,12 @@
+module Glib
+  module JsonCrawler
+    class Menu < ActionCrawler
+      def initialize(http, args, action)
+        super(http)
+
+        @http.router.log action, nil
+        crawl args['buttons']
+      end
+    end
+  end
+end

data/lib/glib/json_crawler/action_crawlers/nav_initiate.rb

@@ -0,0 +1,15 @@
+module Glib
+  module JsonCrawler
+    class NavInitiate < ActionCrawler
+      def initialize(http, args, action)
+        super(http)
+
+        @http = http
+        if (json = (@http.get args['url'], action, args.except('url'))) && (left_drawer = json['leftDrawer'])
+          crawl left_drawer['header']&.[]('childViews')
+          crawl left_drawer['rows']
+        end
+      end
+    end
+  end
+end

data/lib/glib/json_crawler/action_crawlers/windows_open.rb

@@ -0,0 +1,28 @@
+module Glib
+  module JsonCrawler
+    class WindowsOpen < ActionCrawler
+      def initialize(http, args, action)
+        @http = http
+        if (url = args['url'])
+          json = @http.get(url, action, args.except('url'))
+
+          unless json.nil?
+            crawl json['header']&.[]('childViews')
+            crawl json['body']&.[]('childViews')
+            crawl json['footer']&.[]('childViews')
+
+            json['rightNavButtons']&.each do |button|
+              if button['buttons'].present?
+                button['buttons'].each do |inner_button|
+                  click inner_button
+                end
+              else
+                click button
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/glib/json_crawler/coverage.rb

@@ -0,0 +1,20 @@
+module Glib
+  module JsonCrawler
+    class Coverage
+      @@files = []
+      @@coverage_files = Set.new
+
+      def self.files
+        @@files
+      end
+
+      def self.files=(files)
+        @@files = files
+      end
+
+      def self.coverage_files
+        @@coverage_files
+      end
+    end
+  end
+end

data/lib/glib/json_crawler/http.rb

@@ -0,0 +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

data/lib/glib/json_crawler/router.rb

@@ -0,0 +1,86 @@
+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)
+        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 (onClick = (args.fetch('onClick', nil) || args.fetch('onResponse', nil)))
+            action = onClick['action']
+            params = onClick
+          end
+
+          if action.present?
+            @depth += 1
+            case action
+            when 'initiate_navigation'
+              @read_only_actions.add([action, params['url']])
+              JsonCrawler::NavInitiate.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
+            # child
+          end
+        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
+        @logger.close
+      end
+
+      def crawl_multiple(views, block)
+        @visitor.traverse_multiple views, block
+      end
+    end
+  end
+end