lab628 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f85d8324d42e8dd7ad70812a28d351565445f8d8
-  data.tar.gz: 93c817aa260ea017629779075447d0bebae09a57
+  metadata.gz: f991321872a3ffaa675acbd575032405cb54d9a8
+  data.tar.gz: 9c59aa387ad459cb1be7a5818c231baff1c519ab
 SHA512:
-  metadata.gz: cecd467d9a41d1709fb27849d0cc839ffd7997c42b03b39fd4772fed83c322c27348f0741732003ee815512a197896b6036d6e8697ce4ef87b6a7d3825fbf6a9
-  data.tar.gz: 246ac3d34d6a4b07dcf9f16da67e05cdc4c29d7e84a986edb5756d382e1352acbee7cddc4e918fff4fc0a56618a49b5ec200c6707509ce0ac15ee5264ac7236f
+  metadata.gz: 15e5248146d72698285b6329ecd5f13700064714a0af8af421924c9c5b6171226a422d2af7120fe00e9885e2e8fbc047931bc5837838ea6c02f2dbc5f551af86
+  data.tar.gz: fbd5dd2e1c76967b5b24ac4406d5aec41d97a52c198000afe5f490d0ec03e541836c551b346dcd398112f384f9ae3e895824a7d995f411739ab625ba8da8484c

data/.gitignore

@@ -1,4 +1,4 @@
-/Gemfile.lock
+/*.lock
 /.idea/
 /*.gem
 /*.iml

data/.rubocop.yml

@@ -7,6 +7,8 @@ Metrics/MethodLength:
   Max: 15
 Style/CaseIndentation:
   Enabled: false
+Style/Documentation:
+  Enabled: false
 
 Metrics/AbcSize:
   Exclude:

data/.travis.yml

@@ -9,6 +9,10 @@ rvm:
   - ruby-head
   - jruby
   - jruby-head
+gemfile:
+  - Gemfile
+  - activejob.gemfile
+  - activejob_backport.gemfile
 matrix:
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+### 1.2.0
+* Added sync modes
+* Removed suppression of a rare exception (malformed API response)
+
+### 1.1.0
+* Query capability
+* Fixes
+
+### 1.0.0
+* Initial activity tracking capability

data/Gemfile

@@ -1,2 +1,5 @@
 source 'https://rubygems.org'
 gemspec
+
+gem 'pry'
+gem 'codeclimate-test-reporter'

data/README.md

@@ -34,6 +34,8 @@ tracker = Lab628.new(api_key: 'your api key', secret: 'your shared secret')
 
 This is useful if you use multiple keys.
 
+See also: [`sync` configuration](#asynchronous-activity-tracking).
+
 ### Tracking activities
 
 You can track any hash:
@@ -102,3 +104,36 @@ The method returns a response in hash form:
 ```
 
 As with `activity`, the `query` method can also be used on `Lab628` instances.
+
+### Asynchronous activity tracking
+
+Set the `sync` mode on the `Lab628` class or an instance:
+```ruby
+Lab628.sync = :job
+async_tracker = Lab628.new(api_key: 'key', secret: 'secret', sync: :job)
+```
+
+Available modes:
+* `:inline` (default): tracking is performed synchronously, blocking until a response is received.
+    * The `activity` method returns `true` or `false` based on request success.
+* `:job`: an ActiveJob for tracking is placed on the `:lab628` queue.
+    * You must independently include one of these gems:
+        * [`activejob`](https://github.com/rails/rails/tree/master/activejob), included in Rails 4.2+ 
+        * [`activejob_backport`](https://github.com/ankane/activejob_backport), for Rails 4.0 and 4.1
+    * The `activity` method returns the ActiveJob instance.
+* `:thread`: tracking is performed in a concurrent thread using `Thread.new`.
+    * The `activity` method returns the Thread instance.
+
+### Contribution
+
+Test for your current Ruby version with:
+
+```bash
+bundle
+bundle exec rake
+```
+
+Test for all supported environments using [WWTD](https://github.com/grosser/wwtd), 
+which requires all Ruby versions in [the Travis file](.travis.yml) to be installed via [RVM](https://rvm.io/).
+
+We are open to discontinuing support for older Ruby versions, if required by significant fixes or new features.

data/activejob.gemfile

@@ -0,0 +1,2 @@
+eval_gemfile 'Gemfile'
+gem 'activejob'

data/activejob_backport.gemfile

@@ -0,0 +1,2 @@
+eval_gemfile 'Gemfile'
+gem 'activejob_backport'

data/lab628-ruby.gemspec

@@ -23,6 +23,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', ['~> 10.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.rb

@@ -2,23 +2,33 @@ require 'lab628/version'
 require 'faraday'
 require 'json'
 
-class Lab628 # :nodoc:
+require 'lab628/post_job' if (Gem::Specification.map(&:name) & %w(activejob activejob_backport)).any?
+
+class Lab628
   BASE_URL = 'http://www.lab628.com'.freeze
   ConfigurationError = Class.new StandardError
   PayloadError = Class.new StandardError
+  ApiError = Class.new StandardError
+
+  # default sync mode
+  @sync = :inline
 
   class << self
-    # default API configuration
     attr_accessor :api_key
     attr_accessor :secret
+    attr_accessor :sync
 
     def activity(data)
-      send_activity @api_key, @secret, data
+      send_activity @api_key, @secret, data, @sync
     end
 
-    def send_activity(key, sec, data)
-      response = send_command 'track', key, sec, data
-      response.status == 200
+    def send_activity(key, sec, data, sync_mode)
+      response = send_command 'track', key, sec, data, sync_mode
+      if sync_mode == :inline
+        response.status == 200
+      else
+        response
+      end
     end
 
     def query(data)
@@ -28,8 +38,8 @@ class Lab628 # :nodoc:
     def send_query(key, sec, query)
       response = send_command 'query', key, sec, query
       response.status == 200 && JSON.parse(response.body)
-    rescue JSON::ParserError
-      nil
+    rescue JSON::ParserError => e
+      raise ApiError, e.message
     end
 
     def check(key, sec)
@@ -37,11 +47,7 @@ class Lab628 # :nodoc:
       raise ConfigurationError, 'Lab628 shared secret is not set' unless sec
     end
 
-    private
-
-    def send_command(command, key, sec, data)
-      check key, sec
-
+    def post(command, key, sec, data)
       connection.post do |req|
         req.url "/api/#{command}/#{key}"
         req.headers['X-Secret'] = sec
@@ -50,6 +56,25 @@ class Lab628 # :nodoc:
       end
     end
 
+    private
+
+    def send_command(cmd, key, sec, data, sync_mode = :inline)
+      check key, sec
+
+      args = [cmd, key, sec, data]
+      post_fn = -> { post(*args) }
+      case sync_mode
+        when :inline
+          post_fn.call
+        when :job
+          PostJob.perform_later(*args)
+        when :thread
+          Thread.new { post_fn.call }
+        else
+          raise ConfigurationError, "#{sync_mode} is not a valid sync mode"
+      end
+    end
+
     def connection
       @connection ||= Faraday.new url: BASE_URL do |faraday|
         faraday.request :url_encoded
@@ -76,11 +101,12 @@ class Lab628 # :nodoc:
   def initialize(opts = {})
     @api_key = opts[:api_key] || Lab628.api_key
     @secret = opts[:secret] || Lab628.secret
+    @sync = opts[:sync] || Lab628.sync
     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, @sync
   end
 
   def query(query)

data/lib/lab628/post_job.rb

@@ -0,0 +1,13 @@
+require 'active_job'
+# activejob_backport needs Hash#with_indifferent_access
+# TODO check dependencies; maybe just require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/all'
+
+class Lab628
+  class PostJob < ActiveJob::Base
+    queue_as :lab628
+    def perform(command, key, sec, data)
+      Lab628.post command, key, sec, data
+    end
+  end
+end

data/lib/lab628/version.rb

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

data/test/lab628_test.rb

@@ -2,16 +2,18 @@ require 'test_helper'
 
 class TrackTest < Minitest::Test
   def test_configs
+    assert_equal :inline, Lab628.sync
+
     # no default key and secret have been supplied
-    assert_raises Lab628::ConfigurationError do
-      Lab628.new
-    end
+    assert_raises(Lab628::ConfigurationError) { Lab628.new }
 
     Lab628.api_key = 'key'
     Lab628.secret = 'sec'
+    Lab628.sync = :active_job
 
     assert_equal 'key', Lab628.instance_variable_get(:@api_key)
     assert_equal 'sec', Lab628.instance_variable_get(:@secret)
+    assert_equal :active_job, Lab628.instance_variable_get(:@sync)
 
     activity_tracker = Lab628.new
     assert_equal 'key', activity_tracker.instance_variable_get(:@api_key)
@@ -58,6 +60,32 @@ class TrackTest < Minitest::Test
     refute Lab628.activity(a: 1)
   end
 
+  def test_async_activity
+    Lab628.api_key = '123'
+    Lab628.secret = 'abc'
+
+    # thread
+
+    Lab628.expects(:post).with('track', '123', 'abc', 'a' => 1)
+
+    Lab628.sync = :thread
+
+    assert thread = Lab628.activity('a' => 1)
+    assert thread.is_a? Thread
+    thread.join
+
+    return unless active_job?
+
+    # job
+
+    Lab628.expects(:post).with('track', '123', 'abc', 'a' => 2)
+
+    Lab628.sync = :job
+
+    assert job = Lab628.activity('a' => 2)
+    assert job.is_a? Lab628::PostJob
+  end
+
   def test_query
     # missing default key
     assert_raises Lab628::ConfigurationError do

data/test/test_helper.rb

@@ -7,14 +7,18 @@ require 'lab628'
 require 'minitest/autorun'
 require 'mocha/mini_test'
 
-def test_connection
-  Faraday.new do |builder|
-    builder.adapter :test do |stubs|
-      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
+def active_job?
+  (Gem::Specification.map(&:name) & %w(activejob activejob_backport)).any?
+end
+
+ActiveJob::Base.logger.level = Logger::Severity::ERROR if active_job?
+
+TEST_CONNECTION = Faraday.new do |builder|
+  builder.adapter :test do |stubs|
+    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
 
@@ -23,7 +27,8 @@ module Minitest
     def setup
       Lab628.api_key = nil
       Lab628.secret = nil
-      Lab628.stubs(:connection).returns(test_connection)
+      Lab628.sync = :inline
+      Lab628.stubs(:connection).returns(TEST_CONNECTION)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab628
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Lab628
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,34 +80,6 @@ dependencies:
     - - ">="
       - !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.
 email:
 - support@lab628.com
@@ -118,11 +90,15 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
+- activejob.gemfile
+- activejob_backport.gemfile
 - lab628-ruby.gemspec
 - lib/lab628.rb
+- lib/lab628/post_job.rb
 - lib/lab628/version.rb
 - test/lab628_test.rb
 - test/test_helper.rb