exponea 0.1.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d8111631a0a3da6036f5362eb1b51d6ca7f94f764b7378b5b407fc9301e72fc
+  data.tar.gz: 9adbf7e19a2fabb6dbaf1407078f14561cdac62e956ac2768c3c0e6054059e86
+SHA512:
+  metadata.gz: ac433b30f2e2f37e03b4eccb95a2c5e0e434c546edadb7451cf31f13c1be3c855f557c9651f3a3af333ee6be895bf0497a030792d498b25296e16e7d75b4d816
+  data.tar.gz: 366d90775525bab712c0a42b677844407333f2afe117f43dba25588d6373106113e072d592a49633c8ccb98b58a495df1dac8fb80614f993e36a393e119f7cd8

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: false
+  rubocop:
+    enabled: false
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,54 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+Layout/LineLength:
+  IgnoredPatterns: ['^#']
+  Max: 150
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'exponea.gemspec'
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+#Layout/HashAlignment:
+#  EnforcedColonStyle:
+
+Metrics/AbcSize:
+  Max: 25
+
+Style/Documentation:
+  Enabled: false
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/MethodLength:
+  Max: 15
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/DoubleNegation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+dist: trusty
+
+language: ruby
+
+cache: bundler
+
+notifications:
+  email: false
+
+rvm:
+  - 2.6.5
+
+before_install:
+  - gem install bundler
+
+script:
+  - bundle exec rspec --format progress

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    exponea (0.1.9)
+      faraday (~> 1)
+      faraday_middleware (~> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    codecov (0.1.21)
+      json
+      simplecov
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    json (2.3.1)
+    multipart-post (2.1.1)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    unicode-display_width (1.7.0)
+    webmock (3.9.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codecov (~> 0.1.10)
+  exponea!
+  rake (~> 13.0)
+  rspec (~> 3.6)
+  rubocop (~> 0.93.0)
+  simplecov (~> 0.18.5)
+  webmock (~> 3.9.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Lubomir Vnenk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+[![Build Status](https://travis-ci.com/lubosch/exponea.svg?branch=master)](https://travis-ci.com/lubosch/exponea)
+[![Coverage Status](https://codecov.io/gh/lubosch/exponea/branch/master/graph/badge.svg)](https://codecov.io/gh/lubosch/exponea)
+
+# Exponea
+
+Gem for creating or updating customers in Exponea and triggering events in single or batch mode.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exponea'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install exponea
+
+## Configuration
+
+```
+Exponea.configure do |config|
+  config.project = Rails.application.config_for(:exponea)[:project]
+  config.token = Rails.application.config_for(:exponea)[:token]
+  config.api_secret = Rails.application.config_for(:exponea)[:api_secret]
+end
+```
+
+Initialize `exponea.rb` with this settings:
+- **project**: project id from exponea
+- **token**: token generated from exponea
+- **api_secret**(optional): secret API you can use in controllers to authorize requests from exponea to your app
+
+## Usage
+
+### Create or update customer
+```
+Exponea::Customers.update_properties(customer_id, properties, batch = false)
+```
+- **customer_id**: use either `registered` id or hash with one of your id
+- **properties**: hash of properties to be updated
+- **batch**: returns hash that can be sent as batch
+
+### Add event
+```
+Exponea::Events.add_event(customer_id, event_type, properties = nil, batch = false, timestamp = nil)`
+```
+- **customer_id**: use either `registered` id or hash with one of your id
+- **event_type**: event name defined in exponea
+- **batch**: returns hash that can be sent as batch
+- **timestamp**: modified timestamp of event if needed
+
+### Batch events
+```
+Exponea::BaseApi.batch_commands(commands)
+```
+
+- **commands**: list of commands created with `batch = true`. They are sent in batches of 50 (exponea limitation)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lubosch/exponea.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'exponea'
+
+# 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(__FILE__)

data/bin/setup

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

data/changelog.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## 1.0
+Basic api created
+
+## 1.1
+???
+
+## 1.2
+???
+
+## 1.3
+add support for multiple ids in add_event
+
+## 1.6
+Static analysis + readme
+
+## 1.7
+Bump faraday version
+
+## 1.8
+Better batch error handling
+
+## 1.9
+Metadata update

data/exponea.gemspec

@@ -0,0 +1,38 @@
+require_relative 'lib/exponea/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'exponea'
+  spec.version = Exponea::VERSION
+  spec.authors = ['Lubomir Vnenk']
+  spec.email = ['lubomir.vnenk@zoho.com']
+
+  spec.summary = 'Gem to integrate exponea into your app'
+  spec.description = 'Gem to integrate exponea into your app. Provides api for adding events and users, also bulk actions'
+  spec.homepage = 'https://github.com/lubosch/exponea'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.extra_rdoc_files = %w[README.md changelog.md]
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/lubosch/exponea'
+  spec.metadata['changelog_uri'] = 'https://github.com/lubosch/exponea/blob/master/changelog.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'faraday', '~> 1'
+  spec.add_dependency 'faraday_middleware', '~> 1'
+
+  spec.add_development_dependency 'codecov', '~> 0.1.10'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rubocop', '~> 0.93.0'
+  spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  spec.add_development_dependency 'webmock', '~> 3.9.0'
+end

data/lib/exponea.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'exponea/base_api'
+require 'exponea/configuration'
+require 'exponea/customers'
+require 'exponea/events'
+require 'exponea/version'
+
+module Exponea
+  @configuration = Configuration.new
+
+  def self.config
+    @configuration
+  end
+
+  def self.configure
+    yield(@configuration)
+  end
+
+  class Error < StandardError
+  end
+end

data/lib/exponea/base_api.rb

@@ -0,0 +1,52 @@
+module Exponea
+  class BaseApi
+    EXPONEA_URL = 'https://api.exponea.com'.freeze
+
+    def self.request(uri, method = 'POST', payload = nil)
+      client = Faraday.new(url: EXPONEA_URL) do |faraday|
+        faraday.request :json
+        faraday.response :json
+
+        faraday.adapter Faraday.default_adapter
+      end
+
+      response = client.send(method.downcase.to_sym) do |request|
+        request.headers['authorization'] = "Basic #{Exponea.config.token}"
+        request.url(uri)
+        request.body = payload
+      end
+      response.body
+    end
+
+    def self.batch_commands(commands)
+      responses = []
+      commands.each_slice(50) do |command_batch|
+        path = "track/v2/projects/#{Exponea.config.project}/batch"
+        payload = { commands: command_batch }
+        response = post(path, payload)
+        response = post(path, payload) unless response['success'] # retry if exponea failed for some reason
+
+        next unless response['success']
+
+        response['results'].each { |result| responses.push(response['time'] ? result['time'] : result['success']) }
+      end
+      responses
+    end
+
+    def self.get(path)
+      request(path, 'GET')
+    end
+
+    def self.post(path, payload)
+      request(path, 'POST', payload)
+    end
+
+    def self.delete(path, payload)
+      request(path, 'DELETE', payload)
+    end
+
+    def self.put(path, payload)
+      request(path, 'PUT', payload)
+    end
+  end
+end

data/lib/exponea/configuration.rb

@@ -0,0 +1,11 @@
+module Exponea
+  class Configuration
+    attr_accessor :project, :token, :api_secret
+
+    def initialize
+      @project = ENV['EXPONEA_PROJECT']
+      @token = ENV['EXPONEA_TOKEN']
+      @api_secret = ENV['EXPONEA_API_SECRET']
+    end
+  end
+end

data/lib/exponea/customers.rb

@@ -0,0 +1,60 @@
+module Exponea
+  class Customers < BaseApi
+    def self.update_properties(customer_id, properties, batch = false)
+      customer_ids = customer_id.is_a?(Hash) ? customer_id : { registered: customer_id }
+      payload = { customer_ids: customer_ids, properties: properties }
+      return { name: 'customers', data: payload } if batch
+
+      path = "/track/v2/projects/#{Exponea.config.project}/customers"
+      post(path, payload)
+    end
+
+    # def self.customer(ids)
+    #   path = "/data/v2/projects/#{Exponea.config.project}/customers/export-one"
+    #   payload = { customer_ids: ids }
+    #   post(path, payload)
+    # end
+
+    # def customer_consents(ids, consents)
+    #   path = "/data/v2/projects/#{Exponea.config.project}/customers/attributes"
+    #   payload = { customer_ids: ids,
+    #               attributes: consents.map { |consent| { type: 'consent', category: consent } } }
+    #   post(path, payload)
+    # end
+
+    # def customer_attributes(customer_ids, properties: [], segmentations: [], ids: [], expressions: [], aggregations: [], predictions: [])
+    #   path = "/data/v2/projects/#{Exponea.config.project}/customers/attributes"
+    #   payload = {
+    #     customer_ids: customer_ids,
+    #     attributes:
+    #       properties.map { |property| { type: 'property', property: property } } +
+    #         segmentations.map { |segment| { type: 'segmentation', id: segment } } +
+    #         ids.map { |id| { type: 'id', id: id } } +
+    #         expressions.map { |expression| { type: 'expression', id: expression } } +
+    #         aggregations.map { |aggregate| { type: 'aggregate', id: aggregate } } +
+    #         predictions.map { |prediction| { type: 'prediction', id: prediction } }
+    #   }
+    #   post(path, payload)
+    # end
+
+    # def self.customers
+    #   path = "/data/v2/projects/#{Exponea.config.project}/customers/export"
+    #   payload = { format: 'native_json' }
+    #   users = []
+    #   response = post(path, payload)
+    #   response['fields'].filter {|field| field['type'] == 'id'}
+    # end
+
+    # def self.events(customer_ids, event_types)
+    #   path = "/data/v2/projects/#{Exponea.config.project}/customers/events"
+    #   payload = { customer_ids: customer_ids, event_types: event_types }
+    #   response = post(path, payload)
+    # end
+
+    # def self.anonymize_customer(customer_ids)
+    #   path = "/data/v2/projects/#{Exponea.config.project}/customers/anonymize"
+    #   payload = { customer_ids: customer_ids }
+    #   response = post(path, payload)
+    # end
+  end
+end

data/lib/exponea/events.rb

@@ -0,0 +1,15 @@
+module Exponea
+  class Events < BaseApi
+    def self.add_event(customer_id, event_type, properties = nil, batch = false, timestamp = nil)
+      customer_ids = customer_id.is_a?(Hash) ? customer_id : { registered: customer_id }
+      payload = { customer_ids: customer_ids,
+                  properties: properties,
+                  event_type: event_type }
+      payload = payload.merge(timestamp: timestamp.to_i) if timestamp
+      return { name: 'customers/events', data: payload } if batch
+
+      path = "/track/v2/projects/#{Exponea.config.project}/customers/events"
+      post(path, payload)
+    end
+  end
+end

data/lib/exponea/version.rb

@@ -0,0 +1,3 @@
+module Exponea
+  VERSION = '0.1.9'.freeze
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: exponea
+version: !ruby/object:Gem::Version
+  version: 0.1.9
+platform: ruby
+authors:
+- Lubomir Vnenk
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.93.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+description: Gem to integrate exponea into your app. Provides api for adding events
+  and users, also bulk actions
+email:
+- lubomir.vnenk@zoho.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- changelog.md
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changelog.md
+- exponea.gemspec
+- lib/exponea.rb
+- lib/exponea/base_api.rb
+- lib/exponea/configuration.rb
+- lib/exponea/customers.rb
+- lib/exponea/events.rb
+- lib/exponea/version.rb
+homepage: https://github.com/lubosch/exponea
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lubosch/exponea
+  source_code_uri: https://github.com/lubosch/exponea
+  changelog_uri: https://github.com/lubosch/exponea/blob/master/changelog.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Gem to integrate exponea into your app
+test_files: []