delayed_kiss 0.0.1 → 0.1.0

data/README.textile

@@ -6,38 +6,44 @@ h2. Installation
 
 Include the gem in your gemfile:
 
-<pre>
-  gem 'delayed_kiss'
-</pre>
+<pre>gem 'delayed_kiss'</pre>
 
 Configure your API key:
-<pre>
-  #in config/kiss_metrics.yml
-  development:
-    key: <yourkey>
+
+h3. In Version 0.1.0 
+
+<pre>  #in config/delayed_kiss.yml
+  development: 
+    key: yourkey 
+    whiny_config: true 
   test:
-    key: <yourkey>
-  production:
-    key: <yourkey>
+    key: yourkey 
+  production: 
+    key: yourkey 
 </pre>
-Initialize the API key
-<pre>
+
+h3. In Version 0.0.1 
+
+<pre>  #in config/kiss_metrics.yml 
+  development: 
+    key: yourkey 
+  test: 
+    key: yourkey
+  production: 
+    key: yourkey
+
   #in config/initializers
-  KM_CONFIG = YAML::load(ERB.new(IO.read(File.join(Rails.root, "config/kissmetrics.yml"))).result)[Rails.env]
-  if !KM_CONFIG.blank?
+  KM_CONFIG = YAML::load(ERB.new(IO.read(File.join(Rails.root, "config/kissmetrics.yml"))).result)[Rails.env] 
+  if !KM_CONFIG.blank? 
     DelayedKiss.configure do |config|
-      config.key = KM_CONFIG['key']
-    end
-  end
-</pre>
+      config.key = KM_CONFIG['key'] 
+    end 
+  end</pre>
 
 h2. Usage
 
-Start recording events anywhere in your application:
-<pre>
-  DelayedKiss.alias(anonymous_user, user.km_id)
-  DelayedKiss.record(user.km_id, 'signed up')
-</pre>
+Start recording events anywhere in your application: <pre>  DelayedKiss.alias(anonymous_user, user.km_id)
+  DelayedKiss.record(user.km_id, 'signed up')</pre>
 
 h2. Thanks
 

data/lib/delayed_kiss.rb

@@ -1,15 +1,22 @@
 require "delayed_kiss/version"
+require 'delayed_kiss/railtie' if defined?(Rails)
 
 module DelayedKiss
   mattr_accessor :key
   @@key = nil
   
+  mattr_accessor :whiny_config
+  @@whiny_config = false
+  
+  mattr_accessor :config_file
+  @@config_file = "config/delayed_kiss.yml"
+  
   def self.configure
     yield self
   end
 
   def self.record(id, event, query_params={})
-    raise DelayedKiss::ConfigurationError if @@key.blank?
+    self.verify_configuration
     raise ArgumentError.new("id can't be blank") if id.blank?
     raise ArgumentError.new("event can't be blank") if event.blank?
     
@@ -19,11 +26,11 @@ module DelayedKiss
       '_t' => Time.now.to_i.to_s,
       '_k' => @@key
     })
-    HTTParty.delay.get('https://trk.kissmetrics.com/e?' + query_params.to_param)
+    HTTParty.delay.get('https://trk.kissmetrics.com/e?' + query_params.to_param) unless @@key.blank?
   end
 
   def self.alias(alias_from, alias_to)
-    raise DelayedKiss::ConfigurationError if @@key.blank?
+    self.verify_configuration
     raise ArgumentError.new("you must specify both a from a to value") if alias_from.blank? || alias_to.blank?
     
     query_params = {
@@ -32,11 +39,11 @@ module DelayedKiss
       '_t' => Time.now.to_i.to_s,
       '_k' => @@key
     }
-    HTTParty.delay.get('https://trk.kissmetrics.com/a?' + query_params.to_param)
+    HTTParty.delay.get('https://trk.kissmetrics.com/a?' + query_params.to_param) unless @@key.blank?
   end
 
   def self.set(id, query_params)
-    raise DelayedKiss::ConfigurationError if @@key.blank?
+    self.verify_configuration
     raise ArgumentError.new("id can't be blank") if !id || id.blank?
     return if query_params.blank? # don't do anything if we're not setting any values on the identity
     
@@ -45,7 +52,11 @@ module DelayedKiss
       '_t' => Time.now.to_i.to_s,
       '_k' => @@key
     })
-    HTTParty.delay.get('https://trk.kissmetrics.com/s?' + query_params.to_param)
+    HTTParty.delay.get('https://trk.kissmetrics.com/s?' + query_params.to_param) unless @@key.blank?
+  end
+  
+  def self.verify_configuration
+    raise DelayedKiss::ConfigurationError if @@whiny_config && @@key.blank?
   end
   
   class ConfigurationError < StandardError; end

data/lib/delayed_kiss/railtie.rb

@@ -0,0 +1,21 @@
+module DelayedKiss
+  class Railtie < Rails::Railtie
+    initializer "delayed_kiss.load_configuration" do
+      env_config = nil
+      config_file = File.join(Rails.root, DelayedKiss.config_file)
+      if File.exists?(config_file)
+        config_from_yaml = YAML::load(ERB.new(IO.read(config_file)).result)
+        if !config_from_yaml.blank?
+          env_config = config_from_yaml[Rails.env]
+        end
+      else
+        Rails.logger.warn("DelayedKiss: Configuration file not found.")
+      end
+      if !env_config.blank?
+        DelayedKiss.configure do |config|
+          config.key = env_config['key']
+        end
+      end
+    end
+  end
+end

data/lib/delayed_kiss/version.rb

@@ -1,3 +1,3 @@
 module DelayedKiss
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/delayed_kiss_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 
 describe DelayedKiss do
+  before(:each) do
+    DelayedKiss.cache_config
+  end
+  
+  after(:each) do
+    DelayedKiss.reset_config
+  end
+  
   describe :configure do
-    before(:each) do
-      DelayedKiss.cache_config
-    end
-    
-    after(:each) do
-      DelayedKiss.reset_config
-    end
-    
     it "should configure the key" do
       test_key = "youraikeyvalue"
       DelayedKiss.configure do |config|
@@ -31,7 +31,7 @@ describe DelayedKiss do
       expect { DelayedKiss.record(nil, "event") }.to raise_error(ArgumentError)
     end
     
-    it "should rais an error without an event" do
+    it "should raise an error without an event" do
       expect { DelayedKiss.record("identity", nil) }.to raise_error(ArgumentError)
     end
     
@@ -40,11 +40,23 @@ describe DelayedKiss do
       DelayedKiss.record("identity", "event", {:type => "crazy"})
     end
     
-    it "should raise an error if the key is not configured" do
-      DelayedKiss.cache_config
+    it "should raise an error if the key is not configured and the whiny config is turned on" do
       DelayedKiss.key = nil
+      DelayedKiss.whiny_config = true
       expect { DelayedKiss.record("identity", "event") }.to raise_error(DelayedKiss::ConfigurationError)
-      DelayedKiss.reset_config
+    end
+    
+    it "should not raise an error if the key is not configured and the whiny config is turned off" do
+      DelayedKiss.whiny_config = false
+      expect { DelayedKiss.record("identity", "event") }.to_not raise_error(DelayedKiss::ConfigurationError)
+    end
+    
+    it "should not send a request to the KISSmetrics API if the API key is blank and the whiny config is turned off" do
+      HTTParty.expects(:get).never
+      
+      DelayedKiss.key = nil
+      DelayedKiss.whiny_config = false
+      DelayedKiss.record("identity", "event")
     end
   end
   
@@ -72,11 +84,23 @@ describe DelayedKiss do
       expect { DelayedKiss.alias("oldname", nil) }.to raise_error(ArgumentError)
     end
     
-    it "should raise an error if the key is not configured" do
-      DelayedKiss.cache_config
+    it "should raise an error if the key is not configured and the whiny config is turned on" do
       DelayedKiss.key = nil
-      expect { DelayedKiss.record("identity", "event") }.to raise_error(DelayedKiss::ConfigurationError)
-      DelayedKiss.reset_config
+      DelayedKiss.whiny_config = true
+      expect { DelayedKiss.alias("oldname", "newname") }.to raise_error(DelayedKiss::ConfigurationError)
+    end
+    
+    it "should not raise an error if the key is not configured and the whiny config is turned off" do
+      DelayedKiss.whiny_config = false
+      expect { DelayedKiss.alias("oldname", "newname") }.to_not raise_error(DelayedKiss::ConfigurationError)
+    end
+    
+    it "should not send a request to the KISSmetrics API if the API key is blank and the whiny config is turned off" do
+      HTTParty.expects(:get).never
+      
+      DelayedKiss.key = nil
+      DelayedKiss.whiny_config = false
+      DelayedKiss.alias("oldname", "newname")
     end
   end
   
@@ -100,11 +124,23 @@ describe DelayedKiss do
       expect { DelayedKiss.set(nil, {:gener => :female}) }.to raise_error(ArgumentError)
     end
     
-    it "should raise an error if the key is not configured" do
-      DelayedKiss.cache_config
+    it "should raise an error if the key is not configured and the whiny config is turned on" do
       DelayedKiss.key = nil
-      expect { DelayedKiss.record("identity", "event") }.to raise_error(DelayedKiss::ConfigurationError)
-      DelayedKiss.reset_config
+      DelayedKiss.whiny_config = true
+      expect { DelayedKiss.set("identity", {:occupation => "Lab Rat"}) }.to raise_error(DelayedKiss::ConfigurationError)
+    end
+    
+    it "should not raise an error if the key is not configured and the whiny config is turned off" do
+      DelayedKiss.whiny_config = false
+      expect { DelayedKiss.set("identity", {:age => "old"}) }.to_not raise_error(DelayedKiss::ConfigurationError)
+    end
+    
+    it "should not send a request to the KISSmetrics API if the API key is blank and the whiny config is turned off" do
+      HTTParty.expects(:get).never
+      
+      DelayedKiss.key = nil
+      DelayedKiss.whiny_config = false
+      DelayedKiss.set("identity", {:education => "college"})
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed_kiss
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-07 00:00:00.000000000 -05:00
+date: 2011-11-15 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152316100 !ruby/object:Gem::Requirement
+  requirement: &2164268460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152316100
+  version_requirements: *2164268460
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2152315680 !ruby/object:Gem::Requirement
+  requirement: &2164268040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152315680
+  version_requirements: *2164268040
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2152315180 !ruby/object:Gem::Requirement
+  requirement: &2164267540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152315180
+  version_requirements: *2164267540
 - !ruby/object:Gem::Dependency
   name: delayed_job
-  requirement: &2152314680 !ruby/object:Gem::Requirement
+  requirement: &2164267040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *2152314680
+  version_requirements: *2164267040
 description: A simple wrapper for the KissMetrics API using Delayed Job
 email:
 - ddeyoung@authorsolutions.com
@@ -70,6 +70,7 @@ files:
 - Rakefile
 - delayed_kiss.gemspec
 - lib/delayed_kiss.rb
+- lib/delayed_kiss/railtie.rb
 - lib/delayed_kiss/version.rb
 - spec/delayed_kiss_spec.rb
 - spec/spec_helper.rb