planbcd-rails 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e92e7c57c1883b8432fd5a3c1b86aa4450ab48c6
-  data.tar.gz: bb7d6d59dd227b1d9e9d0403166de2b4d84428fe
+  metadata.gz: 5c0d0646acb96f02b50d69e52b19e9d8fba08ec4
+  data.tar.gz: b57d6f8be129bbb7a858698f36ae0867cddb8287
 SHA512:
-  metadata.gz: 189066d4b57ec15859d892fb3502d8d9fa2bfcb62ef1f3d2620439644097c71324c5c0c3e624960590a754df8698467feff6fd0c903fb62a6989e313a118e9c6
-  data.tar.gz: 5e49f5cbd9d0cee7420d5832eb52380877f19ee719b2b8caa335a1788e24df1b657c62b05c0b3313d41de49ed2baf40e445f99d1be4ff10e9b5eed836fcc640f
+  metadata.gz: 3f086b7daee187846c4cfe6c410b3edd650172ed0b3a498166988e5422834beb683e2188786f5086b33fc8fd9db502c4cfc9bd72f9cc4f718d728b0fedd3c3f3
+  data.tar.gz: 5c5d42f3aa70326e1c007269707e3adb1248ae089af4d5fd6469a49864f254c09c3c81580d81aa899c298ca4d120388037e7e1468658e1a041cc4c204503da01

data/README.md

@@ -2,7 +2,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/planbcd-rails.png)](https://rubygems.org/gems/planbcd-rails) [![Build Status](https://secure.travis-ci.org/dtaniwaki/planbcd-rails.png?branch=master)](http://travis-ci.org/dtaniwaki/planbcd-rails) [![Coverage Status](https://coveralls.io/repos/dtaniwaki/planbcd-rails/badge.png)](https://coveralls.io/r/dtaniwaki/planbcd-rails)
 
-PlanBCD For Rails! So great.
+[PlanBCD](https://planb.cd/) For Rails! So great.
+
+This is NOT a official gem from [KAIZEN Platform Inc](http://kaizenplatform.in/).
 
 ## Installation
 
@@ -21,9 +23,15 @@ Then, initialize planbcd.
 bundle exec rails generate planbcd:install
 ```
 
-## TODO
+## Configuration
+
+### `js`
+
+JS URL which you can find on PlanBCD offer page
+
+### `auto_insert` (Optional)
 
-- Add an option to insert the PlanBCD tag to any page
+Set true if you want to insert the PlanBCD tag to all the pages generated by Rails
 
 ## Contributing
 

data/lib/generators/planbcd/templates/planbcd.rb

@@ -2,4 +2,7 @@ PlanBCD::Rails.configure do |c|
   # Set your JS file found in your offer.
   # c.js = "//localhost/abc/def.js"
   # c.js = proc { |controller| controller.is_something? ? "//localhost/abc/def_1.js" : "//localhost/abc/def_2.js" }
+
+  # Insert PlanBCD js code to any response for html request
+  # c.auto_insert = true
 end

data/lib/planbcd/rails/configuration.rb

@@ -1,7 +1,7 @@
 module PlanBCD
   module Rails
     class Configuration
-      attr_accessor :js
+      attr_accessor :js, :auto_insert
     end
   end
 end

data/lib/planbcd/rails/middleware.rb

@@ -0,0 +1,38 @@
+module PlanBCD
+  module Rails
+    class Middleware
+      include Rack::Utils
+      include ViewHelpers
+
+      def initialize(app)
+        @app = app
+      end
+      
+      def call(env)
+        status, headers, response = @app.call(env)
+
+        headers = HeaderHash.new(headers)
+
+        if headers['Content-Type'].to_s =~ %r{^text/html;}i && PlanBCD::Rails.configuration.auto_insert
+          begin
+            response = insert_js(response)
+          rescue PlanBCD::Rails::Exception => e
+            $stderr.write "Failed to insert planbcd tag: #{e.message}\n"
+          end
+        end
+
+        [status, headers, response]
+      end
+
+      private
+
+      def insert_js(response)
+        body = ""
+        response.each do |r|
+          body.concat r.to_s
+        end
+        [body.sub(/(<head[^>]*>)/, "\\1#{pbcd_init}")]
+      end
+    end
+  end
+end

data/lib/planbcd/rails/railtie.rb

@@ -1,11 +1,13 @@
 require 'rails/railtie'
 require 'planbcd/rails/view_helpers'
+require 'planbcd/rails/middleware'
 
 module PlanBCD
   module Rails
     class Railtie < ::Rails::Railtie
-      initializer "planbcd-rails" do
+      initializer "planbcd-rails" do |app|
         ActionView::Base.send :include, ViewHelpers
+        app.middleware.use Middleware
       end
     end
   end

data/lib/planbcd/rails/version.rb

@@ -1,5 +1,5 @@
 module PlanBCD
   module Rails
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/lib/planbcd/rails/view_helpers.rb

@@ -6,7 +6,7 @@ module PlanBCD
     module ViewHelpers
       def pbcd_init
         unless js = PlanBCD::Rails.configuration.js.presence
-          raise PlanBCD::Rails::RuntimeError, "PlanBCD Javascript is not loaded."
+          raise PlanBCD::Rails::RuntimeError, "PlanBCD Javascript has not been set."
         end
 
         if js.respond_to?(:call)

data/planbcd-rails.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.platform    = Gem::Platform::RUBY
   gem.authors     = ["Daisuke Taniwaki"]
   gem.email       = ["daisuketaniwaki@gmail.com"]
-  gem.homepage    = "http://rubygems.org/gems/planbcd-rails"
+  gem.homepage    = "https://github.com/dtaniwaki/planbcd-rails"
   gem.summary     = "Use PlanBCD with Rails 3+"
   gem.description = "This gem provides view helpers for PlanBCD."
   gem.license     = "MIT"

data/spec/planbcd/rails/middleware_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe PlanBCD::Rails::Middleware do
+  let(:app) { double call: [200, {'Content-Type' => 'text/html; charset=utf-8'}, ['<html><head>something</head><body></body></html>']] }
+  let(:js) { '//planb.cd/test.js' }
+  subject { PlanBCD::Rails::Middleware.new(app) }
+  before do
+    PlanBCD::Rails.configure do |c|
+      c.js = js
+      c.auto_insert = true
+    end
+  end
+
+  it "inserts planbcd tag" do
+    status, headers, body = subject.call({})
+    expect(status).to eq(200)
+    expect(headers).to eq({'Content-Type' => 'text/html; charset=utf-8'})
+    expect(body).to eq([%Q~<html><head><script type=\"text/javascript\">(function(){!function(a,b,c,d,e){return d=\"http\"+(\"https:\"===c?\"s\":\"\")+\":\"+d,a.planBCDObject=e,a[e]||(a[e]=function(){var b;return((b=a[e]).q||(b.q=[])).push(arguments),a[e].l=1*new Date}),b.write(unescape('%3Cscript type=\"text/javascript\" src=\"'+d+'\"%3E%3C/script%3E'))}(window,document,document.location.protocol,\"//planb.cd/test.js\",\"pbcd\")}).call(this);</script>something</head><body></body></html>~])
+  end
+  context "head tag with something" do
+    let(:app) { double call: [200, {'Content-Type' => 'text/html; charset=utf-8'}, ['<html><head abcdefg>something</head><body></body></html>']] }
+    it "inserts planbcd tag" do
+      status, headers, body = subject.call({})
+      expect(status).to eq(200)
+      expect(headers).to eq({'Content-Type' => 'text/html; charset=utf-8'})
+      expect(body).to eq([%Q~<html><head abcdefg><script type=\"text/javascript\">(function(){!function(a,b,c,d,e){return d=\"http\"+(\"https:\"===c?\"s\":\"\")+\":\"+d,a.planBCDObject=e,a[e]||(a[e]=function(){var b;return((b=a[e]).q||(b.q=[])).push(arguments),a[e].l=1*new Date}),b.write(unescape('%3Cscript type=\"text/javascript\" src=\"'+d+'\"%3E%3C/script%3E'))}(window,document,document.location.protocol,\"//planb.cd/test.js\",\"pbcd\")}).call(this);</script>something</head><body></body></html>~])
+    end
+  end
+  context "no head tag in body" do
+    let(:app) { double call: [200, {'Content-Type' => 'text/html; charset=utf-8'}, ['<html><body></body></html>']] }
+    it "does not insert planbcd tag if the body does not have head tag" do
+      status, headers, body = subject.call({})
+      expect(status).to eq(200)
+      expect(headers).to eq({'Content-Type' => 'text/html; charset=utf-8'})
+      expect(body).to eq([%Q~<html><body></body></html>~])
+    end
+  end
+  context "not html request" do
+    let(:app) { double call: [200, {'Content-Type' => 'application/json;'}, ['{}']] }
+    it "does not insert planbcd tag if the body does not have head tag" do
+      expect(subject).not_to receive(:insert_js)
+      status, headers, body = subject.call({})
+      expect(status).to eq(200)
+      expect(headers).to eq({'Content-Type' => 'application/json;'})
+      expect(body).to eq(['{}'])
+    end
+  end
+  context "no js" do
+    let(:js) { nil }
+    it "does not raise error but write the log" do
+      expect($stderr).to receive(:write).with(/^Failed to insert planbcd tag: /)
+      expect {
+        subject.call({})
+      }.not_to raise_error
+    end
+  end
+end

data/spec/planbcd/rails/railtie_spec.rb

@@ -3,12 +3,16 @@ require 'action_view'
 
 describe PlanBCD::Rails::Railtie do
   before :all do
-    app = Class.new(Rails::Application)
-    app.initialize!
+    @app = Class.new(Rails::Application)
+    @app.initialize!
   end
   subject { ActionView::Base.new }
   
   it "should have planbcd helpers" do
     expect(subject).to respond_to(:pbcd_init)
   end
+
+  it "should add rack middleware" do
+    expect(@app.middleware.middlewares).to include(PlanBCD::Rails::Middleware)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: planbcd-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Daisuke Taniwaki
@@ -96,14 +96,16 @@ files:
 - lib/planbcd/rails.rb
 - lib/planbcd/rails/configuration.rb
 - lib/planbcd/rails/error.rb
+- lib/planbcd/rails/middleware.rb
 - lib/planbcd/rails/railtie.rb
 - lib/planbcd/rails/version.rb
 - lib/planbcd/rails/view_helpers.rb
 - planbcd-rails.gemspec
+- spec/planbcd/rails/middleware_spec.rb
 - spec/planbcd/rails/railtie_spec.rb
 - spec/planbcd/rails/view_helpers_spec.rb
 - spec/spec_helper.rb
-homepage: http://rubygems.org/gems/planbcd-rails
+homepage: https://github.com/dtaniwaki/planbcd-rails
 licenses:
 - MIT
 metadata: {}
@@ -123,11 +125,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Use PlanBCD with Rails 3+
 test_files:
+- spec/planbcd/rails/middleware_spec.rb
 - spec/planbcd/rails/railtie_spec.rb
 - spec/planbcd/rails/view_helpers_spec.rb
 - spec/spec_helper.rb