gosquared 0.0.1 → 0.0.2

data/README.md

@@ -1,3 +1,75 @@
 ## GoSquared Ruby API client
 
-Under construction. Check back for progress in a few days :)
+This module works with the [GoSquared API][api-docs], making it really easy to integrate GoSquared with your node app. You can also use it to track metrics and events in your application using GoSquared
+
+## Installation
+```bash
+gem install gosquared
+```
+
+## Usage
+
+```ruby
+# Create an API client
+gosquared_api = GoSquared::API.new(opts)
+
+# Create Event client
+gosquared_event = GoSquared::Event.new(opts)
+
+```
+
+##### Options
+
+* api_key: API key from your [account][casa]. Required for API client, not required for event client.
+* site_token: Token for the registered site you're working with. Required.
+* debugLevel: One of:
+	* GoSquared::DEBUG_LEVELS[:ALL]
+	* GoSquared::DEBUG_LEVELS[:TRACE]
+	* GoSquared::DEBUG_LEVELS[:NOTICE]
+	* GoSquared::DEBUG_LEVELS[:WARNING]
+	* GoSquared::DEBUG_LEVELS[:FATAL]
+
+### API
+```ruby
+require 'gosquared'
+
+gosquared_api = GoSquared::API.new({
+  :api_key    => 'demo',
+  :site_token => 'GSN-181546-E'
+})
+
+response = gosquared_api.concurrents(params)
+```
+
+All functions listed in the [API documentation][api-docs] are methods you can call on the ```GoSquared::API``` class.
+
+
+### Tracking
+
+##### Events
+Send events to GoSquared:
+
+```ruby
+require 'gosquared'
+
+gosquared_event = GoSquared::Event.new({
+  :site_token => 'GSN-181546-E'
+})
+
+response = gosquared_event.store_event('Test Event', {
+	:its => true,
+	:'you can' => 'store',
+	:any => 'event',
+	:properties => 'You Like'
+})
+```
+
+## Run tests
+Install all dependencies using ```bundle``` then:
+
+```bash
+rake
+```
+
+[api-docs]: https://www.gosquared.com/developer/latest/
+[casa]: https://www.gosquared.com/home/developer

data/gosquared.gemspec

@@ -5,10 +5,10 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name        = "gosquared"
-  spec.version     = "0.0.1"
+  spec.version     = "0.0.2"
   spec.authors     = ["Geoff Wagstaff"]
   spec.email       = ["geoff@gosquared.com"]
-  spec.homepage    = "https://www.gosquared.com/"
+  spec.homepage    = "https://github.com/gosquared/ruby-client"
   spec.summary     = %q{Official GoSquared Ruby Client}
   spec.description = %q{For use with the API and for tracking metrics}
 

data/test/api.rb

@@ -4,7 +4,7 @@ require 'gosquared'
 
 describe GoSquared do
   before do
-    @gosquared = GoSquared::API.new(:site_token => "GSN-106863-S", :api_key => "demo")
+    @gosquared = GoSquared::API.new({:site_token => "GSN-106863-S", :api_key => "demo"})
   end
 
   describe "getting functions" do

data/test/event.rb

@@ -4,7 +4,7 @@ require 'gosquared'
 
 describe GoSquared do
   before do
-    @gosquared = GoSquared::Event.new(:site_token => "GSN-106863-S")
+    @gosquared = GoSquared::Event.new({:site_token => "GSN-106863-S"})
   end
 
   describe "storing events" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gosquared
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -90,7 +90,7 @@ files:
 - README.md
 - test/api.rb
 - test/event.rb
-homepage: https://www.gosquared.com/
+homepage: https://github.com/gosquared/ruby-client
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Official GoSquared Ruby Client