amplitude-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 481d091552b42dfbe151aa5e58e50dedf2436d38
-  data.tar.gz: 8b391658f981b64f12d0fd683f1cc996a215dd36
+  metadata.gz: f625e998fbbf49741c6d66627ec9d3bd1f8b5579
+  data.tar.gz: 454dbcd32d0e2a7bd613b6dac4e85c30e3700f12
 SHA512:
-  metadata.gz: 6418d071d74f61e23b996c32a04929f70efe45a9df7ffd194f956214a855ab4a3033f90a43dd1726096b382833abf8bea45c4d319dca20fea6da621ebd0e24a4
-  data.tar.gz: 8b1324f82be861baf1e40e90e3e5ed861fffc5fbeac7fecc1b515849a7f240cdac8fc3491bf7159e660f9c9b5ae1ecbfb846236e96eeb0c1a2eee4b812dbf43e
+  metadata.gz: 03fb85419fa8ad2aeeb03fd66a7fa1b42c47ba91bc60ea06fe7f5dbd1394b8df292a39e2f01cb2bfb34997cf219a0752319192c15a360312d9f2b67e1a06c46f
+  data.tar.gz: 72bce071dc1cb54dc7f1b6fa3a3766f8ee089565758bf743044608ad318b155cd325c6e6ea00be93f250795ab932ee2f468960a95032332b7db8c2d64f975a69

data/amplitude-api.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0", '>= 10.0' 
   spec.add_development_dependency "pry", "~> 0.9.12.6" 
   spec.add_dependency "typhoeus", "~> 0.7.1"
+  spec.required_ruby_version = '~> 2.0'
 end

data/lib/amplitude-api.rb

@@ -1,6 +1,6 @@
 require 'json'
 require 'bundler/setup'
-Bundler.require(:default)
+require 'typhoeus'
 require 'amplitude-api/event'
 
 class AmplitudeAPI
@@ -9,13 +9,32 @@ class AmplitudeAPI
   USER_WITH_NO_ACCOUNT = "user who doesn't have an account"
 
   class << self
+    # @!attribute [ rw ] api_key
+    #   @return [ String ] an Amplitude API Key
     attr_accessor :api_key
 
+    # Send a single event immediately to the AmplitudeAPI
+    #
+    # @param [ String ] event_name a string that describes the event, e.g. "clicked on Home"
+    # @param [ String ] user a string or integer that uniquely identifies a user.
+    # @param [ Hash ] properties a hash that is serialized to JSON, and can contain any other property to be stored on the Event
+    #
+    # @return [ Typhoeus::Response ]
     def send_event(event_name, user, properties = {})
       event = AmplitudeAPI::Event.new(user_id: user, event_type: event_name, event_properties: properties)
       track(event)
     end
 
+    # @overload body(event)
+    #   @param [ AmplitudeAPI::Event ]
+    #
+    # @overload body([events])
+    #   @param [ Array<AmplitudeAPI::Event> ]
+    #
+    # @return [ Hash ]
+    #
+    # Converts a series of AmplitudeAPI::Event objects into a body
+    # suitable for the Amplitude API
     def body(*events)
       event_body = events.flatten.map do |event|
         event.to_hash
@@ -26,6 +45,15 @@ class AmplitudeAPI
       }
     end
 
+    # @overload track(event)
+    #   @param [ AmplitudeAPI::Event ] Send a single event to the Amplitude API
+    #
+    # @overload track([events])
+    #   @param [ Array<AmplitudeAPI::Event> ] Send an array of events in a single request to Amplitude
+    #
+    # @return [ Typhoeus::Response ] 
+    #
+    # Send one or more Events to the Amplitude API
     def track(*events)
       Typhoeus.post(URI_STRING, body: body(events))
     end

data/lib/amplitude-api/event.rb

@@ -1,7 +1,20 @@
 class AmplitudeAPI
   class Event
-    attr_accessor :user_id, :event_type, :event_properties
+    # @!attribute [ rw ] user_id
+    #   @return [ String ] the user_id to be sent to Amplitude
+    attr_accessor :user_id
+    # @!attribute [ rw ] event_type
+    #   @return [ String ] the event_type to be sent to Amplitude
+    attr_accessor :event_type
+    # @!attribute [ rw ] event_properties
+    #   @return [ String ] the event_properties to be attached to the Amplitude Event
+    attr_accessor :event_properties
 
+    # Create a new Event
+    #
+    # @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: {})
       self.user_id = user_id
       self.event_type = event_type
@@ -17,6 +30,9 @@ class AmplitudeAPI
         end
     end
 
+    # @return [ Hash ] A serialized Event
+    #
+    # Used for serialization and comparison
     def to_hash
       {
         event_type: self.event_type,
@@ -25,6 +41,9 @@ class AmplitudeAPI
       }
     end
 
+    # @return [ true, false ]
+    #
+    # Compares +to_hash+ for equality
     def ==(other)
       if other.respond_to?(:to_hash)
         self.to_hash == other.to_hash

data/lib/amplitude-api/version.rb

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

data/readme.md

@@ -1,2 +1,38 @@
 # Amplitude API
 [![Build Status](https://travis-ci.org/toothrot/amplitude-api.svg?branch=master)](https://travis-ci.org/toothrot/amplitude-api)
+[![Gem Version](https://badge.fury.io/rb/amplitude-api.svg)](http://badge.fury.io/rb/amplitude-api)
+
+## Installation
+
+```sh
+gem install amplitude-api
+```
+
+## Basic Usage
+
+The following code snippet will immediately track an event to the Amplitude API. The time on the event will automatically be the time of the request.
+
+```ruby
+# Configure your Amplitude API key
+AmplitudeAPI.api_key = "abcdef123456"
+
+event = AmplitudeAPI::Event.new({
+  user_id: "123",
+  event_type: "clicked on Home",
+  event_properties: {
+    cause: "button",
+    arbitrary: "properties"
+  }
+})
+AmplitudeAPI.track(event)
+```
+
+## 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
+ 
+## Contributing
+
+I'd love to hear how you're using this. Please check out the [issues](https://github.com/toothrot/amplitude-api/issues).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amplitude-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alex Rakoczy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -110,9 +110,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -128,3 +128,4 @@ test_files:
 - spec/lib/amplitude-api/event_spec.rb
 - spec/lib/amplitude_api_spec.rb
 - spec/spec_helper.rb
+has_rdoc: