crevalle-pulse 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4412573e5d3220a5f0adc995ff3746fc717a431f
-  data.tar.gz: b142587f036db6d99a2e3ea024b12ac8e05c561e
+  metadata.gz: 64f773c201b0b5c8dfa6e9a32ed35f193526b059
+  data.tar.gz: 0449f7775fc83d4110c518615781d1549339fefa
 SHA512:
-  metadata.gz: f2561db2a22c5811673bc19a8c0390798412686cd8753d90e3cd7132ea75e9e89b63040bc711c3cac24d3296b99759eed7522f7cc9957ffb2e298aaab6780231
-  data.tar.gz: 14f3bcdc3cbcf043d2b007c1744c2d1036bdad5f961552cf34a4e4f957ff010fb292f6af6ec906d6fc5952ddf52114c59b073546578409bc71c15a10db41dbe1
+  metadata.gz: 6c1e833376a178614ece2861322b4b9f8924292d9e441873584245b3d1bb985c0774b706129216fca445d93f182c2b6f1c143be924966cedc70c8a36fc5a7eee
+  data.tar.gz: a2b5f94a4346d4903cd273e7d5602f27da07b4efa93269afa2eea14b3018f4b7d3c8e9b82addfc6b928c900a2691c1187962f201905e167838af64c36f7a156c

data/README.md

@@ -25,10 +25,24 @@ Drop in your api key:
 ```ruby
 # config/initializers/pulse.rb
 
-Crevalle::Pulse.config.api_key = 'your-api-uuid'.
+Crevalle::Pulse.config.api_key = 'your-api-uuid'
 ```
 
-You're ready to send heartbeats!  Anywhere in your code, such as when a user signs up, call `Crevalle::Pulse.beat 'myapp.user-signup'` to send a beat to the Pulse server.  This request runs in a separate thread, so you can drop the notification into your normal codepaths without worrying about performance.
+You're ready to send heartbeats!  Anywhere in your code, such as when a user signs up, call 
+
+```ruby
+Crevalle::Pulse.beat 'myapp.user-signup'
+```
+to send a beat to the Pulse server.  This request runs in a separate thread, so you can drop the notification into your normal codepaths without worrying about performance.
+
+
+## Testing
+
+You probably don't want bunches of heartbeats sent while you're running tests.  To disable beat sending, put the following in your `spec_helper.rb`:
+
+```ruby
+Crevalle::Pulse.config.disabled = true
+```
 
 
 © 2015 Crevalle Technologies, LLC

data/lib/crevalle/pulse.rb

@@ -18,6 +18,8 @@ module Crevalle
       raise ArgumentError, 'please supply a beat name' if name.nil? || name == ''
       raise 'Please configure with an api key' if config.api_key.nil?
 
+      return false if config.disabled?
+
       uri = URI.parse "#{config.host}#{config.endpoint}"
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -47,6 +49,14 @@ module Crevalle
       def endpoint
         '/api/v1/beats'
       end
+
+      def disabled= d
+        @disabled = d
+      end
+
+      def disabled?
+        !!@disabled
+      end
     end
   end
 end

data/lib/crevalle/pulse/version.rb

@@ -1,5 +1,5 @@
 module Crevalle
   module Pulse
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crevalle-pulse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Desmond Bowe