liquid-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e14a0a81084af83f470b35c7593880c4b3dd1b2
+  data.tar.gz: c6d750750969accc7bf78334352cdd2a1f399ce1
+SHA512:
+  metadata.gz: 3196795df3b0347d6834bbc466304928119ca7022c97527be19945d72a880fa981624568377e386fd202c42c9fac803e188775d94da9926c77a029f08cc639a0
+  data.tar.gz: 02839eef2253792000532f80aad8925f6ad164faaf1ea2f9d3afc732e2fb7442ec14287ccb384dedafc20b9d40bb2c3c54dc034a61c76e029c7a69712b7cef2e

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,270 @@
+require: rubocop-rspec
+
+AllCops:
+  RunRailsCops: true
+  Exclude:
+    - 'db/**/*'
+    - 'config/**/*'
+
+Rails/TimeZone:
+  Enabled: false
+
+AccessorMethodName:
+  Enabled: false
+
+ActionFilter:
+  Enabled: false
+
+Alias:
+  Enabled: false
+
+ArrayJoin:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+Attr:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+
+ColonMethodCall:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+DeprecatedHashMethods:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+DoubleNegation:
+  Enabled: false
+
+EachWithObject:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+FlipFlop:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+GuardClause:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IfWithSemicolon:
+  Enabled: false
+
+InlineComment:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LambdaCall:
+  Enabled: false
+
+LineEndConcatenation:
+  Enabled: false
+
+LineLength:
+  Max: 85
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+NegatedIf:
+  Enabled: false
+
+NegatedWhile:
+  Enabled: false
+
+BlockDelimiters:
+  Exclude:
+    - spec/**/*
+
+Next:
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+Not:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+OpMethod:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+SelfAssignment:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+SingleLineMethods:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+
+VariableInterpolation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+WhenThen:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+# Lint
+
+AmbiguousOperator:
+  Enabled: false
+
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+ConditionPosition:
+  Enabled: false
+
+DeprecatedClassMethods:
+  Enabled: false
+
+ElseLayout:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+InvalidCharacterLiteral:
+  Enabled: false
+
+LiteralInCondition:
+  Enabled: false
+
+LiteralInInterpolation:
+  Enabled: false
+
+Loop:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+RequireParentheses:
+  Enabled: false
+
+UnderscorePrefixedVariableName:
+  Enabled: false
+
+Void:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in liquid.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    liquid-ruby (0.1.0)
+      json
+      rest-client (~> 1.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    domain_name (0.5.25)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.2.3)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    method_source (0.8.2)
+    mime-types (2.99)
+    netrc (0.11.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.0)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    vcr (3.0.0)
+    webmock (1.22.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  liquid-ruby!
+  pry
+  rake (~> 10.0)
+  rspec
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,47 @@
+# Liquid
+
+ Ruby wrapper for the Liquid API (analyze and collect)
+
+This gem is currently in development, it might break something :grimacing:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'liquid-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install liquid-ruby
+
+## Usage
+
+#### Setup authentication
+
+```ruby
+Liquid.configure do |config|
+  config.analyze_api = 'your_analyze_token'
+  config.collect_api = 'your_collect_token'
+end
+```
+
+#### Track event
+
+```ruby
+user_attrs = { unique_id: 'your_unique_id', age: 25, premium: true }
+event_attrs = { name: 'buy' }
+
+Liquid.track(user_attrs, event_attrs)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at:
+
+https://github.com/lqd-io/liquid-ruby

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'irb -rubygems -I lib -r liquid.rb'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'liquid'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/liquid.rb

@@ -0,0 +1,54 @@
+require 'net/http'
+require 'cgi'
+require 'uri'
+require 'json'
+
+require 'liquid/version'
+require 'liquid/network'
+require 'liquid/request_factory'
+require 'liquid/configuration'
+require 'liquid/errors'
+
+module Liquid
+  @configuration = Liquid::Configuration.new
+  @network = Liquid::RequestFactory.new
+
+  def self.configure
+    if block_given?
+      yield @configuration
+      @Liquid
+      @network.configure @configuration
+    end
+  end
+
+  # Track an event
+  # @param [Hash] user attributes (mandatory fields [unique_id])
+  # @param [Hash] event attributes (mandatory fields [date])
+  # @param [Hash] device attributes
+  def self.track(user, event, device = {})
+    date = DateTime.now
+    event[:date] = date
+    device[:unique_id] ||= "Ruby::#{user[:unique_id]}"
+    device[:platform] ||= 'Ruby'
+    dp = { user: user, device: device, event: event, timestamp: date }
+    @network.create_data_point dp
+    true
+  end
+
+  # Make alias (merge 2 users)
+  # @param [String] old_unique_id of user
+  # @param [String] new unique_id of user
+  def self.alias(old_unique_id, new_unique_id)
+    @network.make_alias old_unique_id, new_unique_id
+    true
+  end
+
+  # ---------------
+  # ANALYZE API
+  # ---------------
+
+  # Get User info
+  def self.user(unique_id)
+    @network.user unique_id
+  end
+end

data/lib/liquid/configuration.rb

@@ -0,0 +1,13 @@
+class Liquid::Configuration
+  CONFIGURABLE_ATTRIBUTES = %i(collect_api analyze_api)
+
+  attr_accessor *CONFIGURABLE_ATTRIBUTES
+
+  def initialize(attrs = {})
+    self.attributes = attrs
+  end
+
+  def attributes=(attrs = {})
+    attrs.each { |key, value| instance_variable_set("@#{key}", value) }
+  end
+end

data/lib/liquid/errors.rb

@@ -0,0 +1,23 @@
+module Liquid
+  class LiquidError < StandardError
+  end
+
+  class LiquidUnauthorizedError < LiquidError
+  end
+
+  class LiquidInvalidDataPointError < LiquidError
+  end
+
+  class ErrorHandler
+    def self.fail(error_code, message = nil)
+      case error_code
+      when 401
+        raise LiquidUnauthorizedError.new "#{error_code}: #{message}"
+      when 422
+        raise LiquidInvalidDataPointError.new "#{error_code}: #{message}"
+      else
+        raise LiquidError.new "#{error_code}: #{message}"
+      end
+    end
+  end
+end

data/lib/liquid/network.rb

@@ -0,0 +1,63 @@
+class Liquid::Network
+  require 'rest_client'
+
+  USER_AGENT = "Liquid/#{Liquid::VERSION} (Ruby ;)"
+
+  def initialize(end_point = nil, token = nil)
+    @headers = default_headers
+    @end_point = end_point
+    change_token token unless token.nil?
+  end
+
+  def get(path)
+    parse(generic_request(path).get(&handle_error))
+  end
+
+  def post(path, params = {})
+    parse(generic_request(path).post params, &handle_error)
+  end
+
+  def put(path, params = {})
+    parse(generic_request(path).put params, &handle_error)
+  end
+
+  def delete(path, params = {})
+    parse(generic_request(path).delete params, &handle_error)
+  end
+
+  def generic_request(path)
+    RestClient::Resource.new("#{@end_point}#{path}", headers: @headers)
+  end
+
+  def change_token(token)
+    @headers['Authorization'] = "Token #{token}"
+  end
+
+  def default_headers
+    {
+      'User-Agent' => USER_AGENT,
+      'Accept' => 'application/vnd.lqd.v1+json',
+      'Content-Type' => 'application/json',
+      'Accept-Encoding' => 'gzip',
+      'Authorization' => 'Token '
+    }
+  end
+
+  private
+
+  def parse(response)
+    JSON.parse(response)
+  rescue JSON::ParserError
+    true
+  end
+
+  def handle_error
+    proc do |response, request, result, &block|
+      if response.code >= 400 && response.code <= 500
+        Liquid::ErrorHandler.fail response.code, response
+      else
+        response.return!(request, result, &block)
+      end
+    end
+  end
+end

data/lib/liquid/request_factory.rb

@@ -0,0 +1,29 @@
+# Requests router between analyze and collect
+class Liquid::RequestFactory
+  COLLECT_ENDPOINT = 'https://api.lqd.io/collect/'
+  ANALYZE_ENDPOINT = 'https://analyze.onliquid.com/'
+
+  def initialize(configuration = nil)
+    configure configuration unless configuration.nil?
+  end
+
+  def configure(configuration)
+    @collect_token = configuration.collect_api
+    @analyze_token = configuration.analyze_api
+    @collect = Liquid::Network.new COLLECT_ENDPOINT, @collect_token
+    @analyze = Liquid::Network.new ANALYZE_ENDPOINT, @analyze_token
+  end
+
+  def create_data_point(data_point)
+    @collect.post 'data_points', data_point
+  end
+
+  def make_alias(old_unique_id, new_unique_id)
+    payload = { unique_id: new_unique_id, unique_id_alias: old_unique_id }
+    @collect.post 'aliases', payload
+  end
+
+  def user(unique_id)
+    @analyze.get "users/#{unique_id}"
+  end
+end

data/lib/liquid/version.rb

@@ -0,0 +1,3 @@
+module Liquid
+  VERSION = '0.1.0'
+end

data/liquid.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'liquid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'liquid-ruby'
+  spec.version       = Liquid::VERSION
+  spec.authors       = ['Ricardo Leitao']
+  spec.email         = ['rleitao@onliquid.com']
+
+  spec.summary       = 'Ruby wrapper for the Liquid API'
+  spec.description   = 'Ruby wrapper for the Liquid API (https://onliquid.com)'
+  spec.homepage      = 'https://github.com/lqd-io/liquid-ruby'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'rest-client', '~> 1.8.0'
+  spec.add_dependency 'json'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: liquid-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ricardo Leitao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-20 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  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: webmock
+  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: vcr
+  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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
+description: Ruby wrapper for the Liquid API (https://onliquid.com)
+email:
+- rleitao@onliquid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/liquid.rb
+- lib/liquid/configuration.rb
+- lib/liquid/errors.rb
+- lib/liquid/network.rb
+- lib/liquid/request_factory.rb
+- lib/liquid/version.rb
+- liquid.gemspec
+homepage: https://github.com/lqd-io/liquid-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Liquid API
+test_files: []