trakio-ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGY0ZDI2ZDY3MWFiYWQ3OTEwODk3NjM4YTEyMTNiMzcwMGViYjE2ZA==
+    NGQ5ODIxMGM4MjVlMDg2ZGE0MDc1NTZkZmU3ZDlmOWFmNjM5M2IwOQ==
   data.tar.gz: !binary |-
-    NzViZGQ0NTVkZjVmN2Y3NjFjM2VmNWJiZGMxYmFlNGJjY2U0MmYxNw==
+    NWZjODc1MzJhNzFlZWM4ZGQyY2E2YmU3ZTYxOWZlZGIxZjBlMjQ4YQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MmQzNTAyZjg2NDIzZmFlYmM5ZGVjNWUxMzI2ZWJiYjgwZWEzMGFkZTE5M2I3
-    YzUwZTg5ZmQyYjA2MmZkY2UyNGU3NjdmMDI2NzA0YTVkNjA5YzFiM2NiY2I2
-    NjdkYzYzM2M3MDk3MzM4NzBkMTBlMzZlOThiZTFhYzg4ODE0NTY=
+    YWI3YzYyMTExZjJjZmNiMTkwMjhkNDU3NDViZDQxNmMyOWI5Nzc3OTlmZjhh
+    MTJjNDBlZjQxZGQ4MDY5ZDc3MmRhMzZiODA3NmRkM2UzNGRmM2MxNDdhNjM5
+    OTY5YzdmMjllMDMwNTZhNzEwYTNjODVjODNhM2YyOWVlNmVkODQ=
   data.tar.gz: !binary |-
-    Njc2MWU5YWNiMjlkMDU1NzA1OWFlNjFkODVjMDVjMTYxNDA1NjZlMmM5N2Fh
-    OTcyMWVmMTIzY2QxYjM5Y2MzN2ExOGVkOTE3OWY2OWM3MGE0MjFhYTNiOTIx
-    YTkzNTZhNTNjNjkwMmNlZWFiOTBhNjg3ZjI3MzBhYjBhOTY4ZjM=
+    NzJhNjliNzFhMjNiNTE2MDI1Mjc2MmVjZmY4ODgxMTcyNDRmZmY3ZDQ5M2E3
+    OTg4YjM2MjY3YzU5ZmZlYjdlMTJmMTk0ODM1YjY3ZWVkYmMxMGIzY2EyNTY4
+    OTc1NDBiODNmNGRiMzNkMDJhMDJjMDE2Mzc3OWM4YzA0M2Q5OTc=

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+coverage

data/.travis.yml

@@ -1,8 +1,11 @@
+script: bundle exec rspec
 language: ruby
-
 rvm:
     - 2.1.0
     - 2.0.0
     - 1.9.3
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler
 
-script: bundle exec rake test

data/README.md

@@ -1,5 +1,12 @@
 # Official trak.io Ruby Library
 
+[![Gem Version](https://badge.fury.io/rb/trakio-ruby.png)](http://badge.fury.io/rb/trakio-ruby)
+[![Dependency Status](https://gemnasium.com/trakio/trakio-ruby.png)](https://gemnasium.com/trakio/trakio-ruby)
+[![Code Climate](https://codeclimate.com/github/trakio/trakio-ruby.png)](https://codeclimate.com/github/trakio/trakio-ruby)
+[![Build Status](https://travis-ci.org/trakio/trakio-ruby.png?branch=master)](https://travis-ci.org/trakio/trakio-ruby)
+[![Coverage Status](https://coveralls.io/repos/trakio/trakio-ruby/badge.png?branch=master)](https://coveralls.io/r/trakio/trakio-ruby?branch=master)
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/trakio/trakio-ruby/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/trakio/version.rb

@@ -1,3 +1,3 @@
 class Trakio
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/trakio.rb

@@ -25,18 +25,13 @@ class Trakio
     def init(*args)
       api_token, params = args
       raise Trakio::Exceptions::InvalidToken.new('Missing API Token') unless api_token
-      if params and params.has_key?(:distinct_id)
-        raise Trakio::Exceptions::NoDistinctIdForDefaultInstance
-      end
+      raise Trakio::Exceptions::NoDistinctIdForDefaultInstance if params and params.has_key?(:distinct_id)
       @default_instance = Trakio.new(*args)
     end
 
     def default_instance
-      if @default_instance
-        @default_instance
-      else
-        raise Trakio::Exceptions::Uninitiated
-      end
+      raise Trakio::Exceptions::Uninitiated unless @default_instance
+      @default_instance
     end
 
     def default_instance=(instance)
@@ -76,9 +71,7 @@ class Trakio
     @host = 'api.trak.io/v1'
 
     %w{https host channel distinct_id}.each do |name|
-      if params && params.has_key?(name.to_sym)
-        instance_variable_set("@#{name}", params[name.to_sym])
-      end
+      instance_variable_set("@#{name}", params[name.to_sym]) if params && params.has_key?(name.to_sym)
     end
   end
 
@@ -161,6 +154,27 @@ class Trakio
     send_request('annotate', params)
   end
 
+  def page_view(parameters)
+    parameters.default = nil
+    args = {
+      event: 'Page view'
+    }
+
+    distinct_id = parameters[:distinct_id]
+    args[:distinct_id] = distinct_id if distinct_id
+
+    raise "Must specify URL" unless parameters.has_key?(:url)
+    raise "Must specify Title" unless parameters.has_key?(:title)
+
+    properties = {
+      url: parameters[:url],
+      title: parameters[:title],
+    }
+    args[:properties] = properties
+
+    track args  # right now page_view is an alias of track
+  end
+
   def send_request(endpoint, params)
     protocol = @https ? "https" : "http"
     url = "#{protocol}://#{@host}/#{endpoint}"

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'coveralls'
+Coveralls.wear!
 require 'trakio'
 require 'webmock/rspec'
 require 'json'

data/spec/trakio/page_view_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Trakio do
+
+  subject { Trakio }
+
+  after {
+    Trakio.default_instance = nil
+  }
+
+  describe '.page_view' do
+
+    context 'when a url is specified' do
+      context 'when a title is specified' do
+        it 'tracks a page_view' do
+          stub = stub_request(:post, "https://api.trak.io/v1/track").
+            with(:body => {
+              token: 'my_api_token',
+              data: {
+                distinct_id: 'user@example.com',
+                event: 'Page view',
+                properties: {
+                  title: 'Test Title',
+                  url: 'http://test.test/test',
+                }
+              }
+            }).to_return(:body => {
+              status: 'success',
+              trak_id: '1234567890'
+            }.to_json)
+
+          trakio = Trakio.new 'my_api_token'
+          resp = trakio.page_view distinct_id: 'user@example.com', title: 'Test Title', url: 'http://test.test/test'
+
+          expect(resp[:status]).to eql 'success'
+          expect(resp[:trak_id]).to eql '1234567890'
+
+          stub.should have_been_requested
+        end
+      end
+
+      context 'when a title is not specified' do
+        it 'should raise an error' do
+          trakio = Trakio.new 'my_api_token'
+          expect {
+            trakio.page_view distinct_id: 'user@example.com',
+              url: 'http://test.test/test'
+          }.to raise_error RuntimeError
+        end
+      end
+    end
+
+    context 'when a url is not specified' do
+      it 'should raise an error' do
+        trakio = Trakio.new 'my_api_token'
+        expect {
+          trakio.page_view distinct_id: 'user@example.com'
+        }.to raise_error RuntimeError
+      end
+
+      context 'when a title is specified' do
+        it 'should raise an error' do
+          trakio = Trakio.new 'my_api_token'
+          expect {
+            trakio.page_view distinct_id: 'user@example.com', title: 'Test Title'
+          }.to raise_error RuntimeError
+        end
+      end
+    end
+
+  end  # end .page_view
+
+end

data/trakio-ruby.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["matt@trak.io", "tobie.warburton@gmail.com"]
   spec.description   = "Official trak.io ruby library for Ruby"
   spec.summary       = "Official trak.io ruby library for Ruby"
-  spec.homepage      = "https://github.com/trakio/trakio-ruby"
+  spec.homepage      = "https://trak.io"
   spec.license       = "Apache 2.0"
 
   spec.files         = `git ls-files`.split($/)
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'coveralls'
 
   spec.add_dependency 'rest_client'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trakio-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Matthew Spence
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-15 00:00:00.000000000 Z
+date: 2014-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest_client
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +117,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -119,9 +134,10 @@ files:
 - spec/trakio/indentify_spec.rb
 - spec/trakio/initialize_spec.rb
 - spec/trakio/instance_methods_spec.rb
+- spec/trakio/page_view_spec.rb
 - spec/trakio/track_spec.rb
 - trakio-ruby.gemspec
-homepage: https://github.com/trakio/trakio-ruby
+homepage: https://trak.io
 licenses:
 - Apache 2.0
 metadata: {}
@@ -154,4 +170,5 @@ test_files:
 - spec/trakio/indentify_spec.rb
 - spec/trakio/initialize_spec.rb
 - spec/trakio/instance_methods_spec.rb
+- spec/trakio/page_view_spec.rb
 - spec/trakio/track_spec.rb