authi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f82d2e9f72b5643cb5689ececfb636eae3a33f85
-  data.tar.gz: 548972afb8e2444b31fc14a27b7c90db5d2556b3
+  metadata.gz: 5ebecea59ce64d2f65ac72affea7b2ce1ccb443a
+  data.tar.gz: bb120684e24f4263963a1d92aa1e6efee5b07f97
 SHA512:
-  metadata.gz: c11d11832e867ef1c7ac5cf32a61842a54bc50e8d8671758c1088c3fa6fa20141d3d8c08660c865239c6eb4cdadc1902bb168db35d5f210f3a794a9aabf87629
-  data.tar.gz: 115baafa754e7f56989a848a69460b1fee73b3ce1f5ebfbe0a4508cd5839f98b6dc654aa2cb6e210fbdb714f74d817781710f1e5af6079136a0db64df282df08
+  metadata.gz: 3413573cb69ae633cba8fefb86b16cef459b477a7e64f5a3baf91768db0783f2cddc293b5433a3bb429d1132fb07a6b6ff1bfb5792bf8459b4307ef101a51b2e
+  data.tar.gz: 231b6c27c3e5ef2ad5c34dd9a7a1affbb6c96a5eb8f98c8106a21f22cb9f8853337b6d90c5009823cf189c620ee65a03a38b0813d75aeced539e59ba86ab36a6

data/lib/authi.rb

@@ -2,24 +2,24 @@ require 'openssl'
 require 'base64'
 require 'securerandom'
 # Api Authentication Module
-# How it works
-# Client Side
+# =========================
+# <b>How it works</b>
+# ============
+# <i>Client Side</i>
 # ===========
 # A string is first created using your HTTP payload containing all parameters and a preshared key.
 # This string is then used to create the signature which is a Base64 encoded SHA1 HMAC, using the clients private secret key.
-# This signature is then can be added to Authorization HTTP header:
-# Authorization = Authy.generate_signed_header(params)
-# Now add this to to your header,
-# header["Authorization"] = Authorization
-# secret_key generated from the server side can be kept inside the a environment variable with name "shared_key" along with "service_name" as your service name
-# Server Side
-# ===========
-# API validation
-# --------------
-# is_valid = Authy.validate_api(params, request.headers)
-# Generating secret key for clients
-# ---------------------------------
-# secret_key = Authy.generate_secret_key
+# This signature is then can be added to Authorization HTTP header  
+# <code>Authorization = Authy.generate_signed_header(params)</code>  
+# Now add this to to your header    
+# <code>header["Authorization"] = Authorization</code>
+#
+# secret_key generated from the server side can be kept inside the a environment variable with name "shared_key" along with "service_name" as your service name  
+#  
+# <i>Server Side API validation</i>      
+# <code>is_valid = Authy.validate_api(params, request.headers)<code>  
+# Generating secret key for clients  
+# <code>secret_key = Authy.generate_secret_key<code>  
 module Authy
   # Create a signed hash using input parameter
   #
@@ -64,7 +64,7 @@ module Authy
     [fully_qualified_keys.join(','), map]
   end
 
-  # Utility method to build quary from deep lookup table and parameters
+  # Utility method to build query from deep lookup table and parameters
   def self.build_query(processed_data, deep_lookup_table) # :nodoc:
     query = []
     processed_data.split(',').each { |data| query << data + '=' + deep_lookup_table[data].to_s }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nithin Kumar