lab628 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7637fb458789554095236875089f242cf13652c5
-  data.tar.gz: 97296a84e24b9cd0b5283ca184ddefb487f252b3
+  metadata.gz: f85d8324d42e8dd7ad70812a28d351565445f8d8
+  data.tar.gz: 93c817aa260ea017629779075447d0bebae09a57
 SHA512:
-  metadata.gz: 5bdb56f142951e25df06b065fbb231fac801f68fd0b37240d935b08cd46b65f33e1322d57debdaf5f9dd0796a987d08f6531e2b59c2eb8264570c41a702b47b2
-  data.tar.gz: a9d569ee8635ad9727409388df291257aca689f824d0d2bdf870b25054d7a5a8c996ba921eadec71fd4072a19fc1fe9c22ebe796720f227cd1164d10ad4fba74
+  metadata.gz: cecd467d9a41d1709fb27849d0cc839ffd7997c42b03b39fd4772fed83c322c27348f0741732003ee815512a197896b6036d6e8697ce4ef87b6a7d3825fbf6a9
+  data.tar.gz: 246ac3d34d6a4b07dcf9f16da67e05cdc4c29d7e84a986edb5756d382e1352acbee7cddc4e918fff4fc0a56618a49b5ec200c6707509ce0ac15ee5264ac7236f

data/.gitignore

@@ -3,3 +3,4 @@
 /*.gem
 /*.iml
 /bin/
+/coverage

data/.rubocop.yml

@@ -3,7 +3,11 @@ AllCops:
 
 Metrics/LineLength:
   Max: 120
-Metrics/AbcSize:
-  Max: 18
 Metrics/MethodLength:
   Max: 15
+Style/CaseIndentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*'

data/.travis.yml

@@ -12,8 +12,12 @@ rvm:
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - rvm: jruby-head
   fast_finish: true
 before_install:
   - gem install bundler
 before_script:
   - bundle update
+addons:
+  code_climate:
+    repo_token: 89440dfae67f9e66f4d10863601d0976d99b2d78ec5732a9895aef4dfa38ba9c

data/README.md

@@ -1,32 +1,39 @@
 # lab628-ruby
-[![Build Status](https://travis-ci.org/lab628/lab628-ruby.svg?branch=master)](https://travis-ci.org/lab628/lab628-ruby) [![Dependency Status](https://gemnasium.com/badges/github.com/lab628/lab628-ruby.svg)](https://gemnasium.com/github.com/lab628/lab628-ruby) [![Code Climate](https://codeclimate.com/github/lab628/lab628-ruby/badges/gpa.svg)](https://codeclimate.com/github/lab628/lab628-ruby)
+[![Gem Version](http://img.shields.io/gem/v/lab628.svg?style=flat-square)](https://rubygems.org/gems/lab628)
+[![Build Status](http://img.shields.io/travis/lab628/lab628-ruby.svg?style=flat-square)](https://travis-ci.org/lab628/lab628-ruby)
+[![Dependency Status](http://img.shields.io/gemnasium/lab628/lab628-ruby.svg?style=flat-square)](https://gemnasium.com/lab628/lab628-ruby)
+[![Code Climate](http://img.shields.io/codeclimate/github/lab628/lab628-ruby.svg?style=flat-square)](https://codeclimate.com/github/lab628/lab628-ruby)
+[![Code Climate](http://img.shields.io/codeclimate/coverage/github/lab628/lab628-ruby.svg?style=flat-square)](https://codeclimate.com/github/lab628/lab628-ruby)
 
 This is the official Lab628 ruby integration library.
 
-## Installation
+### Installation
 
-Add the gem to your Gemfile:
+Add to your Gemfile:
 
 ```ruby
 gem 'lab628'
 ```
 
-## Usage
-
 ### Initialization
 
-For configuring a single access key globaly, put this in an initializer (e.g. for Rails, `config/initializers/lab628.rb`):
+Configure a single access key globally (e.g. for Rails in `config/initializers/lab628.rb`):
+
 ```ruby
 Lab628.api_key = 'your api key'
 Lab628.secret = 'your shared secret'
 ```
-Both of these values are available in the [**Access Keys** section of the Lab628 dashboard](http://www.lab628.com/credentials), for each of your keys.
 
-To use multiple keys, an instance can be used to supply or override these globals:
+API keys and secrets are available in the [**Access Keys** section of the Lab628 dashboard](http://www.lab628.com/credentials).
+
+An instance can be used to supply or override these globals.
+
 ```ruby
 tracker = Lab628.new(api_key: 'your api key', secret: 'your shared secret')
 ```
 
+This is useful if you use multiple keys.
+
 ### Tracking activities
 
 You can track any hash:
@@ -35,9 +42,9 @@ You can track any hash:
 Lab628.activity(user_id: 7, topic: 'excitement')
 ```
 
-The hash will be converted to JSON, which means Ruby objects that don't correspond to JSON types will be converted to strings.
+The hash will be converted to JSON. Ruby objects in the hash that don't correspond to JSON types will be converted to strings via `.to_s`.
 
-If you have an object that is already in JSON form, you can pass it directly:
+You can also track an activity in JSON form:
 
 ```ruby
 Lab628.activity("{\"this\":\"json\",\"is\":[\"already\",\"encoded\"]}")
@@ -46,5 +53,52 @@ Lab628.activity("{\"this\":\"json\",\"is\":[\"already\",\"encoded\"]}")
 The same method can be used on instances:
 
 ```ruby
-Lab628.new(api_key: 'your api key', secret: 'your shared secret').activity(user_id: 7, topic: 'excitement')
+Lab628.new(api_key: 'key', secret: 'secret').activity(user_id: 7, topic: 'excitement')
 ```
+
+### Querying activities
+
+Query using a hash expressed in the Lab628 query language ([**documentation**](http://www.lab628.com/docs/api_access)):
+
+```ruby
+Lab628.query(
+    query: [
+        { l628_timestamp: '$last_day' },
+        { page: 'checkout' }
+    ],
+    summary: [
+        { cart_size: 'avg' },
+        { total_price: 'sum' }
+    ]
+)
+```
+
+The method returns a response in hash form:
+
+```ruby
+{
+    "total" => 152,
+    "results" => [
+        {
+            "event" => "checkout",
+            "page" => "checkout",
+            "user_id" => "74338979973",
+            "region" => "us",
+            "cart_size" => 4,
+            "total_price" => 128,
+            "event_depth" => 1
+        },
+        ...
+    ],
+    "summary" => {
+        "cart_size" => {
+            "avg" => 5.2272727272727275
+        },
+        "total_price" => {
+            "sum" => 6382.0
+        }
+    }
+}
+```
+
+As with `activity`, the `query` method can also be used on `Lab628` instances.

data/lab628-ruby.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler', ['~> 1.10']
   s.add_development_dependency 'rake', ['~> 10.0']
-  s.add_development_dependency 'minitest', ['~> 0']
-  s.add_development_dependency 'mocha', ['~> 0']
-  s.add_development_dependency 'pry', ['~> 0']
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/lab628/version.rb

@@ -1,3 +1,3 @@
 class Lab628
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/lab628.rb

@@ -17,21 +17,39 @@ class Lab628 # :nodoc:
     end
 
     def send_activity(key, sec, data)
+      response = send_command 'track', key, sec, data
+      response.status == 200
+    end
+
+    def query(data)
+      send_query @api_key, @secret, data
+    end
+
+    def send_query(key, sec, query)
+      response = send_command 'query', key, sec, query
+      response.status == 200 && JSON.parse(response.body)
+    rescue JSON::ParserError
+      nil
+    end
+
+    def check(key, sec)
       raise ConfigurationError, 'Lab628 api key is not set' unless key
       raise ConfigurationError, 'Lab628 shared secret is not set' unless sec
+    end
+
+    private
 
-      response = connection.post do |req|
-        req.url "/api/track/#{key}"
+    def send_command(command, key, sec, data)
+      check key, sec
+
+      connection.post do |req|
+        req.url "/api/#{command}/#{key}"
         req.headers['X-Secret'] = sec
         req.headers['Content-Type'] = 'application/json'
         req.body = validate_payload data
       end
-
-      response.status == 200
     end
 
-    private
-
     def connection
       @connection ||= Faraday.new url: BASE_URL do |faraday|
         faraday.request :url_encoded
@@ -40,29 +58,32 @@ class Lab628 # :nodoc:
     end
 
     def validate_payload(payload)
+      return JSON.generate payload if payload.is_a? Hash
       if payload.is_a? String
         unless JSON.parse(payload).is_a? Hash
-          raise PayloadError, "Activity payload '#{payload}' is not a single JSON object."
+          raise PayloadError, "Payload '#{payload}' is not a single JSON object."
         end
         return payload
       end
-      return JSON.generate payload if payload.is_a? Hash
-      raise PayloadError, "Activity payload '#{payload}' is not a JSON string or hash."
+      raise PayloadError, "Payload '#{payload}' is not a JSON string or hash."
     rescue JSON::ParserError => e
-      raise PayloadError, "Activity payload '#{payload}' is a non-JSON string: #{e.message}"
+      raise PayloadError, "Payload '#{payload}' is a non-JSON string: #{e.message}"
     rescue => e
-      raise PayloadError, "Error converting activity payload '#{payload}' to JSON: #{e.message}"
+      raise PayloadError, "Error converting payload '#{payload}' to JSON: #{e.message}"
     end
   end
 
   def initialize(opts = {})
     @api_key = opts[:api_key] || Lab628.api_key
-    raise ConfigurationError, 'Lab628 api key is not set' unless @api_key
     @secret = opts[:secret] || Lab628.secret
-    raise ConfigurationError, 'Lab628 shared secret is not set' unless @secret
+    self.class.check @api_key, @secret
   end
 
   def activity(data)
-    self.class.send_activity(@api_key, @secret, data)
+    self.class.send_activity @api_key, @secret, data
+  end
+
+  def query(query)
+    self.class.send_query @api_key, @secret, query
   end
 end

data/test/lab628_test.rb

@@ -51,9 +51,27 @@ class TrackTest < Minitest::Test
     Lab628.secret = 'abc'
 
     assert Lab628.activity(a: 1)
+    assert Lab628.new.activity(a: 1)
 
     Lab628.api_key = 'failkey'
 
     refute Lab628.activity(a: 1)
   end
+
+  def test_query
+    # missing default key
+    assert_raises Lab628::ConfigurationError do
+      Lab628.query(query: { a: 1 })
+    end
+
+    Lab628.api_key = '123'
+    Lab628.secret = 'abc'
+
+    assert_equal({ 'a' => 1 }, Lab628.query(query: { a: 1 }))
+    assert_equal({ 'a' => 1 }, Lab628.new.query(query: { a: 1 }))
+
+    Lab628.api_key = 'failkey'
+
+    refute Lab628.query(query: { a: 1 })
+  end
 end

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'lab628'
 
@@ -7,12 +10,10 @@ require 'mocha/mini_test'
 def test_connection
   Faraday.new do |builder|
     builder.adapter :test do |stubs|
-      stubs.post 'api/track/123' do
-        [200, {}, '']
-      end
-      stubs.post 'api/track/failkey' do
-        [422, {}, '']
-      end
+      stubs.post('api/track/123') { [200, {}, ''] }
+      stubs.post('api/track/failkey') { [422, {}, ''] }
+      stubs.post('api/query/123') { [200, {}, '{"a":1}'] }
+      stubs.post('api/query/failkey') { [422, {}, ''] }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab628
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Lab628
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -56,42 +56,56 @@ dependencies:
   name: minitest
   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: mocha
   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: pry
   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: codeclimate-test-reporter
+  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'
 description: Official Ruby library for the Lab628 service.