lab628 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7637fb458789554095236875089f242cf13652c5
+  data.tar.gz: 97296a84e24b9cd0b5283ca184ddefb487f252b3
+SHA512:
+  metadata.gz: 5bdb56f142951e25df06b065fbb231fac801f68fd0b37240d935b08cd46b65f33e1322d57debdaf5f9dd0796a987d08f6531e2b59c2eb8264570c41a702b47b2
+  data.tar.gz: a9d569ee8635ad9727409388df291257aca689f824d0d2bdf870b25054d7a5a8c996ba921eadec71fd4072a19fc1fe9c22ebe796720f227cd1164d10ad4fba74

data/.gitignore

@@ -0,0 +1,5 @@
+/Gemfile.lock
+/.idea/
+/*.gem
+/*.iml
+/bin/

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.0
+
+Metrics/LineLength:
+  Max: 120
+Metrics/AbcSize:
+  Max: 18
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+  - 2.2
+  - 2.1
+  - 2.0
+  - 1.9.3
+  - ruby-head
+  - jruby
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+before_install:
+  - gem install bundler
+before_script:
+  - bundle update

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+# 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)
+
+This is the official Lab628 ruby integration library.
+
+## Installation
+
+Add the gem 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`):
+```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:
+```ruby
+tracker = Lab628.new(api_key: 'your api key', secret: 'your shared secret')
+```
+
+### Tracking activities
+
+You can track any hash:
+
+```ruby
+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.
+
+If you have an object that is already in JSON form, you can pass it directly:
+
+```ruby
+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')
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lab628-ruby.gemspec

@@ -0,0 +1,27 @@
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+require 'lab628/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'lab628'
+  s.version       = Lab628::VERSION
+  s.authors       = ['Lab628']
+  s.email         = ['support@lab628.com']
+
+  s.summary       = 'Lab628 Ruby library'
+  s.description   = 'Official Ruby library for the Lab628 service.'
+  s.homepage      = 'http://lab628.com/'
+  s.licenses      = ['MIT']
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_runtime_dependency 'faraday', ['~> 0']
+
+  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']
+end

data/lib/lab628/version.rb

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

data/lib/lab628.rb

@@ -0,0 +1,68 @@
+require 'lab628/version'
+require 'faraday'
+require 'json'
+
+class Lab628 # :nodoc:
+  BASE_URL = 'http://www.lab628.com'.freeze
+  ConfigurationError = Class.new StandardError
+  PayloadError = Class.new StandardError
+
+  class << self
+    # default API configuration
+    attr_accessor :api_key
+    attr_accessor :secret
+
+    def activity(data)
+      send_activity @api_key, @secret, data
+    end
+
+    def send_activity(key, sec, data)
+      raise ConfigurationError, 'Lab628 api key is not set' unless key
+      raise ConfigurationError, 'Lab628 shared secret is not set' unless sec
+
+      response = connection.post do |req|
+        req.url "/api/track/#{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
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def validate_payload(payload)
+      if payload.is_a? String
+        unless JSON.parse(payload).is_a? Hash
+          raise PayloadError, "Activity 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."
+    rescue JSON::ParserError => e
+      raise PayloadError, "Activity payload '#{payload}' is a non-JSON string: #{e.message}"
+    rescue => e
+      raise PayloadError, "Error converting activity 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
+  end
+
+  def activity(data)
+    self.class.send_activity(@api_key, @secret, data)
+  end
+end

data/test/lab628_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class TrackTest < Minitest::Test
+  def test_configs
+    # no default key and secret have been supplied
+    assert_raises Lab628::ConfigurationError do
+      Lab628.new
+    end
+
+    Lab628.api_key = 'key'
+    Lab628.secret = 'sec'
+
+    assert_equal 'key', Lab628.instance_variable_get(:@api_key)
+    assert_equal 'sec', Lab628.instance_variable_get(:@secret)
+
+    activity_tracker = Lab628.new
+    assert_equal 'key', activity_tracker.instance_variable_get(:@api_key)
+    assert_equal 'sec', activity_tracker.instance_variable_get(:@secret)
+
+    activity_tracker = Lab628.new(api_key: 'key2', secret: 'sec2')
+    assert_equal 'key2', activity_tracker.instance_variable_get(:@api_key)
+    assert_equal 'sec2', activity_tracker.instance_variable_get(:@secret)
+  end
+
+  def val(payload)
+    Lab628.send(:validate_payload, payload)
+  end
+
+  def test_validation
+    a1 = '{"a":1}'
+    assert_equal a1, val(a1)
+    assert_equal a1, val(a: 1)
+
+    e = assert_raises(Lab628::PayloadError) { val 'not JSON' }
+    assert_match 'non-JSON string', e.message
+
+    e = assert_raises(Lab628::PayloadError) { val '["not", "single", "object"]' }
+    assert_match 'not a single JSON object', e.message
+
+    e = assert_raises(Lab628::PayloadError) { val [1, 2] }
+    assert_match 'not a JSON string or hash', e.message
+  end
+
+  def test_activity
+    # missing default key
+    assert_raises Lab628::ConfigurationError do
+      Lab628.activity(a: 1)
+    end
+
+    Lab628.api_key = '123'
+    Lab628.secret = 'abc'
+
+    assert Lab628.activity(a: 1)
+
+    Lab628.api_key = 'failkey'
+
+    refute Lab628.activity(a: 1)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+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' do
+        [200, {}, '']
+      end
+      stubs.post 'api/track/failkey' do
+        [422, {}, '']
+      end
+    end
+  end
+end
+
+module Minitest
+  class Test
+    def setup
+      Lab628.api_key = nil
+      Lab628.secret = nil
+      Lab628.stubs(:connection).returns(test_connection)
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: lab628
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lab628
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  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'
+description: Official Ruby library for the Lab628 service.
+email:
+- support@lab628.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lab628-ruby.gemspec
+- lib/lab628.rb
+- lib/lab628/version.rb
+- test/lab628_test.rb
+- test/test_helper.rb
+homepage: http://lab628.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Lab628 Ruby library
+test_files: []