zopim_rails 0.0.4 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bcf40c21f09b8d08fd0985d53b10cdae2ec026d3
-  data.tar.gz: e7f7f3703a2fa9dede2f4cecef660da84bd409e0
+SHA256:
+  metadata.gz: 7307c5d2ac156daf01b54ad9780f239132ad8b8276b35d500fc26acad6751238
+  data.tar.gz: fc108b3034b2faba84363d24b96a3ff1917724172c0d9d76661fa00dd2dae237
 SHA512:
-  metadata.gz: 0be9c5f106037905993ac8e08d5c9732f258edadcbdac45276f1ed57f52a7fcc4ad03049fd4d9e1ab14f616bba125aa9723a4cf15416aa0de87239e6e43c3576
-  data.tar.gz: 0985011e94b49844193754b63d426a47c61ae69d40b3e4dda400a4ffac9a045b1d0000d62d03f4142fd3982df95e2402a4fa406221cc380025e518768fd63491
+  metadata.gz: e28773ae03f244f24d7609087ff5a2a97f725a03b9716a5a053f869cd50ee2f57bebe036ddc5af2337292214b7e1ca9c0cbfaaeea05051482f2b748b8217669c
+  data.tar.gz: 0c3ea4079fc38f544ed9184654a7abb898bda38da513e1cbdd509445f9d9f8fe31767ea4d393b0b81c2c28a3be5a94a88ac88ede239a58d21a60f6e3ee6f0368

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+vendor
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/README.md

@@ -1,13 +1,18 @@
 # ZopimRails
+[![Gem Version](https://badge.fury.io/rb/zopim_rails.svg)](https://badge.fury.io/rb/zopim_rails)
+[![Build Status](https://travis-ci.org/wittawasw/zopim_rails.svg?branch=master)](https://travis-ci.org/wittawasw/zopim_rails)
+
+Rails simple helper for [Zopim](https://www.zopim.com/) live chat script.    
+Now support turbolink 2.5.3+ with help from [Contributing](https://github.com/wittawasw/zopim_rails/graphs/contributors)
 
-Rails simple helper for [Zopim](https://www.zopim.com/) live chat script.
-Now support turbolink with help from [luizpicolo](https://github.com/luizpicolo).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'zopim_rails'
+```ruby
+gem 'zopim_rails'
+```
 
 And then execute:
 
@@ -19,13 +24,23 @@ Or install it yourself as:
 
 ## Usage
 
-Create file `zopim.rb` in `config/initialize/zopim.rb` and add
+Create file `zopim.rb` in `config/initializers/zopim.rb` and add
 
-    ZopimRails.api_key = "<your-api-key>"
+```ruby
+ZopimRails.configure do |config|
+  config.api_key = 'replace-me-with-your-api_key'
+end
+```
 
 place render method where you want in view.
 
-    <%= zopim_init %>
+```ruby
+<%= zopim_init %>
+```
+
+## Demostration
+
+https://zopimrailstest.herokuapp.com/
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/zopim_rails.rb

@@ -1,36 +1,8 @@
 # coding: utf-8
 require 'zopim_rails/chatbox'
+require 'zopim_rails/configuration'
 require 'zopim_rails/rails/railtie'
 require "zopim_rails/version"
 
 module ZopimRails
-
-  PLACEHOLDER_KEY = "xxxxxxxxx"
-  # Get the current api key.
-  # @return [String]
-  def self.api_key
-    @@api_key ||= PLACEHOLDER_KEY
-  end
-
-  # Set the current api key.
-  # @param [String] tracker The api key.
-  def self.api_key=(api_key)
-    @@api_key = api_key
-  end
-
-  # @return [Boolean]
-  def self.valid_api_key?
-    api_key.nil? || api_key == "" || api_key == PLACEHOLDER_KEY ? false : true
-  end
-
-  #To be removed
-  def self.render
-    <<-JAVASCRIPT
-    <script type="text/javascript">function zopim_chat(){$('[__jx__id]').remove();window.$zopim = null;(function(d,s){var z=$zopim=function(c){z._.push(c)},$=z.s=d.createElement(s),e=d.getElementsByTagName(s)[0];z.set=function(o){z.set._.push(o)};z._=[];z.set._=[];$.async=!0;$.setAttribute('charset','utf-8');$.src='//v2.zopim.com/?2ykAW7vz8GhsKrykTWPE7a6SNXEaYNcJ';z.t=+new Date;$.type='text/javascript';e.parentNode.insertBefore($,e)})(document,'script')};$(window).off('page:change.zopim').on('page:change.zopim', zopim_chat);</script>
-    JAVASCRIPT
-  end
-  def self.init
-    self.render.html_safe
-  end
-
 end

data/lib/zopim_rails/chatbox.rb

@@ -1,10 +1,9 @@
 # coding: utf-8
-
 module ZopimRails
   class Chatbox
     def render_script
       <<-JAVASCRIPT
-      <script type="text/javascript">function zopim_chat(){$('[__jx__id]').remove();window.$zopim = null;(function(d,s){var z=$zopim=function(c){z._.push(c)},$=z.s=d.createElement(s),e=d.getElementsByTagName(s)[0];z.set=function(o){z.set._.push(o)};z._=[];z.set._=[];$.async=!0;$.setAttribute('charset','utf-8');$.src='//v2.zopim.com/?2ykAW7vz8GhsKrykTWPE7a6SNXEaYNcJ';z.t=+new Date;$.type='text/javascript';e.parentNode.insertBefore($,e)})(document,'script')};$(window).off('page:change.zopim').on('page:change.zopim', zopim_chat);</script>
+      <script type="text/javascript">function zopim_chat(){$('[__jx__id]').remove();window.$zopim = null;(function(d,s){var z=$zopim=function(c){z._.push(c)},$=z.s=d.createElement(s),e=d.getElementsByTagName(s)[0];z.set=function(o){z.set._.push(o)};z._=[];z.set._=[];$.async=!0;$.setAttribute('charset','utf-8');$.src='//v2.zopim.com/?#{ZopimRails.configuration.api_key}';z.t=+new Date;$.type='text/javascript';e.parentNode.insertBefore($,e)})(document,'script')};$(window).off('page:change.zopim turbolinks:load.zopim').on('page:change.zopim turbolinks:load.zopim', zopim_chat);</script>
       JAVASCRIPT
     end
   end

data/lib/zopim_rails/configuration.rb

@@ -0,0 +1,22 @@
+require_relative 'version'
+
+module ZopimRails
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key
+    attr_reader :version
+
+    def initialize
+      @version = VERSION
+      @api_key = 'replace-me-with-api_key'
+    end
+  end
+end

data/lib/zopim_rails/rails/railtie.rb

@@ -1,5 +1,4 @@
 # coding: utf-8
-
 require 'zopim_rails/rails/view_helpers'
 
 module ZopimRails::Rails
@@ -9,4 +8,4 @@ module ZopimRails::Rails
       ActionView::Base.send :include, ViewHelpers
     end
   end
-end
+end

data/lib/zopim_rails/rails/view_helpers.rb

@@ -1,21 +1,12 @@
 # coding: utf-8
-
 require 'active_support/core_ext/string/output_safety'
 require 'active_support/core_ext/object/blank'
 
 module ZopimRails::Rails
-
   module ViewHelpers
-
     def zopim_init
-
-      unless ZopimRails.valid_api_key?
-        raise ArgumentError, "API key for Zopim chat is missing."
-      end
-
       queue = ZopimRails::Chatbox.new
       queue.render_script.html_safe
-      
     end
   end
-end
+end

data/lib/zopim_rails/version.rb

@@ -1,3 +1,3 @@
 module ZopimRails
-  VERSION = "0.0.4"
+  VERSION = "1.9.1".freeze
 end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/zopim_rails/chatbox_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require_relative '../../lib/zopim_rails/chatbox'
+
+describe ZopimRails::Chatbox do
+  before do
+    ZopimRails.configure do |config|
+      config.api_key = 'replace-me-with-your-api_key'
+    end
+  end
+
+  let(:chatbox) { ZopimRails::Chatbox.new() }
+
+  it "should return javascript correctly" do
+    expect(chatbox.render_script).to be_a_kind_of(String)
+    expect(chatbox.render_script).to include('replace-me-with-your-api_key')
+  end
+end

data/spec/zopim_rails/configuration_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require_relative '../../lib/zopim_rails/configuration'
+
+describe ZopimRails::Configuration do
+  before do
+    ZopimRails.configure do |config|
+      config.api_key = 'replace-me-with-your-api_key'
+    end
+  end
+
+  it "should return api_key correctly" do
+    expect(ZopimRails.configuration.api_key).to be_a_kind_of(String)
+    expect(ZopimRails.configuration.api_key).to eq 'replace-me-with-your-api_key'
+  end
+end

data/spec/zopim_rails/version_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require_relative '../../lib/zopim_rails/version'
+
+describe ZopimRails do
+  it "should return version correctly" do
+    expect(ZopimRails::VERSION).to be_a_kind_of(String)
+    expect(ZopimRails::VERSION).to eq '1.9.1'
+  end
+end

data/zopim_rails.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency "bundler", ">= 1.5"
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_dependency 'jquery-rails', ['>= 3.0', '< 5']
 end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: zopim_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.9.1
 platform: ruby
 authors:
 - Wittawas Wisarnkanchana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-07 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -66,15 +80,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/zopim_rails.rb
 - lib/zopim_rails/chatbox.rb
+- lib/zopim_rails/configuration.rb
 - lib/zopim_rails/rails/railtie.rb
 - lib/zopim_rails/rails/view_helpers.rb
 - lib/zopim_rails/version.rb
+- spec/spec_helper.rb
+- spec/zopim_rails/chatbox_spec.rb
+- spec/zopim_rails/configuration_spec.rb
+- spec/zopim_rails/version_spec.rb
 - zopim_rails.gemspec
 homepage: https://github.com/wittawasw/zopim_rails
 licenses:
@@ -95,9 +117,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Rails helper for Zopim live chat script.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/zopim_rails/chatbox_spec.rb
+- spec/zopim_rails/configuration_spec.rb
+- spec/zopim_rails/version_spec.rb