amplitude-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f625e998fbbf49741c6d66627ec9d3bd1f8b5579
-  data.tar.gz: 454dbcd32d0e2a7bd613b6dac4e85c30e3700f12
+  metadata.gz: 69388981ec7465494e2f8894a0f8d324430d8280
+  data.tar.gz: 8a97fd8316f0581b18a0420ab5c6a455094626d2
 SHA512:
-  metadata.gz: 03fb85419fa8ad2aeeb03fd66a7fa1b42c47ba91bc60ea06fe7f5dbd1394b8df292a39e2f01cb2bfb34997cf219a0752319192c15a360312d9f2b67e1a06c46f
-  data.tar.gz: 72bce071dc1cb54dc7f1b6fa3a3766f8ee089565758bf743044608ad318b155cd325c6e6ea00be93f250795ab932ee2f468960a95032332b7db8c2d64f975a69
+  metadata.gz: c17936fe48ef36da5ced4833c86a64f57f0df31e8d06909a0d60d55a2ecf2fe2a26b2692d675d6c015d36ed71d7d87ea14bd08ab0034384dbe035a8b81ae98b4
+  data.tar.gz: c4b6ed7af9745f5a75647080c08f9a7ee952977b03d305409f36d285d752da3fdf65830574e7b091deaa72df9242346060d34e403e14270e08119c9840f48324

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--readme readme.md

data/lib/amplitude-api/event.rb

@@ -15,14 +15,14 @@ class AmplitudeAPI
     # @param [ String ] user_id a user_id to associate with the event
     # @param [ String ] event_type a name for the event
     # @param [ Hash ] event_properties various properties to attach to the event
-    def initialize(user_id: , event_type: , event_properties: {})
+    def initialize(user_id: "" , event_type: "", event_properties: {})
       self.user_id = user_id
       self.event_type = event_type
       self.event_properties = event_properties
     end
 
     def user_id=(value)
-      @user_id = 
+      @user_id =
         if value.respond_to?(:id)
           value.id
         else

data/lib/amplitude-api/version.rb

@@ -1,3 +1,3 @@
 class AmplitudeAPI
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/readme.md

@@ -27,11 +27,17 @@ event = AmplitudeAPI::Event.new({
 AmplitudeAPI.track(event)
 ```
 
+Currently, we are using this in Rails and using ActiveJob to dispatch events asynchronously. I plan on moving background/asynchronous support into this gem.
+
 ## What's Next
 
 * Thread support for background dispatching in bulk
 * `device_id` support as an alternative to `user_id`
 * Configurable default account to use when no `user_id` present
+
+## Other useful resources
+* [Amplitude HTTP Api Documentation](https://amplitude.zendesk.com/hc/en-us/articles/204771828)
+* [Segment.io Amplitude integration](https://segment.com/docs/integrations/amplitude/)
  
 ## Contributing
 

data/spec/lib/amplitude_api_spec.rb

@@ -30,6 +30,26 @@ describe AmplitudeAPI do
     end
   end
 
+  describe ".initializer " do
+    it "initializes event without parameter" do
+      event = AmplitudeAPI::Event.new()
+      expect(event.to_hash).to eq({
+        event_type: "",
+        user_id: "",
+        event_properties: {}
+      })
+    end
+
+    it "initializes event with parameter" do
+      event = AmplitudeAPI::Event.new(user_id: 123, event_type: "test_event", event_properties: {test_property: 1})
+      expect(event.to_hash).to eq({
+        event_type: "test_event",
+        user_id: 123,
+        event_properties: {test_property: 1}
+      })
+    end
+  end
+
   describe ".send_event" do
     it "sends an event to AmplitudeAPI" do
       event = AmplitudeAPI::Event.new(user_id: @user, event_type: "test_event", event_properties: {test_property: 1})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alex Rakoczy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -88,6 +88,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -128,4 +129,3 @@ test_files:
 - spec/lib/amplitude-api/event_spec.rb
 - spec/lib/amplitude_api_spec.rb
 - spec/spec_helper.rb
-has_rdoc: