digup 0.0.2 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGU1YjNlNDZhNmJmMWJiNjI5ZWRlYzFjYTM5OGFiNWMyMjdlMmY4OQ==
+    MmQzOTM0ZjFhYTgwMmQ2ZjQxZGI1YjMxN2FmMGIwNTRkZDcxNjUyMQ==
   data.tar.gz: !binary |-
-    Yjg0OWQ4Yjg3ZGNjM2M2ZmI3YzAwOTRjN2QzZGZiMmZhZTc0NThmMA==
+    ZmI3ZDM3MzkzYmFlODRjYjI2MTk4OWZjYTU1YjQ0ODczMmZkOTUzNA==
 SHA512:
   metadata.gz: !binary |-
-    YjM4ZDg2NDMxZDlhMWU5YjY4YTVhZWZiYmRlNmVmNTA3ZmRkNGYxZTg5ZGQ0
-    ZGZiNTJkNTMwYzhhM2FkMzBkN2JjODdiODIyYzFjZWE1Y2Y3ZTI3OTVkM2Q0
-    YzFhZWI1YmVlMzllYWMwYjk4NGM3YmRiOTA2MWVlOWIyOTg1NDU=
+    OTdlYjU4YTFmOGYyZDExNzY4YjI4NzNmZjg1ZDM2ODJjMWMyNjFjZWVkYmZk
+    NzVkMTQxZmM5MjgzMDlkOGEwZDAzMDcxNzNmOTZkNmZjOWFiMzdhNDA5Yjhj
+    MjdjMzMxY2Q1ZDEwN2I2ZmQzZDdmOTI0M2M3NjMxOTBkODhlMWY=
   data.tar.gz: !binary |-
-    OWFmOWRjZWQyNjAzY2FkYjFlNDcxOGM2ZmZiOTFjZDA4YmE1NWZhZmZhZTZj
-    Y2Y0MmNmYjBiMjNhMjU0YWNiYzU5ZTQ0MzIwNGQ1ZWI5OWZlZGU3MDM5M2Ey
-    OTJiMWJmYmRhMjI0ZjVmOGE2MjhlOGQ3OGI2OTMzNmY4M2YxMjM=
+    NDAyYzg0Y2ZkMTUwODBlNmNiMGE1YmM4ZjYzNjk3ZTdjYmJiMTQ0ZTIzYjc3
+    Zjg1MzI1NGQ0ZjU5NTdlYzMxYzUzMGZlZmVlYWU5MDg1N2ZkMThmZTBkMjFl
+    NDk1NjNhZTJkOGFmM2FlMjk5YTFlNDc3NDlkZDhkYTBhZTgxN2M=

data/Changelog.md

@@ -0,0 +1,8 @@
+# 0.0.3
+
+- Added feature to specify type of response to be sent from the controllers action. This will help digup to append appropriate template. It can be used when 'script' request(i.e accepts in request header text/javascript, application/javascript) is  made to the server and server returns html instead of javascript.
+- Solved bugs in case when json was returned from the server
+
+# 0.0.2
+
+Initial working release

data/README.md

@@ -18,6 +18,13 @@ Or install it yourself as:
 
     $ gem install digup
 
+## Dependencies
+Digup requires rails( 4.2 < version > 3.0). It also requires jquery for handling log for js and json request
+
+## Note
+- Digup modifies json when Digup is used to get json response. It appends data to json. If application is calculating number of object inside json data or doing other manipulation then the manipulation may get affected.
+- If you are using firebug and 'track throw catch' is enable under script it may catch the exception throw. You can disable it so that it doesn't respond to exception already caught by Digup.
+
 ## Usage
 
 Digup have several settings to be set to operate diffrently.
@@ -46,7 +53,18 @@ You can configure digup to operate the way you want.
 
      eg) If it includes :json, then log will be appended to json response otherwise it would not be appended
 
-     Possible options for responset type are :js, :json, :html
+     Possible options for response type are :js, :json, :html
+
+     If  request for 'script'(i.e 'accepts' header of request header is text/javascript, application/javascript) is made to a server and server returns html instead of javascript then Digup might not work as accepted. In this case we need to specify response that server will send as digup_log second parameter
+
+     eg) digup_log 'Print this', :html
+
+     We need to use second parameter only once and for subsequent use of digu_log method in same controller action we can be skip second parameter. We can also use method set_digup_response to set response type as
+
+     eg) set_digup_response :html
+
+     Note: Above condition may occur when we use jquery dataType: 'script' in ajax call and server returns html. We can also specify second parameter as :js or :json if 'accepts' parameter of request header is different from the server response type(i.e is 'accepts' in request header is html and server is sending json)
+
 - log_to: It takes single value as symbol or array of symbol to specify multiple options. It sets places where the output should be logged.
 
      Possible options

data/Todo.md

@@ -0,0 +1,3 @@
+## TODO
+- Use rails engine for digup so that model and views are not generated in app directory and can be used from gem folder itself
+- Make it work for rails 4.2.0

data/lib/digup/extension.rb

@@ -1,7 +1,12 @@
 class Object
 
-  def digup_write(msg)
+  def digup_write(msg, response_type=nil)
+    Digup.response_type = response_type if response_type
     Digup.log(msg)
   end
 
+  def set_digup_response(response_type)
+    Digup.response_type = response_type
+  end
+
 end

data/lib/digup/logger.rb

@@ -30,10 +30,10 @@ module Digup
           Template.console_template_for_html_response
         when @responder.javascript_response?
           Template.console_template_for_javascript_response
-        else
+        when !Setting.log_to_html_body?
           new_json_template
       end
-      @responder.append_template_to_response(template)
+      @responder.append_template_to_response(template) if template
     end
 
     # Add log to database. ActiveRecord required

data/lib/digup/rack.rb

@@ -13,10 +13,10 @@ module Digup
         logger.log_all
         responder.append_javascript_to_evaluate_json if Setting.handle_json? && responder.html_response?
         responder.headers['Content-Length'] = responder.response_body.bytesize.to_s
-        responder.clear_digup_message_store
+        responder.clear_parameters
         responder.build_response
       else
-        responder.clear_digup_message_store
+        responder.clear_parameters
       end
       responder.build_response
     end

data/lib/digup/responder.rb

@@ -18,7 +18,7 @@ module Digup
       position = if response_body.include?('</body>')
         response_body.rindex('</body>')
       else
-        javascript_response? ? response_body.length : response_body.length - 1
+        json_response? ? response_body.length - 1 : response_body.length
       end
       response_body.insert(position, (json_response? ? '' : "\n") + template )
     end
@@ -56,10 +56,12 @@ module Digup
       valid? ? [status, headers, [response_body]] : @original_response
     end
 
-    # clears log message unless its not a redirection
+    # clears log message and reponse_type unless its not a redirection
     # If its redirection log needs to be displayed on redirected page. So its not cleared
-    def clear_digup_message_store
-      Digup.message_store.clear unless [301, 302].include?(status)
+    def clear_parameters
+      unless [301, 302].include?(status)
+        Digup.clear_all
+      end
     end
 
     def response_body
@@ -71,15 +73,27 @@ module Digup
     end
 
     def html_response?
-      response.content_type == 'text/html'
+      if Digup.response_type.present?
+        Digup.response_type == :html
+      else
+        response.content_type == 'text/html'
+      end
     end
 
     def javascript_response?
-      response.content_type == 'text/javascript'
+      if Digup.response_type.present?
+        Digup.response_type == :js
+      else
+        response.content_type == 'text/javascript'
+      end
     end
 
     def json_response?
-      response.content_type == 'application/json'
+      if Digup.response_type.present?
+        Digup.response_type == :json
+      else
+        response.content_type == 'application/json'
+      end
     end
 
   end

data/lib/digup/template.rb

@@ -90,19 +90,21 @@ module Digup
         end
         executable_javascript += console_template_for_javascript_response if Setting.log_to_console?
         code = <<-CODE
-        <script type='text/javascript'>
-          $(document).bind("ajaxComplete", function(event, xhr, settings){
-            jsonResponse = xhr.responseJSON;
-            if (jsonResponse) {
-              if ($.isArray(jsonResponse)) {
-                digupData = jsonResponse[jsonResponse.length - 1]
-                } else {
-                digupData = jsonResponse.digup
+          <script type='text/javascript'>
+            $(document).bind("ajaxComplete", function(event, xhr, settings){
+              try {
+                var jsonResponse = JSON.parse(xhr.responseText);
+              } catch(e) {}
+              if (typeof jsonResponse !== 'undefined') {
+                if ($.isArray(jsonResponse)) {
+                  digupData = jsonResponse[jsonResponse.length - 1].digup
+                  } else {
+                  digupData = jsonResponse.digup
+                }
+                #{executable_javascript}
               }
-              #{executable_javascript}
-            }
-          });
-        </script>
+            });
+          </script>
         CODE
       end
 

data/lib/digup/version.rb

@@ -1,3 +1,3 @@
 module Digup
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/digup.rb

@@ -9,7 +9,7 @@ require 'digup/extension'
 module Digup
 
   class << self
-    attr_accessor :message_store
+    attr_accessor :message_store, :response_type
 
     def message_store
       @message_store ||= []
@@ -63,6 +63,11 @@ module Digup
     def cursor_info?(record)
       Setting.cursor_info? && record[:cursor_info]
     end
+
+    def clear_all
+      Digup.message_store.clear
+      Digup.response_type = nil
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digup
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Rohan Pujari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2015-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,10 +68,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Changelog.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- Todo.md
 - digup.gemspec
 - lib/digup.rb
 - lib/digup/digup_railtie.rb