komments 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 567c11064f4cc3f52a8d0de4a5c71ad61eaf039f
-  data.tar.gz: 02608e46236dc6d65ffd62fa379c86d726542551
+  metadata.gz: ee719341eefbc78bd89d99d6d0aab23fcf70b069
+  data.tar.gz: dd3ab5a15f31123b025788a004ec78d51bd1b0b4
 SHA512:
-  metadata.gz: d09398e14f20ca797a42fd26234b0f1440a9b8c5e5a895121d659f8dbdabf59ae36842d550d69a8ed69fceb15456f38f3dcbcab9475417bbefb5c90b2146feec
-  data.tar.gz: f0430e37f9e76e1cc6a18ea81f3bf62894c8c0b83ec2cbaaa0acb5638c545903e84fce21ff329fce97741a450407de3cbbdb5767ee839d6905030e9dd8278088
+  metadata.gz: 17745af6c5ff415deecf72752e54f4b388c4cd8851b28193e70f3ed8e8b9c30e0b1c90ef3d9c24feb3a9fb4f8ef2bdf47a101a78fbfbe4893b1f2b69054685b0
+  data.tar.gz: f2d8ff6386d76c8485de897a14ecf75e0e5ff483b0cb0fd0eaf742a5679d2d991bf491d3667006762f89e1150ce3cd067be363c6a659065b67ebfc04ca134551

data/README.md

@@ -1,5 +1,4 @@
 [![Gem Version](http://img.shields.io/gem/v/komments.svg?style=flat)](http://badge.fury.io/rb/komments)
-[![Build Status](http://img.shields.io/travis/mattpolito/komments_gem/master.svg?style=flat)](https://travis-ci.org/mattpolito/komments_gem)
 [![Code Climate](http://img.shields.io/codeclimate/github/mattpolito/komments_gem.svg?style=flat)](https://codeclimate.com/github/mattpolito/komments_gem)
 
 Ruby wrapper to get configured with the commenting engine, [Komments][]
@@ -26,7 +25,65 @@ gem install komments
 
 ## Usage
 
-TODO: Write usage instructions here
+Currently the main functionality of this library is to configure your api key so that your personalized site url can be generated.
+
+To do this:
+
+```ruby
+Komments.configure do |config|
+  config.api_key = 'API_KEY_GOES_HERE'
+end
+```
+
+Would be the most straight forward way to go about this. If this were being used in a [Rails][] project, I would recommend putting this in your `config/initializers` directory.
+
+Now that your credentials are out of the way, you'll be able to call:
+
+```ruby
+Komments.website_url
+```
+
+This will provide your site's url to [Komments][]. Add that to a `script` tag in your template and you will be good to go.
+
+```erb
+<script async="async" src=<%= Komments.website_url %>></script>
+
+```
+
+That will end up looking this this:
+
+
+```html
+<script async="async" src="//komments.net/embed/{API_KEY_GOES_HERE}"></script>
+```
+
+# Rails Usage
+
+If you happen to be integrating Komments into your Rails application, you're covered as well.
+
+When a Rails app is detected, you'll gain access to the `komments_script_tag` helper.
+
+```ruby
+<%= komments_script_tag %>
+```
+
+Which will render out to:
+
+```html
+<script async="async" src="//komments.net/embed/{API_KEY_GOES_HERE}"></script>
+```
+
+And if you [don't want the script to be loaded asynchronously][async vs defer]...
+
+```ruby
+<%= komments_script_tag(false) %>
+```
+
+Which will render out to:
+
+```html
+<script defer="defer" src="//komments.net/embed/{API_KEY_GOES_HERE}"></script>
+```
 
 ## Contributing
 
@@ -37,3 +94,5 @@ TODO: Write usage instructions here
 5. Create a new Pull Request
 
 [Komments]: http://komments.net
+[Rails]: http://rubyonrails.org
+[async vs defer]: http://www.growingwiththeweb.com/2014/02/async-vs-defer-attributes.html

data/lib/komments.rb

@@ -16,3 +16,7 @@ module Komments
     Configuration.instance
   end
 end
+
+if defined?(Rails::Railtie)
+  require 'komments/railtie'
+end

data/lib/komments/railtie.rb

@@ -0,0 +1,10 @@
+module Komments
+  class Railtie < Rails::Railtie
+    initializer "komments" do |app|
+      ActiveSupport.on_load(:action_view) do
+        require 'komments/view_helpers'
+        ::ActionView::Base.send :include, ViewHelpers
+      end
+    end
+  end
+end

data/lib/komments/version.rb

@@ -1,3 +1,3 @@
 module Komments
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/komments/view_helpers.rb

@@ -0,0 +1,16 @@
+module Komments
+  module ViewHelpers
+    def komments_script_tag(async = true)
+      options = Hash.new
+      options[:src] = Komments.website_url
+
+      if async
+        options[:async] = 'async'
+      else
+        options[:defer] = 'defer'
+      end
+
+      content_tag(:script, nil, options)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: komments
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Matt Polito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2014-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,7 +54,9 @@ files:
 - lib/komments.rb
 - lib/komments/configuration.rb
 - lib/komments/errors.rb
+- lib/komments/railtie.rb
 - lib/komments/version.rb
+- lib/komments/view_helpers.rb
 homepage: https://github.com/mattpolito/komments_gem
 licenses:
 - MIT